|
def | getExecutionOrder (cls) |
|
def | calculate (self, diaObjects, diaSources, filterDiaSources, filterName, **kwargs) |
|
def | calculate (self, cat, **kwargs) |
|
def | fail (self, diaObject, columns, error=None) |
|
def | fail (self, measRecord, error=None) |
|
def | getLogName (self) |
|
Compute median absolute deviation of diaSource fluxes.
Definition at line 521 of file diaCalculationPlugins.py.
◆ calculate() [1/2]
def lsst.meas.base.catalogCalculation.CatalogCalculationPlugin.calculate |
( |
|
self, |
|
|
|
cat, |
|
|
** |
kwargs |
|
) |
| |
|
inherited |
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
----------
cat : `lsst.afw.table.SourceCatalog` or `lsst.afw.table.SourceRecord`
May either be a `~lsst.afw.table.SourceCatalog` or a single
`~lsst.afw.table.SourceRecord`, depending on the plugin type. Will
be updated in place to contain the results of plugin execution.
**kwargs
Any additional keyword arguments that may be passed to the plugin.
Definition at line 98 of file catalogCalculation.py.
◆ calculate() [2/2]
def lsst.meas.base.diaCalculationPlugins.MadDiaPsFlux.calculate |
( |
|
self, |
|
|
|
diaObjects, |
|
|
|
diaSources, |
|
|
|
filterDiaSources, |
|
|
|
filterName, |
|
|
** |
kwargs |
|
) |
| |
Compute the median absolute deviation of the point source fluxes.
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 ``filterName``.
filterName : `str`
Simple, string 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.diaCalculation.DiaObjectCalculationPlugin.
Definition at line 538 of file diaCalculationPlugins.py.
◆ fail() [1/2]
def lsst.meas.base.diaCalculation.DiaObjectCalculationPlugin.fail |
( |
|
self, |
|
|
|
diaObject, |
|
|
|
columns, |
|
|
|
error = None |
|
) |
| |
|
inherited |
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.
Definition at line 141 of file diaCalculation.py.
◆ fail() [2/2]
def lsst.meas.base.pluginsBase.BasePlugin.fail |
( |
|
self, |
|
|
|
measRecord, |
|
|
|
error = None |
|
) |
| |
|
inherited |
Record a failure of the `measure` or `measureN` method.
Parameters
----------
measRecord : `lsst.afw.table.SourceRecord`
Table record describing the source being measured.
error : `MeasurementError`, optional
Only provided if the measurement failed due to a
`MeasurementError` being raised; otherwise, will be `None`.
Notes
-----
When the plugin raises an exception, framework will call
`BasePlugin.fail` to allow the plugin to set its failure flag
field(s). When `BasePlugin.measureN` raises an exception,
`BasePlugin.fail` will be called repeatedly with all the records that
were being measured.
If the exception is an `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.
Reimplemented in lsst.meas.base.wrappers.GenericPlugin, lsst.meas.base.wrappers.WrappedForcedPlugin, lsst.meas.base.wrappers.WrappedSingleFramePlugin, lsst.meas.base.plugins.SingleFrameSkyCoordPlugin, lsst.meas.base.plugins.SingleFramePeakCentroidPlugin, lsst.meas.base.plugins.InputCountPlugin, lsst.meas.base.plugins.VariancePlugin, lsst.meas.base.plugins.SingleFrameJacobianPlugin, lsst.meas.base.plugins.SingleFrameFPPositionPlugin, lsst.meas.base.footprintArea.CatalogCalculationFootprintAreaPlugin, and lsst.meas.base.classification.CatalogCalculationClassificationPlugin.
Definition at line 137 of file pluginsBase.py.
◆ getExecutionOrder()
def lsst.meas.base.diaCalculationPlugins.MadDiaPsFlux.getExecutionOrder |
( |
|
cls | ) |
|
Used to set the relative order of plugin execution.
The values returned by `getExecutionOrder` are compared across all
plugins, and smaller numbers run first.
Notes
-----
`CatalogCalculationPlugin`\s must run with
`BasePlugin.DEFAULT_CATALOGCALCULATION` or higher.
All plugins must implement this method with an appropriate run level
Reimplemented from lsst.meas.base.catalogCalculation.CatalogCalculationPlugin.
Definition at line 534 of file diaCalculationPlugins.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 `transforms.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.
Notes
-----
By default, we copy everything from the input to the output without
transformation.
Reimplemented in lsst.meas.base.plugins.ForcedPeakCentroidPlugin, and lsst.meas.base.plugins.SingleFramePeakCentroidPlugin.
Definition at line 169 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_MOMENTS_CALCULATED
float lsst.meas.base.diaCalculation.DiaObjectCalculationPlugin.FLUX_MOMENTS_CALCULATED = 5.0 |
|
staticinherited |
◆ FLUX_ORDER
float lsst.meas.base.pluginsBase.BasePlugin.FLUX_ORDER = 2.0 |
|
staticinherited |
◆ inputCols
list lsst.meas.base.diaCalculation.DiaObjectCalculationPlugin.inputCols = [] |
|
staticinherited |
◆ logName
lsst.meas.base.pluginsBase.BasePlugin.logName |
|
inherited |
◆ name
lsst.meas.base.pluginsBase.BasePlugin.name |
|
inherited |
◆ needsFilter
bool lsst.meas.base.diaCalculationPlugins.MadDiaPsFlux.needsFilter = True |
|
static |
◆ outputCols
list lsst.meas.base.diaCalculationPlugins.MadDiaPsFlux.outputCols = ["PSFluxMAD"] |
|
static |
◆ plugType
string lsst.meas.base.diaCalculationPlugins.MadDiaPsFlux.plugType = "multi" |
|
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: