lsst.meas.base.catalogCalculation.CatalogCalculationTask Class Reference

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

Public Member Functions
	__init__ (self, schema, plugMetadata=None, **kwargs)
	initializePlugins (self)
	run (self, measCat)
	callCompute (self, catalog)

Public Attributes
	schema = schema
	plugMetadata = plugMetadata
	plugins = PluginMap()
dict	executionDict = {}
	log

Static Public Attributes
	ConfigClass = CatalogCalculationConfig

Static Protected Attributes
str	_DefaultName = "catalogCalculation"

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 173 of file catalogCalculation.py.

Constructor & Destructor Documentation

__init__()

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

Definition at line 197 of file catalogCalculation.py.

Member Function Documentation

callCompute()

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.

Reimplemented in lsst.meas.base.diaCalculation.DiaObjectCalculationTask.

Definition at line 244 of file catalogCalculation.py.

initializePlugins()

lsst.meas.base.catalogCalculation.CatalogCalculationTask.initializePlugins

(

self

)

Initialize the plugins according to the configuration.

Reimplemented in lsst.meas.base.diaCalculation.DiaObjectCalculationTask.

Definition at line 207 of file catalogCalculation.py.

run()

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.

Reimplemented in lsst.meas.base.diaCalculation.DiaObjectCalculationTask.

Definition at line 234 of file catalogCalculation.py.

Member Data Documentation

_DefaultName

str lsst.meas.base.catalogCalculation.CatalogCalculationTask._DefaultName = "catalogCalculation"

staticprotected

Definition at line 195 of file catalogCalculation.py.

ConfigClass

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

static

Definition at line 194 of file catalogCalculation.py.

executionDict

lsst.meas.base.catalogCalculation.CatalogCalculationTask.executionDict = {}

Definition at line 212 of file catalogCalculation.py.

log

lsst.meas.base.catalogCalculation.CatalogCalculationTask.log

Definition at line 255 of file catalogCalculation.py.

plugins

lsst.meas.base.catalogCalculation.CatalogCalculationTask.plugins = PluginMap()

Definition at line 203 of file catalogCalculation.py.

plugMetadata

lsst.meas.base.catalogCalculation.CatalogCalculationTask.plugMetadata = plugMetadata

Definition at line 202 of file catalogCalculation.py.

schema

lsst.meas.base.catalogCalculation.CatalogCalculationTask.schema = schema

Definition at line 199 of file catalogCalculation.py.

---

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

• python/lsst/meas/base/catalogCalculation.py