lsst.meas.base

lsst.meas.base provides core astronomical measurement algorithms and base classes.

Contributing

lsst.meas.base is developed at https://github.com/lsst/meas_base. You can find Jira issues for this module under the meas_base component.

Task reference

Pipeline tasks

ForcedPhotCcdTask
A pipeline task for performing forced measurement on CCD images.
ForcedPhotCoaddTask
A pipeline task for performing forced measurement on coadd images.

Tasks

ApplyApCorrTask
Apply aperture corrections.
BaseMeasurementTask
Ultimate base class for all measurement tasks.
CatalogCalculationTask
Run plugins which operate on a catalog of sources.
ForcedMeasurementTask
Measure sources on an image, constrained by a reference catalog.
SingleFrameMeasurementTask
A subtask for measuring the properties of sources on a single exposure.

Configs

BaseMeasurementPluginConfig
Base config class for all measurement plugins.
BasePluginConfig
Base class measurement plugin config classes.
CatalogCalculationClassificationConfig
Configuration for catalog classification plugin.
CatalogCalculationFootprintAreaConfig
Configuration for footprint area catalog calculation plugin.
CatalogCalculationPluginConfig
Default configuration class for catalog calcuation plugins.
ForcedPluginConfig
Base class for configs of forced measurement plugins.
NoiseReplacerConfig
Noise replacement configuration.
SingleFramePluginConfig
Base class for single-frame plugin configuration classes.
SourceSlotConfig
Assign named plugins to measurement slots.

Python API reference

lsst.meas.base Package

Functions

addApCorrName(name) Register an instrumental flux field name prefix for aperture correction.
generateAlgorithmName(AlgClass) Generate a name for an algorithm.
getApCorrNameSet() Get a copy of the field name prefixes which will be aperture corrected.
makeShapeTransformMatrix(xform)
register(name[, shouldApCorr, apCorrList]) A decorator to register a plugin class in its base class’s registry.
wrapAlgorithm(Base, AlgClass, factory, …) Wrap a C++ algorithm class to create a measurement plugin.
wrapAlgorithmControl(Base, Control[, …]) Wrap a C++ algorithm’s control class into a Python config class.
wrapForcedAlgorithm(AlgClass, executionOrder) Expose a C++ ForcedAlgorithm class as a measurement plugin.
wrapSimpleAlgorithm(AlgClass, executionOrder) Expose a C++ SimpleAlgorithm class as a measurement plugin.
wrapSingleFrameAlgorithm(AlgClass, …[, …]) Expose a C++ SingleFrameAlgorithm class as a measurement plugin.
wrapTransform(transformClass[, hasLogName]) Modify a C++ transform to accept either a Config or a Control.

Classes

