lsst.meas.base

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

Using lsst.meas.base

• Overview of the measurement framework
• Measurement tasks and algorithm plugins
• Generating source and object IDs
• Investigating LSST Measurements

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(*args, **kw)	Aperture correction configuration.
ApplyApCorrTask(schema, **kwds)	Apply aperture corrections.
BaseAlgorithm
BaseIdGeneratorConfig(*args, **kw)	Base class for configuration of IdGenerator instances.
BaseMeasurementConfig(*args[, ...])	Base configuration for all measurement driver tasks.
BaseMeasurementPlugin(config, name[, logName])	Base class for all measurement plugins.
BaseMeasurementPluginConfig(*args, **kw)	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(*args, **kw)	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(*args, **kw)	Config class for the catalog calculation driver task.
CatalogCalculationFootprintAreaConfig(*args, ...)	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(*args, **kw)	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(*args, **kw)
CircularApertureFluxAlgorithm
DetectorExposureIdGeneratorConfig(*args, **kw)	Configuration class for generating integer IDs from {exposure, detector} data IDs.
DetectorVisitIdGeneratorConfig(*args, **kw)	Configuration class for generating integer IDs from {visit, detector} data IDs.
DiaObjectCalculationConfig(*args, **kw)	Config class for the catalog calculation driver task.
DiaObjectCalculationPlugin(config, name, ...)	Base class for DIA catalog calculation plugins.
DiaObjectCalculationPluginConfig(*args, **kw)	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(*args, **kw)
EvaluateLocalPhotoCalibPlugin(config, name, ...)	Evaluate the local value of the Photometric Calibration in the exposure.
EvaluateLocalPhotoCalibPluginConfig(*args, **kw)	Configuration for the variance calculation plugin.
EvaluateLocalWcsPlugin(config, name, schema, ...)	Evaluate the local, linear approximation of the Wcs.
EvaluateLocalWcsPluginConfig(*args, **kw)	Configuration for the variance calculation plugin.
FlagDefinition
FlagDefinitionList
FlagHandler
FluxResult
FluxResultKey
ForcedInputCountPlugin	alias of ForcedFromGenericPlugin
ForcedMeasurementConfig(*args[, ...])	Config class for forced measurement driver task.
ForcedMeasurementTask(refSchema[, algMetadata])	Measure sources on an image, constrained by a reference catalog.
ForcedPeakCentroidConfig(*args, **kw)	Configuration for the forced peak centroid algorithm.
ForcedPeakCentroidPlugin(config, name, ...)	Record the highest peak in a source footprint as its centroid.
ForcedPhotCcdConfig(*args, **kw)	Config class for forced measurement driver task.
ForcedPhotCcdFromDataFrameConfig(*args, **kw)
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(*args, **kw)
ForcedPhotCoaddTask([butler, refSchema, ...])	A pipeline task for performing forced measurement on coadd images.
ForcedPlugin(config, name, schemaMapper, ...)	Base class for forced measurement plugins.
ForcedPluginConfig(*args, **kw)	Base class for configs of forced measurement plugins.
ForcedTransformedCentroidConfig(*args, **kw)	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(*args, **kw)	Configuration for the forced transformed shape algorithm.
ForcedTransformedShapePlugin(config, name, ...)	Record the transformation of the reference catalog shape.
ForcedVariancePlugin	alias of ForcedFromGenericPlugin
FullIdGenerator(dimension_packer, data_id[, ...])	The subclass of IdGenerator that actually includes packed data IDs and release IDs in its generated IDs.
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(*args, **kw)
IdGenerator()	A helper class for packing some combination of a data ID, a per-data-ID counter, and a release ID into a single 64-bit integer.
InputCountConfig(*args, **kw)	Configuration for the input image counting plugin.
LinearFitDiaPsFlux(config, name, metadata)	Compute fit a linear model to flux vs time.
LinearFitDiaPsFluxConfig(*args, **kw)
LocalBackgroundAlgorithm
LocalBackgroundControl
LocalBackgroundTransform(ctrl, name, mapper)
MadDiaPsFlux(config, name, metadata)	Compute median absolute deviation of diaSource fluxes.
MadDiaPsFluxConfig(*args, **kw)
MagResult
MagResultKey
MaxSlopeDiaPsFlux(config, name, metadata)	Compute the maximum ratio time ordered deltaFlux / deltaTime.
MaxSlopeDiaPsFluxConfig(*args, **kw)
MeanDiaPosition(config, name, metadata)	Compute the mean position of a DiaObject given a set of DiaSources.
MeanDiaPositionConfig(*args, **kw)
MeasurementTransform(config, name, mapper)	Base class for measurement transformations.
MinMaxDiaPsFlux(config, name, metadata)	Compute min/max of diaSource fluxes.
MinMaxDiaPsFluxConfig(*args, **kw)
NaiveCentroidAlgorithm
NaiveCentroidControl
NaiveCentroidTransform(ctrl, name, mapper[, ...])
NoiseReplacer(config, exposure, footprints)	Replace sources with noise during measurement.
NoiseReplacerConfig(*args, **kw)	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(*args, **kw)
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(*args, **kw)
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(*args, **kw)
SigmaDiaTotFlux(config, name, metadata)	Compute scatter of diaSource fluxes.
SigmaDiaTotFluxConfig(*args, **kw)
SimpleAlgorithm
SimpleCentroidTransform(config, name, mapper)	Transform pixel centroid, without uncertainty, to celestial coordinates.
SimpleSourceFlagDiaPlugin(config, name, metadata)	Find if any DiaSource is flagged.
SimpleSourceFlagDiaPluginConfig(*args, **kw)
SincCoeffsD
SincCoeffsF
SingleFrameAlgorithm
SingleFrameCompensatedGaussianFluxConfig(...)
SingleFrameCompensatedGaussianFluxPlugin(...)
SingleFrameFPPositionConfig(*args, **kw)	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 SingleFrameFromGenericPlugin
SingleFrameJacobianConfig(*args, **kw)	Configuration for the Jacobian calculation plugin.
SingleFrameJacobianPlugin(config, name, ...)	Compute the Jacobian and its ratio with a nominal pixel area.
SingleFrameMeasurementConfig(*args[, ...])	Config class for single frame measurement driver task.
SingleFrameMeasurementTask(schema[, algMetadata])	A subtask for measuring the properties of sources on a single exposure.
SingleFramePeakCentroidConfig(*args, **kw)	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(*args, **kw)	Base class for single-frame plugin configuration classes.
SingleFrameSkyCoordConfig(*args, **kw)	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 SingleFrameFromGenericPlugin
SkewDiaPsFlux(config, name, metadata)	Compute the skew of diaSource fluxes.
SkewDiaPsFluxConfig(*args, **kw)
SkyMapIdGeneratorConfig(*args, **kw)	Configuration class for generating integer IDs from {tract, patch, [band]} data IDs.
StetsonJDiaPsFlux(config, name, metadata)	Compute the StetsonJ statistic on the DIA point source fluxes.
StetsonJDiaPsFluxConfig(*args, **kw)
UncertaintyEnum	Members:
VarianceConfig(*args, **kw)	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(*args, **kw)
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(*args, **kw)

Class Inheritance Diagram