Image#

class lsst.ts.wep.Image(image, fieldAngle, defocalType, bandLabel=BandLabel.REF, planeType=PlaneType.Image, blendOffsets=None)#

Bases: object

Class to hold a donut image along with metadata.

All quantities in this object are assumed to be in the global camera coordinate system (CCS). See https://sitcomtn-003.lsst.io for details.

I specify the “global” coordinate system because corner wavefront sensor images from the butler are rotated by some multiple of 90 degrees with respect to the global coordinate system. These images should be de-rotated before being stored in this object.

Parameters:

image (np.ndarray) – The square numpy array containing the donut image.
fieldAngle (np.ndarray or tuple or list) – The field angle of the donut, in degrees. The field angle is the angle to the source, measured from the optical axis. See the note on coordinate systems above.
defocalType (DefocalType or str) – Whether the image is intra- or extra-focal. Can be specified using a DefocalType Enum or the corresponding string.
bandLabel (BandLabel or str, optional) – Photometric band for the exposure. Can be specified using a BandLabel Enum or the corresponding string. If None, BandLabel.REF is used. The empty string “” also maps to BandLabel.REF. (the default is BandLabel.REF)
planeType (PlaneType or str, optional) – Whether the image is on the image plane or the pupil plane. Can be specified using a PlaneType Enum, or the corresponding string. (the default is PlaneType.Image)
blendOffsets (np.ndarray or tuple or list, optional) – Positions of blended donuts relative to central donut, in pixels. Must be provided in the format [[dx1, dy1], [dx2, dy2], …]. Note these shifts must be in the global CCS (see the note on coordinate systems above). (the default is an empty array, i.e. no blends)

Attributes Summary

`bandLabel`	The BandLabel Enum of the image.
`blendOffsets`	The blend offsets array for the image.
`defocalType`	Return the DefocalType Enum of the image.
`fieldAngle`	The field angle in degrees.
`image`	The donut image array.
`mask`	The image source mask.
`maskBackground`	The image background mask.
`maskBlends`	The image source mask.
`masks`	Return (self.mask, self.maskBlends, self.maskBackground).
`planeType`	The PlaneType Enum of the image.

Methods Summary

copy()

Return a copy of the DonutImage object.

Attributes Documentation

bandLabel#: The BandLabel Enum of the image.

blendOffsets#: The blend offsets array for the image.

defocalType#: Return the DefocalType Enum of the image.

fieldAngle#: The field angle in degrees.

image#: The donut image array.

mask#

The image source mask.

This mask has value 1 for source pixels and value 0 for other pixels.

maskBackground#

The image background mask.

This mask has value 1 for background pixels and value 0 for other pixels.

maskBlends#

The image source mask.

This mask has value 1 for blend pixels and value 0 for other pixels.

masks#: Return (self.mask, self.maskBlends, self.maskBackground).

planeType#: The PlaneType Enum of the image.

Methods Documentation

copy()#

Return a copy of the DonutImage object.

Returns:: A deep copy of self.
Return type:: DonutImage