FgcmFitCycleTask¶
FgcmFitCycleTask is the task to run the fgcm fit from star observations generated from FgcmBuildFromIsolatedStarsTask or lsst.fgcmcal.fgcmBuildStars.FgcmBuildStarsTask using the look-up table generated from FgcmMakeLutTask.
This code can either be run one “fit cycle” at a time (useful for development/testing) or all together (if config.doMultipleCycles = True.
The final “fit cycle” is a cleanup that does not fit atmosphere or model parameters, but instead generates the final tables required for input to FgcmOutputProductsTask.
This task will produce a large number of QA plots which will be put into the butler with names following the template fgcm_Cycle{N}_{Name}_Plot.
This template makes it easy to see all the plots from a single fit cycle sorted together.
By default, only QA plots from the final two fit cycles (the next-to-last cycle is a full fit and the last cycle is the post-fit cleanup) will be output, unless config.doPlotsBeforeFinalCycles = True.
The plots can either be accessed via a dedicated interface to butler plots, or they may be downloaded to the current directory with the following butler command:
butler retrieve-artifacts REPO ./ --collections COLLECTION -d "fgcm_CycleN_*_Plot" --no-preserve-path
This is the third task in a typical fgcmcal processing chain. The first is FgcmMakeLutTask, the second is FgcmBuildFromIsolatedStarsTask, and the fourth is FgcmOutputProductsTask.
Processing summary¶
FgcmFitCycleTask reads in the star observations and the look-up table, performs an atmosphere and instrument fit, and outputs fit parameters as well as a comprehensive list of QA plots.
If the config option config.isFinalCycle = True then additional datafiles are output that are used by FgcmOutputProductsTask.
This is set automatically when config.doMultipleCycles = True.
In single-cycle mode, FgcmFitCycleTask will output a new config file in the current working directory with recommended settings for the subsequent fit cycle.
Python API summary¶
from lsst.fgcmcal.fgcmFitCycle import FgcmFitCycleTask
-
class
FgcmFitCycleTask(initInputs=None, **kwargs) Run Single fit cycle for FGCM global calibration
...
- attributeconfig
Access configuration fields and retargetable subtasks.
See also
See the FgcmFitCycleTask API reference for complete details.
Retargetable subtasks¶
No subtasks.
Configuration fields¶
aperCorrFitNBins¶
Number of aperture bins used in aperture correction fit. When set to 0no fit will be performed, and the config.aperCorrInputSlopes will be used if available.
aperCorrInputSlopeDict¶
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).
applyRefStarColorCuts¶
Apply color cuts defined in starColorCuts to reference stars? These cuts are in addition to any cuts defined in refStarColorCuts
approxThroughputDict¶
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.
autoHighCutNSig¶
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).
autoPhotometricCutNSig¶
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).
bands¶
Bands to run calibration
brightObsGrayMax¶
Maximum gray extinction to be considered bright observation
ccdGrayFocalPlaneChebyshevOrder¶
Order of the 2D chebyshev polynomials for focal plane fit.
ccdGrayFocalPlaneDict¶
Per-band specification on whether to compute focal-plane residual (‘ccd gray’) corrections.
ccdGrayFocalPlaneFitMinCcd¶
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.
ccdGrayMaxStarErr¶
Maximum error on a star observation to use in ccd gray (achromatic residual) computation
ccdGraySubCcdChebyshevOrder¶
Order of the 2D chebyshev polynomials for sub-ccd gray fit.
ccdGraySubCcdDict¶
Per-band specification on whether to compute achromatic per-ccd residual (‘ccd gray’) on a sub-ccd scale.
ccdGraySubCcdTriangular¶
Should the sub-ccd gray chebyshev matrix be triangular to suppress high-order cross terms?
coatingMjds¶
Mirror coating dates in MJD
colorSplitBands¶
Band names to use to split stars by color. Must have 2 entries.
connections¶
- Data type
lsst.pipe.base.config.FgcmFitCycleConfigConnections- Field type
Configurations describing the connections of the PipelineTask to datatypes
cycleNumber¶
FGCM fit cycle number. This is automatically incremented after each run and stage of outlier rejection. See cookbook for details.
defaultCameraOrientation¶
Default camera orientation for QA plots.
deltaAperFitMinNgoodObs¶
Minimum number of good observations to use mean delta-aper values in fits.
deltaAperFitPerCcdNx¶
Number of x bins per ccd when computing delta-aper background offsets. Only used when doComputeDeltaAperPerCcd is True.
deltaAperFitPerCcdNy¶
Number of y bins per ccd when computing delta-aper background offsets. Only used when doComputeDeltaAperPerCcd is True.
deltaAperFitSpatialNside¶
Healpix nside to compute spatial delta-aper background offset maps.
deltaAperInnerRadiusArcsec¶
Inner radius used to compute deltaMagAper (arcseconds). Must be positive and less than deltaAperOuterRadiusArcsec if any of doComputeDeltaAperPerVisit, doComputeDeltaAperPerStar, doComputeDeltaAperMap, doComputeDeltaAperPerCcd are set.
deltaAperOuterRadiusArcsec¶
Outer radius used to compute deltaMagAper (arcseconds). Must be positive and greater than deltaAperInnerRadiusArcsec if any of doComputeDeltaAperPerVisit, doComputeDeltaAperPerStar, doComputeDeltaAperMap, doComputeDeltaAperPerCcd are set.
deltaMagBkgOffsetPercentile¶
Percentile brightest stars on a visit/ccd to use to compute net offset from local background subtraction.
deltaMagBkgPerCcd¶
Compute net offset from local background subtraction per-ccd? Otherwise, use computation per visit.
doComputeDeltaAperMap¶
Do the computation of delta-aper spatial maps? This is only used if doComputeDeltaAperPerStar is True,
doComputeDeltaAperPerCcd¶
Do the computation of per-ccd delta-aper background offsets?
doComputeDeltaAperPerStar¶
Do the computation of delta-aper mean values per star?
doComputeDeltaAperPerVisit¶
Do the computation of delta-aper background offsets per visit? Note: this option can be very slow when there are many visits.
doMultipleCycles¶
Run multiple fit cycles in one task
doPlots¶
Make fgcm QA plots.
doPlotsBeforeFinalCycles¶
Make fgcm QA plots before the final two fit cycles? This only applies inmulti-cycle mode, and if doPlots is True. These are typically the mostimportant QA plots to inspect.
doReferenceCalibration¶
Use reference catalog as additional constraint on calibration
epochMjds¶
Epoch boundaries in MJD
expGrayErrRecoverCut¶
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.
expGrayHighCutDict¶
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.
expGrayInitialCut¶
Maximum exposure/visit gray value for initial selection of possible photometric observations.
expGrayPhotometricCutDict¶
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.
expGrayRecoverCut¶
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.
expVarGrayPhotometricCutDict¶
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.
fitBands¶
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
fitCcdChromaticityDict¶
Specification on whether to compute first-order quantum efficiency (QE) adjustments. Key is band, and value will be True or False. Any band not explicitly specified will default to False.
fitMirrorChromaticity¶
Fit (intraband) mirror chromatic term?
focalPlaneSigmaClip¶
Number of sigma to clip outliers per focal-plane.
freezeStdAtmosphere¶
Freeze atmosphere parameters to standard (for testing)
instrumentParsPerBand¶
Model instrumental parameters per band? Otherwise, instrumental parameters (QE changes with time) are shared among all bands.
instrumentSlopeMinDeltaT¶
Minimum time change (in days) between observations to use in constraining instrument slope.
isFinalCycle¶
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
latitude¶
Observatory latitude
mapLongitudeRef¶
Reference longitude for plotting maps
mapNSide¶
Healpix nside for plotting maps
maxCcdGrayErr¶
Maximum error on CCD gray offset to be considered photometric
maxIterBeforeFinalCycle¶
Maximum fit iterations, prior to final cycle. The number of iterations will always be 0 in the final cycle for cleanup and final selection.
minCcdPerExp¶
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.
minExpPerNight¶
Minimum number of good exposures/visits to consider a partly photometric night
minObsPerBand¶
Minimum good observations per band
minStarPerCcd¶
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.
minStarPerExp¶
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.
mirrorArea¶
Mirror area (square meters) of telescope. If not set, will try to estimate from camera.telescopeDiameter.
modelMagErrors¶
Should FGCM model the magnitude errors from sky/fwhm? (False means trust inputs)
multipleCyclesFinalCycleNumber¶
- Default
5- Field type
- Range
[2,10]
Final cycle number in multiple cycle mode. The initial cycle is 0, with limited parameters fit. The next cycle is 1 with full parameter fit. The final cycle is a clean-up with no parameters fit. There will be a total of (multipleCycleFinalCycleNumber + 1) cycles run, and the final cycle number cannot be less than 2.
nCore¶
Number of cores to use Deprecated: Number of cores is deprecated as a config, and will be removed after v27. Please use pipetask run --cores-per-quantum instead.
nExpPerRun¶
Number of exposures to run in each chunk
nStarPerRun¶
Number of stars to run in each chunk
outfileBase¶
Filename start for plot output files
outputStandardsBeforeFinalCycle¶
Output standard stars prior to final cycle? Used in debugging.
outputZeropointsBeforeFinalCycle¶
Output standard stars prior to final cycle? Used in debugging.
physicalFilterMap¶
Mapping from ‘physicalFilter’ to band.
precomputeSuperStarInitialCycle¶
Precompute superstar flat for initial cycle
quietMode¶
Be less verbose with logging.
randomSeed¶
Random seed for fgcm for consistency in tests.
refStarColorCuts¶
Encoded star color cuts specifically to apply to reference stars. This is a list with each entry a string of the format band1,band2,low,high such that only stars of color low < band1 - band2 < high will be used as reference stars.
refStarMaxFracUse¶
Maximum fraction of reference stars to use in the fit. Remainder will be used only for validation.
refStarOutlierNSig¶
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.
refStarSnMin¶
Reference star signal-to-noise minimum to use in calibration. Set to <=0 for no cut.
requiredBands¶
Bands that are required for a star to be considered a calibration star. Must be a subset of config.bands
reserveFraction¶
Fraction of stars to reserve for testing
saveLogOutput¶
Flag to enable/disable saving of log output for a task, enabled by default.
sedboundaryterms¶
- Data type
- Field type
Mapping from bands to SED boundary term names used is sedterms.
sedterms¶
- Data type
- Field type
Mapping from terms to bands for fgcm linear SED approximations.
sigFgcmMaxEGrayDict¶
Per-band specification for maximum (absolute) achromatic residual (gray value) for observations in sigma_fgcm (raw repeatability). Broad-band filters should be 0.05.
sigFgcmMaxErr¶
Maximum mag error for fitting sigma_FGCM
sigma0Phot¶
Systematic error floor for all zeropoints
sigmaCalFitPercentile¶
Magnitude percentile range to fit systematic error floor
sigmaCalPlotPercentile¶
Magnitude percentile range to plot systematic error floor
sigmaCalRange¶
Allowed range for systematic error floor estimation
starColorCuts¶
Encoded star-color cuts (using calibration star colors). This is a list with each entry a string of the format band1,band2,low,high such that only stars of color low < band1 - band2 < high will be used for calibration.
superStarPlotCcdResiduals¶
If plotting is enabled, should per-detector residuals be plotted? This may produce a lot of output, and should be used only for debugging purposes.
superStarSigmaClip¶
Number of sigma to clip outliers when selecting for superstar flats
superStarSubCcdChebyshevOrder¶
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.
superStarSubCcdDict¶
Per-band specification on whether to compute superstar flat on sub-ccd scale. Must have one entry per band.
superStarSubCcdTriangular¶
Should the sub-ccd superstar chebyshev matrix be triangular to suppress high-order cross terms?
useExposureReferenceOffset¶
Use per-exposure (visit) offsets between calibrated stars and reference stars for final zeropoints? This may help uniformity for disjoint surveys.
useParquetCatalogFormat¶
Use parquet catalog format?
useQuadraticPwv¶
Model PWV with a quadratic term for variation through the night?
useRepeatabilityForExpGrayCutsDict¶
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.
utBoundary¶
Boundary (in UTC) from day-to-day
washMjds¶
Mirror wash MJDs