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

Public Member Functions
	__init__ (self, astromRefObjLoader=None, photoRefObjLoader=None, icSourceSchema=None, initInputs=None, **kwargs)

	runQuantum (self, butlerQC, inputRefs, outputRefs)

	run (self, exposure, background=None, icSourceCat=None, idGenerator=None)

	setMetadata (self, exposure, photoRes=None)

	copyCalibSourceFields (self, calibType, schemaMapper, calibCat, sourceCat, fieldsToCopy)

	recordMaskedPixelFractions (self, exposure)

Public Attributes
	schemaMapper = afwTable.SchemaMapper(icSourceSchema)

	calibSourceKey

	schema = self.schemaMapper.editOutputSchema()

	algMetadata = dafBase.PropertyList()

	skySourceKey = self.schema.addField("sky_source", type="Flag", doc="Sky objects.")

	outputSchema = sourceCatSchema

Static Public Attributes
	ConfigClass = CalibrateConfig

Static Protected Attributes
str	_DefaultName = "calibrate"

Detailed Description

Calibrate an exposure: measure sources and perform astrometric and
photometric calibration.

Given an exposure with a good PSF model and aperture correction map(e.g. as
provided by `~lsst.pipe.tasks.characterizeImage.CharacterizeImageTask`),
perform the following operations:
- Run detection and measurement
- Run astrometry subtask to fit an improved WCS
- Run photoCal subtask to fit the exposure's photometric zero-point

Parameters
----------
butler : `None`
    Compatibility parameter. Should always be `None`.
astromRefObjLoader : `lsst.meas.algorithms.ReferenceObjectLoader`, optional
    Unused in gen3: must be `None`.
photoRefObjLoader : `lsst.meas.algorithms.ReferenceObjectLoader`, optional
    Unused in gen3: must be `None`.
icSourceSchema : `lsst.afw.table.Schema`, optional
    Schema for the icSource catalog.
initInputs : `dict`, optional
    Dictionary that can contain a key ``icSourceSchema`` containing the
    input schema. If present will override the value of ``icSourceSchema``.

Raises
------
RuntimeError
    Raised if any of the following occur:
    - isSourceCat is missing fields specified in icSourceFieldsToCopy.
    - PipelineTask form of this task is initialized with reference object
      loaders.

Notes
-----
Quantities set in exposure Metadata:

MAGZERO_RMS
    MAGZERO's RMS == sigma reported by photoCal task
MAGZERO_NOBJ
    Number of stars used == ngood reported by photoCal task
COLORTERM1
    ?? (always 0.0)
COLORTERM2
    ?? (always 0.0)
COLORTERM3
    ?? (always 0.0)

Debugging:
CalibrateTask has a debug dictionary containing one key:

calibrate
    frame (an int; <= 0 to not display) in which to display the exposure,
    sources and matches. See @ref lsst.meas.astrom.displayAstrometry for
    the meaning of the various symbols.

Definition at line 389 of file calibrate.py.

Constructor & Destructor Documentation

◆ init()

lsst.pipe.tasks.calibrate.CalibrateTask.__init__	(		self,
			astromRefObjLoader = None,
			photoRefObjLoader = None,
			icSourceSchema = None,
			initInputs = None,
		**	kwargs )

Definition at line 449 of file calibrate.py.

Member Function Documentation

◆ copyCalibSourceFields()

lsst.pipe.tasks.calibrate.CalibrateTask.copyCalibSourceFields	(	self,
		calibType,
		schemaMapper,
		calibCat,
		sourceCat,
		fieldsToCopy )

Match sources in a calibrationCat and a sourceCat and copy fields.

The fields copied are those specified by
``config.icSourceFieldsToCopy`` if ``calibType`` is icSource or
``config.astromFieldsToCopy`` if ``calibType`` is astrometry.

Parameters
----------
calibType : `str`
    The type of calibration: either icSource or astrometry.
calibCat : `lsst.afw.table.SourceCatalog`
    Catalog from which to copy fields.
sourceCat : `lsst.afw.table.SourceCatalog`
    Catalog to which to copy fields.

Raises
------
RuntimeError
    Raised if any of the following occur:
    - calibSchema and calibSourceKeys are not specified.
    - calibCat and sourceCat are not specified.
    - calibFieldsToCopy is empty.

Definition at line 863 of file calibrate.py.

