CharacterizeImageConfig#

class lsst.pipe.tasks.characterizeImage.CharacterizeImageConfig(*args, **kw)#

Bases: PipelineTaskConfig

Config for CharacterizeImageTask.

Attributes Summary

`applyApCorr`	Subtask to apply aperture corrections (`ConfigurableInstance`, default `<class 'lsst.meas.base.applyApCorr.ApplyApCorrConfig'>`)
`background`	Configuration for initial background estimation (`ConfigurableInstance`, default `<class 'lsst.meas.algorithms.subtractBackground.SubtractBackgroundConfig'>`)
`catalogCalculation`	Subtask to run catalogCalculation plugins on catalog (`ConfigurableInstance`, default `<class 'lsst.meas.base.catalogCalculation.CatalogCalculationConfig'>`)
`checkUnitsParseStrict`	Strictness of Astropy unit compatibility check, can be 'raise', 'warn' or 'silent' (`str`, default `'raise'`)
`computeSummaryStats`	Subtask to run computeSummaryStats on exposure Deprecated: This subtask has been moved to CalibrateTask with DM-30701.
`connections`	Field which refers to a dynamically added configuration class which is based on a PipelineTaskConnections class.
`deblend`	Split blended source into their components (`ConfigurableInstance`, default `<class 'lsst.meas.deblender.sourceDeblendTask.SourceDeblendConfig'>`)
`detection`	Detect sources (`ConfigurableInstance`, default `<class 'lsst.meas.algorithms.detection.SourceDetectionConfig'>`)
`doApCorr`	Run subtasks to measure and apply aperture corrections (`bool`, default `True`)
`doComputeSummaryStats`	Run subtask to measure exposure summary statistics Deprecated: This subtask has been moved to CalibrateTask with DM-30701.
`doDeblend`	Run deblender input exposure (`bool`, default `True`)
`doMaskStreaks`	Mask streaks Deprecated: This subtask has been moved to detectAndMeasureTask in ip_diffim with DM-43370 and will be removed in DM-44658.
`doMeasurePsf`	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) (`bool`, default `True`)
`doNormalizedCalibration`	Use normalized calibration flux (e.g. compensated tophats)? (`bool`, default `True`).
`doWrite`	Persist results? (`bool`, default `True`)
`doWriteExposure`	Write icExp and icExpBackground in addition to icSrc? Ignored if doWrite False.
`idGenerator`	Configuration for how to generate catalog IDs from data IDs.
`installSimplePsf`	Install a simple PSF model (`ConfigurableInstance`, default `<class 'lsst.meas.algorithms.installGaussianPsf.InstallGaussianPsfConfig'>`)
`maskStreaks`	Subtask for masking streaks.
`measureApCorr`	Subtask to measure aperture corrections (`ConfigurableInstance`, default `<class 'lsst.meas.algorithms.measureApCorr.MeasureApCorrConfig'>`)
`measurePsf`	Measure PSF (`ConfigurableInstance`, default `<class 'lsst.pipe.tasks.measurePsf.MeasurePsfConfig'>`)
`measurement`	Measure sources (`ConfigurableInstance`, default `<class 'lsst.meas.base.sfm.SingleFrameMeasurementConfig'>`)
`normalizedCalibrationFlux`	Task to normalize the calibration flux (e.g. compensated tophats).
`psfIterations`	Number of iterations of detect sources, measure sources, estimate PSF.
`repair`	Remove cosmic rays (`ConfigurableInstance`, default `<class 'lsst.pipe.tasks.repair.RepairConfig'>`)
`requireCrForPsf`	Require cosmic ray detection and masking to run successfully before measuring the PSF.
`saveLogOutput`	Flag to enable/disable saving of log output for a task, enabled by default.
`useSimplePsf`	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.

Methods Summary

`setDefaults`()	Subclass hook for computing defaults.
`validate`()	Validate the Config, raising an exception if invalid.

Attributes Documentation

applyApCorr#: Subtask to apply aperture corrections (ConfigurableInstance, default <class 'lsst.meas.base.applyApCorr.ApplyApCorrConfig'>)

background#: Configuration for initial background estimation (ConfigurableInstance, default <class 'lsst.meas.algorithms.subtractBackground.SubtractBackgroundConfig'>)

catalogCalculation#: Subtask to run catalogCalculation plugins on catalog (ConfigurableInstance, default <class 'lsst.meas.base.catalogCalculation.CatalogCalculationConfig'>)

