HTMIndexDiaPosition¶
-
class
lsst.meas.base.
HTMIndexDiaPosition
(config, name, metadata)¶ Bases:
lsst.meas.base.DiaObjectCalculationPlugin
Compute the mean position of a DiaObject given a set of DiaSources.
Notes
This plugin was implemented to satisfy requirements of old APDB interface which required
pixelId
column in DiaObject with HTM20 index. APDB interface had migrated to not need that information, but we keep this plugin in case it may be useful for something else.Attributes Summary
APCORR_ORDER
CENTROID_ORDER
DEFAULT_CATALOGCALCULATION
FLUX_MOMENTS_CALCULATED
FLUX_ORDER
SHAPE_ORDER
inputCols
needsFilter
outputCols
plugType
registry
Methods Summary
calculate
(diaObjects, diaObjectId, **kwargs)Compute the mean position of a DiaObject given a set of DiaSources fail
(diaObject, columns[, error])Set diaObject position values to nan. getExecutionOrder
()Used to set the relative order of plugin execution. getLogName
()getTransformClass
()Get the measurement transformation appropriate to this plugin. Attributes Documentation
-
APCORR_ORDER
= 3.0¶
-
CENTROID_ORDER
= 0.0¶
-
DEFAULT_CATALOGCALCULATION
= 4.0¶
-
FLUX_MOMENTS_CALCULATED
= 5.0¶
-
FLUX_ORDER
= 2.0¶
-
SHAPE_ORDER
= 1.0¶
-
inputCols
= ['ra', 'decl']¶
-
needsFilter
= False¶
-
outputCols
= ['pixelId']¶
-
plugType
= 'single'¶
-
registry
= <lsst.meas.base.pluginRegistry.PluginRegistry object>¶
Methods Documentation
-
calculate
(diaObjects, diaObjectId, **kwargs)¶ Compute the mean position of a DiaObject given a set of DiaSources
Parameters: - diaObjects :
pandas.dataFrame
Summary objects to store values in and read ra/decl from.
- diaObjectId :
int
Id of the diaObject to update.
- **kwargs
Any additional keyword arguments that may be passed to the plugin.
- diaObjects :
-
fail
(diaObject, columns, error=None)¶ Set diaObject position values to nan.
Parameters: - diaObject :
dict
Summary object to store values in.
- columns :
list
ofstr
List of string names of columns to write a the failed value.
- error :
BaseException
orNone
Error to pass. Kept for consistency with CatologCalculationPlugin. Unused.
- diaObject :
-
classmethod
getExecutionOrder
()¶ 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 withBasePlugin.DEFAULT_CATALOGCALCULATION
or higher.All plugins must implement this method with an appropriate run level
-
getLogName
()¶
-
static
getTransformClass
()¶ 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.
-