FgcmFitCycleConfig¶
- class lsst.fgcmcal.FgcmFitCycleConfig(*args, **kw)¶
Bases:
PipelineTaskConfig
Config for FgcmFitCycle
Attributes Summary
Number of aperture bins used in aperture correction fit.
Per-band specification of aperture correction input slope parameters.
Apply color cuts defined in
starColorCuts
to reference stars? These cuts are in addition to any cuts defined inrefStarColorCuts
(bool
, defaultTrue
)Per-band specification of the approximate overall throughput at the start of calibration observations.
Number of sigma for automatic computation of (high) outlier cut.
Number of sigma for automatic computation of (low) photometric cut.
Bands to run calibration (
List
, default[]
)Maximum gray extinction to be considered bright observation (
float
, default0.15
)Order of the 2D chebyshev polynomials for focal plane fit.
Per-band specification on whether to compute focal-plane residual ('ccd gray') corrections.
Minimum number of 'good' CCDs required to perform focal-plane gray corrections.
Maximum error on a star observation to use in ccd gray (achromatic residual) computation (
float
, default0.1
)Order of the 2D chebyshev polynomials for sub-ccd gray fit.
Per-band specification on whether to compute achromatic per-ccd residual ('ccd gray') on a sub-ccd scale.
Should the sub-ccd gray chebyshev matrix be triangular to suppress high-order cross terms? (
bool
, defaultTrue
)Mirror coating dates in MJD (
List
, default(0.0,)
)Band names to use to split stars by color.
Field which refers to a dynamically added configuration class which is based on a PipelineTaskConnections class.
FGCM fit cycle number.
Default camera orientation for QA plots.
Minimum number of good observations to use mean delta-aper values in fits.
Number of x bins per ccd when computing delta-aper background offsets.
Number of y bins per ccd when computing delta-aper background offsets.
Healpix nside to compute spatial delta-aper background offset maps.
Inner radius used to compute deltaMagAper (arcseconds).
Outer radius used to compute deltaMagAper (arcseconds).
Percentile brightest stars on a visit/ccd to use to compute net offset from local background subtraction.
Compute net offset from local background subtraction per-ccd? Otherwise, use computation per visit.
Do the computation of delta-aper spatial maps? This is only used if
doComputeDeltaAperPerStar
is True, (bool
, defaultFalse
)Do the computation of per-ccd delta-aper background offsets? (
bool
, defaultFalse
)Do the computation of delta-aper mean values per star? (
bool
, defaultTrue
)Do the computation of delta-aper background offsets per visit? Note: this option can be very slow when there are many visits.
Run multiple fit cycles in one task (
bool
, defaultFalse
)Make fgcm QA plots.
Use reference catalog as additional constraint on calibration (
bool
, defaultTrue
)Epoch boundaries in MJD (
List
, default(0.0,)
)Maximum exposure gray error to be able to recover bad ccds via interpolation.
Per-band specification on maximum (positive) achromatic exposure residual ('gray term') for a visit to be considered photometric.
Maximum exposure/visit gray value for initial selection of possible photometric observations.
Per-band specification on maximum (negative) achromatic exposure residual ('gray term') for a visit to be considered photometric.
Maximum (negative) exposure gray to be able to recover bad ccds via interpolation.
Per-band specification on maximum exposure variance to be considered possibly photometric.
Bands to use in atmospheric fit.
Specification on whether to compute first-order quantum efficiency (QE) adjustments.
Fit (intraband) mirror chromatic term? (
bool
, defaultFalse
)Number of sigma to clip outliers per focal-plane.
Freeze atmosphere parameters to standard (for testing) (
bool
, defaultFalse
)Model instrumental parameters per band? Otherwise, instrumental parameters (QE changes with time) are shared among all bands.
Minimum time change (in days) between observations to use in constraining instrument slope.
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 (
bool
, defaultFalse
)Observatory latitude (
float
)Reference longitude for plotting maps (
float
, default0.0
)Healpix nside for plotting maps (
int
, default256
)Maximum error on CCD gray offset to be considered photometric (
float
, default0.05
)Maximum fit iterations, prior to final cycle.
Minimum number of good CCDs per exposure/visit to be used in calibration fit.
Minimum number of good exposures/visits to consider a partly photometric night (
int
, default10
)Minimum good observations per band (
int
, default2
)Minimum number of good stars per CCD to be used in calibration fit.
Minimum number of good stars per exposure/visit to be used in calibration fit.
Mirror area (square meters) of telescope.
Should FGCM model the magnitude errors from sky/fwhm? (False means trust inputs) (
bool
, defaultTrue
)Final cycle number in multiple cycle mode.
Number of cores to use Deprecated: Number of cores is deprecated as a config, and will be removed after v27.
Number of exposures to run in each chunk (
int
, default1000
)Number of stars to run in each chunk (
int
, default200000
)Filename start for plot output files (
str
)Output standard stars prior to final cycle? Used in debugging.
Output standard stars prior to final cycle? Used in debugging.
Mapping from 'physicalFilter' to band.
Precompute superstar flat for initial cycle (
bool
, defaultFalse
)Be less verbose with logging.
Random seed for fgcm for consistency in tests.
Encoded star color cuts specifically to apply to reference stars.
Maximum fraction of reference stars to use in the fit.
Number of sigma compared to average mag for reference star to be considered an outlier.
Reference star signal-to-noise minimum to use in calibration.
Bands that are required for a star to be considered a calibration star.
Fraction of stars to reserve for testing (
float
, default0.1
)Flag to enable/disable saving of log output for a task, enabled by default.
Mapping from bands to SED boundary term names used is sedterms.
Mapping from terms to bands for fgcm linear SED approximations.
Per-band specification for maximum (absolute) achromatic residual (gray value) for observations in sigma_fgcm (raw repeatability).
Maximum mag error for fitting sigma_FGCM (
float
, default0.01
)Systematic error floor for all zeropoints (
float
, default0.003
)Magnitude percentile range to fit systematic error floor (
List
, default(0.05, 0.15)
)Magnitude percentile range to plot systematic error floor (
List
, default(0.05, 0.95)
)Allowed range for systematic error floor estimation (
List
, default(0.001, 0.003)
)Encoded star-color cuts (using calibration star colors).
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.
Number of sigma to clip outliers when selecting for superstar flats (
float
, default5.0
)Order of the 2D chebyshev polynomials for sub-ccd superstar fit.
Per-band specification on whether to compute superstar flat on sub-ccd scale.
Should the sub-ccd superstar chebyshev matrix be triangular to suppress high-order cross terms? (
bool
, defaultFalse
)Use per-exposure (visit) offsets between calibrated stars and reference stars for final zeropoints? This may help uniformity for disjoint surveys.
Use parquet catalog format? (
bool
, defaultTrue
)Model PWV with a quadratic term for variation through the night? (
bool
, defaultFalse
)Per-band specification on whether to use star repeatability (instead of exposures) for computing photometric cuts.
Boundary (in UTC) from day-to-day (
float
)Mirror wash MJDs (
List
, default(0.0,)
)Methods Summary
applyConfigOverrides
(instrument, ...)Apply config overrides to this config instance.
compare
(other[, shortcut, rtol, atol, output])Compare this configuration to another
Config
for equality.formatHistory
(name, **kwargs)Format a configuration field's history to a human-readable format.
freeze
()Make this config, and all subconfigs, read-only.
items
()Get configurations as
(field name, field value)
pairs.keys
()Get field names.
load
(filename[, root])Modify this config in place by executing the Python code in a configuration file.
loadFromStream
(stream[, root, filename, ...])Modify this Config in place by executing the Python code in the provided stream.
loadFromString
(code[, root, filename, ...])Modify this Config in place by executing the Python code in the provided string.
names
()Get all the field names in the config, recursively.
save
(filename[, root])Save a Python script to the named file, which, when loaded, reproduces this config.
saveToStream
(outfile[, root, skipImports])Save a configuration file to a stream, which, when loaded, reproduces this config.
saveToString
([skipImports])Return the Python script form of this configuration as an executable string.
Subclass hook for computing defaults.
toDict
()Make a dictionary of field names and their values.
update
(**kw)Update values of fields specified by the keyword arguments.
validate
()Validate the Config, raising an exception if invalid.
values
()Get field values.
Attributes Documentation
- 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. (
int
, default10
)
- 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). (
Dict
, default{}
)
- applyRefStarColorCuts¶
Apply color cuts defined in
starColorCuts
to reference stars? These cuts are in addition to any cuts defined inrefStarColorCuts
(bool
, defaultTrue
)
- 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. (
Dict
, default{}
)
- 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). (
float
, default4.0
)
- 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). (
float
, default3.0
)
- bands¶
Bands to run calibration (
List
, default[]
)
- ccdGrayFocalPlaneChebyshevOrder¶
Order of the 2D chebyshev polynomials for focal plane fit. (
int
, default3
)
- ccdGrayFocalPlaneDict¶
Per-band specification on whether to compute focal-plane residual (‘ccd gray’) corrections. (
Dict
, default{}
)
- 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. (
int
, default1
)
- ccdGrayMaxStarErr¶
Maximum error on a star observation to use in ccd gray (achromatic residual) computation (
float
, default0.1
)
- ccdGraySubCcdChebyshevOrder¶
Order of the 2D chebyshev polynomials for sub-ccd gray fit. (
int
, default1
)
- ccdGraySubCcdDict¶
Per-band specification on whether to compute achromatic per-ccd residual (‘ccd gray’) on a sub-ccd scale. (
Dict
, default{}
)
- ccdGraySubCcdTriangular¶
Should the sub-ccd gray chebyshev matrix be triangular to suppress high-order cross terms? (
bool
, defaultTrue
)
- coatingMjds¶
Mirror coating dates in MJD (
List
, default(0.0,)
)
- colorSplitBands¶
Band names to use to split stars by color. Must have 2 entries. (
List
, default('g', 'i')
)
- connections: pexConfig.ConfigField¶
Field which refers to a dynamically added configuration class which is based on a PipelineTaskConnections class.
- cycleNumber¶
FGCM fit cycle number. This is automatically incremented after each run and stage of outlier rejection. See cookbook for details. (
int
)
- deltaAperFitMinNgoodObs¶
Minimum number of good observations to use mean delta-aper values in fits. (
int
, default2
)
- deltaAperFitPerCcdNx¶
Number of x bins per ccd when computing delta-aper background offsets. Only used when
doComputeDeltaAperPerCcd
is True. (int
, default10
)
- deltaAperFitPerCcdNy¶
Number of y bins per ccd when computing delta-aper background offsets. Only used when
doComputeDeltaAperPerCcd
is True. (int
, default10
)
- deltaAperFitSpatialNside¶
Healpix nside to compute spatial delta-aper background offset maps. (
int
, default64
)
- deltaAperInnerRadiusArcsec¶
Inner radius used to compute deltaMagAper (arcseconds). Must be positive and less than
deltaAperOuterRadiusArcsec
if any ofdoComputeDeltaAperPerVisit
,doComputeDeltaAperPerStar
,doComputeDeltaAperMap
,doComputeDeltaAperPerCcd
are set. (float
, default0.0
)
- deltaAperOuterRadiusArcsec¶
Outer radius used to compute deltaMagAper (arcseconds). Must be positive and greater than
deltaAperInnerRadiusArcsec
if any ofdoComputeDeltaAperPerVisit
,doComputeDeltaAperPerStar
,doComputeDeltaAperMap
,doComputeDeltaAperPerCcd
are set. (float
, default0.0
)
- deltaMagBkgOffsetPercentile¶
Percentile brightest stars on a visit/ccd to use to compute net offset from local background subtraction. (
float
, default0.25
)
- deltaMagBkgPerCcd¶
Compute net offset from local background subtraction per-ccd? Otherwise, use computation per visit. (
bool
, defaultFalse
)
- doComputeDeltaAperMap¶
Do the computation of delta-aper spatial maps? This is only used if
doComputeDeltaAperPerStar
is True, (bool
, defaultFalse
)
- doComputeDeltaAperPerCcd¶
Do the computation of per-ccd delta-aper background offsets? (
bool
, defaultFalse
)
- doComputeDeltaAperPerStar¶
Do the computation of delta-aper mean values per star? (
bool
, defaultTrue
)
- doComputeDeltaAperPerVisit¶
Do the computation of delta-aper background offsets per visit? Note: this option can be very slow when there are many visits. (
bool
, defaultFalse
)
- doReferenceCalibration¶
Use reference catalog as additional constraint on calibration (
bool
, defaultTrue
)
- epochMjds¶
Epoch boundaries in MJD (
List
, default(0.0,)
)
- 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. (
float
, default0.05
)
- 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. (
Dict
, default{}
)
- expGrayInitialCut¶
Maximum exposure/visit gray value for initial selection of possible photometric observations. (
float
, default-0.25
)
- 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. (
Dict
, default{}
)
- 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. (
float
, default-1.0
)
- 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. (
Dict
, default{}
)
- 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
(List
, default[]
)
- 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. (
Dict
, default{}
)
- history¶
Read-only history.
- instrumentParsPerBand¶
Model instrumental parameters per band? Otherwise, instrumental parameters (QE changes with time) are shared among all bands. (
bool
, defaultFalse
)
- instrumentSlopeMinDeltaT¶
Minimum time change (in days) between observations to use in constraining instrument slope. (
float
, default20.0
)
- 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 (
bool
, defaultFalse
)
- 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. (
int
, default50
)
- 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. (
int
, default5
)
- minExpPerNight¶
Minimum number of good exposures/visits to consider a partly photometric night (
int
, default10
)
- 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. (
int
, default5
)
- 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. (
int
, default600
)
- mirrorArea¶
Mirror area (square meters) of telescope. If not set, will try to estimate from camera.telescopeDiameter. (
float
, defaultNone
)
- modelMagErrors¶
Should FGCM model the magnitude errors from sky/fwhm? (False means trust inputs) (
bool
, defaultTrue
)
- multipleCyclesFinalCycleNumber¶
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. (
int
, default5
)Valid Range = [2,10]
- 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. (int
, default4
)
- outputStandardsBeforeFinalCycle¶
Output standard stars prior to final cycle? Used in debugging. (
bool
, defaultFalse
)
- outputZeropointsBeforeFinalCycle¶
Output standard stars prior to final cycle? Used in debugging. (
bool
, defaultFalse
)
- physicalFilterMap¶
Mapping from ‘physicalFilter’ to band. (
Dict
, default{}
)
- 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. (List
, default('NO_DATA',)
)
- refStarMaxFracUse¶
Maximum fraction of reference stars to use in the fit. Remainder will be used only for validation. (
float
, default0.5
)
- 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. (
float
, default4.0
)
- refStarSnMin¶
Reference star signal-to-noise minimum to use in calibration. Set to <=0 for no cut. (
float
, default50.0
)
- requiredBands¶
Bands that are required for a star to be considered a calibration star. Must be a subset of
config.bands
(List
, default[]
)
- saveLogOutput¶
Flag to enable/disable saving of log output for a task, enabled by default. (
bool
, defaultTrue
)
- sedboundaryterms¶
Mapping from bands to SED boundary term names used is sedterms. (
SedboundarytermDict
, default<class 'lsst.fgcmcal.sedterms.SedboundarytermDict'>
)
- sedterms¶
Mapping from terms to bands for fgcm linear SED approximations. (
SedtermDict
, default<class 'lsst.fgcmcal.sedterms.SedtermDict'>
)
- 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. (
Dict
, default{}
)
- sigmaCalFitPercentile¶
Magnitude percentile range to fit systematic error floor (
List
, default(0.05, 0.15)
)
- sigmaCalPlotPercentile¶
Magnitude percentile range to plot systematic error floor (
List
, default(0.05, 0.95)
)
- sigmaCalRange¶
Allowed range for systematic error floor estimation (
List
, default(0.001, 0.003)
)
- 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. (List
, default('NO_DATA',)
)
- 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. (
bool
, defaultFalse
)
- superStarSigmaClip¶
Number of sigma to clip outliers when selecting for superstar flats (
float
, default5.0
)
- 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. (
int
, default1
)
- superStarSubCcdDict¶
Per-band specification on whether to compute superstar flat on sub-ccd scale. Must have one entry per band. (
Dict
, default{}
)
- superStarSubCcdTriangular¶
Should the sub-ccd superstar chebyshev matrix be triangular to suppress high-order cross terms? (
bool
, defaultFalse
)
- useExposureReferenceOffset¶
Use per-exposure (visit) offsets between calibrated stars and reference stars for final zeropoints? This may help uniformity for disjoint surveys. (
bool
, defaultFalse
)
- useQuadraticPwv¶
Model PWV with a quadratic term for variation through the night? (
bool
, defaultFalse
)
- 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. (
Dict
, default{}
)
- washMjds¶
Mirror wash MJDs (
List
, default(0.0,)
)
Methods Documentation
- applyConfigOverrides(instrument: Instrument | None, taskDefaultName: str, pipelineConfigs: Iterable[ConfigIR] | None, parameters: ParametersIR, label: str) None ¶
Apply config overrides to this config instance.
- Parameters:
- instrument
Instrument
orNone
An instance of the
Instrument
specified in a pipeline. IfNone
then the pipeline did not specify and instrument.- taskDefaultName
str
The default name associated with the
Task
class. This may be used with instrumental overrides.- pipelineConfigs
Iterable
ofConfigIR
An iterable of
ConfigIR
objects that contain overrides to apply to this config instance.- parameters
ParametersIR
Parameters defined in a Pipeline which are used in formatting of config values across multiple
Task
in a pipeline.- label
str
The label associated with this class’s Task in a pipeline.
- instrument
- compare(other, shortcut=True, rtol=1e-08, atol=1e-08, output=None)¶
Compare this configuration to another
Config
for equality.- Parameters:
- other
lsst.pex.config.Config
Other
Config
object to compare against this config.- shortcut
bool
, optional If
True
, return as soon as an inequality is found. Default isTrue
.- rtol
float
, optional Relative tolerance for floating point comparisons.
- atol
float
, optional Absolute tolerance for floating point comparisons.
- outputcallable, optional
A callable that takes a string, used (possibly repeatedly) to report inequalities.
- other
- Returns:
- isEqual
bool
True
when the twolsst.pex.config.Config
instances are equal.False
if there is an inequality.
- isEqual
See also
Notes
Unselected targets of
RegistryField
fields and unselected choices ofConfigChoiceField
fields are not considered by this method.Floating point comparisons are performed by
numpy.allclose
.
- formatHistory(name, **kwargs)¶
Format a configuration field’s history to a human-readable format.
- Parameters:
- name
str
Name of a
Field
in this config.- **kwargs
Keyword arguments passed to
lsst.pex.config.history.format
.
- name
- Returns:
- history
str
A string containing the formatted history.
- history
See also
- freeze()¶
Make this config, and all subconfigs, read-only.
- items()¶
Get configurations as
(field name, field value)
pairs.- Returns:
- items
ItemsView
Iterator of tuples for each configuration. Tuple items are:
Field name.
Field value.
- items
- keys()¶
Get field names.
- Returns:
- names
KeysView
List of
lsst.pex.config.Field
names.
- names
- load(filename, root='config')¶
Modify this config in place by executing the Python code in a configuration file.
- Parameters:
- filename
str
Name of the configuration file. A configuration file is Python module.
- root
str
, optional Name of the variable in file that refers to the config being overridden.
For example, the value of root is
"config"
and the file contains:config.myField = 5
Then this config’s field
myField
is set to5
.
- filename
- loadFromStream(stream, root='config', filename=None, extraLocals=None)¶
Modify this Config in place by executing the Python code in the provided stream.
- Parameters:
- streamfile-like object,
str
,bytes
, orCodeType
Stream containing configuration override code. If this is a code object, it should be compiled with
mode="exec"
.- root
str
, optional Name of the variable in file that refers to the config being overridden.
For example, the value of root is
"config"
and the file contains:config.myField = 5
Then this config’s field
myField
is set to5
.- filename
str
, optional Name of the configuration file, or
None
if unknown or contained in the stream. Used for error reporting.- extraLocals
dict
ofstr
toobject
, optional Any extra variables to include in local scope when loading.
- streamfile-like object,
See also
Notes
For backwards compatibility reasons, this method accepts strings, bytes and code objects as well as file-like objects. New code should use
loadFromString
instead for most of these types.
- loadFromString(code, root='config', filename=None, extraLocals=None)¶
Modify this Config in place by executing the Python code in the provided string.
- Parameters:
- code
str
,bytes
, orCodeType
Stream containing configuration override code.
- root
str
, optional Name of the variable in file that refers to the config being overridden.
For example, the value of root is
"config"
and the file contains:config.myField = 5
Then this config’s field
myField
is set to5
.- filename
str
, optional Name of the configuration file, or
None
if unknown or contained in the stream. Used for error reporting.- extraLocals
dict
ofstr
toobject
, optional Any extra variables to include in local scope when loading.
- code
- Raises:
- ValueError
Raised if a key in extraLocals is the same value as the value of the root argument.
- save(filename, root='config')¶
Save a Python script to the named file, which, when loaded, reproduces this config.
- Parameters:
- filename
str
Desination filename of this configuration.
- root
str
, optional Name to use for the root config variable. The same value must be used when loading (see
lsst.pex.config.Config.load
).
- filename
- saveToStream(outfile, root='config', skipImports=False)¶
Save a configuration file to a stream, which, when loaded, reproduces this config.
- Parameters:
- outfilefile-like object
Destination file object write the config into. Accepts strings not bytes.
- root
str
, optional Name to use for the root config variable. The same value must be used when loading (see
lsst.pex.config.Config.load
).- skipImports
bool
, optional If
True
then do not includeimport
statements in output, this is to support human-oriented output frompipetask
where additional clutter is not useful.
- saveToString(skipImports=False)¶
Return the Python script form of this configuration as an executable string.
- Parameters:
- Returns:
- code
str
A code string readable by
loadFromString
.
- code
- setDefaults()¶
Subclass hook for computing defaults.
Notes
Derived
Config
classes that must compute defaults rather than using theField
instances’s defaults should do so here. To correctly use inherited defaults, implementations ofsetDefaults
must call their base class’ssetDefaults
.
- toDict()¶
Make a dictionary of field names and their values.
See also
Notes
This method uses the
toDict
method of individual fields. Subclasses ofField
may need to implement atoDict
method for this method to work.
- update(**kw)¶
Update values of fields specified by the keyword arguments.
- Parameters:
- **kw
Keywords are configuration field names. Values are configuration field values.
Notes
The
__at
and__label
keyword arguments are special internal keywords. They are used to strip out any internal steps from the history tracebacks of the config. Do not modify these keywords to subvert aConfig
instance’s history.Examples
This is a config with three fields:
>>> from lsst.pex.config import Config, Field >>> class DemoConfig(Config): ... fieldA = Field(doc='Field A', dtype=int, default=42) ... fieldB = Field(doc='Field B', dtype=bool, default=True) ... fieldC = Field(doc='Field C', dtype=str, default='Hello world') ... >>> config = DemoConfig()
These are the default values of each field:
>>> for name, value in config.iteritems(): ... print(f"{name}: {value}") ... fieldA: 42 fieldB: True fieldC: 'Hello world'
Using this method to update
fieldA
andfieldC
:>>> config.update(fieldA=13, fieldC='Updated!')
Now the values of each field are:
>>> for name, value in config.iteritems(): ... print(f"{name}: {value}") ... fieldA: 13 fieldB: True fieldC: 'Updated!'
- validate()¶
Validate the Config, raising an exception if invalid.
- Raises:
- lsst.pex.config.FieldValidationError
Raised if verification fails.
Notes
The base class implementation performs type checks on all fields by calling their
validate
methods.Complex single-field validation can be defined by deriving new Field types. For convenience, some derived
lsst.pex.config.Field
-types (ConfigField
andConfigChoiceField
) are defined inlsst.pex.config
that handle recursing into subconfigs.Inter-field relationships should only be checked in derived
Config
classes after calling this method, and base validation is complete.
- values()¶
Get field values.
- Returns:
- values
ValuesView
Iterator of field values.
- values