lsst.fgcmcal  20.0.0-4-ge48a6ca+2
Public Member Functions | Public Attributes | Static Public Attributes | List of all members
lsst.fgcmcal.fgcmFitCycle.FgcmFitCycleTask Class Reference
Inheritance diagram for lsst.fgcmcal.fgcmFitCycle.FgcmFitCycleTask:

Public Member Functions

def __init__ (self, butler=None, **kwargs)
 
def runDataRef (self, butler)
 
def writeConfig (self, butler, clobber=False, doBackup=True)
 

Public Attributes

 maxIter
 
 outputStandards
 
 outputZeropoints
 
 resetFitParameters
 

Static Public Attributes

 ConfigClass = FgcmFitCycleConfig
 
 RunnerClass = FgcmFitCycleRunner
 

Detailed Description

Run Single fit cycle for FGCM global calibration

Definition at line 713 of file fgcmFitCycle.py.

Constructor & Destructor Documentation

◆ __init__()

def lsst.fgcmcal.fgcmFitCycle.FgcmFitCycleTask.__init__ (   self,
  butler = None,
**  kwargs 
)
Instantiate an fgcmFitCycle.

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

Definition at line 722 of file fgcmFitCycle.py.

Member Function Documentation

◆ runDataRef()

def lsst.fgcmcal.fgcmFitCycle.FgcmFitCycleTask.runDataRef (   self,
  butler 
)
Run a single fit cycle for FGCM

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

Definition at line 738 of file fgcmFitCycle.py.

◆ writeConfig()

def lsst.fgcmcal.fgcmFitCycle.FgcmFitCycleTask.writeConfig (   self,
  butler,
  clobber = False,
  doBackup = True 
)
Write the configuration used for processing the data, or check that an existing
one is equal to the new one if present.  This is an override of the regular
version from pipe_base that knows about fgcmcycle.

Parameters
----------
butler : `lsst.daf.persistence.Butler`
    Data butler used to write the config. The config is written to dataset type
    `CmdLineTask._getConfigName`.
clobber : `bool`, optional
    A boolean flag that controls what happens if a config already has been saved:
    - `True`: overwrite or rename the existing config, depending on ``doBackup``.
    - `False`: raise `TaskError` if this config does not match the existing config.
doBackup : `bool`, optional
    Set to `True` to backup the config files if clobbering.

Definition at line 749 of file fgcmFitCycle.py.

Member Data Documentation

◆ ConfigClass

lsst.fgcmcal.fgcmFitCycle.FgcmFitCycleTask.ConfigClass = FgcmFitCycleConfig
static

Definition at line 718 of file fgcmFitCycle.py.

◆ maxIter

lsst.fgcmcal.fgcmFitCycle.FgcmFitCycleTask.maxIter

Definition at line 802 of file fgcmFitCycle.py.

◆ outputStandards

lsst.fgcmcal.fgcmFitCycle.FgcmFitCycleTask.outputStandards

Definition at line 803 of file fgcmFitCycle.py.

◆ outputZeropoints

lsst.fgcmcal.fgcmFitCycle.FgcmFitCycleTask.outputZeropoints

Definition at line 804 of file fgcmFitCycle.py.

◆ resetFitParameters

lsst.fgcmcal.fgcmFitCycle.FgcmFitCycleTask.resetFitParameters

Definition at line 805 of file fgcmFitCycle.py.

◆ RunnerClass

lsst.fgcmcal.fgcmFitCycle.FgcmFitCycleTask.RunnerClass = FgcmFitCycleRunner
static

Definition at line 719 of file fgcmFitCycle.py.


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