lsst.pipe.tasks g8b9e2231ea+fa07cb600e
Loading...
Searching...
No Matches
Public Member Functions | Public Attributes | Static Public Attributes | List of all members
lsst.pipe.tasks.characterizeImage.CharacterizeImageConfig Class Reference

Config for CharacterizeImageTask. More...

Inheritance diagram for lsst.pipe.tasks.characterizeImage.CharacterizeImageConfig:
lsst.pipe.tasks.characterizeImage.CharacterizeImageConnections

Public Member Functions

def setDefaults (self)
 
def validate (self)
 

Public Attributes

 doDeblend
 
 doApCorr
 

Static Public Attributes

pexConfig doMeasurePsf
 
pexConfig doWrite
 
pexConfig doWriteExposure
 
pexConfig psfIterations
 
pexConfig background
 
pexConfig detection
 
pexConfig doDeblend
 
pexConfig deblend
 
pexConfig measurement
 
pexConfig doApCorr
 
pexConfig measureApCorr
 
pexConfig applyApCorr
 
pexConfig catalogCalculation
 
pexConfig doComputeSummaryStats
 
pexConfig computeSummaryStats
 
pexConfig useSimplePsf
 
pexConfig installSimplePsf
 
pexConfig refObjLoader
 
pexConfig ref_match
 
pexConfig measurePsf
 
pexConfig repair
 
pexConfig requireCrForPsf
 
pexConfig checkUnitsParseStrict
 

Detailed Description

Config for CharacterizeImageTask.

Definition at line 93 of file characterizeImage.py.

Member Function Documentation

◆ setDefaults()

def lsst.pipe.tasks.characterizeImage.CharacterizeImageConfig.setDefaults (   self)

Definition at line 217 of file characterizeImage.py.

◆ validate()

def lsst.pipe.tasks.characterizeImage.CharacterizeImageConfig.validate (   self)

Definition at line 239 of file characterizeImage.py.

Member Data Documentation

◆ applyApCorr

pexConfig lsst.pipe.tasks.characterizeImage.CharacterizeImageConfig.applyApCorr
static
Initial value:
= pexConfig.ConfigurableField(
target=ApplyApCorrTask,
doc="Subtask to apply aperture corrections"
)

Definition at line 152 of file characterizeImage.py.

◆ background

pexConfig lsst.pipe.tasks.characterizeImage.CharacterizeImageConfig.background
static
Initial value:
= pexConfig.ConfigurableField(
target=SubtractBackgroundTask,
doc="Configuration for initial background estimation",
)

Definition at line 122 of file characterizeImage.py.

◆ catalogCalculation

pexConfig lsst.pipe.tasks.characterizeImage.CharacterizeImageConfig.catalogCalculation
static
Initial value:
= pexConfig.ConfigurableField(
target=CatalogCalculationTask,
doc="Subtask to run catalogCalculation plugins on catalog"
)

Definition at line 158 of file characterizeImage.py.

◆ checkUnitsParseStrict

pexConfig lsst.pipe.tasks.characterizeImage.CharacterizeImageConfig.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 211 of file characterizeImage.py.

◆ computeSummaryStats

pexConfig lsst.pipe.tasks.characterizeImage.CharacterizeImageConfig.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 169 of file characterizeImage.py.

◆ deblend

pexConfig lsst.pipe.tasks.characterizeImage.CharacterizeImageConfig.deblend
static
Initial value:
= pexConfig.ConfigurableField(
target=SourceDeblendTask,
doc="Split blended source into their components"
)

Definition at line 135 of file characterizeImage.py.

◆ detection

pexConfig lsst.pipe.tasks.characterizeImage.CharacterizeImageConfig.detection
static
Initial value:
= pexConfig.ConfigurableField(
target=SourceDetectionTask,
doc="Detect sources"
)

Definition at line 126 of file characterizeImage.py.

◆ doApCorr [1/2]

pexConfig lsst.pipe.tasks.characterizeImage.CharacterizeImageConfig.doApCorr
static
Initial value:
= pexConfig.Field(
dtype=bool,
default=True,
doc="Run subtasks to measure and apply aperture corrections"
)

Definition at line 143 of file characterizeImage.py.

◆ doApCorr [2/2]

lsst.pipe.tasks.characterizeImage.CharacterizeImageConfig.doApCorr

