LSSTApplications  21.0.0+1b62c9342b,21.0.0+45a059f35e,21.0.0-1-ga51b5d4+ceb9cf20a3,21.0.0-10-g68cce58c5+c7d3cce47e,21.0.0-2-g103fe59+c1ca725317,21.0.0-2-g1367e85+a1c2f7fe71,21.0.0-2-g2909d54+45a059f35e,21.0.0-2-g45278ab+1b62c9342b,21.0.0-2-g4bc9b9f+b2e40a4e47,21.0.0-2-g5242d73+a1c2f7fe71,21.0.0-2-g54e2caa+c00cf99ed0,21.0.0-2-g66bcc37+27b9d7859a,21.0.0-2-g7f82c8f+203cf74700,21.0.0-2-g8dde007+b0df52bfdd,21.0.0-2-g8f08a60+73884b2cf5,21.0.0-2-ga326454+203cf74700,21.0.0-2-ga63a54e+eec04437aa,21.0.0-2-gc738bc1+59028256f4,21.0.0-2-gde069b7+5a8f2956b8,21.0.0-2-ge17e5af+a1c2f7fe71,21.0.0-2-ge712728+9ad031c87e,21.0.0-2-gecfae73+d3766aec80,21.0.0-2-gfc62afb+a1c2f7fe71,21.0.0-20-g4449a12+38dfb87bce,21.0.0-22-gf0532904+afb8e7912b,21.0.0-3-g4c5b185+a403cb96fd,21.0.0-3-g6d51c4a+27b9d7859a,21.0.0-3-g8076721+e873df194c,21.0.0-3-gaa929c8+df5d87f43a,21.0.0-3-gd222c45+afc8332dbe,21.0.0-4-g1383c07+27b9d7859a,21.0.0-4-g3300ddd+1b62c9342b,21.0.0-4-g5873dc9+9a92674037,21.0.0-4-g8a80011+f67daf2f53,21.0.0-5-gcff38f6+bce43c5818,21.0.0-6-g463d161+44134145d4,21.0.0-6-gd3283ba+df5d87f43a,21.0.0-8-g19111d86+d6551531e4,w.2021.04
LSSTDataManagementBasePackage
Public Member Functions | Static Public Attributes | List of all members
lsst.fgcmcal.fgcmFitCycle.FgcmFitCycleConfig Class Reference
Inheritance diagram for lsst.fgcmcal.fgcmFitCycle.FgcmFitCycleConfig:

Public Member Functions

def setDefaults (self)
 
def validate (self)
 

Static Public Attributes

 bands
 
 fitFlag
 
 fitBands
 
 requiredFlag
 
 requiredBands
 
 filterMap
 
 doReferenceCalibration
 
 refStarSnMin
 
 refStarOutlierNSig
 
 applyRefStarColorCuts
 
 nCore
 
 nStarPerRun
 
 nExpPerRun
 
 reserveFraction
 
 freezeStdAtmosphere
 
 precomputeSuperStarInitialCycle
 
 superStarSubCcd
 
 superStarSubCcdDict
 
 superStarSubCcdChebyshevOrder
 
 superStarSubCcdTriangular
 
 superStarSigmaClip
 
 focalPlaneSigmaClip
 
 ccdGraySubCcd
 
 ccdGraySubCcdDict
 
 ccdGraySubCcdChebyshevOrder
 
 ccdGraySubCcdTriangular
 
 ccdGrayFocalPlaneDict
 
 ccdGrayFocalPlaneFitMinCcd
 
 ccdGrayFocalPlaneChebyshevOrder
 
 cycleNumber
 
 isFinalCycle
 
 maxIterBeforeFinalCycle
 
 deltaMagBkgOffsetPercentile
 
 deltaMagBkgPerCcd
 
 utBoundary
 
 washMjds
 
 epochMjds
 
 minObsPerBand
 
 latitude
 
 brightObsGrayMax
 
 minStarPerCcd
 
 minCcdPerExp
 
 maxCcdGrayErr
 
 minStarPerExp
 
 minExpPerNight
 
 expGrayInitialCut
 
 expGrayPhotometricCut
 
 expGrayPhotometricCutDict
 
 expGrayHighCut
 
 expGrayHighCutDict
 
 expGrayRecoverCut
 
 expVarGrayPhotometricCut
 
 expVarGrayPhotometricCutDict
 
 expGrayErrRecoverCut
 
 aperCorrFitNBins
 
 aperCorrInputSlopes
 
 aperCorrInputSlopeDict
 
 sedFudgeFactors
 
 sedboundaryterms
 
 sedterms
 
 sigFgcmMaxErr
 
 sigFgcmMaxEGray
 
 sigFgcmMaxEGrayDict
 
 ccdGrayMaxStarErr
 
 approxThroughput
 
 approxThroughputDict
 
 sigmaCalRange
 
 sigmaCalFitPercentile
 
 sigmaCalPlotPercentile
 
 sigma0Phot
 
 mapLongitudeRef
 
 mapNSide
 
 outfileBase
 
 starColorCuts
 
 colorSplitIndices
 
 colorSplitBands
 
 modelMagErrors
 
 useQuadraticPwv
 
 instrumentParsPerBand
 
 instrumentSlopeMinDeltaT
 
 fitMirrorChromaticity
 
 coatingMjds
 
 outputStandardsBeforeFinalCycle
 
 outputZeropointsBeforeFinalCycle
 
 useRepeatabilityForExpGrayCuts
 
 useRepeatabilityForExpGrayCutsDict
 
 autoPhotometricCutNSig
 
 autoHighCutNSig
 
 quietMode
 
 randomSeed
 

Detailed Description

Config for FgcmFitCycle

Definition at line 57 of file fgcmFitCycle.py.

Member Function Documentation

◆ setDefaults()

def lsst.fgcmcal.fgcmFitCycle.FgcmFitCycleConfig.setDefaults (   self)

