lsst.pipe.tasks  13.0-66-gfbf2f2ce+5
Public Member Functions | Public Attributes | Static Public Attributes | List of all members
lsst.pipe.tasks.calibrate.CalibrateTask Class Reference

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

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

Public Member Functions

def __init__ (self, butler=None, astromRefObjLoader=None, photoRefObjLoader=None, icSourceSchema=None, kwargs)
 Construct a CalibrateTask. More...
 
def run (self, dataRef, exposure=None, background=None, icSourceCat=None, doUnpersist=True)
 Calibrate an exposure, optionally unpersisting inputs and persisting outputs. More...
 
def calibrate (self, exposure, exposureIdInfo=None, background=None, icSourceCat=None)
 Calibrate an exposure (science image or coadd) More...
 
def writeOutputs (self, dataRef, exposure, background, sourceCat, astromMatches, matchMeta)
 
def getSchemaCatalogs (self)
 
def setMetadata (self, exposure, photoRes=None)
 Set task and exposure metadata. More...
 
def copyIcSourceFields (self, icSourceCat, sourceCat)
 Match sources in icSourceCat and sourceCat and copy the specified fields. More...
 

Public Attributes

 schemaMapper
 
 calibSourceKey
 
 schema
 
 algMetadata
 
 pixelMargin
 

Static Public Attributes

 ConfigClass = CalibrateConfig
 
 RunnerClass = pipeBase.ButlerInitializedTaskRunner
 

Detailed Description

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

Contents

Description

Given an exposure with a good PSF model and aperture correction map (e.g. as provided by Task Documentation), perform the following operations:

Task initialisation

Construct a CalibrateTask.

Parameters
[in]butlerThe butler is passed to the refObjLoader constructor in case it is needed. Ignored if the refObjLoader argument provides a loader directly.
[in]astromRefObjLoaderAn instance of LoadReferenceObjectsTasks that supplies an external reference catalog for astrometric calibration. May be None if the desired loader can be constructed from the butler argument or all steps requiring a reference catalog are disabled.
[in]photoRefObjLoaderAn instance of LoadReferenceObjectsTasks that supplies an external reference catalog for photometric calibration. May be None if the desired loader can be constructed from the butler argument or all steps requiring a reference catalog are disabled.
[in]icSourceSchemaschema for icSource catalog, or None. Schema values specified in config.icSourceFieldsToCopy will be taken from this schema. If set to None, no values will be propagated from the icSourceCatalog
[in,out]kwargsother keyword arguments for lsst.pipe.base.CmdLineTask

Invoking the Task

If you want this task to unpersist inputs or persist outputs, then call the run method (a wrapper around the calibrate method).

If you already have the inputs unpersisted and do not want to persist the output then it is more direct to call the calibrate method:

Configuration parameters

See CalibrateConfig

Quantities set in exposure Metadata

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)

Debug variables

The command line task interface supports a flag --debug to import debug.py from your $PYTHONPATH; see baseDebug for more about debug.py.

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 lsst.meas.astrom.displayAstrometry for the meaning of the various symbols.

For example, put something like:

import lsstDebug
def DebugInfo(name):
di = lsstDebug.getInfo(name) # N.b. lsstDebug.Info(name) would
# call us recursively
if name == "lsst.pipe.tasks.calibrate":
di.display = dict(
calibrate = 1,
)
return di
lsstDebug.Info = DebugInfo

into your debug.py file and run calibrateTask.py with the --debug flag.

Some subtasks may have their own debug variables; see individual Task documentation.

Definition at line 183 of file calibrate.py.

Constructor & Destructor Documentation

◆ __init__()

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

Construct a CalibrateTask.

Parameters
[in]butlerThe butler is passed to the refObjLoader constructor in case it is needed. Ignored if the refObjLoader argument provides a loader directly.
[in]astromRefObjLoaderAn instance of LoadReferenceObjectsTasks that supplies an external reference catalog for astrometric calibration. May be None if the desired loader can be constructed from the butler argument or all steps requiring a reference catalog are disabled.
[in]photoRefObjLoaderAn instance of LoadReferenceObjectsTasks that supplies an external reference catalog for photometric calibration. May be None if the desired loader can be constructed from the butler argument or all steps requiring a reference catalog are disabled.
[in]icSourceSchemaschema for icSource catalog, or None. Schema values specified in config.icSourceFieldsToCopy will be taken from this schema. If set to None, no values will be propagated from the icSourceCatalog
[in,out]kwargsother keyword arguments for lsst.pipe.base.CmdLineTask

Definition at line 281 of file calibrate.py.

Member Function Documentation

◆ calibrate()

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

Calibrate an exposure (science image or coadd)

Parameters
[in,out]exposureexposure to calibrate (an lsst.afw.image.ExposureF or similar); in:
  • MaskedImage
  • Psf out:
  • MaskedImage has background subtracted
  • Wcs is replaced
  • Calib zero-point is set
[in]exposureIdInfoID info for exposure (an lsst.obs.base.ExposureIdInfo) If not provided, returned SourceCatalog IDs will not be globally unique.
[in,out]backgroundbackground model already subtracted from exposure (an lsst.afw.math.BackgroundList). May be None if no background has been subtracted, though that is unusual for calibration. A refined background model is output.
[in]icSourceCatA SourceCatalog from CharacterizeImageTask from which we can copy some fields.
Returns
pipe_base Struct containing these fields:
  • exposure calibrate science exposure with refined WCS and Calib
  • background model of background subtracted from exposure (an lsst.afw.math.BackgroundList)
  • sourceCat catalog of measured sources
  • astromMatches list of source/refObj matches from the astrometry solver

Definition at line 449 of file calibrate.py.

◆ copyIcSourceFields()

def lsst.pipe.tasks.calibrate.CalibrateTask.copyIcSourceFields (   self,
  icSourceCat,
  sourceCat 
)

Match sources in icSourceCat and sourceCat and copy the specified fields.

Parameters
[in]icSourceCatcatalog from which to copy fields
[in,out]sourceCatcatalog to which to copy fields

The fields copied are those specified by config.icSourceFieldsToCopy that actually exist in the schema. This was set up by the constructor using self.schemaMapper.

Definition at line 632 of file calibrate.py.

◆ getSchemaCatalogs()

def lsst.pipe.tasks.calibrate.CalibrateTask.getSchemaCatalogs (   self)
Return a dict of empty catalogs for each catalog dataset produced
by this task.

Definition at line 593 of file calibrate.py.

◆ run()

def lsst.pipe.tasks.calibrate.CalibrateTask.run (   self,
  dataRef,
  exposure = None,
  background = None,
  icSourceCat = None,
  doUnpersist = True 
)

Calibrate an exposure, optionally unpersisting inputs and persisting outputs.

This is a wrapper around the calibrate method that unpersists inputs (if doUnpersist true) and persists outputs (if config.doWrite true)

Parameters
[in]dataRefbutler data reference corresponding to a science image
[in,out]exposurecharacterized exposure (an lsst.afw.image.ExposureF or similar), or None to unpersist existing icExp and icBackground. See calibrate method for details of what is read and written.
[in,out]backgroundinitial model of background already subtracted from exposure (an lsst.afw.math.BackgroundList). May be None if no background has been subtracted, though that is unusual for calibration. A refined background model is output. Ignored if exposure is None.
[in]icSourceCatcatalog from which to copy the fields specified by icSourceKeys, or None;
[in]doUnpersistunpersist data:
  • if True, exposure, background and icSourceCat are read from dataRef and those three arguments must all be None;
  • if False the exposure must be provided; background and icSourceCat are optional. True is intended for running as a command-line task, False for running as a subtask
Returns
same data as the calibrate method

Definition at line 385 of file calibrate.py.

◆ setMetadata()

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

Set task and exposure metadata.

Logs a warning and continues if needed data is missing.

Parameters
[in,out]exposureexposure whose metadata is to be set
[in]photoResresults of running photoCal; if None then it was not run

Definition at line 601 of file calibrate.py.

◆ writeOutputs()

def lsst.pipe.tasks.calibrate.CalibrateTask.writeOutputs (   self,
  dataRef,
  exposure,
  background,
  sourceCat,
  astromMatches,
  matchMeta 
)
Write output data to the output repository

@param[in] dataRef  butler data reference corresponding to a science
    image
@param[in] exposure  exposure to write
@param[in] background  background model for exposure
@param[in] sourceCat  catalog of measured sources
@param[in] astromMatches  list of source/refObj matches from the
    astrometry solver

Definition at line 569 of file calibrate.py.

Member Data Documentation

◆ algMetadata

lsst.pipe.tasks.calibrate.CalibrateTask.algMetadata

Definition at line 347 of file calibrate.py.

◆ calibSourceKey

lsst.pipe.tasks.calibrate.CalibrateTask.calibSourceKey

Definition at line 321 of file calibrate.py.

◆ ConfigClass

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

Definition at line 276 of file calibrate.py.

◆ pixelMargin

lsst.pipe.tasks.calibrate.CalibrateTask.pixelMargin

Definition at line 367 of file calibrate.py.

◆ RunnerClass

lsst.pipe.tasks.calibrate.CalibrateTask.RunnerClass = pipeBase.ButlerInitializedTaskRunner
static

Definition at line 278 of file calibrate.py.

◆ schema

lsst.pipe.tasks.calibrate.CalibrateTask.schema

Definition at line 341 of file calibrate.py.

◆ schemaMapper

lsst.pipe.tasks.calibrate.CalibrateTask.schemaMapper

Definition at line 312 of file calibrate.py.


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