CatalogCalculationPlugin

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

Bases: BasePlugin

Base class for catalog calculation plugins.

Parameters

configCatalogCalculationPlugin.ConfigClass

Plugin configuration.

namestr

The string the plugin was registered with.

schemalsst.afw.table.Schema

The source schema, New fields should be added here to hold output produced by this plugin.

metadatalsst.daf.base.PropertySet

Plugin metadata that will be attached to the output catalog

Attributes Summary

plugType	Does the plugin operate on a single source or the whole catalog (str)?
registry	List of available plugins (lsst.meas.base.PluginRegistry).

Methods Summary

calculate(cat, **kwargs)	Perform the calculation specified by this plugin.
getExecutionOrder()	Used to set the relative order of plugin execution.

Attributes Documentation

plugType = 'single'

Does the plugin operate on a single source or the whole catalog (str)?

If the plugin operates on a single source at a time, this should be set to "single"; if it expects the whoe catalog, to "multi". If the plugin is of type "multi", the fail method must be implemented to accept the whole catalog. If the plugin is of type "single", fail should accept a single source record.

registry = <lsst.meas.base.pluginRegistry.PluginRegistry object>

List of available plugins (lsst.meas.base.PluginRegistry).

Methods Documentation

calculate(cat, **kwargs)

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.

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