DonutStamps

class lsst.ts.wep.task.DonutStamps(stamps, metadata=None, use_mask=True, use_variance=True, use_archive=False)

Bases: StampsBase

Holds a list of DonutStamp objects with additional functions to get metadata as well as save as FITS files. This storage class is able to be used with the Gen 3 Butler and is storable and readable within a Gen 3 repository.

Attributes Summary

metadata

Methods Summary

append(newStamp)	Add an additional stamp.
count(value)
extend(newStampList)	Extend DonutStamps instance by appending elements from another instance.
getArchiveElements()	Retrieve archive elements associated with each stamp.
getBandpasses()	Get the bandpass for each stamp.
getBlendCentroids()	Get the X,Y centroid positions of the blended sources in pixels.
getCameraNames()	Get the instrument name for each stamp.
getCentroidPositions()	Get the centroid positions of the DonutStamps in the original image.
getDefocalDistances()	Get the defocal distance for each stamp.
getDefocalTypes()	Get the defocal type for each stamp.
getDetectorNames()	Get the detector name for each stamp.
getMaskedImages()	Retrieve star images.
getSkyPositions()	Get the ra, dec coordinates in degrees of the DonutStamps.
getXY0Positions()	Get the corner position of the DonutStamp BBox locations.
index(value, [start, [stop]])	Raises ValueError if the value is not present.
readFits(filename)	Build an instance of this class from a file.
readFitsWithOptions(filename, options)	Build an instance of this class with options.
writeFits(filename)	Write this object to a file.

Attributes Documentation

metadata

Methods Documentation

append(newStamp)

Add an additional stamp.

Parameters

newStampDonutStamp

DonutStamp object to append.

Raises

ValueError

newStamp must be a DonutStamp object.

count(value) → integer -- return number of occurrences of value

extend(newStampList)

Extend DonutStamps instance by appending elements from another instance.

Parameters

newStampListlist [DonutStamp]

List of DonutStamp object to append.

Raises

ValueError

newStampList must only contain DonutStamp objects.

getArchiveElements()

Retrieve archive elements associated with each stamp.

Returns

archiveElements

list [Persistable]

getBandpasses()

Get the bandpass for each stamp.

Returns

list [str]

Bandpass name for each stamp.

getBlendCentroids()

Get the X,Y centroid positions of the blended sources in pixels.

Returns

list [[str], [str]]

X,Y pixel locations of centers of sources blended with the central source.

getCameraNames()

Get the instrument name for each stamp.

Returns

list [str]

Camera names for each stamp.

getCentroidPositions()

Get the centroid positions of the DonutStamps in the original image.

Returns

list [lsst.geom.Point2I]

X,Y pixel locations of center of DonutStamp images.

getDefocalDistances()

Get the defocal distance for each stamp.

Returns

list [float]

Defocal distances for each stamp in mm.

getDefocalTypes()

Get the defocal type for each stamp.

Returns

list [str]

Defocal types for each stamp.

getDetectorNames()

Get the detector name for each stamp.

Returns

list [str]

Detector Names for each stamp.

getMaskedImages()

Retrieve star images.

Returns

maskedImages

list [MaskedImageF]

getSkyPositions()

Get the ra, dec coordinates in degrees of the DonutStamps.

Returns

list [lsst.geom.SpherePoint]

Ra, Dec locations of donuts.

getXY0Positions()

Get the corner position of the DonutStamp BBox locations.

Returns

list [lsst.geom.Point2I]

Corner of BBox of DonutStamp lsst.afw.image.MaskedImage.

index(value[, start[, stop]]) → integer -- return first index of value.

Raises ValueError if the value is not present.

Supporting start and stop arguments is optional, but recommended.

classmethod readFits(filename)

Build an instance of this class from a file.

Parameters

filenamestr

Name of the file to read.

Returns

DonutStamps

An instance of this class.

classmethod readFitsWithOptions(filename, options)

Build an instance of this class with options.

Parameters

filenamestr

Name of the file to read.

optionslsst.daf.base.PropertyList or dict

Collection of metadata parameters.

Returns

DonutStamps

An instance of this class.

writeFits(filename)

Write this object to a file.

Parameters

filenamestr

Name of file to write.