ErrMeanDiaPsfFlux#
- class lsst.meas.base.ErrMeanDiaPsfFlux(config, name, metadata)#
Bases:
DiaObjectCalculationPluginCompute the mean of the dia source errors.
Attributes Summary
This plugin requires a filter to be specified.
DiaObject column names output by the plugin.
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".Methods Summary
calculate(diaObjects, diaSources, ...)Compute the mean of the dia source errors.
Used to set the relative order of plugin execution.
Attributes Documentation
- 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 = ['psfFluxErrMean']#
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
psfFluxMeaninstead ofu_psfFluxMean.
- plugType = 'multi'#
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", thefailmethod must be implemented to accept the whole catalog. If the plugin is of type"single",failshould accept a single source record.
Methods Documentation
- calculate(diaObjects, diaSources, filterDiaSources, band, **kwargs)#
Compute the mean of the dia source errors.
Parameters#
- diaObject
dict Summary object to store values in.
- diaSources
pandas.DataFrame DataFrame representing all diaSources associated with this diaObject.
- filterDiaSources
pandas.DataFrame DataFrame representing diaSources associated with this diaObject that are observed in the band pass
band.- band
str Simple, string name of the filter for the flux being calculated.
- **kwargs
Any additional keyword arguments that may be passed to the plugin.
- diaObject
- classmethod getExecutionOrder()#
Used to set the relative order of plugin execution.
The values returned by
getExecutionOrderare compared across all plugins, and smaller numbers run first.Notes#
CatalogCalculationPlugins must run withBasePlugin.DEFAULT_CATALOGCALCULATIONor higher.All plugins must implement this method with an appropriate run level