Inheritance diagram for lsst.pipe.tasks.calibrate.CalibrateConfig:

Public Member Functions
def	setDefaults (self)

def	validate (self)

Static Public Attributes
	doWrite

	doWriteHeavyFootprintsInSources

	doWriteMatches

	doWriteMatchesDenormalized

	doAstrometry

	astromRefObjLoader

	photoRefObjLoader

	astrometry

	requireAstrometry

	doPhotoCal

	requirePhotoCal

	photoCal

	icSourceFieldsToCopy

	matchRadiusPix

	checkUnitsParseStrict

	detection

	doDeblend

	deblend

	doSkySources

	skySources

	measurement

	setPrimaryFlags

	doApCorr

	applyApCorr

	catalogCalculation

	doInsertFakes

	insertFakes

	doComputeSummaryStats

	computeSummaryStats

	doWriteExposure

	icSourceSchema

	outputSchema

	exposure

	background

	icSourceCat

	astromRefCat

	photoRefCat

	outputExposure

	outputCat

	outputBackground

	matches

	matchesDenormalized

Detailed Description

Config for CalibrateTask

Definition at line 153 of file calibrate.py.

Member Function Documentation

◆ setDefaults()

def lsst.pipe.tasks.calibrate.CalibrateConfig.setDefaults ( self )

Definition at line 308 of file calibrate.py.

     def setDefaults(self):
         super().setDefaults()
         self.detection.doTempLocalBackground = False
         self.deblend.maxFootprintSize = 2000
         self.measurement.plugins.names |= ["base_LocalPhotoCalib", "base_LocalWcs"]
  

◆ validate()

def lsst.pipe.tasks.calibrate.CalibrateConfig.validate ( self )

Definition at line 314 of file calibrate.py.

     def validate(self):
         super().validate()
         astromRefCatGen2 = getattr(self.astromRefObjLoader, "ref_dataset_name", None)
         if astromRefCatGen2 is not None and astromRefCatGen2 != self.connections.astromRefCat:
             raise ValueError(
                 f"Gen2 ({astromRefCatGen2}) and Gen3 ({self.connections.astromRefCat}) astrometry reference "
                 f"catalogs are different.  These options must be kept in sync until Gen2 is retired."
             )
         photoRefCatGen2 = getattr(self.photoRefObjLoader, "ref_dataset_name", None)
         if photoRefCatGen2 is not None and photoRefCatGen2 != self.connections.photoRefCat:
             raise ValueError(
                 f"Gen2 ({photoRefCatGen2}) and Gen3 ({self.connections.photoRefCat}) photometry reference "
                 f"catalogs are different.  These options must be kept in sync until Gen2 is retired."
             )
  
  

Member Data Documentation

◆ applyApCorr

lsst.pipe.tasks.calibrate.CalibrateConfig.applyApCorr

static

Initial value:

=  pexConfig.ConfigurableField(
        target=ApplyApCorrTask,
        doc="Subtask to apply aperture corrections"
    )

Definition at line 271 of file calibrate.py.

◆ astrometry

lsst.pipe.tasks.calibrate.CalibrateConfig.astrometry

static

Initial value:

=  pexConfig.ConfigurableField(
        target=AstrometryTask,
        doc="Perform astrometric calibration to refine the WCS",
    )

Definition at line 191 of file calibrate.py.

◆ astromRefCat

lsst.pipe.tasks.calibrate.CalibrateConnections.astromRefCat

staticinherited

Initial value:

=  cT.PrerequisiteInput(
        doc="Reference catalog to use for astrometry",
        name="cal_ref_cat",
        storageClass="SimpleCatalog",
        dimensions=("skypix",),
        deferLoad=True,
        multiple=True,
    )

Definition at line 86 of file calibrate.py.

◆ astromRefObjLoader

lsst.pipe.tasks.calibrate.CalibrateConfig.astromRefObjLoader

static

Initial value:

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

Definition at line 183 of file calibrate.py.

◆ background

lsst.pipe.tasks.calibrate.CalibrateConnections.background

staticinherited

Initial value:

=  cT.Input(
        doc="Backgrounds determined by characterize task",
        name="icExpBackground",
        storageClass="Background",
        dimensions=("instrument", "visit", "detector"),
    )

Definition at line 72 of file calibrate.py.

◆ catalogCalculation

lsst.pipe.tasks.calibrate.CalibrateConfig.catalogCalculation

static

Initial value:

