Interfaces

Table of Contents

• Interfaces

class dials.interfaces.__init__.BackgroundIface(params, experiments)

Bases: dials.framework.interface.Interface

Interface for background algorithms.

compute_background(reflections)

Compute the reflection background

Parameters:reflections – The list of reflections

name = 'background'

scope = 'integration'

class dials.interfaces.__init__.CentroidIface(params, experiments)

Bases: dials.framework.interface.Interface

Interface for centroid algorithms.

compute_centroid(reflections)

Compute the reflection centroids

Parameters:reflections – The list of reflections

name = 'centroid'

scope = 'integration'

class dials.interfaces.__init__.ProfileModelIface

Bases: dials.framework.interface.Interface

The interface definition for a profile model.

classmethod algorithm()

Get the algorithm.

classmethod from_dict(d)

Get from dictionary.

name = 'profile'

class dials.interfaces.__init__.ProfileModelInterfaceMeta(name, bases, attrs)

Bases: dials.framework.interface.InterfaceMeta

The interface meta class.

This class adds some definition-time checking to the Interface base class to make sure that interfaces have the required fields.

class dials.interfaces.__init__.SpotFinderThresholdIface(params, imageset)

Bases: dials.framework.interface.Interface

Interface for threshold algorithms to be used in spot finding.

compute_threshold(image, mask)

Threshold the image. The image may be either a flex.int or flex.double type. The thresholded image should be returned as a flex.bool where pixels labelled True are spot pixels and False are background.

Parameters:

• image – The image to threshold
• mask – The corresponding mask

Returns:

The thresholded image

name = 'threshold'

scope = 'spotfinder'