Definition at line 228 of file characterizeImage.py.

◆ doComputeSummaryStats

pexConfig lsst.pipe.tasks.characterizeImage.CharacterizeImageConfig.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 162 of file characterizeImage.py.

◆ doDeblend [1/2]

pexConfig lsst.pipe.tasks.characterizeImage.CharacterizeImageConfig.doDeblend
static
Initial value:
= pexConfig.Field(
dtype=bool,
default=True,
doc="Run deblender input exposure"
)

Definition at line 130 of file characterizeImage.py.

◆ doDeblend [2/2]

lsst.pipe.tasks.characterizeImage.CharacterizeImageConfig.doDeblend

Definition at line 225 of file characterizeImage.py.

◆ doMeasurePsf

pexConfig lsst.pipe.tasks.characterizeImage.CharacterizeImageConfig.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 97 of file characterizeImage.py.

◆ doWrite

pexConfig lsst.pipe.tasks.characterizeImage.CharacterizeImageConfig.doWrite
static
Initial value:
= pexConfig.Field(
dtype=bool,
default=True,
doc="Persist results?",
)

Definition at line 104 of file characterizeImage.py.

◆ doWriteExposure

pexConfig lsst.pipe.tasks.characterizeImage.CharacterizeImageConfig.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 109 of file characterizeImage.py.

◆ installSimplePsf

pexConfig lsst.pipe.tasks.characterizeImage.CharacterizeImageConfig.installSimplePsf
static
Initial value:
= pexConfig.ConfigurableField(
target=InstallGaussianPsfTask,
doc="Install a simple PSF model",
)

Definition at line 182 of file characterizeImage.py.

◆ measureApCorr

pexConfig lsst.pipe.tasks.characterizeImage.CharacterizeImageConfig.measureApCorr
static
Initial value:
= pexConfig.ConfigurableField(
target=MeasureApCorrTask,
doc="Subtask to measure aperture corrections"
)

Definition at line 148 of file characterizeImage.py.

◆ measurement

pexConfig lsst.pipe.tasks.characterizeImage.CharacterizeImageConfig.measurement
static
Initial value:
= pexConfig.ConfigurableField(
target=SingleFrameMeasurementTask,
doc="Measure sources"
)

Definition at line 139 of file characterizeImage.py.

◆ measurePsf

pexConfig lsst.pipe.tasks.characterizeImage.CharacterizeImageConfig.measurePsf
static
Initial value:
= pexConfig.ConfigurableField(
target=MeasurePsfTask,
doc="Measure PSF",
)

Definition at line 198 of file characterizeImage.py.

◆ psfIterations

pexConfig lsst.pipe.tasks.characterizeImage.CharacterizeImageConfig.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 114 of file characterizeImage.py.

◆ ref_match

pexConfig lsst.pipe.tasks.characterizeImage.CharacterizeImageConfig.ref_match
static
Initial value:
= pexConfig.ConfigurableField(
target=RefMatchTask,
deprecated="This field was never usable. Will be removed after v24 (see DM-34768).",
doc="Task to load and match reference objects. Only used if measurePsf can use matches. "
"Warning: matching will only work well if the initial WCS is accurate enough "
"to give good matches (roughly: good to 3 arcsec across the CCD).",
)

Definition at line 191 of file characterizeImage.py.

◆ refObjLoader

pexConfig lsst.pipe.tasks.characterizeImage.CharacterizeImageConfig.refObjLoader
static
Initial value:
= pexConfig.ConfigurableField(
target=LoadIndexedReferenceObjectsTask,
deprecated="This field does nothing. Will be removed after v24 (see DM-34768).",
doc="reference object loader",
)

Definition at line 186 of file characterizeImage.py.

◆ repair

pexConfig lsst.pipe.tasks.characterizeImage.CharacterizeImageConfig.repair
static
Initial value:
= pexConfig.ConfigurableField(
target=RepairTask,
doc="Remove cosmic rays",
)

Definition at line 202 of file characterizeImage.py.

◆ requireCrForPsf

pexConfig lsst.pipe.tasks.characterizeImage.CharacterizeImageConfig.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 206 of file characterizeImage.py.

◆ useSimplePsf

pexConfig lsst.pipe.tasks.characterizeImage.CharacterizeImageConfig.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 175 of file characterizeImage.py.


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