=  pexConfig.ConfigurableField(
        target=CatalogCalculationTask,
        doc="Subtask to run catalogCalculation plugins on catalog"
    )

Definition at line 278 of file calibrate.py.

◆ checkUnitsParseStrict

lsst.pipe.tasks.calibrate.CalibrateConfig.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 229 of file calibrate.py.

◆ computeSummaryStats

lsst.pipe.tasks.calibrate.CalibrateConfig.computeSummaryStats

static

Initial value:

=  pexConfig.ConfigurableField(
        target=ComputeExposureSummaryStatsTask,
        doc="Subtask to run computeSummaryStats on exposure"
    )

Definition at line 297 of file calibrate.py.

◆ deblend

lsst.pipe.tasks.calibrate.CalibrateConfig.deblend

static

Initial value:

=  pexConfig.ConfigurableField(
        target=SourceDeblendTask,
        doc="Split blended sources into their components"
    )

Definition at line 244 of file calibrate.py.

◆ detection

lsst.pipe.tasks.calibrate.CalibrateConfig.detection

static

Initial value:

=  pexConfig.ConfigurableField(
        target=SourceDetectionTask,
        doc="Detect sources"
    )

Definition at line 235 of file calibrate.py.

◆ doApCorr

lsst.pipe.tasks.calibrate.CalibrateConfig.doApCorr

static

Initial value:

=  pexConfig.Field(
        dtype=bool,
        default=True,
        doc="Run subtask to apply aperture correction"
    )

Definition at line 266 of file calibrate.py.

◆ doAstrometry

lsst.pipe.tasks.calibrate.CalibrateConfig.doAstrometry

static

Initial value:

=  pexConfig.Field(
        dtype=bool,
        default=True,
        doc="Perform astrometric calibration?",
    )

Definition at line 178 of file calibrate.py.

◆ doComputeSummaryStats

lsst.pipe.tasks.calibrate.CalibrateConfig.doComputeSummaryStats

static

Initial value:

=  pexConfig.Field(
        dtype=bool,
        default=True,
        doc="Run subtask to measure exposure summary statistics?"
    )

Definition at line 292 of file calibrate.py.

◆ doDeblend

lsst.pipe.tasks.calibrate.CalibrateConfig.doDeblend

static

Initial value:

=  pexConfig.Field(
        dtype=bool,
        default=True,
        doc="Run deblender input exposure"
    )

Definition at line 239 of file calibrate.py.

◆ doInsertFakes

lsst.pipe.tasks.calibrate.CalibrateConfig.doInsertFakes

static

Initial value:

=  pexConfig.Field(
        dtype=bool,
        default=False,
        doc="Run fake sources injection task"
    )

Definition at line 282 of file calibrate.py.

◆ doPhotoCal

lsst.pipe.tasks.calibrate.CalibrateConfig.doPhotoCal

static

Initial value:

=  pexConfig.Field(
        dtype=bool,
        default=True,
        doc="Perform phometric calibration?",
    )

Definition at line 201 of file calibrate.py.

◆ doSkySources

lsst.pipe.tasks.calibrate.CalibrateConfig.doSkySources

static

Initial value:

=  pexConfig.Field(
        dtype=bool,
        default=True,
        doc="Generate sky sources?",
    )

Definition at line 248 of file calibrate.py.

◆ doWrite

lsst.pipe.tasks.calibrate.CalibrateConfig.doWrite

static

Initial value:

=  pexConfig.Field(
        dtype=bool,
        default=True,
        doc="Save calibration results?",
    )

Definition at line 155 of file calibrate.py.

◆ doWriteExposure

lsst.pipe.tasks.calibrate.CalibrateConfig.doWriteExposure

static

Initial value:

=  pexConfig.Field(
        dtype=bool,
        default=True,
        doc="Write the calexp? If fakes have been added then we do not want to write out the calexp as a "
            "normal calexp but as a fakes_calexp."
    )

Definition at line 301 of file calibrate.py.

◆ doWriteHeavyFootprintsInSources

lsst.pipe.tasks.calibrate.CalibrateConfig.doWriteHeavyFootprintsInSources

static

Initial value:

=  pexConfig.Field(
        dtype=bool,
        default=True,
        doc="Include HeavyFootprint data in source table? If false then heavy "
            "footprints are saved as normal footprints, which saves some space"
    )

Definition at line 160 of file calibrate.py.

◆ doWriteMatches

lsst.pipe.tasks.calibrate.CalibrateConfig.doWriteMatches

static

Initial value:

