lsst.pipe.tasks g7ab1c79000+4bbf02a586
Loading...
Searching...
No Matches
Public Member Functions | Public Attributes | Static Public Attributes | List of all members
lsst.pipe.tasks.calibrate.CalibrateTask Class Reference
Inheritance diagram for lsst.pipe.tasks.calibrate.CalibrateTask:

Public Member Functions

def __init__ (self, butler=None, astromRefObjLoader=None, photoRefObjLoader=None, icSourceSchema=None, initInputs=None, **kwargs)
 
def runQuantum (self, butlerQC, inputRefs, outputRefs)
 
def run (self, exposure, exposureIdInfo=None, background=None, icSourceCat=None)
 
def setMetadata (self, exposure, photoRes=None)
 
def copyIcSourceFields (self, icSourceCat, sourceCat)
 

Public Attributes

 schemaMapper
 
 calibSourceKey
 
 schema
 
 algMetadata
 
 skySourceKey
 
 outputSchema
 

Static Public Attributes

 ConfigClass = CalibrateConfig
 

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 331 of file calibrate.py.

Constructor & Destructor Documentation

◆ __init__()

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

Definition at line 391 of file calibrate.py.

Member Function Documentation

◆ copyIcSourceFields()

def lsst.pipe.tasks.calibrate.CalibrateTask.copyIcSourceFields (   self,
  icSourceCat,
  sourceCat 
)
Match sources in an icSourceCat and a sourceCat and copy fields.

The fields copied are those specified by
``config.icSourceFieldsToCopy``.

Parameters
----------
icSourceCat : `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:
    - icSourceSchema and icSourceKeys are not specified.
    - icSourceCat and sourceCat are not specified.
    - icSourceFieldsToCopy is empty.

Definition at line 719 of file calibrate.py.

◆ run()

def lsst.pipe.tasks.calibrate.CalibrateTask.run (   self,
  exposure,
  exposureIdInfo = None,
  background = None,
  icSourceCat = None 
)
Calibrate an exposure.

Parameters
----------
exposure : `lsst.afw.image.ExposureF`
    Exposure to calibrate.
exposureIdInfo : `lsst.obs.baseExposureIdInfo`, optional
    Exposure ID info. If not provided, returned SourceCatalog IDs will
    not be globally unique.
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.

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 517 of file calibrate.py.

◆ runQuantum()

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

Definition at line 479 of file calibrate.py.

◆ setMetadata()

def 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 683 of file calibrate.py.

Member Data Documentation

◆ algMetadata

lsst.pipe.tasks.calibrate.CalibrateTask.algMetadata

Definition at line 441 of file calibrate.py.

◆ calibSourceKey

lsst.pipe.tasks.calibrate.CalibrateTask.calibSourceKey

Definition at line 415 of file calibrate.py.

◆ ConfigClass

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

Definition at line 388 of file calibrate.py.

◆ outputSchema

lsst.pipe.tasks.calibrate.CalibrateTask.outputSchema

Definition at line 477 of file calibrate.py.

◆ schema

lsst.pipe.tasks.calibrate.CalibrateTask.schema

Definition at line 435 of file calibrate.py.

◆ schemaMapper

lsst.pipe.tasks.calibrate.CalibrateTask.schemaMapper

Definition at line 406 of file calibrate.py.

◆ skySourceKey

lsst.pipe.tasks.calibrate.CalibrateTask.skySourceKey

Definition at line 447 of file calibrate.py.


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