CharacterizeImageTask

Python API summary

from lsst.pipe.tasks.characterizeImage import CharacterizeImageTask
classCharacterizeImageTask(schema=None, **kwargs)

Measure bright sources and use this to estimate background and PSF of an exposure...

attributeconfig

Access configuration fields and retargetable subtasks.

methodrun(exposure, exposureIdInfo=None, background=None, idGenerator=None)

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

maskStreaks

Default

lsst.pipe.tasks.maskStreaks.MaskStreaksTask

Field type

ConfigurableField

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.

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

repair

Default

lsst.pipe.tasks.repair.RepairTask

Field type

ConfigurableField

Remove cosmic rays

Configuration fields

checkUnitsParseStrict

Default
'raise'
Field type

str Field

Strictness of Astropy unit compatibility check, can be ‘raise’, ‘warn’ or ‘silent’

connections

Data type

lsst.pipe.base.config.CharacterizeImageConfigConnections

Field type

ConfigField

Configurations describing the connections of the PipelineTask to datatypes

doApCorr

Default
True
Field type

bool Field

Run subtasks to measure and apply aperture corrections

doComputeSummaryStats

Default
True
Field type

bool Field

Run subtask to measure exposure summary statistics Deprecated: This subtask has been moved to CalibrateTask with DM-30701.

doDeblend

Default
True
Field type

bool Field

Run deblender input exposure

doMaskStreaks

Default
True
Field type

bool Field

Mask streaks

doMeasurePsf

Default
True
Field type

bool Field

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

Default
True
Field type

bool Field

Persist results?

doWriteExposure

Default
True
Field type

bool Field

Write icExp and icExpBackground in addition to icSrc? Ignored if doWrite False.

idGenerator

Data type

lsst.meas.base._id_generator.DetectorVisitIdGeneratorConfig

Field type

ConfigField

Configuration for how to generate catalog IDs from data IDs.

psfIterations

Default
2
Field type

int RangeField

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

Default
True
Field type

bool Field

Require cosmic ray detection and masking to run successfully before measuring the PSF.

saveLogOutput

Default
True
Field type

bool Field

Flag to enable/disable saving of log output for a task, enabled by default.

saveMetadata

Default
True
Field type

bool Field

Flag to enable/disable metadata saving for a task, enabled by default. Deprecated: This field is deprecated and will be removed after v26.

useSimplePsf

Default
True
Field type

bool Field

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.