lsst.pipe.tasks  13.0-66-gfbf2f2ce+5
Public Member Functions | 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:

Public Member Functions

def setDefaults (self)
 
def validate (self)
 

Static Public Attributes

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

Detailed Description

Config for CharacterizeImageTask.

Definition at line 45 of file characterizeImage.py.

Member Function Documentation

◆ setDefaults()

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

Definition at line 147 of file characterizeImage.py.

◆ validate()

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

Definition at line 168 of file characterizeImage.py.

Member Data Documentation

◆ applyApCorr

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

Definition at line 102 of file characterizeImage.py.

◆ background

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

Definition at line 72 of file characterizeImage.py.

◆ catalogCalculation

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

Definition at line 108 of file characterizeImage.py.

◆ checkUnitsParseStrict

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 141 of file characterizeImage.py.

◆ deblend

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

Definition at line 85 of file characterizeImage.py.

◆ detection

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

Definition at line 76 of file characterizeImage.py.

◆ doApCorr

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 93 of file characterizeImage.py.

◆ doDeblend

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

Definition at line 80 of file characterizeImage.py.

◆ doMeasurePsf

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 47 of file characterizeImage.py.

◆ doWrite

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

Definition at line 54 of file characterizeImage.py.

◆ doWriteExposure

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 59 of file characterizeImage.py.

◆ installSimplePsf

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

Definition at line 119 of file characterizeImage.py.

◆ measureApCorr

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

Definition at line 98 of file characterizeImage.py.

◆ measurement

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

Definition at line 89 of file characterizeImage.py.

◆ measurePsf

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

Definition at line 133 of file characterizeImage.py.

◆ psfIterations

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 64 of file characterizeImage.py.

◆ ref_match

lsst.pipe.tasks.characterizeImage.CharacterizeImageConfig.ref_match
static
Initial value:
= pexConfig.ConfigurableField(
target = RefMatchTask,
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 127 of file characterizeImage.py.

◆ refObjLoader

lsst.pipe.tasks.characterizeImage.CharacterizeImageConfig.refObjLoader
static
Initial value:
= pexConfig.ConfigurableField(
target = LoadAstrometryNetObjectsTask,
doc = "reference object loader",
)

Definition at line 123 of file characterizeImage.py.

◆ repair

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

Definition at line 137 of file characterizeImage.py.

◆ useSimplePsf

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 112 of file characterizeImage.py.


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