Definition at line 634 of file fgcmFitCycle.py.

634  def setDefaults(self):
635  pass
636 

◆ validate()

def lsst.fgcmcal.fgcmFitCycle.FgcmFitCycleConfig.validate (   self)

Definition at line 637 of file fgcmFitCycle.py.

637  def validate(self):
638  super().validate()
639 
640  for band in self.fitBands:
641  if band not in self.bands:
642  msg = 'fitBand %s not in bands' % (band)
643  raise pexConfig.FieldValidationError(FgcmFitCycleConfig.fitBands, self, msg)
644  for band in self.requiredBands:
645  if band not in self.bands:
646  msg = 'requiredBand %s not in bands' % (band)
647  raise pexConfig.FieldValidationError(FgcmFitCycleConfig.requiredBands, self, msg)
648  for band in self.colorSplitBands:
649  if band not in self.bands:
650  msg = 'colorSplitBand %s not in bands' % (band)
651  raise pexConfig.FieldValidationError(FgcmFitCycleConfig.colorSplitBands, self, msg)
652  for band in self.bands:
653  if band not in self.superStarSubCcdDict:
654  msg = 'band %s not in superStarSubCcdDict' % (band)
655  raise pexConfig.FieldValidationError(FgcmFitCycleConfig.superStarSubCcdDict,
656  self, msg)
657  if band not in self.ccdGraySubCcdDict:
658  msg = 'band %s not in ccdGraySubCcdDict' % (band)
659  raise pexConfig.FieldValidationError(FgcmFitCycleConfig.ccdGraySubCcdDict,
660  self, msg)
661  if band not in self.expGrayPhotometricCutDict:
662  msg = 'band %s not in expGrayPhotometricCutDict' % (band)
663  raise pexConfig.FieldValidationError(FgcmFitCycleConfig.expGrayPhotometricCutDict,
664  self, msg)
665  if band not in self.expGrayHighCutDict:
666  msg = 'band %s not in expGrayHighCutDict' % (band)
667  raise pexConfig.FieldValidationError(FgcmFitCycleConfig.expGrayHighCutDict,
668  self, msg)
669  if band not in self.expVarGrayPhotometricCutDict:
670  msg = 'band %s not in expVarGrayPhotometricCutDict' % (band)
671  raise pexConfig.FieldValidationError(FgcmFitCycleConfig.expVarGrayPhotometricCutDict,
672  self, msg)
673  if band not in self.sigFgcmMaxEGrayDict:
674  msg = 'band %s not in sigFgcmMaxEGrayDict' % (band)
675  raise pexConfig.FieldValidationError(FgcmFitCycleConfig.sigFgcmMaxEGrayDict,
676  self, msg)
677  if band not in self.approxThroughputDict:
678  msg = 'band %s not in approxThroughputDict' % (band)
679  raise pexConfig.FieldValidationError(FgcmFitCycleConfig.approxThroughputDict,
680  self, msg)
681  if band not in self.useRepeatabilityForExpGrayCutsDict:
682  msg = 'band %s not in useRepeatabilityForExpGrayCutsDict' % (band)
683  raise pexConfig.FieldValidationError(FgcmFitCycleConfig.useRepeatabilityForExpGrayCutsDict,
684  self, msg)
685 
686 

Member Data Documentation

◆ aperCorrFitNBins

lsst.fgcmcal.fgcmFitCycle.FgcmFitCycleConfig.aperCorrFitNBins
static
Initial value:
= pexConfig.Field(
doc=("Number of aperture bins used in aperture correction fit. When set to 0"
"no fit will be performed, and the config.aperCorrInputSlopes will be "
"used if available."),
dtype=int,
default=10,
)

Definition at line 401 of file fgcmFitCycle.py.

◆ aperCorrInputSlopeDict

lsst.fgcmcal.fgcmFitCycle.FgcmFitCycleConfig.aperCorrInputSlopeDict
static
Initial value:
= pexConfig.DictField(
doc=("Per-band specification of aperture correction input slope parameters. These "
"are used on the first fit iteration, and aperture correction parameters will "
"be updated from the data if config.aperCorrFitNBins > 0. It is recommended "
"to set this when there is insufficient data to fit the parameters (e.g. "
"tract mode)."),
keytype=str,
itemtype=float,
default={},
)

Definition at line 420 of file fgcmFitCycle.py.

◆ aperCorrInputSlopes

lsst.fgcmcal.fgcmFitCycle.FgcmFitCycleConfig.aperCorrInputSlopes
static
Initial value:
= pexConfig.ListField(
doc=("Aperture correction input slope parameters. These are used on the first "
"fit iteration, and aperture correction parameters will be updated from "
"the data if config.aperCorrFitNBins > 0. It is recommended to set this"
"when there is insufficient data to fit the parameters (e.g. tract mode). "
"If set, must be same length as config.bands, and matched band-by-band."),
dtype=float,
default=[],
optional=True,
deprecated=("This field is no longer used, and has been deprecated by DM-23699. "
"It will be removed after v20. Use aperCorrInputSlopeDict instead."),
)

Definition at line 408 of file fgcmFitCycle.py.

◆ applyRefStarColorCuts

lsst.fgcmcal.fgcmFitCycle.FgcmFitCycleConfig.applyRefStarColorCuts
static
Initial value:
= pexConfig.Field(
doc="Apply color cuts to reference stars?",
dtype=bool,
default=True,
)

Definition at line 121 of file fgcmFitCycle.py.

◆ approxThroughput

lsst.fgcmcal.fgcmFitCycle.FgcmFitCycleConfig.approxThroughput
static
Initial value:
= pexConfig.ListField(
doc=("Approximate overall throughput at start of calibration observations. "
"May be 1 element (same for all bands) or the same length as config.bands."),
dtype=float,
default=(1.0, ),
optional=True,
deprecated=("This field is no longer used, and has been deprecated by DM-23699. "
"It will be removed after v20. Use approxThroughputDict instead."),
)

