CharacterizeImageTask¶
Python API summary¶
from lsst.pipe.tasks.characterizeImage import CharacterizeImageTask
-
class
CharacterizeImageTask Measure bright sources and use this to estimate background and PSF of an exposure
...
-
attribute
config Access configuration fields and retargetable subtasks.
-
method
run Characterize a science image
...
See also
See the CharacterizeImageTask API reference for complete details.
Retargetable subtasks¶
applyApCorr¶
- Default
lsst.meas.base.applyApCorr.ApplyApCorrTask- Field type
ConfigurableField
Subtask to apply aperture corrections
background¶
- Default
lsst.meas.algorithms.subtractBackground.SubtractBackgroundTask- Field type
ConfigurableField
Configuration for initial background estimation
catalogCalculation¶
- Default
lsst.meas.base.catalogCalculation.CatalogCalculationTask- Field type
ConfigurableField
Subtask to run catalogCalculation plugins on catalog
computeSummaryStats¶
- Default
lsst.pipe.tasks.computeExposureSummaryStats.ComputeExposureSummaryStatsTask- Field type
ConfigurableField
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
ConfigurableField
Split blended source into their components
detection¶
- Default
lsst.meas.algorithms.detection.SourceDetectionTask- Field type
ConfigurableField
Detect sources
installSimplePsf¶
- Default
lsst.meas.algorithms.installGaussianPsf.InstallGaussianPsfTask- Field type
ConfigurableField
Install a simple PSF model
measureApCorr¶
- Default
lsst.meas.algorithms.measureApCorr.MeasureApCorrTask- Field type
ConfigurableField
Subtask to measure aperture corrections
measurePsf¶
- Default
lsst.pipe.tasks.measurePsf.MeasurePsfTask- Field type
ConfigurableField
Measure PSF
measurement¶
- Default
lsst.meas.base.sfm.SingleFrameMeasurementTask- Field type
ConfigurableField
Measure sources
ref_match¶
- Default
lsst.meas.astrom.ref_match.RefMatchTask- Field type
ConfigurableField
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).
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
ConfigField
Configurations describing the connections of the PipelineTask to datatypes
doComputeSummaryStats¶
Run subtask to measure exposure summary statistics Deprecated: This subtask has been moved to CalibrateTask with DM-30701.
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)
doWriteExposure¶
Write icExp and icExpBackground in addition to icSrc? Ignored if doWrite False.
psfIterations¶
- Default
2- Field type
intRangeField- 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.
refObjLoader¶
- Data type
lsst.meas.algorithms.loadReferenceObjects.LoadReferenceObjectsConfig- Field type
ConfigField
reference object loader Deprecated: This field does nothing. Will be removed after v24 (see DM-34768).
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.