lsst.fgcmcal  21.0.0-4-g8a80011+5955f0fd15
Public Member Functions | Public Attributes | Static Public Attributes | List of all members
lsst.fgcmcal.fgcmOutputProducts.FgcmOutputProductsTask Class Reference
Inheritance diagram for lsst.fgcmcal.fgcmOutputProducts.FgcmOutputProductsTask:

Public Member Functions

def __init__ (self, butler=None, **kwargs)
 
def runDataRef (self, butler)
 
def generateTractOutputProducts (self, butler, tract, visitCat, zptCat, atmCat, stdCat, fgcmBuildStarsConfig, fgcmFitCycleConfig)
 

Public Attributes

 indexer
 
 visitDataRefName
 
 ccdDataRefName
 
 filterMap
 
 configBands
 
 bands
 

Static Public Attributes

 ConfigClass = FgcmOutputProductsConfig
 
 RunnerClass = FgcmOutputProductsRunner
 

Detailed Description

Output products from FGCM global calibration.

Definition at line 242 of file fgcmOutputProducts.py.

Constructor & Destructor Documentation

◆ __init__()

def lsst.fgcmcal.fgcmOutputProducts.FgcmOutputProductsTask.__init__ (   self,
  butler = None,
**  kwargs 
)
Instantiate an fgcmOutputProductsTask.

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

Definition at line 251 of file fgcmOutputProducts.py.

Member Function Documentation

◆ generateTractOutputProducts()

def lsst.fgcmcal.fgcmOutputProducts.FgcmOutputProductsTask.generateTractOutputProducts (   self,
  butler,
  tract,
  visitCat,
  zptCat,
  atmCat,
  stdCat,
  fgcmBuildStarsConfig,
  fgcmFitCycleConfig 
)
Generate the output products for a given tract, as specified in the config.

This method is here to have an alternate entry-point for
FgcmCalibrateTract.

Parameters
----------
butler: `lsst.daf.persistence.Butler`
tract: `int`
   Tract number
visitCat: `lsst.afw.table.BaseCatalog`
   FGCM visitCat from `FgcmBuildStarsTask`
zptCat: `lsst.afw.table.BaseCatalog`
   FGCM zeropoint catalog from `FgcmFitCycleTask`
atmCat: `lsst.afw.table.BaseCatalog`
   FGCM atmosphere parameter catalog from `FgcmFitCycleTask`
stdCat: `lsst.afw.table.SimpleCatalog`
   FGCM standard star catalog from `FgcmFitCycleTask`
fgcmBuildStarsConfig: `lsst.fgcmcal.FgcmBuildStarsConfig`
   Configuration object from `FgcmBuildStarsTask`
fgcmFitCycleConfig: `lsst.fgcmcal.FgcmFitCycleConfig`
   Configuration object from `FgcmFitCycleTask`

Definition at line 399 of file fgcmOutputProducts.py.

◆ runDataRef()

def lsst.fgcmcal.fgcmOutputProducts.FgcmOutputProductsTask.runDataRef (   self,
  butler 
)
Make FGCM output products for use in the stack

Parameters
----------
butler:  `lsst.daf.persistence.Butler`
cycleNumber: `int`
   Final fit cycle number, override config.

Returns
-------
offsets: `lsst.pipe.base.Struct`
   A structure with array of zeropoint offsets

Raises
------
RuntimeError:
   Raised if any one of the following is true:

   - butler cannot find "fgcmBuildStars_config" or
     "fgcmBuildStarsTable_config".
   - butler cannot find "fgcmFitCycle_config".
   - "fgcmFitCycle_config" does not refer to
     `self.config.cycleNumber`.
   - butler cannot find "fgcmAtmosphereParameters" and
     `self.config.doAtmosphereOutput` is `True`.
   - butler cannot find "fgcmStandardStars" and
     `self.config.doReferenceCalibration` is `True` or
     `self.config.doRefcatOutput` is `True`.
   - butler cannot find "fgcmZeropoints" and
     `self.config.doZeropointOutput` is `True`.

Definition at line 275 of file fgcmOutputProducts.py.

Member Data Documentation

◆ bands

lsst.fgcmcal.fgcmOutputProducts.FgcmOutputProductsTask.bands

Definition at line 368 of file fgcmOutputProducts.py.

◆ ccdDataRefName

lsst.fgcmcal.fgcmOutputProducts.FgcmOutputProductsTask.ccdDataRefName

Definition at line 321 of file fgcmOutputProducts.py.

◆ configBands

lsst.fgcmcal.fgcmOutputProducts.FgcmOutputProductsTask.configBands

Definition at line 337 of file fgcmOutputProducts.py.

◆ ConfigClass

lsst.fgcmcal.fgcmOutputProducts.FgcmOutputProductsTask.ConfigClass = FgcmOutputProductsConfig
static

Definition at line 247 of file fgcmOutputProducts.py.

◆ filterMap

lsst.fgcmcal.fgcmOutputProducts.FgcmOutputProductsTask.filterMap

Definition at line 322 of file fgcmOutputProducts.py.

◆ indexer

lsst.fgcmcal.fgcmOutputProducts.FgcmOutputProductsTask.indexer

Definition at line 267 of file fgcmOutputProducts.py.

◆ RunnerClass

lsst.fgcmcal.fgcmOutputProducts.FgcmOutputProductsTask.RunnerClass = FgcmOutputProductsRunner
static

Definition at line 248 of file fgcmOutputProducts.py.

◆ visitDataRefName

lsst.fgcmcal.fgcmOutputProducts.FgcmOutputProductsTask.visitDataRefName

Definition at line 320 of file fgcmOutputProducts.py.


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