lsst.meas.base 22.0.1-27-gd28f579+846c297299
Public Member Functions | Static Public Attributes | List of all members
lsst.meas.base.diaCalculation.DiaObjectCalculationPlugin Class Reference
Inheritance diagram for lsst.meas.base.diaCalculation.DiaObjectCalculationPlugin:
lsst.meas.base.catalogCalculation.CatalogCalculationPlugin lsst.meas.base.pluginsBase.BasePlugin lsst.meas.base.diaCalculationPlugins.Chi2DiaPsFlux lsst.meas.base.diaCalculationPlugins.ErrMeanDiaPsFlux lsst.meas.base.diaCalculationPlugins.HTMIndexDiaPosition lsst.meas.base.diaCalculationPlugins.LinearFitDiaPsFlux lsst.meas.base.diaCalculationPlugins.MadDiaPsFlux lsst.meas.base.diaCalculationPlugins.MaxSlopeDiaPsFlux lsst.meas.base.diaCalculationPlugins.MeanDiaPosition lsst.meas.base.diaCalculationPlugins.MinMaxDiaPsFlux lsst.meas.base.diaCalculationPlugins.NumDiaSourcesDiaPlugin lsst.meas.base.diaCalculationPlugins.PercentileDiaPsFlux lsst.meas.base.diaCalculationPlugins.SigmaDiaPsFlux lsst.meas.base.diaCalculationPlugins.SigmaDiaTotFlux lsst.meas.base.diaCalculationPlugins.SimpleSourceFlagDiaPlugin lsst.meas.base.diaCalculationPlugins.SkewDiaPsFlux lsst.meas.base.diaCalculationPlugins.StetsonJDiaPsFlux lsst.meas.base.diaCalculationPlugins.WeightedMeanDiaPsFlux lsst.meas.base.diaCalculationPlugins.WeightedMeanDiaTotFlux

Public Member Functions

def __init__ (self, config, name, metadata)
 
def calculate (self, diaObject, diaSources, filterDiaFluxes=None, filterName=None, **kwargs)
 
def fail (self, diaObject, columns, error=None)
 

Static Public Attributes

 ConfigClass = DiaObjectCalculationPluginConfig
 
 registry = PluginRegistry(DiaObjectCalculationPluginConfig)
 
float FLUX_MOMENTS_CALCULATED = 5.0
 
string plugType = 'single'
 
list inputCols = []
 
list outputCols = []
 
bool needsFilter = True
 

Detailed Description

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 49 of file diaCalculation.py.

Constructor & Destructor Documentation

◆ __init__()

def lsst.meas.base.diaCalculation.DiaObjectCalculationPlugin.__init__ (   self,
  config,
  name,
  metadata 
)

Member Function Documentation

◆ calculate()

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 109 of file diaCalculation.py.

◆ fail()

def lsst.meas.base.diaCalculation.DiaObjectCalculationPlugin.fail (   self,
  diaObject,
  columns,
  error = None 
)
Set diaObject position values to nan.

Parameters
----------
diaObject : `dict`
    Summary object to store values in.
columns : `list` of `str`
    List of string names of columns to write a the failed value.
error : `BaseException` or `None`
    Error to pass. Kept for consistency with CatologCalculationPlugin.
    Unused.

Reimplemented from lsst.meas.base.pluginsBase.BasePlugin.

Definition at line 141 of file diaCalculation.py.

Member Data Documentation

◆ ConfigClass

lsst.meas.base.diaCalculation.DiaObjectCalculationPlugin.ConfigClass = DiaObjectCalculationPluginConfig
static

Definition at line 64 of file diaCalculation.py.

◆ FLUX_MOMENTS_CALCULATED

float lsst.meas.base.diaCalculation.DiaObjectCalculationPlugin.FLUX_MOMENTS_CALCULATED = 5.0
static

Definition at line 70 of file diaCalculation.py.

◆ inputCols

list lsst.meas.base.diaCalculation.DiaObjectCalculationPlugin.inputCols = []
static

Definition at line 83 of file diaCalculation.py.

◆ needsFilter

bool lsst.meas.base.diaCalculation.DiaObjectCalculationPlugin.needsFilter = True
static

Definition at line 99 of file diaCalculation.py.

◆ outputCols

list lsst.meas.base.diaCalculation.DiaObjectCalculationPlugin.outputCols = []
static

Definition at line 91 of file diaCalculation.py.

◆ plugType

string lsst.meas.base.diaCalculation.DiaObjectCalculationPlugin.plugType = 'single'
static

Definition at line 74 of file diaCalculation.py.

◆ registry

lsst.meas.base.diaCalculation.DiaObjectCalculationPlugin.registry = PluginRegistry(DiaObjectCalculationPluginConfig)
static

Definition at line 66 of file diaCalculation.py.


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