Definition at line 475 of file fgcmFitCycle.py.

◆ approxThroughputDict

lsst.fgcmcal.fgcmFitCycle.FgcmFitCycleConfig.approxThroughputDict
static
Initial value:
= pexConfig.DictField(
doc=("Per-band specification of the approximate overall throughput at the start of "
"calibration observations. Must have one entry per band. Typically should "
"be 1.0."),
keytype=str,
itemtype=float,
default={},
)

Definition at line 484 of file fgcmFitCycle.py.

◆ autoHighCutNSig

lsst.fgcmcal.fgcmFitCycle.FgcmFitCycleConfig.autoHighCutNSig
static
Initial value:
= pexConfig.Field(
doc=("Number of sigma for automatic computation of (high) outlier cut. "
"Cut is based on exposure gray width (per band), unless "
"useRepeatabilityForExpGrayCuts is set, in which case the star "
"repeatability is used (also per band)."),
dtype=float,
default=4.0,
)

Definition at line 614 of file fgcmFitCycle.py.

◆ autoPhotometricCutNSig

lsst.fgcmcal.fgcmFitCycle.FgcmFitCycleConfig.autoPhotometricCutNSig
static
Initial value:
= pexConfig.Field(
doc=("Number of sigma for automatic computation of (low) photometric cut. "
"Cut is based on exposure gray width (per band), unless "
"useRepeatabilityForExpGrayCuts is set, in which case the star "
"repeatability is used (also per band)."),
dtype=float,
default=3.0,
)

Definition at line 606 of file fgcmFitCycle.py.

◆ bands

lsst.fgcmcal.fgcmFitCycle.FgcmFitCycleConfig.bands
static
Initial value:
= pexConfig.ListField(
doc="Bands to run calibration",
dtype=str,
default=[],
)

Definition at line 60 of file fgcmFitCycle.py.

◆ brightObsGrayMax

lsst.fgcmcal.fgcmFitCycle.FgcmFitCycleConfig.brightObsGrayMax
static
Initial value:
= pexConfig.Field(
doc="Maximum gray extinction to be considered bright observation",
dtype=float,
default=0.15,
)

Definition at line 297 of file fgcmFitCycle.py.

◆ ccdGrayFocalPlaneChebyshevOrder

lsst.fgcmcal.fgcmFitCycle.FgcmFitCycleConfig.ccdGrayFocalPlaneChebyshevOrder
static
Initial value:
= pexConfig.Field(
doc="Order of the 2D chebyshev polynomials for focal plane fit.",
dtype=int,
default=3,
)

Definition at line 234 of file fgcmFitCycle.py.

◆ ccdGrayFocalPlaneDict

lsst.fgcmcal.fgcmFitCycle.FgcmFitCycleConfig.ccdGrayFocalPlaneDict
static
Initial value:
= pexConfig.DictField(
doc=("Per-band specification on whether to compute focal-plane residual "
"('ccd gray') corrections."),
keytype=str,
itemtype=bool,
default={},
)

Definition at line 220 of file fgcmFitCycle.py.

◆ ccdGrayFocalPlaneFitMinCcd

lsst.fgcmcal.fgcmFitCycle.FgcmFitCycleConfig.ccdGrayFocalPlaneFitMinCcd
static
Initial value:
= pexConfig.Field(
doc=("Minimum number of 'good' CCDs required to perform focal-plane "
"gray corrections. If there are fewer good CCDs then the gray "
"correction is computed per-ccd."),
dtype=int,
default=1,
)

Definition at line 227 of file fgcmFitCycle.py.

◆ ccdGrayMaxStarErr

lsst.fgcmcal.fgcmFitCycle.FgcmFitCycleConfig.ccdGrayMaxStarErr
static
Initial value:
= pexConfig.Field(
doc=("Maximum error on a star observation to use in ccd gray (achromatic residual) "
"computation"),
dtype=float,
default=0.10,
)

Definition at line 469 of file fgcmFitCycle.py.

◆ ccdGraySubCcd

lsst.fgcmcal.fgcmFitCycle.FgcmFitCycleConfig.ccdGraySubCcd
static
Initial value:
= pexConfig.Field(
doc="Compute CCD gray terms on sub-ccd scale",
dtype=bool,
default=False,
optional=True,
deprecated=("This field is no longer used, and has been deprecated by DM-23699. "
"It will be removed after v20. Use ccdGraySubCcdDict instead."),
)

Definition at line 194 of file fgcmFitCycle.py.

◆ ccdGraySubCcdChebyshevOrder

lsst.fgcmcal.fgcmFitCycle.FgcmFitCycleConfig.ccdGraySubCcdChebyshevOrder
static
Initial value:
= pexConfig.Field(
doc="Order of the 2D chebyshev polynomials for sub-ccd gray fit.",
dtype=int,
default=1,
)

Definition at line 209 of file fgcmFitCycle.py.

◆ ccdGraySubCcdDict

lsst.fgcmcal.fgcmFitCycle.FgcmFitCycleConfig.ccdGraySubCcdDict
static
Initial value:
= pexConfig.DictField(
doc=("Per-band specification on whether to compute achromatic per-ccd residual "
"('ccd gray') on a sub-ccd scale."),
keytype=str,
itemtype=bool,
default={},
)

Definition at line 202 of file fgcmFitCycle.py.

◆ ccdGraySubCcdTriangular

lsst.fgcmcal.fgcmFitCycle.FgcmFitCycleConfig.ccdGraySubCcdTriangular
static
Initial value:
= pexConfig.Field(
doc=("Should the sub-ccd gray chebyshev matrix be triangular to "
"suppress high-order cross terms?"),
dtype=bool,
default=True,
)

Definition at line 214 of file fgcmFitCycle.py.

◆ coatingMjds

lsst.fgcmcal.fgcmFitCycle.FgcmFitCycleConfig.coatingMjds
static
Initial value:
= pexConfig.ListField(
doc="Mirror coating dates in MJD",
dtype=float,
default=(0.0,),
)

