AsLegacy ( self )

Returns a string describing the complete detector calibration.

This is basically a concatenation of all standard calibration files.

AsXml ( self,  filename='calibration.xml' )

Returns a string describing the complete detector calibration as XML.

There are currently no programs that can read the calibration from the resulting data. This is for future use.

DistortionSet ( self,  **kw )

Used by calibration procedures to create the distortion calibration.

Save ( self )

Save all calibration components

SaveIfModified ( self )

Save all calibration components that were modified

__init__ (
        self,
        header=None,
        ideal=0,
        )

Constructor.

Parameters:

header

image header used to identify the detector.

ideal

boolean indicating whether idealized calibration data are desired.

__repr__ ( self )

A summary string

align ( self )

Returns an object describing the detector alignment.

The following attributes are available on the returned object:

detzero

3-element list with the zero-point of the detector

detalign

3-element list describing the rotations of the detector around the three primary axes

ideal

boolean indicating whether these values are idealized if this is false, the values have been read from a calibration file.

All attributes are read-only. Changing any value will have unpredictable results.

badpixel ( self )

Returns an object describing the unreliable pixels of the detector.

The following attributes are available on the returned object:

pix

A list of 4-tuples, each describing one unreliable pixel. The four elements are the horizontal pixel coordinate, the vertical pixel coordinate, the variance of the pixel at 0 second exposure time, and the variance added to the pixel for every second of exposure time.

ideal

boolean indicating whether these values are idealized if this is false, the values have been read from a calibration file.

All attributes are read-only. Changing any value will have unpredictable results.

distortion ( self )

Returns an object describing the distortion of the detector.

The following attributes are available on the returned object:

mm2pxpol

a polynomial function that returns the vertical pixel coordinate when given horizontal and vertical millimeter coordinates of a point.

mm2pypol

a polynomial function that returns the horizontal pixel coordinate when given horizontal and vertical millimeter coordinates of a point.

p2mmxpol

a polynomial function that returns the horizontal millimeter coordinate when given vertical and horizontal pixel coordinates of a point.

p2mmypol

a polynomial function that returns the vertical millimeter coordinate when given vertical and horizontal pixel coordinates of a point.

ideal

boolean indicating whether these values are idealized if this is false, the values have been read from a calibration file.

All attributes are read-only. Changing any value will have unpredictable results.

incidencecoefficient ( self )

Returns an object describing the incidence coefficients.

The following attributes are available on the returned object:

getvalue

A function that will return the incidence coefficient. It can be passed an argument wavelength to ask for the incidence coefficient at another wavelength than the currently active one.

ideal

boolean indicating whether these values are idealized if this is false, the values have been read from a calibration file.

All attributes are read-only. Changing any value will have unpredictable results.