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 755 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 764 of file fgcmFitCycle.py.

     def __init__(self, butler=None, **kwargs):
         """
         Instantiate an fgcmFitCycle.
  
         Parameters
         ----------
         butler : `lsst.daf.persistence.Butler`
         """
  
         pipeBase.CmdLineTask.__init__(self, **kwargs)
  

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 780 of file fgcmFitCycle.py.

     def runDataRef(self, butler):
         """
         Run a single fit cycle for FGCM
  
         Parameters
         ----------
         butler:  `lsst.daf.persistence.Butler`
         """
  
         self._fgcmFitCycle(butler)
  

◆ 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 791 of file fgcmFitCycle.py.

     def 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.
         """
         configName = self._getConfigName()
         if configName is None:
             return
         if clobber:
             butler.put(self.config, configName, doBackup=doBackup, fgcmcycle=self.config.cycleNumber)
         elif butler.datasetExists(configName, write=True, fgcmcycle=self.config.cycleNumber):
             # this may be subject to a race condition; see #2789
             try:
                 oldConfig = butler.get(configName, immediate=True, fgcmcycle=self.config.cycleNumber)
             except Exception as exc:
                 raise type(exc)("Unable to read stored config file %s (%s); consider using --clobber-config" %
                                 (configName, exc))
  
             def logConfigMismatch(msg):
                 self.log.fatal("Comparing configuration: %s", msg)
  
             if not self.config.compare(oldConfig, shortcut=False, output=logConfigMismatch):
                 raise pipeBase.TaskError(
                     ("Config does not match existing task config %r on disk; tasks configurations " +
                      "must be consistent within the same output repo (override with --clobber-config)") %
                     (configName,))
         else:
             butler.put(self.config, configName, fgcmcycle=self.config.cycleNumber)
  

Member Data Documentation

◆ ConfigClass

lsst.fgcmcal.fgcmFitCycle.FgcmFitCycleTask.ConfigClass = FgcmFitCycleConfig

static

Definition at line 760 of file fgcmFitCycle.py.

◆ maxIter

lsst.fgcmcal.fgcmFitCycle.FgcmFitCycleTask.maxIter

Definition at line 844 of file fgcmFitCycle.py.

◆ outputStandards

lsst.fgcmcal.fgcmFitCycle.FgcmFitCycleTask.outputStandards

Definition at line 845 of file fgcmFitCycle.py.

◆ outputZeropoints

lsst.fgcmcal.fgcmFitCycle.FgcmFitCycleTask.outputZeropoints

Definition at line 846 of file fgcmFitCycle.py.

◆ resetFitParameters

lsst.fgcmcal.fgcmFitCycle.FgcmFitCycleTask.resetFitParameters

Definition at line 847 of file fgcmFitCycle.py.

◆ RunnerClass

lsst.fgcmcal.fgcmFitCycle.FgcmFitCycleTask.RunnerClass = FgcmFitCycleRunner