Definition at line 574 of file fgcmFitCycle.py.

◆ colorSplitBands

lsst.fgcmcal.fgcmFitCycle.FgcmFitCycleConfig.colorSplitBands
static
Initial value:
= pexConfig.ListField(
doc="Band names to use to split stars by color. Must have 2 entries.",
dtype=str,
length=2,
default=('g', 'i'),
)

Definition at line 540 of file fgcmFitCycle.py.

◆ colorSplitIndices

lsst.fgcmcal.fgcmFitCycle.FgcmFitCycleConfig.colorSplitIndices
static
Initial value:
= pexConfig.ListField(
doc="Band indices to use to split stars by color",
dtype=int,
default=None,
optional=True,
deprecated=("This field is no longer used, and has been deprecated by DM-23699. "
"It will be removed after v20. Use colorSplitBands instead."),
)

Definition at line 532 of file fgcmFitCycle.py.

◆ cycleNumber

lsst.fgcmcal.fgcmFitCycle.FgcmFitCycleConfig.cycleNumber
static
Initial value:
= pexConfig.Field(
doc=("FGCM fit cycle number. This is automatically incremented after each run "
"and stage of outlier rejection. See cookbook for details."),
dtype=int,
default=None,
)

Definition at line 239 of file fgcmFitCycle.py.

◆ deltaMagBkgOffsetPercentile

lsst.fgcmcal.fgcmFitCycle.FgcmFitCycleConfig.deltaMagBkgOffsetPercentile
static
Initial value:
= pexConfig.Field(
doc=("Percentile brightest stars on a visit/ccd to use to compute net "
"offset from local background subtraction."),
dtype=float,
default=0.25,
)

Definition at line 258 of file fgcmFitCycle.py.

◆ deltaMagBkgPerCcd

lsst.fgcmcal.fgcmFitCycle.FgcmFitCycleConfig.deltaMagBkgPerCcd
static
Initial value:
= pexConfig.Field(
doc=("Compute net offset from local background subtraction per-ccd? "
"Otherwise, use computation per visit."),
dtype=bool,
default=False,
)

Definition at line 264 of file fgcmFitCycle.py.

◆ doReferenceCalibration

lsst.fgcmcal.fgcmFitCycle.FgcmFitCycleConfig.doReferenceCalibration
static
Initial value:
= pexConfig.Field(
doc="Use reference catalog as additional constraint on calibration",
dtype=bool,
default=True,
)

Definition at line 105 of file fgcmFitCycle.py.

◆ epochMjds

lsst.fgcmcal.fgcmFitCycle.FgcmFitCycleConfig.epochMjds
static
Initial value:
= pexConfig.ListField(
doc="Epoch boundaries in MJD",
dtype=float,
default=(0.0,),
)

Definition at line 280 of file fgcmFitCycle.py.

◆ expGrayErrRecoverCut

lsst.fgcmcal.fgcmFitCycle.FgcmFitCycleConfig.expGrayErrRecoverCut
static
Initial value:
= pexConfig.Field(
doc=("Maximum exposure gray error to be able to recover bad ccds via interpolation. "
"Visits with more gray variance will only get CCD zeropoints if there are "
"sufficient star observations (minStarPerCcd) on that CCD."),
dtype=float,
default=0.05,
)

Definition at line 394 of file fgcmFitCycle.py.

◆ expGrayHighCut

lsst.fgcmcal.fgcmFitCycle.FgcmFitCycleConfig.expGrayHighCut
static
Initial value:
= pexConfig.ListField(
doc=("Maximum (positive) exposure gray for a visit to be considered photometric. "
"Must be same length as config.bands, and matched band-by-band."),
dtype=float,
default=(0.0,),
optional=True,
deprecated=("This field is no longer used, and has been deprecated by DM-23699. "
"It will be removed after v20. Use expGrayHighCutDict instead."),
)

Definition at line 354 of file fgcmFitCycle.py.

◆ expGrayHighCutDict

lsst.fgcmcal.fgcmFitCycle.FgcmFitCycleConfig.expGrayHighCutDict
static
Initial value:
= pexConfig.DictField(
doc=("Per-band specification on maximum (positive) achromatic exposure residual "
"('gray term') for a visit to be considered photometric. Must have one "
"entry per band. Broad-band filters should be 0.2."),
keytype=str,
itemtype=float,
default={},
)

Definition at line 363 of file fgcmFitCycle.py.

◆ expGrayInitialCut

lsst.fgcmcal.fgcmFitCycle.FgcmFitCycleConfig.expGrayInitialCut
static
Initial value:
= pexConfig.Field(
doc=("Maximum exposure/visit gray value for initial selection of possible photometric "
"observations."),
dtype=float,
default=-0.25,
)

Definition at line 331 of file fgcmFitCycle.py.

◆ expGrayPhotometricCut

lsst.fgcmcal.fgcmFitCycle.FgcmFitCycleConfig.expGrayPhotometricCut
static
Initial value:
= pexConfig.ListField(
doc=("Maximum (negative) exposure gray for a visit to be considered photometric. "
"Must be same length as config.bands, and matched band-by-band."),
dtype=float,
default=(0.0,),
optional=True,
deprecated=("This field is no longer used, and has been deprecated by DM-23699. "
"It will be removed after v20. Use expGrayPhotometricCutDict instead."),
)

Definition at line 337 of file fgcmFitCycle.py.

◆ expGrayPhotometricCutDict

lsst.fgcmcal.fgcmFitCycle.FgcmFitCycleConfig.expGrayPhotometricCutDict
static
Initial value:
= pexConfig.DictField(
doc=("Per-band specification on maximum (negative) achromatic exposure residual "
"('gray term') for a visit to be considered photometric. Must have one "
"entry per band. Broad-band filters should be -0.05."),
keytype=str,
itemtype=float,
default={},
)

