AddFilter ( self,  filter )

Add a peak filter (some other classes in this module)

ChainAppend ( self,  sink )

Add an image sink to the chain of image filters used.

For internal use only.

HighPixel ( self )

Return the highest pixel value per (second/degree) encountered in the peak search.

PeakRadius ( self )

Return an estimated (single sigma) peak radius (in mm)

Read ( self,  filename )

Read the image in filename, and return a peak list.

RequireAlignment ( self )

Require Detector alignment.

This can be called if you want to make sure that detector alignment calibration is available for the detector while making a peak search.

RequireDistortion ( self )

Require Distortion polynomial.

This can be called if you want to make sure that distortion correction is available for the detector while making a peak search.

UnfilteredRead ( self,  filename )

Read the image in filename and return an unfiltered peak list.

Internal use.

__call__ ( self,  filename )

Read the image in filename, and return a peak list.

This is the normal way to use this object.

__init__ (
        self,
        peaksclass=Peaks,
        hints=0,
        sensi=0,
        accurate=0,
        kill=3.8,
        filter=1,
        allowshift=1.0,
        hardware=None,
        )

Constructor.

optional arguments:

peaksclass

either Peaks or SimplePeaks from this same module, or a class deriving from it. This class will be used as 'peak list's

hints

if set to 1, some global variables about peak size will be written after peak search is completed.

sensi

if set to 1, detector sensitivity correction is applied. This normally does not make sense, since the integration used by default is very rough!

accurate

use the integrate routine from this module to get more accurate intensity and sigma values. The resulting peak lists will have a ".rec" attribute for each peak that gives the integration record.

kill

set the peak search sensitivity (the number of sigma's above the background for a single pixel required to start considering a peak). Lowering this will slow down peak search significantly.

filter

if set to 1, correct incoming images for ADC0, dark current, and bad pixels before use.

hardware

hardware connection object