checkUnitsParseStrict#: Strictness of Astropy unit compatibility check, can be ‘raise’, ‘warn’ or ‘silent’ (str, default 'raise')

computeSummaryStats#: Subtask to run computeSummaryStats on exposure Deprecated: This subtask has been moved to CalibrateTask with DM-30701. (ConfigurableInstance, default <class 'lsst.pipe.tasks.computeExposureSummaryStats.ComputeExposureSummaryStatsConfig'>)

connections: pexConfig.ConfigField#: Field which refers to a dynamically added configuration class which is based on a PipelineTaskConnections class.

deblend#: Split blended source into their components (ConfigurableInstance, default <class 'lsst.meas.deblender.sourceDeblendTask.SourceDeblendConfig'>)

detection#: Detect sources (ConfigurableInstance, default <class 'lsst.meas.algorithms.detection.SourceDetectionConfig'>)

doApCorr#: Run subtasks to measure and apply aperture corrections (bool, default True)

doComputeSummaryStats#: Run subtask to measure exposure summary statistics Deprecated: This subtask has been moved to CalibrateTask with DM-30701. (bool, default True)

doDeblend#: Run deblender input exposure (bool, default True)

doMaskStreaks#: Mask streaks Deprecated: This subtask has been moved to detectAndMeasureTask in ip_diffim with DM-43370 and will be removed in DM-44658. (bool, default False)

doMeasurePsf#: 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) (bool, default True)

doNormalizedCalibration#: Use normalized calibration flux (e.g. compensated tophats)? (bool, default True)

doWrite#: Persist results? (bool, default True)

doWriteExposure#: Write icExp and icExpBackground in addition to icSrc? Ignored if doWrite False. (bool, default True)

idGenerator#: Configuration for how to generate catalog IDs from data IDs. (DetectorVisitIdGeneratorConfig, default <class 'lsst.meas.base._id_generator.DetectorVisitIdGeneratorConfig'>)

installSimplePsf#: Install a simple PSF model (ConfigurableInstance, default <class 'lsst.meas.algorithms.installGaussianPsf.InstallGaussianPsfConfig'>)

maskStreaks#: 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. (ConfigurableInstance, default <class 'lsst.meas.algorithms.maskStreaks.MaskStreaksConfig'>)

measureApCorr#: Subtask to measure aperture corrections (ConfigurableInstance, default <class 'lsst.meas.algorithms.measureApCorr.MeasureApCorrConfig'>)

measurePsf#: Measure PSF (ConfigurableInstance, default <class 'lsst.pipe.tasks.measurePsf.MeasurePsfConfig'>)

measurement#: Measure sources (ConfigurableInstance, default <class 'lsst.meas.base.sfm.SingleFrameMeasurementConfig'>)

normalizedCalibrationFlux#: Task to normalize the calibration flux (e.g. compensated tophats). (ConfigurableInstance, default <class 'lsst.meas.algorithms.normalizedCalibrationFlux.NormalizedCalibrationFluxConfig'>)

psfIterations#

Number of iterations of detect sources, measure sources, estimate PSF. If useSimplePsf is True then 2 should be plenty; otherwise more may be wanted. (int, default 2)

Valid Range = [1,inf)

repair#: Remove cosmic rays (ConfigurableInstance, default <class 'lsst.pipe.tasks.repair.RepairConfig'>)

requireCrForPsf#: Require cosmic ray detection and masking to run successfully before measuring the PSF. (bool, default True)

saveLogOutput#: Flag to enable/disable saving of log output for a task, enabled by default. (bool, default True)

useSimplePsf#: 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. (bool, default True)

Methods Documentation

setDefaults()#: Subclass hook for computing defaults.

Notes#

Derived Config classes that must compute defaults rather than using the Field instances’s defaults should do so here. To correctly use inherited defaults, implementations of setDefaults must call their base class’s setDefaults.

validate()#

Validate the Config, raising an exception if invalid.

Raises#

lsst.pex.config.FieldValidationError: Raised if verification fails.

Notes#

The base class implementation performs type checks on all fields by calling their validate methods.

Complex single-field validation can be defined by deriving new Field types. For convenience, some derived lsst.pex.config.Field-types (ConfigField and ConfigChoiceField) are defined in lsst.pex.config that handle recursing into subconfigs.

Inter-field relationships should only be checked in derived Config classes after calling this method, and base validation is complete.