Definition at line 346 of file fgcmFitCycle.py.

◆ expGrayRecoverCut

lsst.fgcmcal.fgcmFitCycle.FgcmFitCycleConfig.expGrayRecoverCut
static
Initial value:
= pexConfig.Field(
doc=("Maximum (negative) exposure gray to be able to recover bad ccds via interpolation. "
"Visits with more gray extinction will only get CCD zeropoints if there are "
"sufficient star observations (minStarPerCcd) on that CCD."),
dtype=float,
default=-1.0,
)

Definition at line 371 of file fgcmFitCycle.py.

◆ expVarGrayPhotometricCut

lsst.fgcmcal.fgcmFitCycle.FgcmFitCycleConfig.expVarGrayPhotometricCut
static
Initial value:
= pexConfig.Field(
doc="Maximum exposure variance to be considered possibly photometric",
dtype=float,
default=0.0005,
optional=True,
deprecated=("This field is no longer used, and has been deprecated by DM-23699. "
"It will be removed after v20. Use expVarGrayPhotometricCutDict instead."),
)

Definition at line 378 of file fgcmFitCycle.py.

◆ expVarGrayPhotometricCutDict

lsst.fgcmcal.fgcmFitCycle.FgcmFitCycleConfig.expVarGrayPhotometricCutDict
static
Initial value:
= pexConfig.DictField(
doc=("Per-band specification on maximum exposure variance to be considered possibly "
"photometric. Must have one entry per band. Broad-band filters should be "
"0.0005."),
keytype=str,
itemtype=float,
default={},
)

Definition at line 386 of file fgcmFitCycle.py.

◆ filterMap

lsst.fgcmcal.fgcmFitCycle.FgcmFitCycleConfig.filterMap
static
Initial value:
= pexConfig.DictField(
doc="Mapping from 'filterName' to band.",
keytype=str,
itemtype=str,
default={},
)

Definition at line 99 of file fgcmFitCycle.py.

◆ fitBands

lsst.fgcmcal.fgcmFitCycle.FgcmFitCycleConfig.fitBands
static
Initial value:
= pexConfig.ListField(
doc=("Bands to use in atmospheric fit. The bands not listed here will have "
"the atmosphere constrained from the 'fitBands' on the same night. "
"Must be a subset of `config.bands`"),
dtype=str,
default=[],
)

Definition at line 76 of file fgcmFitCycle.py.

◆ fitFlag

lsst.fgcmcal.fgcmFitCycle.FgcmFitCycleConfig.fitFlag
static
Initial value:
= pexConfig.ListField(
doc=("Flag for which bands are directly constrained in the FGCM fit. "
"Bands set to 0 will have the atmosphere constrained from observations "
"in other bands on the same night. Must be same length as config.bands, "
"and matched band-by-band."),
dtype=int,
default=(0,),
optional=True,
deprecated=("This field is no longer used, and has been deprecated by DM-23699. "
"It will be removed after v20. Use fitBands instead."),
)

Definition at line 65 of file fgcmFitCycle.py.

◆ fitMirrorChromaticity

lsst.fgcmcal.fgcmFitCycle.FgcmFitCycleConfig.fitMirrorChromaticity
static
Initial value:
= pexConfig.Field(
doc="Fit (intraband) mirror chromatic term?",
dtype=bool,
default=False,
)

Definition at line 569 of file fgcmFitCycle.py.

◆ focalPlaneSigmaClip

lsst.fgcmcal.fgcmFitCycle.FgcmFitCycleConfig.focalPlaneSigmaClip
static
Initial value:
= pexConfig.Field(
doc="Number of sigma to clip outliers per focal-plane.",
dtype=float,
default=4.0,
)

Definition at line 189 of file fgcmFitCycle.py.

◆ freezeStdAtmosphere

lsst.fgcmcal.fgcmFitCycle.FgcmFitCycleConfig.freezeStdAtmosphere
static
Initial value:
= pexConfig.Field(
doc="Freeze atmosphere parameters to standard (for testing)",
dtype=bool,
default=False,
)

Definition at line 146 of file fgcmFitCycle.py.

◆ instrumentParsPerBand

lsst.fgcmcal.fgcmFitCycle.FgcmFitCycleConfig.instrumentParsPerBand
static
Initial value:
= pexConfig.Field(
doc=("Model instrumental parameters per band? "
"Otherwise, instrumental parameters (QE changes with time) are "
"shared among all bands."),
dtype=bool,
default=False,
)

Definition at line 556 of file fgcmFitCycle.py.

◆ instrumentSlopeMinDeltaT

lsst.fgcmcal.fgcmFitCycle.FgcmFitCycleConfig.instrumentSlopeMinDeltaT
static
Initial value:
= pexConfig.Field(
doc=("Minimum time change (in days) between observations to use in constraining "
"instrument slope."),
dtype=float,
default=20.0,
)

Definition at line 563 of file fgcmFitCycle.py.

◆ isFinalCycle

lsst.fgcmcal.fgcmFitCycle.FgcmFitCycleConfig.isFinalCycle
static
Initial value:
= pexConfig.Field(
doc=("Is this the final cycle of the fitting? Will automatically compute final "
"selection of stars and photometric exposures, and will output zeropoints "
"and standard stars for use in fgcmOutputProducts"),
dtype=bool,
default=False,
)

Definition at line 245 of file fgcmFitCycle.py.

◆ latitude

lsst.fgcmcal.fgcmFitCycle.FgcmFitCycleConfig.latitude
static
Initial value:
= pexConfig.Field(
doc="Observatory latitude",
dtype=float,
default=None,
)

Definition at line 292 of file fgcmFitCycle.py.

◆ mapLongitudeRef

lsst.fgcmcal.fgcmFitCycle.FgcmFitCycleConfig.mapLongitudeRef
static
Initial value:
= pexConfig.Field(
doc="Reference longitude for plotting maps",
dtype=float,
default=0.0,
)

