lsst.meas.base  16.0-6-g4a515f9
Public Member Functions | Static Public Member Functions | Public Attributes | 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...
 
def getLogName (self)
 
def fail (self, measRecord, error=None)
 Record a failure of the measure or measureN() method. More...
 

Static Public Member Functions

def getTransformClass ()
 Get the measurement transformation appropriate to this plugin. More...
 

Public Attributes

 config
 
 name
 
 logName
 

Static Public Attributes

 registry = PluginRegistry(CatalogCalculationPluginConfig)
 
 ConfigClass = CatalogCalculationPluginConfig
 
string plugType = 'single'
 
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
 

Detailed Description

Base class for after CatalogCalculation plugin

Definition at line 25 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 38 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 60 of file catalogCalculation.py.

◆ fail()

def lsst.meas.base.pluginsBase.BasePlugin.fail (   self,
  measRecord,
  error = None 
)
inherited

Record a failure of the measure or measureN() method.

When the plugin raises an exception, framework will call fail() to allow the plugin to set its failure flag field(s). When measureN() raises an exception, fail() will be called repeatedly with all the records that were being measured.

If the exception is a MeasurementError, it will be passed as the error argument; in all other cases the error argument will be None, and the failure will be logged by the measurement framework as a warning.

Definition at line 93 of file pluginsBase.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 51 of file catalogCalculation.py.

◆ getLogName()

def lsst.meas.base.pluginsBase.BasePlugin.getLogName (   self)
inherited

Definition at line 90 of file pluginsBase.py.

◆ getTransformClass()

def lsst.meas.base.pluginsBase.BasePlugin.getTransformClass ( )
staticinherited

Get the measurement transformation appropriate to this plugin.

This returns a subclass of MeasurementTransform, which may be instantiated with details of the algorithm configuration and then called with information about calibration and WCS to convert from raw measurement quantities to calibrated units. Calibrated data is then provided in a separate output table.

By default, we copy everything from the input to the output without transformation.

Definition at line 115 of file pluginsBase.py.

Member Data Documentation

◆ APCORR_ORDER

float lsst.meas.base.pluginsBase.BasePlugin.APCORR_ORDER = 3.0
staticinherited

Definition at line 51 of file pluginsBase.py.

◆ CENTROID_ORDER

float lsst.meas.base.pluginsBase.BasePlugin.CENTROID_ORDER = 0.0
staticinherited

Definition at line 48 of file pluginsBase.py.

◆ config

lsst.meas.base.pluginsBase.BasePlugin.config
inherited

Definition at line 86 of file pluginsBase.py.

◆ ConfigClass

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

Definition at line 30 of file catalogCalculation.py.

◆ DEFAULT_CATALOGCALCULATION

float lsst.meas.base.pluginsBase.BasePlugin.DEFAULT_CATALOGCALCULATION = 4.0
staticinherited

Definition at line 52 of file pluginsBase.py.

◆ FLUX_ORDER

float lsst.meas.base.pluginsBase.BasePlugin.FLUX_ORDER = 2.0
staticinherited

Definition at line 50 of file pluginsBase.py.

◆ logName

lsst.meas.base.pluginsBase.BasePlugin.logName
inherited

Definition at line 88 of file pluginsBase.py.

◆ name

lsst.meas.base.pluginsBase.BasePlugin.name
inherited

Definition at line 87 of file pluginsBase.py.

◆ plugType

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

Definition at line 36 of file catalogCalculation.py.

◆ registry

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

Definition at line 29 of file catalogCalculation.py.

◆ SHAPE_ORDER

float lsst.meas.base.pluginsBase.BasePlugin.SHAPE_ORDER = 1.0
staticinherited

Definition at line 49 of file pluginsBase.py.


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