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

Public Member Functions
def	__init__ (self, schema, plugMetadata=None, kwargs)

def	initializePlugins (self)

def	run (self, measCat)

def	callCompute (self, catalog)

Public Attributes
	schema

	plugMetadata

	plugins

	executionDict

Static Public Attributes
	ConfigClass = CatalogCalculationConfig

Detailed Description

Run plugins which operate on a catalog of sources.

This task facilitates running plugins which will operate on a source
catalog. These plugins may do things such as classifying an object based
on source record entries inserted during a measurement task.

Parameters
----------
plugMetaData : `lsst.daf.base.PropertyList` or `None`
    Will be modified in-place to contain metadata about the plugins being
    run. If `None`, an empty `~lsst.daf.base.PropertyList` will be
    created.
**kwargs
    Additional arguments passed to the superclass constructor.

Notes
-----
Plugins may either take an entire catalog to work on at a time, or work on
individual records.

Definition at line 169 of file catalogCalculation.py.

Constructor & Destructor Documentation

◆ init()

def lsst.meas.base.catalogCalculation.CatalogCalculationTask.__init__	(	self,
		schema,
		plugMetadata = `None`,
		kwargs
	)

Definition at line 193 of file catalogCalculation.py.

Member Function Documentation

◆ callCompute()

def lsst.meas.base.catalogCalculation.CatalogCalculationTask.callCompute	(	self,
		catalog
	)

Run each of the plugins on the catalog.

Parameters
----------
catalog : `lsst.afw.table.SourceCatalog`
    The catalog on which the plugins will operate.

Definition at line 240 of file catalogCalculation.py.

◆ initializePlugins()

def lsst.meas.base.catalogCalculation.CatalogCalculationTask.initializePlugins ( self )

Initialize the plugins according to the configuration.

Definition at line 203 of file catalogCalculation.py.

◆ run()

def lsst.meas.base.catalogCalculation.CatalogCalculationTask.run	(	self,
		measCat
	)

The entry point for the catalog calculation task.

Parameters
----------
meascat : `lsst.afw.table.SourceCatalog`
    Catalog for measurement.

Definition at line 230 of file catalogCalculation.py.

Member Data Documentation

◆ ConfigClass

lsst.meas.base.catalogCalculation.CatalogCalculationTask.ConfigClass = CatalogCalculationConfig

static

Definition at line 190 of file catalogCalculation.py.

◆ executionDict

lsst.meas.base.catalogCalculation.CatalogCalculationTask.executionDict

Definition at line 208 of file catalogCalculation.py.

◆ plugins

lsst.meas.base.catalogCalculation.CatalogCalculationTask.plugins

Definition at line 199 of file catalogCalculation.py.

◆ plugMetadata

lsst.meas.base.catalogCalculation.CatalogCalculationTask.plugMetadata

Definition at line 198 of file catalogCalculation.py.

◆ schema

lsst.meas.base.catalogCalculation.CatalogCalculationTask.schema

Definition at line 195 of file catalogCalculation.py.

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

python/lsst/meas/base/catalogCalculation.py

Public Member Functions

Public Attributes

Static Public Attributes