Definition at line 512 of file fgcmFitCycle.py.

◆ mapNSide

lsst.fgcmcal.fgcmFitCycle.FgcmFitCycleConfig.mapNSide
static
Initial value:
= pexConfig.Field(
doc="Healpix nside for plotting maps",
dtype=int,
default=256,
)

Definition at line 517 of file fgcmFitCycle.py.

◆ maxCcdGrayErr

lsst.fgcmcal.fgcmFitCycle.FgcmFitCycleConfig.maxCcdGrayErr
static
Initial value:
= pexConfig.Field(
doc="Maximum error on CCD gray offset to be considered photometric",
dtype=float,
default=0.05,
)

Definition at line 315 of file fgcmFitCycle.py.

◆ maxIterBeforeFinalCycle

lsst.fgcmcal.fgcmFitCycle.FgcmFitCycleConfig.maxIterBeforeFinalCycle
static
Initial value:
= pexConfig.Field(
doc=("Maximum fit iterations, prior to final cycle. The number of iterations "
"will always be 0 in the final cycle for cleanup and final selection."),
dtype=int,
default=50,
)

Definition at line 252 of file fgcmFitCycle.py.

◆ minCcdPerExp

lsst.fgcmcal.fgcmFitCycle.FgcmFitCycleConfig.minCcdPerExp
static
Initial value:
= pexConfig.Field(
doc=("Minimum number of good CCDs per exposure/visit to be used in calibration fit. "
"Visits with fewer good CCDs will have CCD zeropoints estimated where possible."),
dtype=int,
default=5,
)

Definition at line 309 of file fgcmFitCycle.py.

◆ minExpPerNight

lsst.fgcmcal.fgcmFitCycle.FgcmFitCycleConfig.minExpPerNight
static
Initial value:
= pexConfig.Field(
doc="Minimum number of good exposures/visits to consider a partly photometric night",
dtype=int,
default=10,
)

Definition at line 326 of file fgcmFitCycle.py.

◆ minObsPerBand

lsst.fgcmcal.fgcmFitCycle.FgcmFitCycleConfig.minObsPerBand
static
Initial value:
= pexConfig.Field(
doc="Minimum good observations per band",
dtype=int,
default=2,
)

Definition at line 285 of file fgcmFitCycle.py.

◆ minStarPerCcd

lsst.fgcmcal.fgcmFitCycle.FgcmFitCycleConfig.minStarPerCcd
static
Initial value:
= pexConfig.Field(
doc=("Minimum number of good stars per CCD to be used in calibration fit. "
"CCDs with fewer stars will have their calibration estimated from other "
"CCDs in the same visit, with zeropoint error increased accordingly."),
dtype=int,
default=5,
)

Definition at line 302 of file fgcmFitCycle.py.

◆ minStarPerExp

lsst.fgcmcal.fgcmFitCycle.FgcmFitCycleConfig.minStarPerExp
static
Initial value:
= pexConfig.Field(
doc=("Minimum number of good stars per exposure/visit to be used in calibration fit. "
"Visits with fewer good stars will have CCD zeropoints estimated where possible."),
dtype=int,
default=600,
)

Definition at line 320 of file fgcmFitCycle.py.

◆ modelMagErrors

lsst.fgcmcal.fgcmFitCycle.FgcmFitCycleConfig.modelMagErrors
static
Initial value:
= pexConfig.Field(
doc="Should FGCM model the magnitude errors from sky/fwhm? (False means trust inputs)",
dtype=bool,
default=True,
)

Definition at line 546 of file fgcmFitCycle.py.

◆ nCore

lsst.fgcmcal.fgcmFitCycle.FgcmFitCycleConfig.nCore
static
Initial value:
= pexConfig.Field(
doc="Number of cores to use",
dtype=int,
default=4,
)

Definition at line 126 of file fgcmFitCycle.py.

◆ nExpPerRun

lsst.fgcmcal.fgcmFitCycle.FgcmFitCycleConfig.nExpPerRun
static
Initial value:
= pexConfig.Field(
doc="Number of exposures to run in each chunk",
dtype=int,
default=1000,
)

Definition at line 136 of file fgcmFitCycle.py.

◆ nStarPerRun

lsst.fgcmcal.fgcmFitCycle.FgcmFitCycleConfig.nStarPerRun
static
Initial value:
= pexConfig.Field(
doc="Number of stars to run in each chunk",
dtype=int,
default=200000,
)

Definition at line 131 of file fgcmFitCycle.py.

◆ outfileBase

lsst.fgcmcal.fgcmFitCycle.FgcmFitCycleConfig.outfileBase
static
Initial value:
= pexConfig.Field(
doc="Filename start for plot output files",
dtype=str,
default=None,
)

Definition at line 522 of file fgcmFitCycle.py.

◆ outputStandardsBeforeFinalCycle

lsst.fgcmcal.fgcmFitCycle.FgcmFitCycleConfig.outputStandardsBeforeFinalCycle
static
Initial value:
= pexConfig.Field(
doc="Output standard stars prior to final cycle? Used in debugging.",
dtype=bool,
default=False,
)

Definition at line 579 of file fgcmFitCycle.py.

◆ outputZeropointsBeforeFinalCycle

lsst.fgcmcal.fgcmFitCycle.FgcmFitCycleConfig.outputZeropointsBeforeFinalCycle
static
Initial value:
= pexConfig.Field(
doc="Output standard stars prior to final cycle? Used in debugging.",
dtype=bool,
default=False,
)

Definition at line 584 of file fgcmFitCycle.py.

◆ precomputeSuperStarInitialCycle

lsst.fgcmcal.fgcmFitCycle.FgcmFitCycleConfig.precomputeSuperStarInitialCycle
static
Initial value:
= pexConfig.Field(
doc="Precompute superstar flat for initial cycle",
dtype=bool,
default=False,
)

Definition at line 151 of file fgcmFitCycle.py.

◆ quietMode

