Inheritance diagram for lsst.meas.base.catalogCalculation.CatalogCalculationPlugin:

Public Member Functions
	__init__ (self, config, name, schema, metadata)

	getExecutionOrder (cls)

	calculate (self, cat, **kwargs)

Static Public Attributes
	ConfigClass = CatalogCalculationPluginConfig

	registry = PluginRegistry(CatalogCalculationPluginConfig)

str	plugType = 'single'

Detailed Description

Base class for catalog calculation plugins.

Parameters
----------
config : `CatalogCalculationPlugin.ConfigClass`
    Plugin configuration.
name : `str`
    The string the plugin was registered with.
schema : `lsst.afw.table.Schema`
    The source schema, New fields should be added here to
    hold output produced by this plugin.
metadata : `lsst.daf.base.PropertySet`
    Plugin metadata that will be attached to the output catalog

Definition at line 47 of file catalogCalculation.py.

Constructor & Destructor Documentation

◆ init()

lsst.meas.base.catalogCalculation.CatalogCalculationPlugin.__init__	(	self,
		config,
		name,
		schema,
		metadata )

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

Reimplemented in lsst.meas.base.diaCalculation.DiaObjectCalculationPlugin, lsst.meas.base.diaCalculationPlugins.HTMIndexDiaPosition, lsst.meas.base.diaCalculationPlugins.PercentileDiaPsfFlux, lsst.meas.base.classification.CatalogCalculationClassificationPlugin, and lsst.meas.base.footprintArea.CatalogCalculationFootprintAreaPlugin.

Definition at line 79 of file catalogCalculation.py.

    def __init__(self, config, name, schema, metadata):
        BasePlugin.__init__(self, config, name)
 

Member Function Documentation

◆ calculate()

lsst.meas.base.catalogCalculation.CatalogCalculationPlugin.calculate	(		self,
			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
----------
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.

Definition at line 98 of file catalogCalculation.py.

    def calculate(self, 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
        ----------
        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.
        """
        raise NotImplementedError()
 
 

◆ getExecutionOrder()

lsst.meas.base.catalogCalculation.CatalogCalculationPlugin.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.pluginsBase.BasePlugin.

Definition at line 83 of file catalogCalculation.py.

    def getExecutionOrder(cls):
        r"""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
        """
        raise NotImplementedError()
 

Member Data Documentation

◆ ConfigClass

lsst.meas.base.catalogCalculation.CatalogCalculationPlugin.ConfigClass = CatalogCalculationPluginConfig

static

Definition at line 63 of file catalogCalculation.py.

◆ plugType

str lsst.meas.base.catalogCalculation.CatalogCalculationPlugin.plugType = 'single'

static

Definition at line 69 of file catalogCalculation.py.

◆ registry

lsst.meas.base.catalogCalculation.CatalogCalculationPlugin.registry = PluginRegistry(CatalogCalculationPluginConfig)

static

Definition at line 65 of file catalogCalculation.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+f88676dd22/python/lsst/meas/base/catalogCalculation.py

Public Member Functions

Static Public Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __init__()

Member Function Documentation

◆ calculate()

◆ getExecutionOrder()

Member Data Documentation

◆ ConfigClass

◆ plugType

◆ registry

◆ init()