=  pexConfig.Field(
        dtype=bool,
        default=True,
        doc="Write reference matches (ignored if doWrite or doAstrometry false)?",
    )

Definition at line 166 of file calibrate.py.

◆ doWriteMatchesDenormalized

lsst.pipe.tasks.calibrate.CalibrateConfig.doWriteMatchesDenormalized

static

Initial value:

=  pexConfig.Field(
        dtype=bool,
        default=False,
        doc=("Write reference matches in denormalized format? "
             "This format uses more disk space, but is more convenient to "
             "read. Ignored if doWriteMatches=False or doWrite=False."),
    )

Definition at line 171 of file calibrate.py.

◆ exposure

lsst.pipe.tasks.calibrate.CalibrateConnections.exposure

staticinherited

Initial value:

=  cT.Input(
        doc="Input image to calibrate",
        name="icExp",
        storageClass="ExposureF",
        dimensions=("instrument", "visit", "detector"),
    )

Definition at line 65 of file calibrate.py.

◆ icSourceCat

lsst.pipe.tasks.calibrate.CalibrateConnections.icSourceCat

staticinherited

Initial value:

=  cT.Input(
        doc="Source catalog created by characterize task",
        name="icSrc",
        storageClass="SourceCatalog",
        dimensions=("instrument", "visit", "detector"),
    )

Definition at line 79 of file calibrate.py.

◆ icSourceFieldsToCopy

lsst.pipe.tasks.calibrate.CalibrateConfig.icSourceFieldsToCopy

static

Initial value:

=  pexConfig.ListField(
        dtype=str,
        default=("calib_psf_candidate", "calib_psf_used", "calib_psf_reserved"),
        doc=("Fields to copy from the icSource catalog to the output catalog "
             "for matching sources Any missing fields will trigger a "
             "RuntimeError exception. Ignored if icSourceCat is not provided.")
    )

Definition at line 216 of file calibrate.py.

◆ icSourceSchema

lsst.pipe.tasks.calibrate.CalibrateConnections.icSourceSchema

staticinherited

Initial value:

=  cT.InitInput(
        doc="Schema produced by characterize image task, used to initialize this task",
        name="icSrc_schema",
        storageClass="SourceCatalog",
    )

Definition at line 53 of file calibrate.py.

◆ insertFakes

lsst.pipe.tasks.calibrate.CalibrateConfig.insertFakes

static

Initial value:

=  pexConfig.ConfigurableField(
        target=BaseFakeSourcesTask,
        doc="Injection of fake sources for testing purposes (must be "
            "retargeted)"
    )

Definition at line 287 of file calibrate.py.

◆ matches

lsst.pipe.tasks.calibrate.CalibrateConnections.matches

staticinherited

Initial value:

=  cT.Output(
        doc="Source/refObj matches from the astrometry solver",
        name="srcMatch",
        storageClass="Catalog",
        dimensions=("instrument", "visit", "detector"),
    )

Definition at line 125 of file calibrate.py.

◆ matchesDenormalized

lsst.pipe.tasks.calibrate.CalibrateConnections.matchesDenormalized

staticinherited

Initial value:

=  cT.Output(
        doc="Denormalized matches from astrometry solver",
        name="srcMatchFull",
        storageClass="Catalog",
        dimensions=("instrument", "visit", "detector"),
    )

Definition at line 132 of file calibrate.py.

◆ matchRadiusPix

lsst.pipe.tasks.calibrate.CalibrateConfig.matchRadiusPix

static

Initial value:

=  pexConfig.Field(
        dtype=float,
        default=3,
        doc=("Match radius for matching icSourceCat objects to sourceCat "
             "objects (pixels)"),
    )

Definition at line 223 of file calibrate.py.

◆ measurement

lsst.pipe.tasks.calibrate.CalibrateConfig.measurement

static

Initial value:

=  pexConfig.ConfigurableField(
        target=SingleFrameMeasurementTask,
        doc="Measure sources"
    )

Definition at line 257 of file calibrate.py.

◆ outputBackground

lsst.pipe.tasks.calibrate.CalibrateConnections.outputBackground

staticinherited

Initial value:

=  cT.Output(
        doc="Background models estimated in calibration task",
        name="calexpBackground",
        storageClass="Background",
        dimensions=("instrument", "visit", "detector"),
    )

Definition at line 118 of file calibrate.py.

◆ outputCat

lsst.pipe.tasks.calibrate.CalibrateConnections.outputCat

staticinherited

Initial value:

=  cT.Output(
        doc="Source catalog produced in calibrate task",
        name="src",
        storageClass="SourceCatalog",
        dimensions=("instrument", "visit", "detector"),
    )

Definition at line 111 of file calibrate.py.

◆ outputExposure

lsst.pipe.tasks.calibrate.CalibrateConnections.outputExposure

staticinherited

Initial value:

=  cT.Output(
        doc="Exposure after running calibration task",
        name="calexp",
        storageClass="ExposureF",
        dimensions=("instrument", "visit", "detector"),
    )

Definition at line 104 of file calibrate.py.

◆ outputSchema

lsst.pipe.tasks.calibrate.CalibrateConnections.outputSchema

staticinherited

Initial value:

=  cT.InitOutput(
        doc="Schema after CalibrateTask has been initialized",
        name="src_schema",
        storageClass="SourceCatalog",
    )

Definition at line 59 of file calibrate.py.

◆ photoCal

lsst.pipe.tasks.calibrate.CalibrateConfig.photoCal

static

Initial value:

=  pexConfig.ConfigurableField(
        target=PhotoCalTask,
        doc="Perform photometric calibration",
    )

Definition at line 212 of file calibrate.py.

◆ photoRefCat

lsst.pipe.tasks.calibrate.CalibrateConnections.photoRefCat

staticinherited

Initial value:

=  cT.PrerequisiteInput(
        doc="Reference catalog to use for photometric calibration",
        name="cal_ref_cat",
        storageClass="SimpleCatalog",
        dimensions=("skypix",),
        deferLoad=True,
        multiple=True
    )

Definition at line 95 of file calibrate.py.

◆ photoRefObjLoader

lsst.pipe.tasks.calibrate.CalibrateConfig.photoRefObjLoader

static

Initial value:

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

Definition at line 187 of file calibrate.py.

◆ requireAstrometry

lsst.pipe.tasks.calibrate.CalibrateConfig.requireAstrometry

static

Initial value:

=  pexConfig.Field(
        dtype=bool,
        default=True,
        doc=("Raise an exception if astrometry fails? Ignored if doAstrometry "
             "false."),
    )

Definition at line 195 of file calibrate.py.

◆ requirePhotoCal

lsst.pipe.tasks.calibrate.CalibrateConfig.requirePhotoCal

static

Initial value:

=  pexConfig.Field(
        dtype=bool,
        default=True,
        doc=("Raise an exception if photoCal fails? Ignored if doPhotoCal "
             "false."),
    )

Definition at line 206 of file calibrate.py.

◆ setPrimaryFlags

lsst.pipe.tasks.calibrate.CalibrateConfig.setPrimaryFlags

static

Initial value:

=  pexConfig.ConfigurableField(
        target=SetPrimaryFlagsTask,
        doc=("Set flags for primary source classification in single frame "
             "processing. True if sources are not sky sources and not a parent.")
    )

Definition at line 261 of file calibrate.py.

◆ skySources

lsst.pipe.tasks.calibrate.CalibrateConfig.skySources

static

Initial value:

=  pexConfig.ConfigurableField(
        target=SkyObjectsTask,
        doc="Generate sky sources",
    )

Definition at line 253 of file calibrate.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/calibrate.py

Public Member Functions

Static Public Attributes

Detailed Description

Member Function Documentation

◆ setDefaults()

◆ validate()

Member Data Documentation

◆ applyApCorr

◆ astrometry

◆ astromRefCat

◆ astromRefObjLoader

◆ background

◆ catalogCalculation

◆ checkUnitsParseStrict

◆ computeSummaryStats

◆ deblend

◆ detection

◆ doApCorr

◆ doAstrometry

◆ doComputeSummaryStats

◆ doDeblend

◆ doInsertFakes

◆ doPhotoCal

◆ doSkySources

◆ doWrite

◆ doWriteExposure

◆ doWriteHeavyFootprintsInSources

◆ doWriteMatches

◆ doWriteMatchesDenormalized

◆ exposure

◆ icSourceCat

◆ icSourceFieldsToCopy

◆ icSourceSchema

◆ insertFakes

◆ matches

◆ matchesDenormalized

◆ matchRadiusPix

◆ measurement

◆ outputBackground

◆ outputCat

◆ outputExposure

◆ outputSchema

◆ photoCal

◆ photoRefCat

◆ photoRefObjLoader

◆ requireAstrometry

◆ requirePhotoCal

◆ setPrimaryFlags

◆ skySources