lsst.meas.base  13.0-26-g0f127ff+5
Public Member Functions | Static Public Attributes | List of all members
lsst.meas.base.catalogCalculation.CatalogCalculationPlugin Class Reference
Inheritance diagram for lsst.meas.base.catalogCalculation.CatalogCalculationPlugin:
lsst.meas.base.pluginsBase.BasePlugin lsst.meas.base.classification.CatalogCalculationClassificationPlugin lsst.meas.base.footprintArea.CatalogCalculationFootprintAreaPlugin

Public Member Functions

def __init__ (self, config, name, schema, metadata)
 Initialize the catalogCalculation plugin. More...
 
def getExecutionOrder (cls)
 
def calculate (self, cat, kwargs)
 Process either a single catalog enter or the whole catalog and produce output defined by the plugin. More...
 
- Public Member Functions inherited from lsst.meas.base.pluginsBase.BasePlugin
def getExecutionOrder (cls)
 
def __init__ (self, config, name, logName=None)
 Initialize the plugin object. More...
 
def getLogName (self)
 
def fail (self, measRecord, error=None)
 Record a failure of the measure or measureN() method. More...
 

Static Public Attributes

 registry = PluginRegistry(CatalogCalculationPluginConfig)
 
 ConfigClass = CatalogCalculationPluginConfig
 
string plugType = 'single'
 
- Static Public Attributes inherited from lsst.meas.base.pluginsBase.BasePlugin
float CENTROID_ORDER = 0.0
 
float SHAPE_ORDER = 1.0
 
float FLUX_ORDER = 2.0
 
float APCORR_ORDER = 3.0
 
float DEFAULT_CATALOGCALCULATION = 4.0
 

Additional Inherited Members

- Static Public Member Functions inherited from lsst.meas.base.pluginsBase.BasePlugin
def getTransformClass ()
 Get the measurement transformation appropriate to this plugin. More...
 
- Public Attributes inherited from lsst.meas.base.pluginsBase.BasePlugin
 config
 
 name
 
 logName
 

Detailed Description

Base class for after CatalogCalculation plugin

Definition at line 27 of file catalogCalculation.py.

Constructor & Destructor Documentation

◆ __init__()

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

Initialize the catalogCalculation plugin.

Parameters
[in]configAn instance of catalogCalculation config class.
[in]nameThe string the plugin was registered with.
[in,out]schemaThe source schema, New fields should be added here to hold output produced by this plugin.
[in]metadataPlugin metadata that will be attached to the output catalog

Definition at line 40 of file catalogCalculation.py.

Member Function Documentation

◆ calculate()

def lsst.meas.base.catalogCalculation.CatalogCalculationPlugin.calculate (   self,
  cat,
  kwargs 
)

Process either a single catalog enter or the whole catalog and produce output defined by the plugin.

Parameters
[in,out]catEither a lsst source catalog or a catalog entery depending on the plug type specified in the classes configuration. Results may be added to new columns, or existing entries altered.
[in]kwargsAny additional kwargs that may be passed through the CatalogCalculationPlugin.

Definition at line 62 of file catalogCalculation.py.

◆ getExecutionOrder()

def lsst.meas.base.catalogCalculation.CatalogCalculationPlugin.getExecutionOrder (   cls)
Sets the relative order of plugins (smaller numbers run first).

CatalogCalculation plugins must run with BasePlugin.DEFAULT_CATALOGCALCULATION or higher

All plugins must implement this method with an appropriate run level

Definition at line 53 of file catalogCalculation.py.

Member Data Documentation

◆ ConfigClass

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

Definition at line 32 of file catalogCalculation.py.

◆ plugType

string lsst.meas.base.catalogCalculation.CatalogCalculationPlugin.plugType = 'single'
static

Definition at line 38 of file catalogCalculation.py.

◆ registry

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

Definition at line 31 of file catalogCalculation.py.


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