CfhtIsrTaskConfig

class lsst.obs.cfht.cfhtIsrTask.CfhtIsrTaskConfig

Bases: lsst.ip.isr.IsrTaskConfig

Attributes Summary

ampOffset	Amp offset correction task.
assembleCcd	CCD assembly task (ConfigurableInstance, default <class 'lsst.ip.isr.assembleCcdTask.AssembleCcdConfig'>)
badStatistic	How to estimate the average value for BAD regions.
biasDataProductName	Name of the bias data product (str, default 'bias')
brighterFatterApplyGain	Should the gain be applied when applying the brighter-fatter correction? (bool, default True)
brighterFatterLevel	The level at which to correct for brighter-fatter.
brighterFatterMaskGrowSize	Number of pixels to grow the masks listed in config.brighterFatterMaskListToInterpolate when brighter-fatter correction is applied.
brighterFatterMaskListToInterpolate	List of mask planes that should be interpolated over when applying the brighter-fatter correction.
brighterFatterMaxIter	Maximum number of iterations for the brighter-fatter correction (int, default 10)
brighterFatterThreshold	Threshold used to stop iterating the brighter-fatter correction.
connections	Configurations describing the connections of the PipelineTask to datatypes (Connections, default <class 'lsst.pipe.base.config.Connections'>)
crosstalk	Intra-CCD crosstalk correction (ConfigurableInstance, default <class 'lsst.ip.isr.crosstalk.CrosstalkConfig'>)
darkDataProductName	Name of the dark data product (str, default 'dark')
datasetType	Dataset type for input data; users will typically leave this alone, but camera-specific ISR tasks will override it (str, default 'raw')
defaultFluxMag0T1	Default value for fluxMag0T1 (for an unrecognized filter).
deferredChargeCorrection	Deferred charge correction task.
doAmpOffset	Calculate and apply amp offset corrections? (bool, default False)
doApplyGains	Correct the amplifiers for their gains instead of applying flat correction (bool, default False)
doAssembleCcd	Assemble amp-level exposures into a ccd-level exposure? (bool, default True)
doAssembleIsrExposures	Assemble amp-level calibration exposures into ccd-level exposure? (bool, default False)
doAttachTransmissionCurve	Construct and attach a wavelength-dependent throughput curve for this CCD image? (bool, default False)
doBias	Apply bias frame correction? (bool, default True)
doBiasBeforeOverscan	Reverse order of overscan and bias correction.
doBrighterFatter	Apply the brighter-fatter correction? (bool, default False)
doCalculateStatistics	Should additional ISR statistics be calculated? (bool, default False)
doCameraSpecificMasking	Mask camera-specific bad regions? (bool, default False)
doConvertIntToFloat	Convert integer raw images to floating point values? (bool, default True)
doCrosstalk	Apply intra-CCD crosstalk correction? (bool, default False)
doCrosstalkBeforeAssemble	Apply crosstalk correction before CCD assembly, and before trimming? (bool, default False)
doDark	Apply dark frame correction? (bool, default True)
doDefect	Apply correction for CCD defects, e.g.
doDeferredCharge	Apply deferred charge correction? (bool, default False)
doEmpiricalReadNoise	Calculate empirical read noise instead of value from AmpInfo data? (bool, default False)
doFlat	Apply flat field correction? (bool, default True)
doFringe	Apply fringe correction? (bool, default True)
doIlluminationCorrection	Perform illumination correction? (bool, default False)
doInterpolate	Interpolate masked pixels? (bool, default True)
doLinearize	Correct for nonlinearity of the detector’s response? (bool, default True)
doMaskVignettePolygon	Add a mask bit for pixels within the vignetted region.
doMeasureBackground	Measure the background level on the reduced image? (bool, default False)
doNanInterpAfterFlat	If True, ensure we interpolate NaNs after flat-fielding, even if we also have to interpolate them before flat-fielding.
doNanInterpolation	Perform interpolation over pixels masked as NaN? NB: This is independent of doNanMasking; if that is False this plane will likely be blank, resulting in a no-op here.
doNanMasking	Mask non-finite (NAN, inf) pixels? (bool, default True)
doOverscan	Do overscan subtraction? (bool, default True)
doSaturation	Mask saturated pixels? NB: this is totally independent of the interpolation option - this is ONLY setting the bits in the mask.
doSaturationInterpolation	Perform interpolation over pixels masked as saturated? NB: This is independent of doSaturation; if that is False this plane will likely be blank, resulting in a no-op here.
doSaveInterpPixels	Save a copy of the pre-interpolated pixel values? (bool, default False)
doSetBadRegions	Should we set the level of all BAD patches of the chip to the chip’s average value? (bool, default True)
doStrayLight	Subtract stray light in the y-band (due to encoder LEDs)? (bool, default False)
doSuspect	Mask suspect pixels? (bool, default False)
doTrimToMatchCalib	Trim raw data to match calibration bounding boxes? (bool, default False)
doTweakFlat	Tweak flats to match observed amplifier ratios? (bool, default False)
doUseAtmosphereTransmission	Load and use transmission_atmosphere (if doAttachTransmissionCurve is True)? (bool, default True)
doUseFilterTransmission	Load and use transmission_filter (if doAttachTransmissionCurve is True)? (bool, default True)
doUseOpticsTransmission	Load and use transmission_optics (if doAttachTransmissionCurve is True)? (bool, default True)
doUseSensorTransmission	Load and use transmission_sensor (if doAttachTransmissionCurve is True)? (bool, default True)
doVariance	Calculate variance? (bool, default True)
doVignette	Compute and attach the validPolygon defining the unvignetted region to the exposure according to vignetting parameters? (bool, default False)
doWidenSaturationTrails	Widen bleed trails based on their width? (bool, default True)
doWrite	Persist postISRCCD? (bool, default True)
edgeMaskLevel	Mask edge pixels in which coordinate frame: DETECTOR or AMP? (str, default 'DETECTOR')
expectWcs	Expect input science images to have a WCS (set False for e.g.
fallbackFilterName	Fallback default filter name for calibrations.
flatDataProductName	Name of the flat data product (str, default 'flat')
flatScalingType	The method for scaling the flat on the fly.
flatUserScale	If flatScalingType is ‘USER’ then scale flat by this amount; ignored otherwise (float, default 1.0)
fluxMag0T1	The approximate flux of a zero-magnitude object in a one-second exposure, per filter.
fringe	Fringe subtraction task (ConfigurableInstance, default <class 'lsst.ip.isr.fringe.FringeConfig'>)
fringeAfterFlat	Do fringe subtraction after flat-fielding? (bool, default True)
fwhm	FWHM of PSF in arcseconds.
gain	The gain to use if no Detector is present in the Exposure (ignored if NaN) (float, default nan)
growSaturationFootprintSize	Number of pixels by which to grow the saturation footprints (int, default 1)
history
illumFilters	Only perform illumination correction for these filters.
illumScale	Scale factor for the illumination correction.
illuminationCorrectionDataProductName	Name of the illumination correction data product.
isrStats	Task to calculate additional statistics.
maskListToInterpolate	List of mask planes that should be interpolated.
maskNegativeVariance	Mask pixels that claim a negative variance? This likely indicates a failure in the measurement of the overscan at an edge due to the data falling off faster than the overscan model can account for it.
masking	Masking task.
negativeVarianceMaskName	Mask plane to use to mark pixels with negative variance, if maskNegativeVariance is True.
normalizeGains	Normalize all the amplifiers in each CCD to have the same median value.
numEdgeSuspect	Number of edge pixels to be flagged as untrustworthy.
overscan	Overscan subtraction task for image segments.
qa	QA related configuration options.
readNoise	The read noise to use if no Detector is present in the Exposure (float, default 0.0)
safe	Safety margin for CFHT sensors gain determination (float, default 0.95)
saturatedMaskName	Name of mask plane to use in saturation detection and interpolation (str, default 'SAT')
saturation	The saturation level to use if no Detector is present in the Exposure (ignored if NaN) (float, default nan)
saveLogOutput	Flag to enable/disable saving of log output for a task, enabled by default.
saveMetadata	Flag to enable/disable metadata saving for a task, enabled by default.
strayLight	y-band stray light correction (ConfigurableInstance, default <class 'lsst.ip.isr.straylight.StrayLightConfig'>)
suspectMaskName	Name of mask plane to use for suspect pixels (str, default 'SUSPECT')
useFallbackDate	Pass observation date when using fallback filter.
usePtcGains	Use the gain values from the Photon Transfer Curve? (bool, default False)
usePtcReadNoise	Use readnoise values from the Photon Transfer Curve? (bool, default False)
vignette	Vignetting task.
vignetteValue	Value to replace image array pixels with in the vignetted region? Ignored if None.

Methods Summary

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.
setDefaults()	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

ampOffset

Amp offset correction task. (ConfigurableInstance, default <class 'lsst.ip.isr.ampOffset.AmpOffsetConfig'>)

assembleCcd

CCD assembly task (ConfigurableInstance, default <class 'lsst.ip.isr.assembleCcdTask.AssembleCcdConfig'>)

badStatistic

How to estimate the average value for BAD regions. (str, default 'MEANCLIP')

Allowed values:

'MEANCLIP'

Correct using the (clipped) mean of good data

'MEDIAN'

Correct using the median of the good data

'None'

Field is optional

biasDataProductName

Name of the bias data product (str, default 'bias')

brighterFatterApplyGain

Should the gain be applied when applying the brighter-fatter correction? (bool, default True)

brighterFatterLevel

The level at which to correct for brighter-fatter. (str, default 'DETECTOR')

Allowed values:

'AMP'

Every amplifier treated separately.

'DETECTOR'

One kernel per detector

'None'

Field is optional

brighterFatterMaskGrowSize

Number of pixels to grow the masks listed in config.brighterFatterMaskListToInterpolate when brighter-fatter correction is applied. (int, default 0)

brighterFatterMaskListToInterpolate

List of mask planes that should be interpolated over when applying the brighter-fatter correction. (List, default ['SAT', 'BAD', 'NO_DATA', 'UNMASKEDNAN'])

brighterFatterMaxIter

Maximum number of iterations for the brighter-fatter correction (int, default 10)

brighterFatterThreshold

Threshold used to stop iterating the brighter-fatter correction. It is the absolute value of the difference between the current corrected image and the one from the previous iteration summed over all the pixels. (float, default 1000)

connections

Configurations describing the connections of the PipelineTask to datatypes (Connections, default <class 'lsst.pipe.base.config.Connections'>)

crosstalk

Intra-CCD crosstalk correction (ConfigurableInstance, default <class 'lsst.ip.isr.crosstalk.CrosstalkConfig'>)

darkDataProductName

Name of the dark data product (str, default 'dark')

datasetType

Dataset type for input data; users will typically leave this alone, but camera-specific ISR tasks will override it (str, default 'raw')

defaultFluxMag0T1

Default value for fluxMag0T1 (for an unrecognized filter). (float, default 158489319246.11172)

deferredChargeCorrection

Deferred charge correction task. (ConfigurableInstance, default <class 'lsst.ip.isr.deferredCharge.DeferredChargeConfig'>)

doAmpOffset

Calculate and apply amp offset corrections? (bool, default False)

doApplyGains

Correct the amplifiers for their gains instead of applying flat correction (bool, default False)

doAssembleCcd

Assemble amp-level exposures into a ccd-level exposure? (bool, default True)

doAssembleIsrExposures

Assemble amp-level calibration exposures into ccd-level exposure? (bool, default False)

doAttachTransmissionCurve

Construct and attach a wavelength-dependent throughput curve for this CCD image? (bool, default False)

doBias

Apply bias frame correction? (bool, default True)

doBiasBeforeOverscan

Reverse order of overscan and bias correction. (bool, default False)

doBrighterFatter

Apply the brighter-fatter correction? (bool, default False)

doCalculateStatistics

Should additional ISR statistics be calculated? (bool, default False)

doCameraSpecificMasking

Mask camera-specific bad regions? (bool, default False)

doConvertIntToFloat

Convert integer raw images to floating point values? (bool, default True)

doCrosstalk

Apply intra-CCD crosstalk correction? (bool, default False)

doCrosstalkBeforeAssemble

Apply crosstalk correction before CCD assembly, and before trimming? (bool, default False)

doDark

Apply dark frame correction? (bool, default True)

doDefect

Apply correction for CCD defects, e.g. hot pixels? (bool, default True)

doDeferredCharge

Apply deferred charge correction? (bool, default False)

doEmpiricalReadNoise

Calculate empirical read noise instead of value from AmpInfo data? (bool, default False)

doFlat

Apply flat field correction? (bool, default True)

doFringe

Apply fringe correction? (bool, default True)

doIlluminationCorrection

Perform illumination correction? (bool, default False)

doInterpolate

Interpolate masked pixels? (bool, default True)

doLinearize

Correct for nonlinearity of the detector’s response? (bool, default True)

doMaskVignettePolygon

Add a mask bit for pixels within the vignetted region. Ignored if doVignette is False (bool, default True)

doMeasureBackground

Measure the background level on the reduced image? (bool, default False)

doNanInterpAfterFlat

If True, ensure we interpolate NaNs after flat-fielding, even if we also have to interpolate them before flat-fielding. (bool, default False)

doNanInterpolation

Perform interpolation over pixels masked as NaN? NB: This is independent of doNanMasking; if that is False this plane will likely be blank, resulting in a no-op here. (bool, default True)

doNanMasking

Mask non-finite (NAN, inf) pixels? (bool, default True)

doOverscan

Do overscan subtraction? (bool, default True)

doSaturation

Mask saturated pixels? NB: this is totally independent of the interpolation option - this is ONLY setting the bits in the mask. To have them interpolated make sure doSaturationInterpolation=True (bool, default True)

doSaturationInterpolation

Perform interpolation over pixels masked as saturated? NB: This is independent of doSaturation; if that is False this plane will likely be blank, resulting in a no-op here. (bool, default True)

doSaveInterpPixels

Save a copy of the pre-interpolated pixel values? (bool, default False)

doSetBadRegions

Should we set the level of all BAD patches of the chip to the chip’s average value? (bool, default True)

doStrayLight

Subtract stray light in the y-band (due to encoder LEDs)? (bool, default False)

doSuspect

Mask suspect pixels? (bool, default False)

doTrimToMatchCalib

Trim raw data to match calibration bounding boxes? (bool, default False)

doTweakFlat

Tweak flats to match observed amplifier ratios? (bool, default False)

doUseAtmosphereTransmission

Load and use transmission_atmosphere (if doAttachTransmissionCurve is True)? (bool, default True)

doUseFilterTransmission

Load and use transmission_filter (if doAttachTransmissionCurve is True)? (bool, default True)

doUseOpticsTransmission

Load and use transmission_optics (if doAttachTransmissionCurve is True)? (bool, default True)

doUseSensorTransmission

Load and use transmission_sensor (if doAttachTransmissionCurve is True)? (bool, default True)

doVariance

Calculate variance? (bool, default True)

doVignette

Compute and attach the validPolygon defining the unvignetted region to the exposure according to vignetting parameters? (bool, default False)

doWidenSaturationTrails

Widen bleed trails based on their width? (bool, default True)

doWrite

Persist postISRCCD? (bool, default True)

edgeMaskLevel

Mask edge pixels in which coordinate frame: DETECTOR or AMP? (str, default 'DETECTOR')

Allowed values:

'DETECTOR'

Mask only the edges of the full detector.

'AMP'

Mask edges of each amplifier.

'None'

Field is optional

expectWcs

Expect input science images to have a WCS (set False for e.g. spectrographs). (bool, default True)

fallbackFilterName

Fallback default filter name for calibrations. (str, default None)

flatDataProductName

Name of the flat data product (str, default 'flat')

flatScalingType

The method for scaling the flat on the fly. (str, default 'USER')

Allowed values:

'USER'

Scale by flatUserScale

'MEAN'

Scale by the inverse of the mean

'MEDIAN'

Scale by the inverse of the median

'None'

Field is optional

flatUserScale

If flatScalingType is ‘USER’ then scale flat by this amount; ignored otherwise (float, default 1.0)

fluxMag0T1

The approximate flux of a zero-magnitude object in a one-second exposure, per filter. (Dict, default {'Unknown': 158489319246.11172})

fringe

Fringe subtraction task (ConfigurableInstance, default <class 'lsst.ip.isr.fringe.FringeConfig'>)

fringeAfterFlat

Do fringe subtraction after flat-fielding? (bool, default True)

fwhm

FWHM of PSF in arcseconds. (float, default 1.0)

gain

The gain to use if no Detector is present in the Exposure (ignored if NaN) (float, default nan)

growSaturationFootprintSize

Number of pixels by which to grow the saturation footprints (int, default 1)

history

illumFilters

Only perform illumination correction for these filters. (List, default [])

illumScale

Scale factor for the illumination correction. (float, default 1.0)

illuminationCorrectionDataProductName

Name of the illumination correction data product. (str, default 'illumcor')

isrStats

Task to calculate additional statistics. (ConfigurableInstance, default <class 'lsst.ip.isr.isrStatistics.IsrStatisticsTaskConfig'>)

maskListToInterpolate

List of mask planes that should be interpolated. (List, default ['SAT', 'BAD'])

maskNegativeVariance

Mask pixels that claim a negative variance? This likely indicates a failure in the measurement of the overscan at an edge due to the data falling off faster than the overscan model can account for it. (bool, default True)

masking

Masking task. (ConfigurableInstance, default <class 'lsst.ip.isr.masking.MaskingConfig'>)

negativeVarianceMaskName

Mask plane to use to mark pixels with negative variance, if maskNegativeVariance is True. (str, default 'BAD')

normalizeGains

Normalize all the amplifiers in each CCD to have the same median value. (bool, default False)

numEdgeSuspect

Number of edge pixels to be flagged as untrustworthy. (int, default 0)

overscan

Overscan subtraction task for image segments. (ConfigurableInstance, default <class 'lsst.ip.isr.overscan.OverscanCorrectionTaskConfig'>)

qa

QA related configuration options. (IsrQaConfig, default <class 'lsst.ip.isr.isrQa.IsrQaConfig'>)

readNoise

The read noise to use if no Detector is present in the Exposure (float, default 0.0)

safe

Safety margin for CFHT sensors gain determination (float, default 0.95)

saturatedMaskName

Name of mask plane to use in saturation detection and interpolation (str, default 'SAT')

saturation

The saturation level to use if no Detector is present in the Exposure (ignored if NaN) (float, default nan)

saveLogOutput

Flag to enable/disable saving of log output for a task, enabled by default. (bool, default True)

saveMetadata

Flag to enable/disable metadata saving for a task, enabled by default. (bool, default True)

strayLight

y-band stray light correction (ConfigurableInstance, default <class 'lsst.ip.isr.straylight.StrayLightConfig'>)

suspectMaskName

Name of mask plane to use for suspect pixels (str, default 'SUSPECT')

useFallbackDate

Pass observation date when using fallback filter. (bool, default False)

usePtcGains

Use the gain values from the Photon Transfer Curve? (bool, default False)

usePtcReadNoise

Use readnoise values from the Photon Transfer Curve? (bool, default False)

vignette

Vignetting task. (ConfigurableInstance, default <class 'lsst.ip.isr.vignette.VignetteConfig'>)

vignetteValue

Value to replace image array pixels with in the vignetted region? Ignored if None. (float, default None)

Methods Documentation

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 is True.

rtol : float, optional

Relative tolerance for floating point comparisons.

atol : float, optional

Absolute tolerance for floating point comparisons.

output : callable, optional

A callable that takes a string, used (possibly repeatedly) to report inequalities.

Returns:

isEqual : bool

True when the two lsst.pex.config.Config instances are equal. False if there is an inequality.

See also

lsst.pex.config.compareConfigs

Notes

Unselected targets of RegistryField fields and unselected choices of ConfigChoiceField 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.

Returns:

history : str

A string containing the formatted history.

See also

lsst.pex.config.history.format

freeze()

Make this config, and all subconfigs, read-only.

items()

Get configurations as (field name, field value) pairs.

Returns:

items : dict_items

Iterator of tuples for each configuration. Tuple items are:

0. Field name.
1. Field value.

keys()

Get field names.

Returns:

names : dict_keys

List of lsst.pex.config.Field names.

See also

lsst.pex.config.Config.iterkeys

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 to 5.

See also

lsst.pex.config.Config.loadFromStream

lsst.pex.config.Config.loadFromString

lsst.pex.config.Config.save

lsst.pex.config.Config.saveToStream

lsst.pex.config.Config.saveToString

loadFromStream(stream, root='config', filename=None)

Modify this Config in place by executing the Python code in the provided stream.

Parameters:

stream : file-like object, str, bytes, or compiled string

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 to 5.

filename : str, optional

Name of the configuration file, or None if unknown or contained in the stream. Used for error reporting.

See also

lsst.pex.config.Config.load

lsst.pex.config.Config.loadFromString

lsst.pex.config.Config.save

lsst.pex.config.Config.saveToStream

lsst.pex.config.Config.saveToString

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)

