ObjectMaskCatalog

class lsst.pipe.tasks.objectMasks.ObjectMaskCatalog

Bases: object

Class to support bright object masks

Methods Summary

read(fileName) Read a ds9 region file, returning a ObjectMaskCatalog object

Methods Documentation

classmethod read(fileName)

Read a ds9 region file, returning a ObjectMaskCatalog object

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.