CatalogCalculationFootprintAreaPlugin

class lsst.meas.base.CatalogCalculationFootprintAreaPlugin(config, name, schema, metadata)

Bases: CatalogCalculationPlugin

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

Methods Summary

calculate(measRecord)	Perform the calculation specified by this plugin.
fail(measRecord[, error])	Record a failure of the measure or measureN method.
getExecutionOrder()	Used to set the relative order of plugin execution.

Methods Documentation

calculate(measRecord)

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

catlsst.afw.table.SourceCatalog or lsst.afw.table.SourceRecord

May either be a SourceCatalog or a single 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.

fail(measRecord, error=None)

Record a failure of the measure or measureN method.

Parameters

measRecordlsst.afw.table.SourceRecord

Table record describing the source being measured.

errorMeasurementError, 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.

classmethod getExecutionOrder()

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

CatalogCalculationPlugins must run with BasePlugin.DEFAULT_CATALOGCALCULATION or higher.

All plugins must implement this method with an appropriate run level