|
| __init__ (self, butler=None, astromRefObjLoader=None, photoRefObjLoader=None, icSourceSchema=None, initInputs=None, **kwargs) |
|
| runQuantum (self, butlerQC, inputRefs, outputRefs) |
|
| run (self, exposure, exposureIdInfo=None, background=None, icSourceCat=None, idGenerator=None) |
|
| setMetadata (self, exposure, photoRes=None) |
|
| copyIcSourceFields (self, icSourceCat, sourceCat) |
|
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 318 of file calibrate.py.
lsst.pipe.tasks.calibrate.CalibrateTask.run |
( |
|
self, |
|
|
|
exposure, |
|
|
|
exposureIdInfo = None , |
|
|
|
background = None , |
|
|
|
icSourceCat = None , |
|
|
|
idGenerator = None |
|
) |
| |
Calibrate an exposure.
Parameters
----------
exposure : `lsst.afw.image.ExposureF`
Exposure to calibrate.
exposureIdInfo : `lsst.obs.baseExposureIdInfo`, optional
Exposure ID info. Deprecated in favor of ``idGenerator``, and
ignored if that is provided.
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 504 of file calibrate.py.