lsst.fgcmcal.fgcmFitCycle.FgcmFitCycleConfig.quietMode
static
Initial value:
= pexConfig.Field(
doc="Be less verbose with logging.",
dtype=bool,
default=False,
)

Definition at line 622 of file fgcmFitCycle.py.

◆ randomSeed

lsst.fgcmcal.fgcmFitCycle.FgcmFitCycleConfig.randomSeed
static
Initial value:
= pexConfig.Field(
doc="Random seed for fgcm for consistency in tests.",
dtype=int,
default=None,
optional=True,
)

Definition at line 627 of file fgcmFitCycle.py.

◆ refStarOutlierNSig

lsst.fgcmcal.fgcmFitCycle.FgcmFitCycleConfig.refStarOutlierNSig
static
Initial value:
= pexConfig.Field(
doc=("Number of sigma compared to average mag for reference star to be considered an outlier. "
"Computed per-band, and if it is an outlier in any band it is rejected from fits."),
dtype=float,
default=4.0,
)

Definition at line 115 of file fgcmFitCycle.py.

◆ refStarSnMin

lsst.fgcmcal.fgcmFitCycle.FgcmFitCycleConfig.refStarSnMin
static
Initial value:
= pexConfig.Field(
doc="Reference star signal-to-noise minimum to use in calibration. Set to <=0 for no cut.",
dtype=float,
default=50.0,
)

Definition at line 110 of file fgcmFitCycle.py.

◆ requiredBands

lsst.fgcmcal.fgcmFitCycle.FgcmFitCycleConfig.requiredBands
static
Initial value:
= pexConfig.ListField(
doc=("Bands that are required for a star to be considered a calibration star. "
"Must be a subset of `config.bands`"),
dtype=str,
default=[],
)

Definition at line 93 of file fgcmFitCycle.py.

◆ requiredFlag

lsst.fgcmcal.fgcmFitCycle.FgcmFitCycleConfig.requiredFlag
static
Initial value:
= pexConfig.ListField(
doc=("Flag for which bands are required for a star to be considered a calibration "
"star in the FGCM fit. Typically this should be the same as fitFlag. Must "
"be same length as config.bands, and matched band-by-band."),
dtype=int,
default=(0,),
optional=True,
deprecated=("This field is no longer used, and has been deprecated by DM-23699. "
"It will be removed after v20. Use requiredBands instead."),
)

Definition at line 83 of file fgcmFitCycle.py.

◆ reserveFraction

lsst.fgcmcal.fgcmFitCycle.FgcmFitCycleConfig.reserveFraction
static
Initial value:
= pexConfig.Field(
doc="Fraction of stars to reserve for testing",
dtype=float,
default=0.1,
)

Definition at line 141 of file fgcmFitCycle.py.

◆ sedboundaryterms

lsst.fgcmcal.fgcmFitCycle.FgcmFitCycleConfig.sedboundaryterms
static
Initial value:
= pexConfig.ConfigField(
doc="Mapping from bands to SED boundary term names used is sedterms.",
dtype=SedboundarytermDict,
)

Definition at line 439 of file fgcmFitCycle.py.

◆ sedFudgeFactors

lsst.fgcmcal.fgcmFitCycle.FgcmFitCycleConfig.sedFudgeFactors
static
Initial value:
= pexConfig.ListField(
doc=("Fudge factors for computing linear SED from colors. Must be same length as "
"config.bands, and matched band-by-band."),
dtype=float,
default=(0,),
optional=True,
deprecated=("This field has been deprecated and will be removed after v20. "
"Please use sedSlopeTermMap and sedSlopeMap."),
)

Definition at line 430 of file fgcmFitCycle.py.

◆ sedterms

lsst.fgcmcal.fgcmFitCycle.FgcmFitCycleConfig.sedterms
static
Initial value:
= pexConfig.ConfigField(
doc="Mapping from terms to bands for fgcm linear SED approximations.",
dtype=SedtermDict,
)

Definition at line 443 of file fgcmFitCycle.py.

◆ sigFgcmMaxEGray

lsst.fgcmcal.fgcmFitCycle.FgcmFitCycleConfig.sigFgcmMaxEGray
static
Initial value:
= pexConfig.ListField(
doc=("Maximum (absolute) gray value for observation in sigma_FGCM. "
"May be 1 element (same for all bands) or the same length as config.bands."),
dtype=float,
default=(0.05,),
optional=True,
deprecated=("This field is no longer used, and has been deprecated by DM-23699. "
"It will be removed after v20. Use sigFgcmMaxEGrayDict instead."),
)

Definition at line 452 of file fgcmFitCycle.py.

◆ sigFgcmMaxEGrayDict

lsst.fgcmcal.fgcmFitCycle.FgcmFitCycleConfig.sigFgcmMaxEGrayDict
static
Initial value:
= pexConfig.DictField(
doc=("Per-band specification for maximum (absolute) achromatic residual (gray value) "
"for observations in sigma_fgcm (raw repeatability). Broad-band filters "
"should be 0.05."),
keytype=str,
itemtype=float,
default={},
)

Definition at line 461 of file fgcmFitCycle.py.

◆ sigFgcmMaxErr

lsst.fgcmcal.fgcmFitCycle.FgcmFitCycleConfig.sigFgcmMaxErr
static
Initial value:
= pexConfig.Field(
doc="Maximum mag error for fitting sigma_FGCM",
dtype=float,
default=0.01,
)

Definition at line 447 of file fgcmFitCycle.py.

◆ sigma0Phot

lsst.fgcmcal.fgcmFitCycle.FgcmFitCycleConfig.sigma0Phot
static
Initial value:
= pexConfig.Field(
doc="Systematic error floor for all zeropoints",
dtype=float,
default=0.003,
)

Definition at line 507 of file fgcmFitCycle.py.

◆ sigmaCalFitPercentile

