lsst.fgcmcal.fgcmCalibrateTractBase.FgcmCalibrateTractConfigBase Class Reference

Inheritance diagram for lsst.fgcmcal.fgcmCalibrateTractBase.FgcmCalibrateTractConfigBase:

Public Member Functions
def	setDefaults (self)
def	validate (self)

Static Public Attributes
	fgcmBuildStars
	fgcmFitCycle
	fgcmOutputProducts
	convergenceTolerance
	maxFitCycles
	doDebuggingPlots

Detailed Description

Config for FgcmCalibrateTract

Definition at line 51 of file fgcmCalibrateTractBase.py.

Member Function Documentation

setDefaults()

def lsst.fgcmcal.fgcmCalibrateTractBase.FgcmCalibrateTractConfigBase.setDefaults

(

self

)

Reimplemented in lsst.fgcmcal.fgcmCalibrateTractTable.FgcmCalibrateTractTableConfig, and lsst.fgcmcal.fgcmCalibrateTract.FgcmCalibrateTractConfig.

Definition at line 82 of file fgcmCalibrateTractBase.py.

    def setDefaults(self):
        pexConfig.Config.setDefaults(self)
 
        self.fgcmFitCycle.quietMode = True
        self.fgcmFitCycle.doPlots = False
        self.fgcmOutputProducts.doReferenceCalibration = False
        self.fgcmOutputProducts.doRefcatOutput = False
        self.fgcmOutputProducts.cycleNumber = 0
        self.fgcmOutputProducts.photoCal.applyColorTerms = False
 

validate()

def lsst.fgcmcal.fgcmCalibrateTractBase.FgcmCalibrateTractConfigBase.validate

(

self

)

Definition at line 92 of file fgcmCalibrateTractBase.py.

    def validate(self):
        super().validate()
 
        for band in self.fgcmFitCycle.bands:
            if not self.fgcmFitCycle.useRepeatabilityForExpGrayCutsDict[band]:
                msg = 'Must set useRepeatabilityForExpGrayCutsDict[band]=True for all bands'
                raise pexConfig.FieldValidationError(FgcmFitCycleConfig.useRepeatabilityForExpGrayCutsDict,
                                                     self, msg)
 
 

Member Data Documentation

convergenceTolerance

lsst.fgcmcal.fgcmCalibrateTractBase.FgcmCalibrateTractConfigBase.convergenceTolerance

static

Initial value:

=  pexConfig.Field(
        doc="Tolerance on repeatability convergence (per band)",
        dtype=float,
        default=0.005,
    )

Definition at line 66 of file fgcmCalibrateTractBase.py.

doDebuggingPlots

lsst.fgcmcal.fgcmCalibrateTractBase.FgcmCalibrateTractConfigBase.doDebuggingPlots

static

Initial value:

=  pexConfig.Field(
        doc="Make plots for debugging purposes?",
        dtype=bool,
        default=False,
    )

Definition at line 76 of file fgcmCalibrateTractBase.py.

fgcmBuildStars

lsst.fgcmcal.fgcmCalibrateTractBase.FgcmCalibrateTractConfigBase.fgcmBuildStars

static

Initial value:

=  pexConfig.ConfigurableField(
        target=FgcmBuildStarsTask,
        doc="Task to load and match stars for fgcm",
    )

Definition at line 54 of file fgcmCalibrateTractBase.py.

fgcmFitCycle

lsst.fgcmcal.fgcmCalibrateTractBase.FgcmCalibrateTractConfigBase.fgcmFitCycle

static

Initial value:

=  pexConfig.ConfigField(
        dtype=FgcmFitCycleConfig,
        doc="Config to run a single fgcm fit cycle",
    )

Definition at line 58 of file fgcmCalibrateTractBase.py.

fgcmOutputProducts

lsst.fgcmcal.fgcmCalibrateTractBase.FgcmCalibrateTractConfigBase.fgcmOutputProducts

static

Initial value:

=  pexConfig.ConfigurableField(
        target=FgcmOutputProductsTask,
        doc="Task to output fgcm products",
    )

Definition at line 62 of file fgcmCalibrateTractBase.py.

maxFitCycles

lsst.fgcmcal.fgcmCalibrateTractBase.FgcmCalibrateTractConfigBase.maxFitCycles

static

Initial value:

=  pexConfig.Field(
        doc="Maximum number of fit cycles",
        dtype=int,
        default=5,
    )

Definition at line 71 of file fgcmCalibrateTractBase.py.

---

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

• /j/snowflake/release/lsstsw/stack/lsst-scipipe-0.7.0/Linux64/fgcmcal/22.0.1-15-g6a90155+515f58c32b/python/lsst/fgcmcal/fgcmCalibrateTractBase.py