Base class for DIA catalog calculation plugins.
Task follows CatalogCalculationPlugin with modifications for use in AP.
Parameters
----------
config : `DiaObjectCalculationPlugin.ConfigClass`
Plugin configuration.
name : `str`
The string the plugin was registered with.
metadata : `lsst.daf.base.PropertySet`
Plugin metadata that will be attached to the output catalog
Definition at line 48 of file diaCalculation.py.
def lsst.meas.base.diaCalculation.DiaObjectCalculationPlugin.calculate |
( |
|
self, |
|
|
|
diaObject, |
|
|
|
diaSources, |
|
|
|
filterDiaFluxes = None , |
|
|
|
filterName = None , |
|
|
** |
kwargs |
|
) |
| |
Perform the calculation specified by this plugin.
This method can either be used to operate on a single catalog record
or a whole catalog, populating it with the output defined by this
plugin.
Note that results may be added to catalog records as new columns, or
may result in changes to existing values.
Parameters
----------
diaObject : `dict`
Summary object to store values in.
diaSources : `pandas.DataFrame`
DataFrame representing all diaSources associated with this
diaObject.
filterDiaFluxes : `pandas.DataFrame`
DataFrame representing diaSources associated with this
diaObject that are observed in the band pass ``filterName``.
filterName : `str`
Simple name of the filter for the flux being calculated.
**kwargs
Any additional keyword arguments that may be passed to the plugin.
Reimplemented from lsst.meas.base.catalogCalculation.CatalogCalculationPlugin.
Reimplemented in lsst.meas.base.diaCalculationPlugins.HTMIndexDiaPosition, lsst.meas.base.diaCalculationPlugins.MeanDiaPosition, lsst.meas.base.diaCalculationPlugins.NumDiaSourcesDiaPlugin, lsst.meas.base.diaCalculationPlugins.SimpleSourceFlagDiaPlugin, lsst.meas.base.diaCalculationPlugins.WeightedMeanDiaPsFlux, lsst.meas.base.diaCalculationPlugins.PercentileDiaPsFlux, lsst.meas.base.diaCalculationPlugins.SigmaDiaPsFlux, lsst.meas.base.diaCalculationPlugins.Chi2DiaPsFlux, lsst.meas.base.diaCalculationPlugins.MadDiaPsFlux, lsst.meas.base.diaCalculationPlugins.SkewDiaPsFlux, lsst.meas.base.diaCalculationPlugins.MinMaxDiaPsFlux, lsst.meas.base.diaCalculationPlugins.MaxSlopeDiaPsFlux, lsst.meas.base.diaCalculationPlugins.ErrMeanDiaPsFlux, lsst.meas.base.diaCalculationPlugins.LinearFitDiaPsFlux, lsst.meas.base.diaCalculationPlugins.StetsonJDiaPsFlux, lsst.meas.base.diaCalculationPlugins.WeightedMeanDiaTotFlux, and lsst.meas.base.diaCalculationPlugins.SigmaDiaTotFlux.
Definition at line 108 of file diaCalculation.py.