Inheritance diagram for lsst.meas.algorithms.defects.Defects:
Public Member Functions | |
| def | __init__ (self, defectList=None, metadata=None) |
| def | __len__ (self) |
| def | __getitem__ (self, index) |
| def | __setitem__ (self, index, value) |
| def | __iter__ (self) |
| def | __delitem__ (self, index) |
| def | __eq__ (self, other) |
| def | __str__ (self) |
| def | insert (self, index, value) |
| def | getMetadata (self) |
| def | setMetadata (self, metadata=None) |
| def | copy (self) |
| def | transpose (self) |
| def | maskPixels (self, maskedImage, maskName="BAD") |
| def | toTable (self) |
| def | writeFits (self, args) |
| def | fromTable (cls, table) |
| def | readFits (cls, args) |
| def | readLsstDefectsFile (cls, filename) |
| def | fromFootprintList (cls, fpList) |
| def | fromMask (cls, maskedImage, maskName) |
Detailed Description
Collection of `lsst.meas.algorithms.Defect`.
Parameters
----------
defectList : iterable of `lsst.meas.algorithms.Defect`
or `lsst.geom.BoxI`, optional
Collections of defects to apply to the image.
Definition at line 78 of file defects.py.
Constructor & Destructor Documentation
◆ __init__()
| def lsst.meas.algorithms.defects.Defects.__init__ | ( | self, | |
defectList = None, |
|||
metadata = None |
|||
| ) |
Definition at line 91 of file defects.py.
Member Function Documentation
◆ __delitem__()
| def lsst.meas.algorithms.defects.Defects.__delitem__ | ( | self, | |
| index | |||
| ) |
Definition at line 152 of file defects.py.
◆ __eq__()
| def lsst.meas.algorithms.defects.Defects.__eq__ | ( | self, | |
| other | |||
| ) |
Compare if two `Defects` are equal. Two `Defects` are equal if their bounding boxes are equal and in the same order. Metadata content is ignored.
Definition at line 155 of file defects.py.
◆ __getitem__()
| def lsst.meas.algorithms.defects.Defects.__getitem__ | ( | self, | |
| index | |||
| ) |
Definition at line 141 of file defects.py.
◆ __iter__()
| def lsst.meas.algorithms.defects.Defects.__iter__ | ( | self | ) |
Definition at line 149 of file defects.py.
◆ __len__()
| def lsst.meas.algorithms.defects.Defects.__len__ | ( | self | ) |
Definition at line 138 of file defects.py.
◆ __setitem__()
| def lsst.meas.algorithms.defects.Defects.__setitem__ | ( | self, | |
| index, | |||
| value | |||
| ) |
Can be given a `~lsst.meas.algorithms.Defect` or a `lsst.geom.BoxI`
Definition at line 144 of file defects.py.
◆ __str__()
| def lsst.meas.algorithms.defects.Defects.__str__ | ( | self | ) |
Definition at line 171 of file defects.py.
◆ copy()
| def lsst.meas.algorithms.defects.Defects.copy | ( | self | ) |
Copy the defects to a new list, creating new defects from the
bounding boxes.
Returns
-------
new : `Defects`
New list with new `Defect` entries.
Notes
-----
This is not a shallow copy in that new `Defect` instances are
created from the original bounding boxes. It's also not a deep
copy since the bounding boxes are not recreated.
Definition at line 207 of file defects.py.
◆ fromFootprintList()
| def lsst.meas.algorithms.defects.Defects.fromFootprintList | ( | cls, | |
| fpList | |||
| ) |
Compute a defect list from a footprint list, optionally growing
the footprints.
Parameters
----------
fpList : `list` of `lsst.afw.detection.Footprint`
Footprint list to process.
Returns
-------
defects : `Defects`
List of defects.
Definition at line 429 of file defects.py.
◆ fromMask()
| def lsst.meas.algorithms.defects.Defects.fromMask | ( | cls, | |
| maskedImage, | |||
| maskName | |||
| ) |
Compute a defect list from a specified mask plane.
Parameters
----------
maskedImage : `lsst.afw.image.MaskedImage`
Image to process.
maskName : `str` or `list`
Mask plane name, or list of names to convert.
Returns
-------
defects : `Defects`
Defect list constructed from masked pixels.
Definition at line 447 of file defects.py.
◆ fromTable()
| def lsst.meas.algorithms.defects.Defects.fromTable | ( | cls, | |
| table | |||
| ) |
Construct a `Defects` from the contents of a
`~lsst.afw.table.BaseCatalog`.
Parameters
----------
table : `lsst.afw.table.BaseCatalog`
Table with one row per defect.
Returns
-------
defects : `Defects`
A `Defects` list.
Definition at line 313 of file defects.py.
◆ getMetadata()
| def lsst.meas.algorithms.defects.Defects.getMetadata | ( | self | ) |
Retrieve metadata associated with these `Defects`.
Returns
-------
meta : `lsst.daf.base.PropertyList`
Metadata. The returned `~lsst.daf.base.PropertyList` can be
modified by the caller and the changes will be written to
external files.
Definition at line 177 of file defects.py.
◆ insert()
| def lsst.meas.algorithms.defects.Defects.insert | ( | self, | |
| index, | |||
| value | |||
| ) |
Definition at line 174 of file defects.py.
◆ maskPixels()
| def lsst.meas.algorithms.defects.Defects.maskPixels | ( | self, | |
| maskedImage, | |||
maskName = "BAD" |
|||
| ) |
Set mask plane based on these defects.
Parameters
----------
maskedImage : `lsst.afw.image.MaskedImage`
Image to process. Only the mask plane is updated.
maskName : str, optional
Mask plane name to use.
Definition at line 241 of file defects.py.
◆ readFits()
| def lsst.meas.algorithms.defects.Defects.readFits | ( | cls, | |
| args | |||
| ) |
Read defect list from FITS table.
Parameters
----------
*args
Arguments to be forwarded to
`lsst.afw.table.BaseCatalog.writeFits`.
Returns
-------
defects : `Defects`
Defects read from a FITS table.
Definition at line 369 of file defects.py.
◆ readLsstDefectsFile()
| def lsst.meas.algorithms.defects.Defects.readLsstDefectsFile | ( | cls, | |
| filename | |||
| ) |
Read defects information from an LSST format text file.
Parameters
----------
filename : `str`
Name of text file containing the defect information.
Returns
-------
defects : `Defects`
The defects.
Notes
-----
These defect text files are used as the human readable definitions
of defects in calibration data definition repositories. The format
is to use four columns defined as follows:
x0 : `int`
X coordinate of bottom left corner of box.
y0 : `int`
Y coordinate of bottom left corner of box.
width : `int`
X extent of the box.
height : `int`
Y extent of the box.
Definition at line 390 of file defects.py.
◆ setMetadata()
| def lsst.meas.algorithms.defects.Defects.setMetadata | ( | self, | |
metadata = None |
|||
| ) |
Store a copy of the supplied metadata with the defects.
Parameters
----------
metadata : `lsst.daf.base.PropertyList`, optional
Metadata to associate with the defects. Will be copied and
overwrite existing metadata. If not supplied the existing
metadata will be reset.
Definition at line 189 of file defects.py.
◆ toTable()
| def lsst.meas.algorithms.defects.Defects.toTable | ( | self | ) |
Convert defect list to `~lsst.afw.table.BaseCatalog`
Returns
-------
table : `lsst.afw.table.BaseCatalog`
Defects in tabular form.
Definition at line 258 of file defects.py.
◆ transpose()
| def lsst.meas.algorithms.defects.Defects.transpose | ( | self | ) |
Make a transposed copy of this defect list.
Returns
-------
retDefectList : `Defects`
Transposed list of defects.
Definition at line 224 of file defects.py.
◆ writeFits()
| def lsst.meas.algorithms.defects.Defects.writeFits | ( | self, | |
| args | |||
| ) |
Write defect list to FITS.
Parameters
----------
*args
Arguments to be forwarded to
`lsst.afw.table.BaseCatalog.writeFits`.
Definition at line 292 of file defects.py.
The documentation for this class was generated from the following file:
- python/lsst/meas/algorithms/defects.py
