Config for CharacterizeImageTask. More...

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

Public Member Functions
def	setDefaults (self)

def	validate (self)

def	adjustQuantum (self, inputs, outputs, label, dataId)

Detailed Description

Config for CharacterizeImageTask.

Definition at line 93 of file characterizeImage.py.

Member Function Documentation

◆ adjustQuantum()

def lsst.pipe.tasks.characterizeImage.CharacterizeImageConnections.adjustQuantum	(	self,
		inputs,
		outputs,
		label,
		dataId
	)

inherited

Definition at line 80 of file characterizeImage.py.

     def adjustQuantum(self, inputs, outputs, label, dataId):
         # Docstring inherited from PipelineTaskConnections
         try:
             return super().adjustQuantum(inputs, outputs, label, dataId)
         except pipeBase.ScalarError as err:
             raise pipeBase.ScalarError(
                 "CharacterizeImageTask can at present only be run on visits that are associated with "
                 "exactly one exposure.  Either this is not a valid exposure for this pipeline, or the "
                 "snap-combination step you probably want hasn't been configured to run between ISR and "
                 "this task (as of this writing, that would be because it hasn't been implemented yet)."
             ) from err
  
  

◆ setDefaults()

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

Definition at line 215 of file characterizeImage.py.

     def setDefaults(self):
         super().setDefaults()
         # just detect bright stars; includeThresholdMultipler=10 seems large,
         # but these are the values we have been using
         self.detection.thresholdValue = 5.0
         self.detection.includeThresholdMultiplier = 10.0
         self.detection.doTempLocalBackground = False
         # do not deblend, as it makes a mess
         self.doDeblend = False
         # measure and apply aperture correction; note: measuring and applying aperture
         # correction are disabled until the final measurement, after PSF is measured
         self.doApCorr = True
         # minimal set of measurements needed to determine PSF
         self.measurement.plugins.names = [
             "base_PixelFlags",
             "base_SdssCentroid",
             "base_SdssShape",
             "base_GaussianFlux",
             "base_PsfFlux",
             "base_CircularApertureFlux",
         ]
  

◆ validate()

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

Definition at line 237 of file characterizeImage.py.

     def validate(self):
         if self.doApCorr and not self.measurePsf:
             raise RuntimeError("Must measure PSF to measure aperture correction, "
                                "because flags determined by PSF measurement are used to identify "
                                "sources used to measure aperture correction")
  

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

◆ backgroundModel

lsst.pipe.tasks.characterizeImage.CharacterizeImageConnections.backgroundModel

staticinherited

Initial value:

=  cT.Output(
        doc="Output background model.",
        name="icExpBackground",
        storageClass="Background",
        dimensions=["instrument", "visit", "detector"],
    )

Definition at line 68 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 158 of file characterizeImage.py.

◆ characterized

lsst.pipe.tasks.characterizeImage.CharacterizeImageConnections.characterized

staticinherited

Initial value:

=  cT.Output(
        doc="Output characterized data.",
        name="icExp",
        storageClass="ExposureF",
        dimensions=["instrument", "visit", "detector"],
    )

Definition at line 56 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 209 of file characterizeImage.py.

◆ computeSummaryStats

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

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

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

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.

◆ doComputeSummaryStats

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

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.

◆ 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 97 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 104 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 109 of file characterizeImage.py.

◆ exposure

lsst.pipe.tasks.characterizeImage.CharacterizeImageConnections.exposure

staticinherited

Initial value:

=  cT.Input(
        doc="Input exposure data",
        name="postISRCCD",
        storageClass="Exposure",
        dimensions=["instrument", "exposure", "detector"],
    )

Definition at line 50 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 182 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 148 of file characterizeImage.py.

◆ measurement

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

lsst.pipe.tasks.characterizeImage.CharacterizeImageConfig.measurePsf

static

Initial value:

=  pexConfig.ConfigurableField(
        target=MeasurePsfTask,
        doc="Measure PSF",
    )

Definition at line 196 of file characterizeImage.py.

◆ outputSchema

lsst.pipe.tasks.characterizeImage.CharacterizeImageConnections.outputSchema

staticinherited

Initial value:

=  cT.InitOutput(
        doc="Schema of the catalog produced by CharacterizeImage",
        name="icSrc_schema",
        storageClass="SourceCatalog",
    )

Definition at line 74 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 114 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 190 of file characterizeImage.py.

◆ refObjLoader

lsst.pipe.tasks.characterizeImage.CharacterizeImageConfig.refObjLoader

static

Initial value:

=  pexConfig.ConfigurableField(
        target=LoadIndexedReferenceObjectsTask,
        doc="reference object loader",
    )

Definition at line 186 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 200 of file characterizeImage.py.

◆ requireCrForPsf

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

◆ sourceCat

lsst.pipe.tasks.characterizeImage.CharacterizeImageConnections.sourceCat

staticinherited

Initial value:

=  cT.Output(
        doc="Output source catalog.",
        name="icSrc",
        storageClass="SourceCatalog",
        dimensions=["instrument", "visit", "detector"],
    )

Definition at line 62 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 175 of file characterizeImage.py.

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

/j/snowflake/release/lsstsw/stack/lsst-scipipe-0.7.0/Linux64/pipe_tasks/21.0.0-172-gfb10e10a+18fedfabac/python/lsst/pipe/tasks/characterizeImage.py

Static Public Attributes
	doMeasurePsf

	doWrite

	doWriteExposure

	psfIterations

	background

	detection

	doDeblend

	deblend

	measurement

	doApCorr

	measureApCorr

	applyApCorr

	catalogCalculation

	doComputeSummaryStats

	computeSummaryStats

	useSimplePsf

	installSimplePsf

	refObjLoader

	ref_match

	measurePsf

	repair

	requireCrForPsf

	checkUnitsParseStrict

	exposure

	characterized

	sourceCat

	backgroundModel

	outputSchema

Public Member Functions

Static Public Attributes

Detailed Description

Member Function Documentation

◆ adjustQuantum()

◆ setDefaults()

◆ validate()

Member Data Documentation

◆ applyApCorr

◆ background

◆ backgroundModel

◆ catalogCalculation

◆ characterized

◆ checkUnitsParseStrict

◆ computeSummaryStats

◆ deblend

◆ detection

◆ doApCorr

◆ doComputeSummaryStats

◆ doDeblend

◆ doMeasurePsf

◆ doWrite

◆ doWriteExposure

◆ exposure

◆ installSimplePsf

◆ measureApCorr

◆ measurement

◆ measurePsf

◆ outputSchema

◆ psfIterations

◆ ref_match

◆ refObjLoader

◆ repair

◆ requireCrForPsf

◆ sourceCat

◆ useSimplePsf