Base class for after CatalogCalculation plugin
Definition at line 27 of file catalogCalculation.py.
◆ __init__()
def lsst.meas.base.catalogCalculation.CatalogCalculationPlugin.__init__ |
( |
|
self, |
|
|
|
config, |
|
|
|
name, |
|
|
|
schema, |
|
|
|
metadata |
|
) |
| |
Initialize the catalogCalculation plugin.
- Parameters
-
[in] | config | An instance of catalogCalculation config class. |
[in] | name | The string the plugin was registered with. |
[in,out] | schema | The source schema, New fields should be added here to hold output produced by this plugin. |
[in] | metadata | Plugin metadata that will be attached to the output catalog |
Definition at line 40 of file catalogCalculation.py.
◆ 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] | cat | Either 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] | kwargs | Any additional kwargs that may be passed through the CatalogCalculationPlugin. |
Definition at line 62 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 95 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 53 of file catalogCalculation.py.
◆ getLogName()
def lsst.meas.base.pluginsBase.BasePlugin.getLogName |
( |
|
self | ) |
|
|
inherited |
◆ 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 117 of file pluginsBase.py.
◆ APCORR_ORDER
float lsst.meas.base.pluginsBase.BasePlugin.APCORR_ORDER = 3.0 |
|
staticinherited |
◆ CENTROID_ORDER
float lsst.meas.base.pluginsBase.BasePlugin.CENTROID_ORDER = 0.0 |
|
staticinherited |
◆ config
lsst.meas.base.pluginsBase.BasePlugin.config |
|
inherited |
◆ ConfigClass
◆ DEFAULT_CATALOGCALCULATION
float lsst.meas.base.pluginsBase.BasePlugin.DEFAULT_CATALOGCALCULATION = 4.0 |
|
staticinherited |
◆ FLUX_ORDER
float lsst.meas.base.pluginsBase.BasePlugin.FLUX_ORDER = 2.0 |
|
staticinherited |
◆ logName
lsst.meas.base.pluginsBase.BasePlugin.logName |
|
inherited |
◆ name
lsst.meas.base.pluginsBase.BasePlugin.name |
|
inherited |
◆ plugType
string lsst.meas.base.catalogCalculation.CatalogCalculationPlugin.plugType = 'single' |
|
static |
◆ registry
◆ SHAPE_ORDER
float lsst.meas.base.pluginsBase.BasePlugin.SHAPE_ORDER = 1.0 |
|
staticinherited |
The documentation for this class was generated from the following file: