Interfaces¶
Table of Contents
-
class
dials.interfaces.__init__.
BackgroundIface
(params, experiments)[source]¶ Bases:
dials.framework.interface.Interface
Interface for background algorithms.
-
compute_background
(reflections)[source]¶ Compute the reflection background
Parameters: reflections – The list of reflections
-
name
= 'background'¶
-
scope
= 'integration'¶
-
-
class
dials.interfaces.__init__.
CentroidIface
(params, experiments)[source]¶ Bases:
dials.framework.interface.Interface
Interface for centroid algorithms.
-
compute_centroid
(reflections)[source]¶ Compute the reflection centroids
Parameters: reflections – The list of reflections
-
name
= 'centroid'¶
-
scope
= 'integration'¶
-
-
class
dials.interfaces.__init__.
ProfileModelIface
[source]¶ Bases:
dials.framework.interface.Interface
The interface definition for a profile model.
-
name
= 'profile'¶
-
-
class
dials.interfaces.__init__.
ProfileModelInterfaceMeta
(name, bases, attrs)[source]¶ 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)[source]¶ Bases:
dials.framework.interface.Interface
Interface for threshold algorithms to be used in spot finding.
-
compute_threshold
(image, mask)[source]¶ 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'¶
-