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
• 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

Command-line tasks

No topics.

Tasks

ApplyApCorrTask

Apply aperture corrections.

BaseMeasurementTask

Ultimate base class for all measurement tasks.

BaseReferencesTask

Base class for forced photometry subtask that fetches reference sources.

CatalogCalculationTask

Run plugins which operate on a catalog of sources.

CoaddSrcReferencesTask

Select reference sources by loading the “coadd source” dataset directly.

ForcedMeasurementTask

Measure sources on an image, constrained by a reference catalog.

MultiBandReferencesTask

Loads references from the multi-band processing scheme.

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.
imageOverlapsTract(tract, imageWcs, imageBox)	Return whether the given bounding box overlaps the tract given a WCS.
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.
BaseReferencesTask([butler, schema])	Base class for forced photometry subtask that fetches reference sources.
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
CircularApertureFluxAlgorithm
CoaddSrcReferencesTask([butler, schema])	Select reference sources by loading the “coadd source” dataset directly.
DummyNoiseReplacer	A noise replacer which does nothing.
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
ForcedPhotCcdTask([butler, refSchema, …])	A command-line driver for performing forced measurement on CCD images.
ForcedPhotCoaddConfig
ForcedPhotCoaddTask([butler, refSchema, …])	A command-line driver for performing forced measurement on coadd images.
ForcedPhotImageConfig	Config class for forced measurement driver task.
ForcedPhotImageConnections(*, config)
ForcedPhotImageTask([butler, refSchema, …])	A base class for command-line forced measurement drivers.
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.
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.
InputCountConfig	Configuration for the input image counting plugin.
LocalBackgroundAlgorithm
LocalBackgroundControl
LocalBackgroundTransform(ctrl, name, mapper)
MagResult
MagResultKey
MeasurementTransform(config, name, mapper)	Base class for measurement transformations.
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.
PassThroughTransform(config, name, mapper)	Copy fields from input to output without transformation.
PeakLikelihoodFluxAlgorithm
PeakLikelihoodFluxControl
PeakLikelihoodFluxTransform(ctrl, name, mapper)
PerTractCcdDataIdContainer([level])	A data ID container which combines raw data IDs with a tract.
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
SimpleAlgorithm
SimpleCentroidTransform(config, name, mapper)	Transform pixel centroid, without uncertainty, to celestial coordinates.
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
UncertaintyEnum
VarianceConfig	Configuration for the variance calculation plugin.

Class Inheritance Diagram