Class to support bright object masks
N.b. I/O is done by providing a readFits method which fools the butler.
Definition at line 11 of file objectMasks.py.
◆ __init__()
def lsst.pipe.tasks.objectMasks.ObjectMaskCatalog.__init__ |
( |
|
self | ) |
|
◆ __getitem__()
def lsst.pipe.tasks.objectMasks.ObjectMaskCatalog.__getitem__ |
( |
|
self, |
|
|
|
i |
|
) |
| |
◆ __iter__()
def lsst.pipe.tasks.objectMasks.ObjectMaskCatalog.__iter__ |
( |
|
self | ) |
|
◆ __len__()
def lsst.pipe.tasks.objectMasks.ObjectMaskCatalog.__len__ |
( |
|
self | ) |
|
◆ __setitem__()
def lsst.pipe.tasks.objectMasks.ObjectMaskCatalog.__setitem__ |
( |
|
self, |
|
|
|
i, |
|
|
|
v |
|
) |
| |
◆ readFits()
def lsst.pipe.tasks.objectMasks.ObjectMaskCatalog.readFits |
( |
|
fileName, |
|
|
|
hdu = 0 , |
|
|
|
flags = 0 |
|
) |
| |
|
static |
Read a ds9 region file, returning a ObjectMaskCatalog object
This method is called "readFits" to fool the butler. The corresponding mapper entry looks like
brightObjectMask: {
template: "deepCoadd/BrightObjectMasks/%(tract)d/BrightObjectMask-%(tract)d-%(patch)s-%(filter)s.reg"
python: "lsst.obs.subaru.objectMasks.ObjectMaskCatalog"
persistable: "PurePythonClass"
storage: "FitsCatalogStorage"
}
and this is the only way I know to get it to read a random file type, in this case a ds9 region file.
This method expects to find files named as BrightObjectMask-%(tract)d-%(patch)s-%(filter)s.reg
The files should be structured as follows:
# Description of catalogue as a comment
# CATALOG: catalog-id-string
# TRACT: 0
# PATCH: 5,4
# FILTER: HSC-I
wcs; fk5
circle(RA, DEC, RADIUS) # ID: 1, mag: 12.34
box(RA, DEC, XSIZE, YSIZE, THETA) # ID: 2, mag: 23.45
...
The ", mag: XX.YY" is optional
The commented lines must be present, with the relevant fields such as tract patch and filter filled
in. The coordinate system must be listed as above. Each patch is specified as a box or circle, with
RA, DEC, and dimensions specified in decimal degrees (with or without an explicit "d").
Only (axis-aligned) boxes and circles are currently supported as region definitions.
Definition at line 45 of file objectMasks.py.
◆ addNew
lsst.pipe.tasks.objectMasks.ObjectMaskCatalog.addNew |
◆ table
lsst.pipe.tasks.objectMasks.ObjectMaskCatalog.table |
The documentation for this class was generated from the following file: