lsst.fgcmcal g34bb90edf1+cb620522f0
Public Member Functions | List of all members
lsst.fgcmcal.fgcmCalibrateTractBase.FgcmCalibrateTractBaseTask Class Reference
Inheritance diagram for lsst.fgcmcal.fgcmCalibrateTractBase.FgcmCalibrateTractBaseTask:
lsst.fgcmcal.fgcmCalibrateTract.FgcmCalibrateTractTask lsst.fgcmcal.fgcmCalibrateTractTable.FgcmCalibrateTractTableTask

Public Member Functions

def __init__ (self, initInputs=None, butler=None, **kwargs)
 
def runDataRef (self, butler, dataRefs)
 
def run (self, dataRefDict, tract, buildStarsRefObjLoader=None, returnCatalogs=True, butler=None)
 

Detailed Description

Base class to calibrate a single tract using fgcmcal

Definition at line 176 of file fgcmCalibrateTractBase.py.

Constructor & Destructor Documentation

◆ __init__()

def lsst.fgcmcal.fgcmCalibrateTractBase.FgcmCalibrateTractBaseTask.__init__ (   self,
  initInputs = None,
  butler = None,
**  kwargs 
)
Instantiate an `FgcmCalibrateTractTask`.

Parameters
----------
butler : `lsst.daf.persistence.Butler`, optional

Reimplemented in lsst.fgcmcal.fgcmCalibrateTractTable.FgcmCalibrateTractTableTask.

Definition at line 179 of file fgcmCalibrateTractBase.py.

Member Function Documentation

◆ run()

def lsst.fgcmcal.fgcmCalibrateTractBase.FgcmCalibrateTractBaseTask.run (   self,
  dataRefDict,
  tract,
  buildStarsRefObjLoader = None,
  returnCatalogs = True,
  butler = None 
)
Run the calibrations for a single tract with fgcm.

Parameters
----------
dataRefDict : `dict`
    All dataRefs are `lsst.daf.persistence.ButlerDataRef` (gen2) or
    `lsst.daf.butler.DeferredDatasetHandle` (gen3)
    dataRef dictionary with the following keys.  Note that all
    keys need not be set based on config parameters.

    ``"camera"``
        Camera object (`lsst.afw.cameraGeom.Camera`)
    ``"source_catalogs"``
        `list` of dataRefs for input source catalogs.
    ``"sourceSchema"``
        Schema for the source catalogs.
    ``"fgcmLookUpTable"``
        dataRef for the FGCM look-up table.
    ``"calexps"``
        `list` of dataRefs for the input calexps (Gen3 only)
    ``"fgcmPhotoCalibs"``
        `dict` of output photoCalib dataRefs.  Key is
        (tract, visit, detector). (Gen3 only)
        Present if doZeropointOutput is True.
    ``"fgcmTransmissionAtmospheres"``
        `dict` of output atmosphere transmission dataRefs.
        Key is (tract, visit). (Gen3 only)
        Present if doAtmosphereOutput is True.
tract : `int`
    Tract number
buildStarsRefObjLoader : `lsst.meas.algorithms.ReferenceObjectLoader`, optional
    Reference object loader object for fgcmBuildStars.
returnCatalogs : `bool`, optional
    Return photoCalibs as per-visit exposure catalogs.
butler : `lsst.daf.persistence.Butler`, optional
    Gen2 butler used for reference star outputs

Returns
-------
outstruct : `lsst.pipe.base.Struct`
    Output structure with keys:

    offsets : `np.ndarray`
        Final reference offsets, per band.
    repeatability : `np.ndarray`
        Raw fgcm repeatability for bright stars, per band.
    atmospheres : `generator` [(`int`, `lsst.afw.image.TransmissionCurve`)]
        Generator that returns (visit, transmissionCurve) tuples.
    photoCalibs : `generator` [(`int`, `int`, `str`, `lsst.afw.image.PhotoCalib`)]
        Generator that returns (visit, ccd, filtername, photoCalib) tuples.
        (returned if returnCatalogs is False).
    photoCalibCatalogs : `generator` [(`int`, `lsst.afw.table.ExposureCatalog`)]
        Generator that returns (visit, exposureCatalog) tuples.
        (returned if returnCatalogs is True).

Definition at line 265 of file fgcmCalibrateTractBase.py.

◆ runDataRef()

def lsst.fgcmcal.fgcmCalibrateTractBase.FgcmCalibrateTractBaseTask.runDataRef (   self,
  butler,
  dataRefs 
)
Run full FGCM calibration on a single tract, including building star list,
fitting multiple cycles, and making outputs.

Parameters
----------
butler:  `lsst.daf.persistence.Butler`
dataRefs: `list` of `lsst.daf.persistence.ButlerDataRef`
   Data references for the input visits.
   These may be either per-ccd "src" or per-visit"sourceTable_visit"
   references.

Raises
------
RuntimeError: Raised if `config.fgcmBuildStars.doReferenceMatches` is
   not True, or if fgcmLookUpTable is not available, or if
   doSubtractLocalBackground is True and aperture radius cannot be
   determined.

Definition at line 196 of file fgcmCalibrateTractBase.py.


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