DiaObjectCalculationPlugin#

class lsst.meas.base.DiaObjectCalculationPlugin(config, name, metadata)#

Base class for DIA catalog calculation plugins.

Task follows CatalogCalculationPlugin with modifications for use in AP.

Parameters#

configDiaObjectCalculationPlugin.ConfigClass: Plugin configuration.
namestr: The string the plugin was registered with.
metadatalsst.daf.base.PropertySet: Plugin metadata that will be attached to the output catalog

Attributes Summary

`FLUX_MOMENTS_CALCULATED`	Add order after flux means and stds are calculated.
`inputCols`	DiaObject column names required by the plugin in order to run and complete its calculation.
`needsFilter`	This plugin requires a filter to be specified.
`outputCols`	DiaObject column names output by the plugin.
`plugType`	Does the plugin operate on a single source or the whole catalog (`str`)? If the plugin operates on a single source at a time, this should be set to `"single"`; if it expects the whoe catalog, to `"multi"`.
`registry`	List of available plugins (`lsst.meas.base.PluginRegistry`).

Methods Summary

`calculate`(diaObject, diaSources[, ...])	Perform the calculation specified by this plugin.
`fail`(diaObject, columns[, error])	Set diaObject position values to nan.

Attributes Documentation

FLUX_MOMENTS_CALCULATED = 5.0#: Add order after flux means and stds are calculated.

inputCols = []#: DiaObject column names required by the plugin in order to run and complete its calculation. DiaCalculationTask should raise an error is a plugin is instantiated without the needed column available. Input columns should be defined in the DPDD/cat/Apdb schema. Filter dependent columns should be specified without the filter name perpended to them. eg psfFluxMean instead of u_psfFluxMean.

needsFilter = True#: This plugin requires a filter to be specified. Plugin’s using filter names usually deal with fluxes and only a sub-set of the DiaSource catalog. Plugins that to not use the filter name usually run over a value common across all observations/detections such as position.

outputCols = []#: DiaObject column names output by the plugin. DiaCalculationTask should raise an error if another pluging is run output to the same column. Output columns should be defined in the DPDD/cat/Apdb schema. Filter dependent columns should be specified without the filter name perpended to them. eg psfFluxMean instead of u_psfFluxMean.

plugType = 'single'#: Does the plugin operate on a single source or the whole catalog (str)? If the plugin operates on a single source at a time, this should be set to "single"; if it expects the whoe catalog, to "multi". If the plugin is of type "multi", the fail method must be implemented to accept the whole catalog. If the plugin is of type "single", fail should accept a single source record.

registry = <lsst.meas.base.pluginRegistry.PluginRegistry object>#: List of available plugins (lsst.meas.base.PluginRegistry).

Methods Documentation

calculate(diaObject, diaSources, filterDiaFluxes=None, band=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.

diaObjectdict: Summary object to store values in.
diaSourcespandas.DataFrame: DataFrame representing all diaSources associated with this diaObject.
filterDiaFluxespandas.DataFrame: DataFrame representing diaSources associated with this diaObject that are observed in the band pass band.
bandstr: Simple name of the filter for the flux being calculated.
**kwargs: Any additional keyword arguments that may be passed to the plugin.

fail(diaObject, columns, error=None)#

Set diaObject position values to nan.

diaObjectdict: Summary object to store values in.
columnslist of str: List of string names of columns to write a the failed value.
errorBaseException or None: Error to pass. Kept for consistency with CatologCalculationPlugin. Unused.