lsst.pipe.tasks.measurementDriver.MeasurementDriverBaseConfig Class Reference

Inheritance diagram for lsst.pipe.tasks.measurementDriver.MeasurementDriverBaseConfig:

Public Member Functions
	validate (self)

Static Public Attributes
	doScaleVariance = Field[bool](doc="Scale variance plane using empirical noise?", default=False)
	scaleVariance
	doDetect = Field[bool](doc="Run the source detection algorithm?", default=True)
	detection
	doDeblend = Field[bool](doc="Run the source deblending algorithm?", default=True)
	doMeasure = Field[bool](doc="Run the source measurement algorithm?", default=True)
	measurement
	psfCache
	checkUnitsParseStrict
	doApCorr
	applyApCorr
	doRunCatalogCalculation = Field[bool](doc="Run catalogCalculation task?", default=False)
	catalogCalculation
list	doOptions

Detailed Description

Base configuration for measurement driver tasks.

This class provides foundational configuration for its subclasses to handle
single-band and multi-band data. It defines variance scaling, detection,
deblending, measurement, aperture correction, and catalog calculation
subtasks, which are intended to be executed in sequence by the driver task.

Definition at line 54 of file measurementDriver.py.

Member Function Documentation

validate()

lsst.pipe.tasks.measurementDriver.MeasurementDriverBaseConfig.validate

(

self

)

Ensure that at least one processing step is enabled.

Definition at line 122 of file measurementDriver.py.

Member Data Documentation

applyApCorr

lsst.pipe.tasks.measurementDriver.MeasurementDriverBaseConfig.applyApCorr

static

Initial value:

=  ConfigurableField(
        doc="Subtask to apply aperture corrections",
        target=measBase.ApplyApCorrTask,
    )

Definition at line 102 of file measurementDriver.py.

catalogCalculation

lsst.pipe.tasks.measurementDriver.MeasurementDriverBaseConfig.catalogCalculation

static

Initial value:

=  ConfigurableField(
        doc="Subtask to run catalogCalculation plugins on catalog", target=measBase.CatalogCalculationTask
    )

Definition at line 109 of file measurementDriver.py.

checkUnitsParseStrict

lsst.pipe.tasks.measurementDriver.MeasurementDriverBaseConfig.checkUnitsParseStrict

static

Initial value:

=  Field[str](
        doc="Strictness of Astropy unit compatibility check, can be 'raise', 'warn' or 'silent'",
        default="raise",
    )

Definition at line 92 of file measurementDriver.py.

detection

lsst.pipe.tasks.measurementDriver.MeasurementDriverBaseConfig.detection

static

Initial value:

=  ConfigurableField(
        doc="Subtask to detect sources in the image", target=measAlgorithms.SourceDetectionTask
    )

Definition at line 71 of file measurementDriver.py.

doApCorr

lsst.pipe.tasks.measurementDriver.MeasurementDriverBaseConfig.doApCorr

static

Initial value:

=  Field[bool](
        doc="Apply aperture corrections? If yes, your image must have an aperture correction map",
        default=False,
    )

Definition at line 97 of file measurementDriver.py.

doDeblend

lsst.pipe.tasks.measurementDriver.MeasurementDriverBaseConfig.doDeblend = Field[bool](doc="Run the source deblending algorithm?", default=True)

static

Definition at line 75 of file measurementDriver.py.

doDetect

lsst.pipe.tasks.measurementDriver.MeasurementDriverBaseConfig.doDetect = Field[bool](doc="Run the source detection algorithm?", default=True)

static

Definition at line 69 of file measurementDriver.py.

doMeasure

lsst.pipe.tasks.measurementDriver.MeasurementDriverBaseConfig.doMeasure = Field[bool](doc="Run the source measurement algorithm?", default=True)

static

Definition at line 78 of file measurementDriver.py.

doOptions

lsst.pipe.tasks.measurementDriver.MeasurementDriverBaseConfig.doOptions

static

Initial value:

=  [
        "doScaleVariance",
        "doDetect",
        "doDeblend",
        "doMeasure",
        "doApCorr",
        "doRunCatalogCalculation",
    ]

Definition at line 113 of file measurementDriver.py.

doRunCatalogCalculation

lsst.pipe.tasks.measurementDriver.MeasurementDriverBaseConfig.doRunCatalogCalculation = Field[bool](doc="Run catalogCalculation task?", default=False)

static

Definition at line 107 of file measurementDriver.py.

doScaleVariance

lsst.pipe.tasks.measurementDriver.MeasurementDriverBaseConfig.doScaleVariance = Field[bool](doc="Scale variance plane using empirical noise?", default=False)

static

Definition at line 63 of file measurementDriver.py.

measurement

lsst.pipe.tasks.measurementDriver.MeasurementDriverBaseConfig.measurement

static

Initial value:

=  ConfigurableField(
        doc="Subtask to measure sources and populate the output catalog",
        target=measBase.SingleFrameMeasurementTask,
    )

Definition at line 80 of file measurementDriver.py.

psfCache

lsst.pipe.tasks.measurementDriver.MeasurementDriverBaseConfig.psfCache

static

Initial value:

=  Field[int](
        doc="Maximum number of PSFs to cache, preventing repeated PSF evaluations at the same "
        "point across different measurement plugins. Defaults to -1, which auto-sizes the cache "
        "based on the plugin count.",
        default=-1,
    )

Definition at line 85 of file measurementDriver.py.

scaleVariance

lsst.pipe.tasks.measurementDriver.MeasurementDriverBaseConfig.scaleVariance

static

Initial value:

=  ConfigurableField(
        doc="Subtask to rescale variance plane", target=measAlgorithms.ScaleVarianceTask
    )

Definition at line 65 of file measurementDriver.py.

---

The documentation for this class was generated from the following file:

• python/lsst/pipe/tasks/measurementDriver.py