lsst.pipe.tasks.measurementDriver.MultiBandMeasurementDriverConfig Class Reference
Inheritance diagram for lsst.pipe.tasks.measurementDriver.MultiBandMeasurementDriverConfig:
Public Member Functions | |
| validate (self) | |
Static Public Attributes | |
| deblend | |
| doConserveFlux | |
| measureOnlyInRefBand | |
| removeScarletData | |
| updateFluxColumns | |
| 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
Configuration for the multi-band measurement driver task.
Definition at line 888 of file measurementDriver.py.
Member Function Documentation
◆ validate()
|
inherited |
Ensure that at least one processing step is enabled.
Definition at line 122 of file measurementDriver.py.
Member Data Documentation
◆ applyApCorr
|
staticinherited |
Initial value:
= ConfigurableField(
doc="Subtask to apply aperture corrections",
target=measBase.ApplyApCorrTask,
)
Definition at line 102 of file measurementDriver.py.
◆ catalogCalculation
|
staticinherited |
Initial value:
= ConfigurableField(
doc="Subtask to run catalogCalculation plugins on catalog", target=measBase.CatalogCalculationTask
)
Definition at line 109 of file measurementDriver.py.
◆ checkUnitsParseStrict
|
staticinherited |
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.
◆ deblend
|
static |
Initial value:
= ConfigurableField(
target=scarlet.ScarletDeblendTask, doc="Scarlet deblender for multi-band data"
)
Definition at line 891 of file measurementDriver.py.
◆ detection
|
staticinherited |
Initial value:
= ConfigurableField(
doc="Subtask to detect sources in the image", target=measAlgorithms.SourceDetectionTask
)
Definition at line 71 of file measurementDriver.py.
◆ doApCorr
|
staticinherited |
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.
◆ doConserveFlux
|
static |
Initial value:
= Field[bool](
doc="Whether to use the deblender models as templates to re-distribute the flux from "
"the 'exposure' (True), or to perform measurements on the deblender model footprints.",
default=False,
)
Definition at line 895 of file measurementDriver.py.
◆ doDeblend
|
staticinherited |
Definition at line 75 of file measurementDriver.py.
◆ doDetect
|
staticinherited |
Definition at line 69 of file measurementDriver.py.
◆ doMeasure
|
staticinherited |
Definition at line 78 of file measurementDriver.py.
◆ doOptions
|
staticinherited |
Initial value:
= [
"doScaleVariance",
"doDetect",
"doDeblend",
"doMeasure",
"doApCorr",
"doRunCatalogCalculation",
]
Definition at line 113 of file measurementDriver.py.
◆ doRunCatalogCalculation
|
staticinherited |
Definition at line 107 of file measurementDriver.py.
◆ doScaleVariance
|
staticinherited |
Definition at line 63 of file measurementDriver.py.
◆ measurement
|
staticinherited |
Initial value:
= ConfigurableField(
doc="Subtask to measure sources and populate the output catalog",
target=measBase.SingleFrameMeasurementTask,
)
Definition at line 80 of file measurementDriver.py.
◆ measureOnlyInRefBand
|
static |
Initial value:
= Field[bool](
doc="If True, all measurements downstream of deblending run only in the reference band that "
"was used for detection; otherwise, they are performed in all available bands, generating a "
"catalog for each. Regardless of this setting, deblending still uses all available bands.",
default=False,
)
Definition at line 901 of file measurementDriver.py.
◆ psfCache
|
staticinherited |
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.
◆ removeScarletData
|
static |
Initial value:
= Field[bool](
doc="Whether or not to remove `ScarletBlendData` for each blend in order to save memory. "
"If set to True, some sources may end up with missing footprints in catalogs other than the "
"reference-band catalog, leading to failures in subsequent measurements that require footprints. "
"For example, keep this False if `measureOnlyInRefBand` is set to False and "
"`measurement.doReplaceWithNoise` to True, in order to make the footprints available in "
"non-reference bands in addition to the reference band.",
default=False,
)
Definition at line 908 of file measurementDriver.py.
◆ scaleVariance
|
staticinherited |
Initial value:
= ConfigurableField(
doc="Subtask to rescale variance plane", target=measAlgorithms.ScaleVarianceTask
)
Definition at line 65 of file measurementDriver.py.
◆ updateFluxColumns
|
static |
Initial value:
= Field[bool](
doc="Whether or not to update the `deblend_*` columns in the catalog. This should only be "
"True when the input catalog schema already contains those columns.",
default=True,
)
Definition at line 918 of file measurementDriver.py.
The documentation for this class was generated from the following file:
- python/lsst/pipe/tasks/measurementDriver.py
Generated on Thu Apr 30 2026 09:11:36 for lsst.pipe.tasks by
1.13.2