Modify this Config in place by executing the Python code in the provided string.

Parameters:

code : str, bytes, or compiled string

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 to 5.

filename : str, optional

Name of the configuration file, or None if unknown or contained in the stream. Used for error reporting.

See also

lsst.pex.config.Config.load

lsst.pex.config.Config.loadFromStream

lsst.pex.config.Config.save

lsst.pex.config.Config.saveToStream

lsst.pex.config.Config.saveToString

names()

Get all the field names in the config, recursively.

Returns:

names : list of str

Field names.

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).

See also

lsst.pex.config.Config.saveToStream

lsst.pex.config.Config.saveToString

lsst.pex.config.Config.load

lsst.pex.config.Config.loadFromStream

lsst.pex.config.Config.loadFromString

saveToStream(outfile, root='config', skipImports=False)

Save a configuration file to a stream, which, when loaded, reproduces this config.

Parameters:

outfile : file-like object

Destination file object write the config into. Accepts strings not bytes.

root

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 include import statements in output, this is to support human-oriented output from pipetask where additional clutter is not useful.

See also

lsst.pex.config.Config.save

lsst.pex.config.Config.saveToString

lsst.pex.config.Config.load

lsst.pex.config.Config.loadFromStream

lsst.pex.config.Config.loadFromString

saveToString(skipImports=False)

Return the Python script form of this configuration as an executable string.

Parameters:

skipImports : bool, optional

If True then do not include import statements in output, this is to support human-oriented output from pipetask where additional clutter is not useful.

Returns:

code : str

A code string readable by loadFromString.

See also

lsst.pex.config.Config.save

lsst.pex.config.Config.saveToStream

lsst.pex.config.Config.load

lsst.pex.config.Config.loadFromStream

lsst.pex.config.Config.loadFromString

setDefaults()

Subclass hook for computing defaults.

Notes

Derived Config classes that must compute defaults rather than using the Field instances’s defaults should do so here. To correctly use inherited defaults, implementations of setDefaults must call their base class’s setDefaults.

toDict()

Make a dictionary of field names and their values.

Returns:

dict_ : dict

Dictionary with keys that are Field names. Values are Field values.

See also

lsst.pex.config.Field.toDict

Notes

This method uses the toDict method of individual fields. Subclasses of Field may need to implement a toDict 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 a Config 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 and fieldC:

>>> 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 and ConfigChoiceField) are defined in lsst.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 : dict_values

Iterator of field values.