lsst.fgcmcal.fgcmFitCycle.FgcmFitCycleConfig.sigmaCalFitPercentile
static
Initial value:
= pexConfig.ListField(
doc="Magnitude percentile range to fit systematic error floor",
dtype=float,
default=(0.05, 0.15),
)

Definition at line 497 of file fgcmFitCycle.py.

◆ sigmaCalPlotPercentile

lsst.fgcmcal.fgcmFitCycle.FgcmFitCycleConfig.sigmaCalPlotPercentile
static
Initial value:
= pexConfig.ListField(
doc="Magnitude percentile range to plot systematic error floor",
dtype=float,
default=(0.05, 0.95),
)

Definition at line 502 of file fgcmFitCycle.py.

◆ sigmaCalRange

lsst.fgcmcal.fgcmFitCycle.FgcmFitCycleConfig.sigmaCalRange
static
Initial value:
= pexConfig.ListField(
doc="Allowed range for systematic error floor estimation",
dtype=float,
default=(0.001, 0.003),
)

Definition at line 492 of file fgcmFitCycle.py.

◆ starColorCuts

lsst.fgcmcal.fgcmFitCycle.FgcmFitCycleConfig.starColorCuts
static
Initial value:
= pexConfig.ListField(
doc="Encoded star-color cuts (to be cleaned up)",
dtype=str,
default=("NO_DATA",),
)

Definition at line 527 of file fgcmFitCycle.py.

◆ superStarSigmaClip

lsst.fgcmcal.fgcmFitCycle.FgcmFitCycleConfig.superStarSigmaClip
static
Initial value:
= pexConfig.Field(
doc="Number of sigma to clip outliers when selecting for superstar flats",
dtype=float,
default=5.0,
)

Definition at line 184 of file fgcmFitCycle.py.

◆ superStarSubCcd

lsst.fgcmcal.fgcmFitCycle.FgcmFitCycleConfig.superStarSubCcd
static
Initial value:
= pexConfig.Field(
doc="Compute superstar flat on sub-ccd scale",
dtype=bool,
default=True,
optional=True,
deprecated=("This field is no longer used, and has been deprecated by DM-23699. "
"It will be removed after v20. Use superStarSubCcdDict instead."),
)

Definition at line 156 of file fgcmFitCycle.py.

◆ superStarSubCcdChebyshevOrder

lsst.fgcmcal.fgcmFitCycle.FgcmFitCycleConfig.superStarSubCcdChebyshevOrder
static
Initial value:
= pexConfig.Field(
doc=("Order of the 2D chebyshev polynomials for sub-ccd superstar fit. "
"Global default is first-order polynomials, and should be overridden "
"on a camera-by-camera basis depending on the ISR."),
dtype=int,
default=1,
)

Definition at line 171 of file fgcmFitCycle.py.

◆ superStarSubCcdDict

lsst.fgcmcal.fgcmFitCycle.FgcmFitCycleConfig.superStarSubCcdDict
static
Initial value:
= pexConfig.DictField(
doc=("Per-band specification on whether to compute superstar flat on sub-ccd scale. "
"Must have one entry per band."),
keytype=str,
itemtype=bool,
default={},
)

Definition at line 164 of file fgcmFitCycle.py.

◆ superStarSubCcdTriangular

lsst.fgcmcal.fgcmFitCycle.FgcmFitCycleConfig.superStarSubCcdTriangular
static
Initial value:
= pexConfig.Field(
doc=("Should the sub-ccd superstar chebyshev matrix be triangular to "
"suppress high-order cross terms?"),
dtype=bool,
default=False,
)

Definition at line 178 of file fgcmFitCycle.py.

◆ useQuadraticPwv

lsst.fgcmcal.fgcmFitCycle.FgcmFitCycleConfig.useQuadraticPwv
static
Initial value:
= pexConfig.Field(
doc="Model PWV with a quadratic term for variation through the night?",
dtype=bool,
default=False,
)

Definition at line 551 of file fgcmFitCycle.py.

◆ useRepeatabilityForExpGrayCuts

lsst.fgcmcal.fgcmFitCycle.FgcmFitCycleConfig.useRepeatabilityForExpGrayCuts
static
Initial value:
= pexConfig.ListField(
doc=("Use star repeatability (instead of exposures) for computing photometric "
"cuts? Recommended for tract mode or bands with few exposures. "
"May be 1 element (same for all bands) or the same length as config.bands."),
dtype=bool,
default=(False,),
optional=True,
deprecated=("This field is no longer used, and has been deprecated by DM-23699. "
"It will be removed after v20. Use useRepeatabilityForExpGrayCutsDict instead."),
)

Definition at line 589 of file fgcmFitCycle.py.

◆ useRepeatabilityForExpGrayCutsDict

lsst.fgcmcal.fgcmFitCycle.FgcmFitCycleConfig.useRepeatabilityForExpGrayCutsDict
static
Initial value:
= pexConfig.DictField(
doc=("Per-band specification on whether to use star repeatability (instead of exposures) "
"for computing photometric cuts. Recommended for tract mode or bands with few visits."),
keytype=str,
itemtype=bool,
default={},
)

Definition at line 599 of file fgcmFitCycle.py.

◆ utBoundary

lsst.fgcmcal.fgcmFitCycle.FgcmFitCycleConfig.utBoundary
static
Initial value:
= pexConfig.Field(
doc="Boundary (in UTC) from day-to-day",
dtype=float,
default=None,
)

Definition at line 270 of file fgcmFitCycle.py.

◆ washMjds

lsst.fgcmcal.fgcmFitCycle.FgcmFitCycleConfig.washMjds
static
Initial value:
= pexConfig.ListField(
doc="Mirror wash MJDs",
dtype=float,
default=(0.0,),
)

Definition at line 275 of file fgcmFitCycle.py.


The documentation for this class was generated from the following file:
lsst.pex.config.wrap.setDefaults
setDefaults
Definition: wrap.py:293
lsst.pex.config.wrap.validate
validate
Definition: wrap.py:295