ApertureFluxAlgorithm
ApertureFluxControl
ApertureFluxResult
ApertureFluxTransform(ctrl, name, mapper[, …])
ApplyApCorrConfig Aperture correction configuration.
ApplyApCorrTask(schema, **kwds) Apply aperture corrections.
BaseAlgorithm
BaseMeasurementConfig Base configuration for all measurement driver tasks.
BaseMeasurementPlugin(config, name[, logName]) Base class for all measurement plugins.
BaseMeasurementPluginConfig Base config class for all measurement plugins.
BaseMeasurementTask([algMetadata]) Ultimate base class for all measurement tasks.
BasePlugin(config, name[, logName]) Base class for measurement plugins.
BasePluginConfig Base class measurement plugin config classes.
BaseTransform
BlendednessAlgorithm
BlendednessControl
CatalogCalculationClassificationConfig Configuration for catalog classification plugin.
CatalogCalculationClassificationPlugin(…) Plugin which calculates a binary measure of source extendedness.
CatalogCalculationConfig Config class for the catalog calculation driver task.
CatalogCalculationFootprintAreaConfig Configuration for footprint area catalog calculation plugin.
CatalogCalculationFootprintAreaPlugin(…) Catalog calculation plugin to record the area of a source’s footprint.
CatalogCalculationPlugin(config, name, …) Base class for catalog calculation plugins.
CatalogCalculationPluginConfig Default configuration class for catalog calcuation plugins.
CatalogCalculationTask(schema[, plugMetadata]) Run plugins which operate on a catalog of sources.
CentroidChecker
CentroidResult
CentroidResultKey
CentroidTransform
Chi2DiaPsFlux(config, name, metadata) Compute chi2 of diaSource fluxes.
Chi2DiaPsFluxConfig
CircularApertureFluxAlgorithm
DiaObjectCalculationConfig Config class for the catalog calculation driver task.
DiaObjectCalculationPlugin(config, name, …) Base class for DIA catalog calculation plugins.
DiaObjectCalculationPluginConfig Default configuration class for DIA catalog calculation plugins.
DiaObjectCalculationTask([plugMetadata]) Run plugins which operate on a catalog of DIA sources.
DummyNoiseReplacer A noise replacer which does nothing.
ErrMeanDiaPsFlux(config, name, metadata) Compute the mean of the dia source errors.
ErrMeanDiaPsFluxConfig
EvaluateLocalPhotoCalibPlugin(config, name, …) Evaluate the local value of the Photometric Calibration in the exposure.
EvaluateLocalPhotoCalibPluginConfig Configuration for the variance calculation plugin.
EvaluateLocalWcsPlugin(config, name, schema, …) Evaluate the local, linear approximation of the Wcs.
EvaluateLocalWcsPluginConfig Configuration for the variance calculation plugin.
FlagDefinition
FlagDefinitionList
FlagHandler
FluxResult
FluxResultKey
ForcedInputCountPlugin alias of lsst.meas.base.wrappers.GenericPlugin.makeForcedPlugin.<locals>.ForcedFromGenericPlugin
ForcedMeasurementConfig Config class for forced measurement driver task.
ForcedMeasurementTask(refSchema[, algMetadata]) Measure sources on an image, constrained by a reference catalog.
ForcedPeakCentroidConfig Configuration for the forced peak centroid algorithm.
ForcedPeakCentroidPlugin(config, name, …) Record the highest peak in a source footprint as its centroid.
ForcedPhotCcdConfig Config class for forced measurement driver task.
ForcedPhotCcdFromDataFrameConfig
ForcedPhotCcdFromDataFrameTask([butler, …]) Force Photometry on a per-detector exposure with coords from a DataFrame
ForcedPhotCcdTask([butler, refSchema, …]) A pipeline task for performing forced measurement on CCD images.
ForcedPhotCoaddConfig
ForcedPhotCoaddTask([butler, refSchema, …]) A pipeline task for performing forced measurement on coadd images.
ForcedPlugin(config, name, schemaMapper, …) Base class for forced measurement plugins.
ForcedPluginConfig Base class for configs of forced measurement plugins.
ForcedTransformedCentroidConfig Configuration for the forced transformed centroid algorithm.
ForcedTransformedCentroidFromCoordConfig Configuration for the forced transformed coord algorithm.
ForcedTransformedCentroidFromCoordPlugin(…) Record the transformation of the reference catalog coord.
ForcedTransformedCentroidPlugin(config, …) Record the transformation of the reference catalog centroid.
ForcedTransformedShapeConfig Configuration for the forced transformed shape algorithm.
ForcedTransformedShapePlugin(config, name, …) Record the transformation of the reference catalog shape.
ForcedVariancePlugin alias of lsst.meas.base.wrappers.GenericPlugin.makeForcedPlugin.<locals>.ForcedFromGenericPlugin
GaussianFluxAlgorithm
GaussianFluxControl
GaussianFluxTransform(ctrl, name, mapper[, …])
GenericPlugin(config, name, schema, metadata) Abstract base class for a generic plugin.
HTMIndexDiaPosition(config, name, metadata) Compute the mean position of a DiaObject given a set of DiaSources.
HTMIndexDiaPositionConfig
InputCountConfig Configuration for the input image counting plugin.
LinearFitDiaPsFlux(config, name, metadata) Compute fit a linear model to flux vs time.
LinearFitDiaPsFluxConfig
LocalBackgroundAlgorithm
LocalBackgroundControl
LocalBackgroundTransform(ctrl, name, mapper)
MadDiaPsFlux(config, name, metadata) Compute median absolute deviation of diaSource fluxes.
MadDiaPsFluxConfig
MagResult
MagResultKey
MaxSlopeDiaPsFlux(config, name, metadata) Compute the maximum ratio time ordered deltaFlux / deltaTime.
MaxSlopeDiaPsFluxConfig
MeanDiaPosition(config, name, metadata) Compute the mean position of a DiaObject given a set of DiaSources.
MeanDiaPositionConfig
MeasurementTransform(config, name, mapper) Base class for measurement transformations.
MinMaxDiaPsFlux(config, name, metadata) Compute min/max of diaSource fluxes.
MinMaxDiaPsFluxConfig
NaiveCentroidAlgorithm
NaiveCentroidControl
NaiveCentroidTransform(ctrl, name, mapper[, …])
NoiseReplacer(config, exposure, footprints) Replace sources with noise during measurement.
NoiseReplacerConfig Noise replacement configuration.
NullTransform(config, name, mapper) Null transform which transfers no data from input to output.
NumDiaSourcesDiaPlugin(config, name, metadata) Compute the total number of DiaSources associated with this DiaObject.
NumDiaSourcesDiaPluginConfig
PassThroughTransform(config, name, mapper) Copy fields from input to output without transformation.
PeakLikelihoodFluxAlgorithm
PeakLikelihoodFluxControl
PeakLikelihoodFluxTransform(ctrl, name, mapper)
PercentileDiaPsFlux(config, name, metadata, …) Compute percentiles of diaSource fluxes.
PercentileDiaPsFluxConfig
PixelFlagsAlgorithm
PixelFlagsControl
PluginMap Map of plugins to be run for a given task.
PluginRegistry([configBaseType]) Base class for plugin registries.
PsfFluxAlgorithm
PsfFluxControl
PsfFluxTransform(ctrl, name, mapper[, logName])
SafeCentroidExtractor
ScaledApertureFluxAlgorithm
ScaledApertureFluxControl
ScaledApertureFluxTransform(ctrl, name, mapper)
SdssCentroidAlgorithm
SdssCentroidControl
SdssCentroidTransform(ctrl, name, mapper[, …])
SdssShapeAlgorithm
SdssShapeControl
SdssShapeResult
SdssShapeResultKey
SdssShapeTransform(ctrl, name, mapper[, logName])
ShapeResult
ShapeResultKey
SigmaDiaPsFlux(config, name, metadata) Compute scatter of diaSource fluxes.
SigmaDiaPsFluxConfig
SigmaDiaTotFlux(config, name, metadata) Compute scatter of diaSource fluxes.
SigmaDiaTotFluxConfig
SimpleAlgorithm
SimpleCentroidTransform(config, name, mapper) Transform pixel centroid, without uncertainty, to celestial coordinates.
SimpleSourceFlagDiaPlugin(config, name, metadata) Find if any DiaSource is flagged.
SimpleSourceFlagDiaPluginConfig
SincCoeffsD
SincCoeffsF
SingleFrameAlgorithm
SingleFrameFPPositionConfig Configuration for the focal plane position measurment algorithm.
SingleFrameFPPositionPlugin(config, name, …) Algorithm to calculate the position of a centroid on the focal plane.
SingleFrameInputCountPlugin alias of lsst.meas.base.wrappers.GenericPlugin.makeSingleFramePlugin.<locals>.SingleFrameFromGenericPlugin
SingleFrameJacobianConfig Configuration for the Jacobian calculation plugin.
SingleFrameJacobianPlugin(config, name, …) Compute the Jacobian and its ratio with a nominal pixel area.
SingleFrameMeasurementConfig Config class for single frame measurement driver task.
SingleFrameMeasurementTask(schema[, algMetadata]) A subtask for measuring the properties of sources on a single exposure.
SingleFramePeakCentroidConfig Configuration for the single frame peak centroiding algorithm.
SingleFramePeakCentroidPlugin(config, name, …) Record the highest peak in a source footprint as its centroid.
SingleFramePlugin(config, name, schema, metadata) Base class for single-frame measurement plugin.
SingleFramePluginConfig Base class for single-frame plugin configuration classes.
SingleFrameSkyCoordConfig Configuration for the sky coordinates algorithm.
SingleFrameSkyCoordPlugin(config, name, …) Record the sky position of an object based on its centroid slot and WCS.
SingleFrameVariancePlugin alias of lsst.meas.base.wrappers.GenericPlugin.makeSingleFramePlugin.<locals>.SingleFrameFromGenericPlugin
SkewDiaPsFlux(config, name, metadata) Compute the skew of diaSource fluxes.
SkewDiaPsFluxConfig
StetsonJDiaPsFlux(config, name, metadata) Compute the StetsonJ statistic on the DIA point source fluxes.
StetsonJDiaPsFluxConfig
UncertaintyEnum
VarianceConfig Configuration for the variance calculation plugin.
WeightedMeanDiaPsFlux(config, name, metadata) Compute the weighted mean and mean error on the point source fluxes of the DiaSource measured on the difference image.
WeightedMeanDiaPsFluxConfig
WeightedMeanDiaTotFlux(config, name, metadata) Compute the weighted mean and mean error on the point source fluxes forced photometered at the DiaSource location in the calibrated image.
WeightedMeanDiaTotFluxConfig

