lsst.pipe.tasks.characterizeImage.CharacterizeImageConfig Class Reference
Inheritance diagram for lsst.pipe.tasks.characterizeImage.CharacterizeImageConfig:
Public Member Functions | |
| setDefaults (self) | |
| validate (self) | |
| adjustQuantum (self, inputs, outputs, label, dataId) | |
Static Public Attributes | |
| doMeasurePsf | |
| doWrite | |
| doWriteExposure | |
| psfIterations | |
| background | |
| detection | |
| bool | doDeblend |
| deblend | |
| measurement | |
| doNormalizedCalibration | |
| normalizedCalibrationFlux | |
| bool | doApCorr |
| measureApCorr | |
| applyApCorr | |
| catalogCalculation | |
| doComputeSummaryStats | |
| computeSummaryStats | |
| useSimplePsf | |
| installSimplePsf | |
| measurePsf | |
| repair | |
| requireCrForPsf | |
| checkUnitsParseStrict | |
| doMaskStreaks | |
| maskStreaks | |
| idGenerator = DetectorVisitIdGeneratorConfig.make_field() | |
| exposure | |
| characterized | |
| sourceCat | |
| backgroundModel | |
| outputSchema | |
Detailed Description
Config for CharacterizeImageTask.
Definition at line 105 of file characterizeImage.py.
Member Function Documentation
◆ adjustQuantum()
|
inherited |
Definition at line 92 of file characterizeImage.py.
◆ setDefaults()
| lsst.pipe.tasks.characterizeImage.CharacterizeImageConfig.setDefaults | ( | self | ) |
Definition at line 241 of file characterizeImage.py.
◆ validate()
| lsst.pipe.tasks.characterizeImage.CharacterizeImageConfig.validate | ( | self | ) |
Definition at line 277 of file characterizeImage.py.
Member Data Documentation
◆ applyApCorr
|
static |
Initial value:
= pexConfig.ConfigurableField(
target=ApplyApCorrTask,
doc="Subtask to apply aperture corrections"
)
Definition at line 173 of file characterizeImage.py.
◆ background
|
static |
Initial value:
= pexConfig.ConfigurableField(
target=SubtractBackgroundTask,
doc="Configuration for initial background estimation",
)
Definition at line 134 of file characterizeImage.py.
◆ backgroundModel
|
staticinherited |
Initial value:
= cT.Output(
doc="Output background model.",
name="icExpBackground",
storageClass="Background",
dimensions=["instrument", "visit", "detector"],
)
Definition at line 80 of file characterizeImage.py.
◆ catalogCalculation
|
static |
Initial value:
= pexConfig.ConfigurableField(
target=CatalogCalculationTask,
doc="Subtask to run catalogCalculation plugins on catalog"
)
Definition at line 179 of file characterizeImage.py.
◆ characterized
|
staticinherited |
Initial value:
= cT.Output(
doc="Output characterized data.",
name="icExp",
storageClass="ExposureF",
dimensions=["instrument", "visit", "detector"],
)
Definition at line 68 of file characterizeImage.py.
◆ checkUnitsParseStrict
|
static |
Initial value:
= pexConfig.Field(
doc="Strictness of Astropy unit compatibility check, can be 'raise', 'warn' or 'silent'",
dtype=str,
default="raise",
)
Definition at line 220 of file characterizeImage.py.
◆ computeSummaryStats
|
static |
Initial value:
= pexConfig.ConfigurableField(
target=ComputeExposureSummaryStatsTask,
doc="Subtask to run computeSummaryStats on exposure",
deprecated=("This subtask has been moved to CalibrateTask "
"with DM-30701.")
)
Definition at line 190 of file characterizeImage.py.
◆ deblend
|
static |
Initial value:
= pexConfig.ConfigurableField(
target=SourceDeblendTask,
doc="Split blended source into their components"
)
Definition at line 147 of file characterizeImage.py.
◆ detection
|
static |
Initial value:
= pexConfig.ConfigurableField(
target=SourceDetectionTask,
doc="Detect sources"
)
Definition at line 138 of file characterizeImage.py.
◆ doApCorr
|
static |
Initial value:
= pexConfig.Field(
dtype=bool,
default=True,
doc="Run subtasks to measure and apply aperture corrections"
)
Definition at line 164 of file characterizeImage.py.
◆ doComputeSummaryStats
|
static |
Initial value:
= pexConfig.Field(
dtype=bool,
default=True,
doc="Run subtask to measure exposure summary statistics",
deprecated=("This subtask has been moved to CalibrateTask "
"with DM-30701.")
)
Definition at line 183 of file characterizeImage.py.
◆ doDeblend
|
static |
Initial value:
= pexConfig.Field(
dtype=bool,
default=True,
doc="Run deblender input exposure"
)
Definition at line 142 of file characterizeImage.py.
◆ doMaskStreaks
|
static |
Initial value:
= pexConfig.Field(
doc="Mask streaks",
default=False,
dtype=bool,
deprecated=("This subtask has been moved to detectAndMeasureTask in "
"ip_diffim with DM-43370 and will be removed in DM-44658.")
)
Definition at line 225 of file characterizeImage.py.
◆ doMeasurePsf
|
static |
Initial value:
= pexConfig.Field(
dtype=bool,
default=True,
doc="Measure PSF? If False then for all subsequent operations use either existing PSF "
"model when present, or install simple PSF model when not (see installSimplePsf "
"config options)"
)
Definition at line 109 of file characterizeImage.py.
◆ doNormalizedCalibration
|
static |
Initial value:
= pexConfig.Field(
dtype=bool,
default=True,
doc="Use normalized calibration flux (e.g. compensated tophats)?",
)
Definition at line 155 of file characterizeImage.py.
◆ doWrite
|
static |
Initial value:
= pexConfig.Field(
dtype=bool,
default=True,
doc="Persist results?",
)
Definition at line 116 of file characterizeImage.py.
◆ doWriteExposure
|
static |
Initial value:
= pexConfig.Field(
dtype=bool,
default=True,
doc="Write icExp and icExpBackground in addition to icSrc? Ignored if doWrite False.",
)
Definition at line 121 of file characterizeImage.py.
◆ exposure
|
staticinherited |
Initial value:
= cT.Input(
doc="Input exposure data",
name="postISRCCD",
storageClass="Exposure",
dimensions=["instrument", "exposure", "detector"],
)
Definition at line 62 of file characterizeImage.py.
◆ idGenerator
|
static |
Definition at line 239 of file characterizeImage.py.
◆ installSimplePsf
|
static |
Initial value:
= pexConfig.ConfigurableField(
target=InstallGaussianPsfTask,
doc="Install a simple PSF model",
)
Definition at line 203 of file characterizeImage.py.
◆ maskStreaks
|
static |
Initial value:
= pexConfig.ConfigurableField(
target=MaskStreaksTask,
doc="Subtask for masking streaks. Only used if doMaskStreaks is True. "
"Adds a mask plane to an exposure, with the mask plane name set by streakMaskName.",
deprecated=("This subtask has been moved to detectAndMeasureTask in "
"ip_diffim with DM-43370 and will be removed in DM-44658.")
)
Definition at line 232 of file characterizeImage.py.
◆ measureApCorr
|
static |
Initial value:
= pexConfig.ConfigurableField(
target=MeasureApCorrTask,
doc="Subtask to measure aperture corrections"
)
Definition at line 169 of file characterizeImage.py.
◆ measurement
|
static |
Initial value:
= pexConfig.ConfigurableField(
target=SingleFrameMeasurementTask,
doc="Measure sources"
)
Definition at line 151 of file characterizeImage.py.
◆ measurePsf
|
static |
Initial value:
= pexConfig.ConfigurableField(
target=MeasurePsfTask,
doc="Measure PSF",
)
Definition at line 207 of file characterizeImage.py.
◆ normalizedCalibrationFlux
|
static |
Initial value:
= pexConfig.ConfigurableField(
target=NormalizedCalibrationFluxTask,
doc="Task to normalize the calibration flux (e.g. compensated tophats).",
)
Definition at line 160 of file characterizeImage.py.
◆ outputSchema
|
staticinherited |
Initial value:
= cT.InitOutput(
doc="Schema of the catalog produced by CharacterizeImage",
name="icSrc_schema",
storageClass="SourceCatalog",
)
Definition at line 86 of file characterizeImage.py.
◆ psfIterations
|
static |
Initial value:
= pexConfig.RangeField(
dtype=int,
default=2,
min=1,
doc="Number of iterations of detect sources, measure sources, "
"estimate PSF. If useSimplePsf is True then 2 should be plenty; "
"otherwise more may be wanted.",
)
Definition at line 126 of file characterizeImage.py.
◆ repair
|
static |
Initial value:
= pexConfig.ConfigurableField(
target=RepairTask,
doc="Remove cosmic rays",
)
Definition at line 211 of file characterizeImage.py.
◆ requireCrForPsf
|
static |
Initial value:
= pexConfig.Field(
dtype=bool,
default=True,
doc="Require cosmic ray detection and masking to run successfully before measuring the PSF."
)
Definition at line 215 of file characterizeImage.py.
◆ sourceCat
|
staticinherited |
Initial value:
= cT.Output(
doc="Output source catalog.",
name="icSrc",
storageClass="SourceCatalog",
dimensions=["instrument", "visit", "detector"],
)
Definition at line 74 of file characterizeImage.py.
◆ useSimplePsf
|
static |
Initial value:
= pexConfig.Field(
dtype=bool,
default=True,
doc="Replace the existing PSF model with a simplified version that has the same sigma "
"at the start of each PSF determination iteration? Doing so makes PSF determination "
"converge more robustly and quickly.",
)
Definition at line 196 of file characterizeImage.py.
The documentation for this class was generated from the following file:
- python/lsst/pipe/tasks/characterizeImage.py
Generated on for lsst.pipe.tasks by
1.17.0