◆ recordMaskedPixelFractions()

lsst.pipe.tasks.calibrate.CalibrateTask.recordMaskedPixelFractions	(		self,
			exposure )

Record the fraction of all the pixels in an exposure
that are masked with a given flag. Each fraction is
recorded in the task metadata. One record per flag type.

Parameters
----------
exposure : `lsst.afw.image.ExposureF`
    The target exposure to calculate masked pixel fractions for.

Definition at line 951 of file calibrate.py.

◆ run()

lsst.pipe.tasks.calibrate.CalibrateTask.run	(	self,
		exposure,
		background = None,
		icSourceCat = None,
		idGenerator = None )

Calibrate an exposure.

Parameters
----------
exposure : `lsst.afw.image.ExposureF`
    Exposure to calibrate.
background : `lsst.afw.math.BackgroundList`, optional
    Initial model of background already subtracted from exposure.
icSourceCat : `lsst.afw.image.SourceCatalog`, optional
    SourceCatalog from CharacterizeImageTask from which we can copy
    some fields.
idGenerator : `lsst.meas.base.IdGenerator`, optional
    Object that generates source IDs and provides RNG seeds.

Returns
-------
result : `lsst.pipe.base.Struct`
    Results as a struct with attributes:

    ``exposure``
       Characterized exposure (`lsst.afw.image.ExposureF`).
    ``sourceCat``
       Detected sources (`lsst.afw.table.SourceCatalog`).
    ``outputBackground``
       Model of subtracted background (`lsst.afw.math.BackgroundList`).
    ``astromMatches``
       List of source/ref matches from astrometry solver.
    ``matchMeta``
       Metadata from astrometry matches.
    ``outputExposure``
       Another reference to ``exposure`` for compatibility.
    ``outputCat``
       Another reference to ``sourceCat`` for compatibility.

Definition at line 576 of file calibrate.py.

◆ runQuantum()

lsst.pipe.tasks.calibrate.CalibrateTask.runQuantum	(	self,
		butlerQC,
		inputRefs,
		outputRefs )

Definition at line 538 of file calibrate.py.

◆ setMetadata()

lsst.pipe.tasks.calibrate.CalibrateTask.setMetadata	(	self,
		exposure,
		photoRes = None )

Set task and exposure metadata.

Logs a warning continues if needed data is missing.

Parameters
----------
exposure : `lsst.afw.image.ExposureF`
    Exposure to set metadata on.
photoRes : `lsst.pipe.base.Struct`, optional
    Result of running photoCal task.

Definition at line 827 of file calibrate.py.

Member Data Documentation

◆ _DefaultName

str lsst.pipe.tasks.calibrate.CalibrateTask._DefaultName = "calibrate"

staticprotected

Definition at line 447 of file calibrate.py.

◆ algMetadata

lsst.pipe.tasks.calibrate.CalibrateTask.algMetadata = dafBase.PropertyList()

Definition at line 495 of file calibrate.py.

◆ calibSourceKey

lsst.pipe.tasks.calibrate.CalibrateTask.calibSourceKey

Initial value:

=  self.schemaMapper.addOutputField(
                afwTable.Field["Flag"]("calib_detected",
                                       "Source was detected as an icSource"))

Definition at line 468 of file calibrate.py.

◆ ConfigClass

lsst.pipe.tasks.calibrate.CalibrateTask.ConfigClass = CalibrateConfig

static

Definition at line 446 of file calibrate.py.

◆ outputSchema

lsst.pipe.tasks.calibrate.CalibrateTask.outputSchema = sourceCatSchema

Definition at line 536 of file calibrate.py.

◆ schema

lsst.pipe.tasks.calibrate.CalibrateTask.schema = self.schemaMapper.editOutputSchema()

Definition at line 488 of file calibrate.py.

◆ schemaMapper

lsst.pipe.tasks.calibrate.CalibrateTask.schemaMapper = afwTable.SchemaMapper(icSourceSchema)

Definition at line 459 of file calibrate.py.

◆ skySourceKey

lsst.pipe.tasks.calibrate.CalibrateTask.skySourceKey = self.schema.addField("sky_source", type="Flag", doc="Sky objects.")

Definition at line 501 of file calibrate.py.

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

python/lsst/pipe/tasks/calibrate.py

Public Member Functions

Public Attributes

Static Public Attributes

Static Protected Attributes