Class Inheritance Diagram

Inheritance diagram of lsst.meas.base.apertureFlux.ApertureFluxAlgorithm, lsst.meas.base.apertureFlux.ApertureFluxControl, lsst.meas.base.apertureFlux.ApertureFluxResult, lsst.meas.base.apertureFlux.ApertureFluxTransform, lsst.meas.base.applyApCorr.ApplyApCorrConfig, lsst.meas.base.applyApCorr.ApplyApCorrTask, lsst.meas.base.algorithm.BaseAlgorithm, lsst.meas.base.baseMeasurement.BaseMeasurementConfig, lsst.meas.base.baseMeasurement.BaseMeasurementPlugin, lsst.meas.base.baseMeasurement.BaseMeasurementPluginConfig, lsst.meas.base.baseMeasurement.BaseMeasurementTask, lsst.meas.base.pluginsBase.BasePlugin, lsst.meas.base.pluginsBase.BasePluginConfig, lsst.meas.base.transform.BaseTransform, lsst.meas.base.blendedness.BlendednessAlgorithm, lsst.meas.base.blendedness.BlendednessControl, lsst.meas.base.classification.CatalogCalculationClassificationConfig, lsst.meas.base.classification.CatalogCalculationClassificationPlugin, lsst.meas.base.catalogCalculation.CatalogCalculationConfig, lsst.meas.base.footprintArea.CatalogCalculationFootprintAreaConfig, lsst.meas.base.footprintArea.CatalogCalculationFootprintAreaPlugin, lsst.meas.base.catalogCalculation.CatalogCalculationPlugin, lsst.meas.base.catalogCalculation.CatalogCalculationPluginConfig, lsst.meas.base.catalogCalculation.CatalogCalculationTask, lsst.meas.base.centroidUtilities.CentroidChecker, lsst.meas.base.centroidUtilities.CentroidResult, lsst.meas.base.centroidUtilities.CentroidResultKey, lsst.meas.base.centroidUtilities.CentroidTransform, lsst.meas.base.diaCalculationPlugins.Chi2DiaPsFlux, lsst.meas.base.diaCalculationPlugins.Chi2DiaPsFluxConfig, lsst.meas.base.circularApertureFlux.CircularApertureFluxAlgorithm, lsst.meas.base.diaCalculation.DiaObjectCalculationConfig, lsst.meas.base.diaCalculation.DiaObjectCalculationPlugin, lsst.meas.base.diaCalculation.DiaObjectCalculationPluginConfig, lsst.meas.base.diaCalculation.DiaObjectCalculationTask, lsst.meas.base.noiseReplacer.DummyNoiseReplacer, lsst.meas.base.diaCalculationPlugins.ErrMeanDiaPsFlux, lsst.meas.base.diaCalculationPlugins.ErrMeanDiaPsFluxConfig, lsst.meas.base.plugins.EvaluateLocalPhotoCalibPlugin, lsst.meas.base.plugins.EvaluateLocalPhotoCalibPluginConfig, lsst.meas.base.plugins.EvaluateLocalWcsPlugin, lsst.meas.base.plugins.EvaluateLocalWcsPluginConfig, lsst.meas.base.flagHandler.FlagDefinition, lsst.meas.base.flagHandler.FlagDefinitionList, lsst.meas.base.flagHandler.FlagHandler, lsst.meas.base.fluxUtilities.FluxResult, lsst.meas.base.fluxUtilities.FluxResultKey, lsst.meas.base.forcedMeasurement.ForcedMeasurementConfig, lsst.meas.base.forcedMeasurement.ForcedMeasurementTask, lsst.meas.base.plugins.ForcedPeakCentroidConfig, lsst.meas.base.plugins.ForcedPeakCentroidPlugin, lsst.meas.base.forcedPhotCcd.ForcedPhotCcdConfig, lsst.meas.base.forcedPhotCcd.ForcedPhotCcdFromDataFrameConfig, lsst.meas.base.forcedPhotCcd.ForcedPhotCcdFromDataFrameTask, lsst.meas.base.forcedPhotCcd.ForcedPhotCcdTask, lsst.meas.base.forcedPhotCoadd.ForcedPhotCoaddConfig, lsst.meas.base.forcedPhotCoadd.ForcedPhotCoaddTask, lsst.meas.base.forcedMeasurement.ForcedPlugin, lsst.meas.base.forcedMeasurement.ForcedPluginConfig, lsst.meas.base.plugins.ForcedTransformedCentroidConfig, lsst.meas.base.plugins.ForcedTransformedCentroidFromCoordConfig, lsst.meas.base.plugins.ForcedTransformedCentroidFromCoordPlugin, lsst.meas.base.plugins.ForcedTransformedCentroidPlugin, lsst.meas.base.plugins.ForcedTransformedShapeConfig, lsst.meas.base.plugins.ForcedTransformedShapePlugin, lsst.meas.base.gaussianFlux.GaussianFluxAlgorithm, lsst.meas.base.gaussianFlux.GaussianFluxControl, lsst.meas.base.gaussianFlux.GaussianFluxTransform, lsst.meas.base.wrappers.GenericPlugin, lsst.meas.base.diaCalculationPlugins.HTMIndexDiaPosition, lsst.meas.base.diaCalculationPlugins.HTMIndexDiaPositionConfig, lsst.meas.base.plugins.InputCountConfig, lsst.meas.base.diaCalculationPlugins.LinearFitDiaPsFlux, lsst.meas.base.diaCalculationPlugins.LinearFitDiaPsFluxConfig, lsst.meas.base.localBackground.LocalBackgroundAlgorithm, lsst.meas.base.localBackground.LocalBackgroundControl, lsst.meas.base.localBackground.LocalBackgroundTransform, lsst.meas.base.diaCalculationPlugins.MadDiaPsFlux, lsst.meas.base.diaCalculationPlugins.MadDiaPsFluxConfig, lsst.meas.base.fluxUtilities.MagResult, lsst.meas.base.fluxUtilities.MagResultKey, lsst.meas.base.diaCalculationPlugins.MaxSlopeDiaPsFlux, lsst.meas.base.diaCalculationPlugins.MaxSlopeDiaPsFluxConfig, lsst.meas.base.diaCalculationPlugins.MeanDiaPosition, lsst.meas.base.diaCalculationPlugins.MeanDiaPositionConfig, lsst.meas.base.transforms.MeasurementTransform, lsst.meas.base.diaCalculationPlugins.MinMaxDiaPsFlux, lsst.meas.base.diaCalculationPlugins.MinMaxDiaPsFluxConfig, lsst.meas.base.naiveCentroid.NaiveCentroidAlgorithm, lsst.meas.base.naiveCentroid.NaiveCentroidControl, lsst.meas.base.naiveCentroid.NaiveCentroidTransform, lsst.meas.base.noiseReplacer.NoiseReplacer, lsst.meas.base.noiseReplacer.NoiseReplacerConfig, lsst.meas.base.transforms.NullTransform, lsst.meas.base.diaCalculationPlugins.NumDiaSourcesDiaPlugin, lsst.meas.base.diaCalculationPlugins.NumDiaSourcesDiaPluginConfig, lsst.meas.base.transforms.PassThroughTransform, lsst.meas.base.peakLikelihoodFlux.PeakLikelihoodFluxAlgorithm, lsst.meas.base.peakLikelihoodFlux.PeakLikelihoodFluxControl, lsst.meas.base.peakLikelihoodFlux.PeakLikelihoodFluxTransform, lsst.meas.base.diaCalculationPlugins.PercentileDiaPsFlux, lsst.meas.base.diaCalculationPlugins.PercentileDiaPsFluxConfig, lsst.meas.base.pixelFlags.PixelFlagsAlgorithm, lsst.meas.base.pixelFlags.PixelFlagsControl, lsst.meas.base.pluginRegistry.PluginMap, lsst.meas.base.pluginRegistry.PluginRegistry, lsst.meas.base.psfFlux.PsfFluxAlgorithm, lsst.meas.base.psfFlux.PsfFluxControl, lsst.meas.base.psfFlux.PsfFluxTransform, lsst.meas.base.inputUtilities.SafeCentroidExtractor, lsst.meas.base.scaledApertureFlux.ScaledApertureFluxAlgorithm, lsst.meas.base.scaledApertureFlux.ScaledApertureFluxControl, lsst.meas.base.scaledApertureFlux.ScaledApertureFluxTransform, lsst.meas.base.sdssCentroid.SdssCentroidAlgorithm, lsst.meas.base.sdssCentroid.SdssCentroidControl, lsst.meas.base.sdssCentroid.SdssCentroidTransform, lsst.meas.base.sdssShape.SdssShapeAlgorithm, lsst.meas.base.sdssShape.SdssShapeControl, lsst.meas.base.sdssShape.SdssShapeResult, lsst.meas.base.sdssShape.SdssShapeResultKey, lsst.meas.base.sdssShape.SdssShapeTransform, lsst.meas.base.shapeUtilities.ShapeResult, lsst.meas.base.shapeUtilities.ShapeResultKey, lsst.meas.base.diaCalculationPlugins.SigmaDiaPsFlux, lsst.meas.base.diaCalculationPlugins.SigmaDiaPsFluxConfig, lsst.meas.base.diaCalculationPlugins.SigmaDiaTotFlux, lsst.meas.base.diaCalculationPlugins.SigmaDiaTotFluxConfig, lsst.meas.base.algorithm.SimpleAlgorithm, lsst.meas.base.transforms.SimpleCentroidTransform, lsst.meas.base.diaCalculationPlugins.SimpleSourceFlagDiaPlugin, lsst.meas.base.diaCalculationPlugins.SimpleSourceFlagDiaPluginConfig, lsst.meas.base.sincCoeffs.SincCoeffsD, lsst.meas.base.sincCoeffs.SincCoeffsF, lsst.meas.base.algorithm.SingleFrameAlgorithm, lsst.meas.base.plugins.SingleFrameFPPositionConfig, lsst.meas.base.plugins.SingleFrameFPPositionPlugin, lsst.meas.base.plugins.SingleFrameJacobianConfig, lsst.meas.base.plugins.SingleFrameJacobianPlugin, lsst.meas.base.sfm.SingleFrameMeasurementConfig, lsst.meas.base.sfm.SingleFrameMeasurementTask, lsst.meas.base.plugins.SingleFramePeakCentroidConfig, lsst.meas.base.plugins.SingleFramePeakCentroidPlugin, lsst.meas.base.sfm.SingleFramePlugin, lsst.meas.base.sfm.SingleFramePluginConfig, lsst.meas.base.plugins.SingleFrameSkyCoordConfig, lsst.meas.base.plugins.SingleFrameSkyCoordPlugin, lsst.meas.base.diaCalculationPlugins.SkewDiaPsFlux, lsst.meas.base.diaCalculationPlugins.SkewDiaPsFluxConfig, lsst.meas.base.diaCalculationPlugins.StetsonJDiaPsFlux, lsst.meas.base.diaCalculationPlugins.StetsonJDiaPsFluxConfig, lsst.meas.base.centroidUtilities.UncertaintyEnum, lsst.meas.base.plugins.VarianceConfig, lsst.meas.base.diaCalculationPlugins.WeightedMeanDiaPsFlux, lsst.meas.base.diaCalculationPlugins.WeightedMeanDiaPsFluxConfig, lsst.meas.base.diaCalculationPlugins.WeightedMeanDiaTotFlux, lsst.meas.base.diaCalculationPlugins.WeightedMeanDiaTotFluxConfig