Public Member Functions
	__init__ (self)
	__len__ (self)
	__iter__ (self)
	__getitem__ (self, i)
	__setitem__ (self, i, v)
	read (cls, fileName)

Public Attributes
	table = self._catalog.table
	addNew = self._catalog.addNew

Protected Attributes
	_catalog = afwTable.SimpleCatalog(schema)

Detailed Description

Class to support bright object masks

Definition at line 34 of file objectMasks.py.

Constructor & Destructor Documentation

◆ init()

lsst.pipe.tasks.objectMasks.ObjectMaskCatalog.__init__ ( self )

Definition at line 38 of file objectMasks.py.

Member Function Documentation

◆ getitem()

lsst.pipe.tasks.objectMasks.ObjectMaskCatalog.__getitem__	(		self,
			i )

Definition at line 59 of file objectMasks.py.

◆ iter()

lsst.pipe.tasks.objectMasks.ObjectMaskCatalog.__iter__ ( self )

Definition at line 56 of file objectMasks.py.

◆ len()

lsst.pipe.tasks.objectMasks.ObjectMaskCatalog.__len__ ( self )

Definition at line 53 of file objectMasks.py.

◆ setitem()

lsst.pipe.tasks.objectMasks.ObjectMaskCatalog.__setitem__	(	self,
		i,
		v )

Definition at line 62 of file objectMasks.py.

◆ read()

lsst.pipe.tasks.objectMasks.ObjectMaskCatalog.read	(		cls,
			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.

Definition at line 66 of file objectMasks.py.

Member Data Documentation

◆ _catalog

lsst.pipe.tasks.objectMasks.ObjectMaskCatalog._catalog = afwTable.SimpleCatalog(schema)

protected

Definition at line 47 of file objectMasks.py.

◆ addNew

lsst.pipe.tasks.objectMasks.ObjectMaskCatalog.addNew = self._catalog.addNew

Definition at line 51 of file objectMasks.py.

◆ table

lsst.pipe.tasks.objectMasks.ObjectMaskCatalog.table = self._catalog.table

Definition at line 50 of file objectMasks.py.

The documentation for this class was generated from the following file:

python/lsst/pipe/tasks/objectMasks.py

Public Member Functions

Public Attributes

Protected Attributes