lsst.meas.base.footprintArea.CatalogCalculationFootprintAreaPlugin Class Reference

Inheritance diagram for lsst.meas.base.footprintArea.CatalogCalculationFootprintAreaPlugin:

Public Member Functions
	getExecutionOrder (cls)
	__init__ (self, config, name, schema, metadata)
	calculate (self, measRecord)
	fail (self, measRecord, error=None)

Public Attributes
	key

Static Public Attributes
	ConfigClass = CatalogCalculationFootprintAreaConfig

Detailed Description

Catalog calculation plugin to record the area of a source's footprint.

Definition at line 42 of file footprintArea.py.

Constructor & Destructor Documentation

__init__()

lsst.meas.base.footprintArea.CatalogCalculationFootprintAreaPlugin.__init__	(		self,
			config,
			name,
			schema,
			metadata )

Reimplemented from lsst.meas.base.catalogCalculation.CatalogCalculationPlugin.

Definition at line 52 of file footprintArea.py.

    def __init__(self, config, name, schema, metadata):
        CatalogCalculationPlugin.__init__(self, config, name, schema, metadata)
        self.key = schema.addField(
            schema.join(name, "value"),
            type=np.int32,
            doc="Number of pixels in the source's detection footprint.",
            units="pixel"
        )
 

Member Function Documentation

calculate()

lsst.meas.base.footprintArea.CatalogCalculationFootprintAreaPlugin.calculate	(		self,
			cat )

Perform the calculation specified by this plugin.

This method can either be used to operate on a single catalog record
or a whole catalog, populating it with the output defined by this
plugin.

Note that results may be added to catalog records as new columns, or
may result in changes to existing values.

Parameters
----------
cat : `lsst.afw.table.SourceCatalog` or `lsst.afw.table.SourceRecord`
    May either be a `~lsst.afw.table.SourceCatalog` or a single
    `~lsst.afw.table.SourceRecord`, depending on the plugin type. Will
    be updated in place to contain the results of plugin execution.
**kwargs
    Any additional keyword arguments that may be passed to the plugin.

Reimplemented from lsst.meas.base.catalogCalculation.CatalogCalculationPlugin.

Definition at line 61 of file footprintArea.py.

    def calculate(self, measRecord):
        measRecord.set(self.key, measRecord.getFootprint().getArea())
 

fail()

lsst.meas.base.footprintArea.CatalogCalculationFootprintAreaPlugin.fail	(		self,
			measRecord,
			error = None )

Record a failure of the `measure` or `measureN` method.

Parameters
----------
measRecord : `lsst.afw.table.SourceRecord`
    Table record describing the source being measured.
error : `MeasurementError`, optional
    Only provided if the measurement failed due to a
    `MeasurementError` being raised; otherwise, will be `None`.

Notes
-----
When the plugin raises an exception, framework will call
`BasePlugin.fail` to allow the plugin to set its failure flag
field(s).  When `BasePlugin.measureN` raises an exception,
`BasePlugin.fail` will be called repeatedly with all the records that
were being measured.

If the exception is an `MeasurementError`, it will be passed as the
error argument; in all other cases the error argument will be `None`,
and the failure will be logged by the measurement framework as a
warning.

Reimplemented from lsst.meas.base.pluginsBase.BasePlugin.

Definition at line 64 of file footprintArea.py.

    def fail(self, measRecord, error=None):
        # Should be impossible for this algorithm to fail unless there is no
        # Footprint (and that's a precondition for measurement).
        pass

getExecutionOrder()

lsst.meas.base.footprintArea.CatalogCalculationFootprintAreaPlugin.getExecutionOrder

(

cls

)

Used to set the relative order of plugin execution.

    The values returned by `getExecutionOrder` are compared across all
    plugins, and smaller numbers run first.

    Notes
    -----
    `CatalogCalculationPlugin`\s must run with
    `BasePlugin.DEFAULT_CATALOGCALCULATION` or higher.

    All plugins must implement this method with an appropriate run level

Reimplemented from lsst.meas.base.catalogCalculation.CatalogCalculationPlugin.

Definition at line 49 of file footprintArea.py.

    def getExecutionOrder(cls):
        return cls.DEFAULT_CATALOGCALCULATION
 

Member Data Documentation

ConfigClass

lsst.meas.base.footprintArea.CatalogCalculationFootprintAreaPlugin.ConfigClass = CatalogCalculationFootprintAreaConfig

static

Definition at line 46 of file footprintArea.py.

key

lsst.meas.base.footprintArea.CatalogCalculationFootprintAreaPlugin.key

Definition at line 54 of file footprintArea.py.

---

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

• /j/snowflake/release/lsstsw/stack/lsst-scipipe-8.0.0/Linux64/meas_base/g48712c4677+9ea88d309d/python/lsst/meas/base/footprintArea.py