lsst.fgcmcal g2e4e590914+5cd89aba49
Public Member Functions | List of all members
lsst.fgcmcal.fgcmCalibrateTractBase.FgcmCalibrateTractBaseTask Class Reference
Inheritance diagram for lsst.fgcmcal.fgcmCalibrateTractBase.FgcmCalibrateTractBaseTask:
lsst.fgcmcal.fgcmCalibrateTractTable.FgcmCalibrateTractTableTask

Public Member Functions

def __init__ (self, initInputs=None, **kwargs)
 
def run (self, handleDict, tract, buildStarsRefObjLoader=None, returnCatalogs=True)
 

Detailed Description

Base class to calibrate a single tract using fgcmcal

Definition at line 97 of file fgcmCalibrateTractBase.py.

Constructor & Destructor Documentation

◆ __init__()

def lsst.fgcmcal.fgcmCalibrateTractBase.FgcmCalibrateTractBaseTask.__init__ (   self,
  initInputs = None,
**  kwargs 
)

Member Function Documentation

◆ run()

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

Parameters
----------
handleDict : `dict`
    All handles are `lsst.daf.butler.DeferredDatasetHandle`
    handle 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 handles for input source catalogs.
    ``"sourceSchema"``
        Schema for the source catalogs.
    ``"fgcmLookUpTable"``
        handle for the FGCM look-up table.
    ``"calexps"``
        `list` of handles for the input calexps
    ``"fgcmPhotoCalibs"``
        `dict` of output photoCalib handles.  Key is
        (tract, visit, detector).
        Present if doZeropointOutput is True.
    ``"fgcmTransmissionAtmospheres"``
        `dict` of output atmosphere transmission handles.
        Key is (tract, visit).
        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.

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 105 of file fgcmCalibrateTractBase.py.


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