Inheritance diagram for lsst.pipe.tasks.characterizeImage.CharacterizeImageConfig:
Public Member Functions | |
| setDefaults (self) | |
| validate (self) | |
Detailed Description
Config for CharacterizeImageTask.
Definition at line 104 of file characterizeImage.py.
Member Function Documentation
◆ setDefaults()
| lsst.pipe.tasks.characterizeImage.CharacterizeImageConfig.setDefaults | ( | self | ) |
Definition at line 227 of file characterizeImage.py.
227 def setDefaults(self):
228 super().setDefaults()
229 # just detect bright stars; includeThresholdMultipler=10 seems large,
230 # but these are the values we have been using
231 self.detection.thresholdValue = 5.0
232 self.detection.includeThresholdMultiplier = 10.0
233 # do not deblend, as it makes a mess
234 self.doDeblend = False
235 # measure and apply aperture correction; note: measuring and applying aperture
236 # correction are disabled until the final measurement, after PSF is measured
237 self.doApCorr = True
238 # During characterization, we don't have full source measurement information,
239 # so must do the aperture correction with only psf stars, combined with the
240 # default signal-to-noise cuts in MeasureApCorrTask.
241 selector = self.measureApCorr.sourceSelector["science"]
242 selector.doUnresolved = False
243 selector.flags.good = ["calib_psf_used"]
244 selector.flags.bad = []
245
246 # minimal set of measurements needed to determine PSF
247 self.measurement.plugins.names = [
248 "base_PixelFlags",
249 "base_SdssCentroid",
250 "ext_shapeHSM_HsmSourceMoments",
251 "base_GaussianFlux",
252 "base_PsfFlux",
253 "base_CircularApertureFlux",
254 "base_ClassificationSizeExtendedness",
255 ]
256 self.measurement.slots.shape = "ext_shapeHSM_HsmSourceMoments"
257
◆ validate()
| lsst.pipe.tasks.characterizeImage.CharacterizeImageConfig.validate | ( | self | ) |
Definition at line 258 of file characterizeImage.py.
258 def validate(self):
259 if self.doApCorr and not self.measurePsf:
260 raise RuntimeError("Must measure PSF to measure aperture correction, "
261 "because flags determined by PSF measurement are used to identify "
262 "sources used to measure aperture correction")
263
264
Member Data Documentation
◆ applyApCorr
|
static |
Initial value:
= pexConfig.ConfigurableField(
target=ApplyApCorrTask,
doc="Subtask to apply aperture corrections"
)
Definition at line 163 of file characterizeImage.py.
◆ background
|
static |
Initial value:
= pexConfig.ConfigurableField(
target=SubtractBackgroundTask,
doc="Configuration for initial background estimation",
)
Definition at line 133 of file characterizeImage.py.
◆ catalogCalculation
|
static |
Initial value:
= pexConfig.ConfigurableField(
target=CatalogCalculationTask,
doc="Subtask to run catalogCalculation plugins on catalog"
)
Definition at line 169 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 210 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 180 of file characterizeImage.py.
◆ deblend
|
static |
Initial value:
= pexConfig.ConfigurableField(
target=SourceDeblendTask,
doc="Split blended source into their components"
)
Definition at line 146 of file characterizeImage.py.
◆ detection
|
static |
Initial value:
= pexConfig.ConfigurableField(
target=SourceDetectionTask,
doc="Detect sources"
)
Definition at line 137 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 154 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 173 of file characterizeImage.py.
◆ doDeblend
|
static |
Initial value:
= pexConfig.Field(
dtype=bool,
default=True,
doc="Run deblender input exposure"
)
Definition at line 141 of file characterizeImage.py.
◆ doMaskStreaks
|
static |
Initial value:
= pexConfig.Field(
doc="Mask streaks",
default=True,
dtype=bool,
)
Definition at line 215 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 108 of file characterizeImage.py.
◆ doWrite
|
static |
Initial value:
= pexConfig.Field(
dtype=bool,
default=True,
doc="Persist results?",
)
Definition at line 115 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 120 of file characterizeImage.py.
◆ idGenerator
|
static |
Definition at line 225 of file characterizeImage.py.
◆ installSimplePsf
|
static |
Initial value:
= pexConfig.ConfigurableField(
target=InstallGaussianPsfTask,
doc="Install a simple PSF model",
)
Definition at line 193 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.",
)
Definition at line 220 of file characterizeImage.py.
◆ measureApCorr
|
static |
Initial value:
= pexConfig.ConfigurableField(
target=MeasureApCorrTask,
doc="Subtask to measure aperture corrections"
)
Definition at line 159 of file characterizeImage.py.
◆ measurement
|
static |
Initial value:
= pexConfig.ConfigurableField(
target=SingleFrameMeasurementTask,
doc="Measure sources"
)
Definition at line 150 of file characterizeImage.py.
◆ measurePsf
|
static |
Initial value:
= pexConfig.ConfigurableField(
target=MeasurePsfTask,
doc="Measure PSF",
)
Definition at line 197 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 125 of file characterizeImage.py.
◆ repair
|
static |
Initial value:
= pexConfig.ConfigurableField(
target=RepairTask,
doc="Remove cosmic rays",
)
Definition at line 201 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 205 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 186 of file characterizeImage.py.
The documentation for this class was generated from the following file:
- /j/snowflake/release/lsstsw/stack/lsst-scipipe-8.0.0/Linux64/pipe_tasks/gc07e1c2157+f6e5778202/python/lsst/pipe/tasks/characterizeImage.py
