CharacterizeImageTask¶
Python API summary¶
from lsst.pipe.tasks.characterizeImage import CharacterizeImageTask
-
class
CharacterizeImageTask(butler=None, refObjLoader=None, schema=None, **kwargs) ! Measure bright sources and use this to estimate background and PSF of an exposure
...
- attributeconfig
Access configuration fields and retargetable subtasks.
-
method
run(exposure, exposureIdInfo=None, background=None) !Characterize a science image
...
-
method
runDataRef(dataRef, exposure=None, background=None, doUnpersist=True) !Characterize a science image and, if wanted, persist the results
...
See also
See the CharacterizeImageTask API reference for complete details.
Retargetable subtasks¶
applyApCorr¶
- Default
- Field type
Subtask to apply aperture corrections
background¶
Configuration for initial background estimation
catalogCalculation¶
Subtask to run catalogCalculation plugins on catalog
computeSummaryStats¶
Subtask to run computeSummaryStats on exposure Deprecated: This subtask has been moved to CalibrateTask with DM-30701.
deblend¶
- Default
lsst.meas.deblender.sourceDeblendTask.SourceDeblendTask- Field type
Split blended source into their components
detection¶
- Default
- Field type
Detect sources
installSimplePsf¶
Install a simple PSF model
measureApCorr¶
- Default
- Field type
Subtask to measure aperture corrections
measurePsf¶
- Default
- Field type
Measure PSF
measurement¶
- Default
- Field type
Measure sources
refObjLoader¶
reference object loader Deprecated: This field does nothing. Will be removed after v24 (see DM-34768).
ref_match¶
- Default
lsst.meas.astrom.ref_match.RefMatchTask- Field type
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). Deprecated: This field was never usable. Will be removed after v24 (see DM-34768).
repair¶
- Default
- Field type
Remove cosmic rays
Configuration fields¶
checkUnitsParseStrict¶
Strictness of Astropy unit compatibility check, can be ‘raise’, ‘warn’ or ‘silent’
connections¶
- Data type
lsst.pipe.base.config.Connections- Field type
Configurations describing the connections of the PipelineTask to datatypes
doApCorr¶
Run subtasks to measure and apply aperture corrections
doComputeSummaryStats¶
Run subtask to measure exposure summary statistics Deprecated: This subtask has been moved to CalibrateTask with DM-30701.
doDeblend¶
Run deblender input exposure
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)
doWrite¶
Persist results?
doWriteExposure¶
Write icExp and icExpBackground in addition to icSrc? Ignored if doWrite False.
psfIterations¶
- Default
2- Field type
- Range
[1,inf)
Number of iterations of detect sources, measure sources, estimate PSF. If useSimplePsf is True then 2 should be plenty; otherwise more may be wanted.
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.
saveMetadata¶
Flag to enable/disable metadata saving 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.