LSST Applications g044012fb7c+6976b5ec80,g04a91732dc+88a5fc122b,g07dc498a13+7e3c5f68a2,g114c6a66ad+09472d7a76,g1409bbee79+7e3c5f68a2,g1a7e361dbc+7e3c5f68a2,g1fd858c14a+3a43eabc0e,g35bb328faa+fcb1d3bbc8,g3bd4b5ce2c+2647bb081c,g4e0f332c67+5d362be553,g53246c7159+fcb1d3bbc8,g5477a8d5ce+b19c77c7ae,g58d0cdf3ff+4a2e102ff8,g60b5630c4e+09472d7a76,g623d845a50+09472d7a76,g6f0c2978f1+fcf1c0bcd6,g71fabbc107+09472d7a76,g75b6c65c88+d0b1dc44cc,g78460c75b0+2f9a1b4bcd,g786e29fd12+cf7ec2a62a,g7b71ed6315+fcb1d3bbc8,g8852436030+349c7e81d4,g89139ef638+7e3c5f68a2,g9125e01d80+fcb1d3bbc8,g95236ca021+f7a31438ed,g989de1cb63+7e3c5f68a2,g9f33ca652e+f17d666fbc,gaaedd4e678+7e3c5f68a2,gabe3b4be73+1e0a283bba,gb1101e3267+f870f33517,gb58c049af0+f03b321e39,gc99c83e5f0+76d20ab76d,gcf25f946ba+349c7e81d4,gd0fa69b896+f3a65fa83c,gd6cbbdb0b4+c8606af20c,gde0f65d7ad+5bd27d919f,ge278dab8ac+932305ba37,gfba249425e+fcb1d3bbc8,w.2025.07
LSST Data Management Base Package
|
Public Member Functions | |
__iter__ (self) | |
keys (self) | |
values (self) | |
items (self) | |
__contains__ (self, name) | |
__new__ (cls, *args, **kw) | |
__reduce__ (self) | |
setDefaults (self) | |
update (self, **kw) | |
load (self, filename, root="config") | |
loadFromStream (self, stream, root="config", filename=None, extraLocals=None) | |
loadFromString (self, code, root="config", filename=None, extraLocals=None) | |
save (self, filename, root="config") | |
saveToString (self, skipImports=False) | |
saveToStream (self, outfile, root="config", skipImports=False) | |
freeze (self) | |
toDict (self) | |
names (self) | |
validate (self) | |
formatHistory (self, name, **kwargs) | |
__setattr__ (self, attr, value, at=None, label="assignment") | |
__delattr__ (self, attr, at=None, label="deletion") | |
__eq__ (self, other) | |
__ne__ (self, other) | |
__str__ (self) | |
__repr__ (self) | |
compare (self, other, shortcut=True, rtol=1e-8, atol=1e-8, output=None) | |
__init_subclass__ (cls, **kwargs) | |
Protected Member Functions | |
_save (self, outfile) | |
_collectImports (self) | |
_rename (self, name) | |
_fromPython (cls, config_py) | |
Protected Attributes | |
bool | _frozen = True |
_name = name | |
dict | _fields = {} |
_source = getStackFrame() | |
Static Protected Attributes | |
dict | _storage [str, Any] |
dict | _history [str, list[Any]] |
set | _imports [Any] |
Properties | |
history = property(lambda x: x._history) | |
Definition at line 950 of file diaCalculationPlugins.py.
|
inherited |
Return `True` if the specified field exists in this config. Parameters ---------- name : `str` Field name to test for. Returns ------- in : `bool` `True` if the specified field exists in the config.
Definition at line 1010 of file config.py.
|
inherited |
|
inherited |
Definition at line 1593 of file config.py.
|
inherited |
Run initialization for every subclass. Specifically registers the subclass with a YAML representer and YAML constructor (if pyyaml is available)
Definition at line 1662 of file config.py.
|
inherited |
|
inherited |
|
inherited |
Allocate a new `lsst.pex.config.Config` object. In order to ensure that all Config object are always in a proper state when handed to users or to derived `~lsst.pex.config.Config` classes, some attributes are handled at allocation time rather than at initialization. This ensures that even if a derived `~lsst.pex.config.Config` class implements ``__init__``, its author does not need to be concerned about when or even the base ``Config.__init__`` should be called.
Definition at line 1025 of file config.py.
|
inherited |
Reduction for pickling (function with arguments to reproduce). We need to condense and reconstitute the `~lsst.pex.config.Config`, since it may contain lambdas (as the ``check`` elements) that cannot be pickled.
Definition at line 1058 of file config.py.
|
inherited |
|
inherited |
Set an attribute (such as a field's value). Notes ----- Unlike normal Python objects, `~lsst.pex.config.Config` objects are locked such that no additional attributes nor properties may be added to them dynamically. Although this is not the standard Python behavior, it helps to protect users from accidentally mispelling a field name, or trying to set a non-existent field.
Definition at line 1550 of file config.py.
|
inherited |
|
protectedinherited |
Add module containing self to the list of things to import and then loops over all the fields in the config calling a corresponding collect method. The field method will call _collectImports on any configs it may own and return the set of things to import. This returned set will be merged with the set of imports for this config class.
Reimplemented in lsst.pex.config.configChoiceField.ConfigChoiceField.
Definition at line 1406 of file config.py.
|
protectedinherited |
Instantiate a `Config`-subclass from serialized Python form. Parameters ---------- config_py : `str` A serialized form of the Config as created by `Config.saveToStream`. Returns ------- config : `Config` Reconstructed `Config` instant.
Definition at line 1676 of file config.py.
|
protectedinherited |
Rename this config object in its parent `~lsst.pex.config.Config`. Parameters ---------- name : `str` New name for this config in its parent `~lsst.pex.config.Config`. Notes ----- This method uses the `~lsst.pex.config.Field.rename` method of individual `lsst.pex.config.Field` instances. `lsst.pex.config.Field` subclasses may need to implement a ``rename`` method for *this* method to work. See Also -------- lsst.pex.config.Field.rename
Reimplemented in lsst.pex.config.configChoiceField.ConfigInstanceDict.
Definition at line 1474 of file config.py.
|
protectedinherited |
Save this config to an open stream object. Parameters ---------- outfile : file-like object Destination file object write the config into. Accepts strings not bytes.
Definition at line 1394 of file config.py.
|
inherited |
Compare this configuration to another `~lsst.pex.config.Config` for equality. Parameters ---------- other : `lsst.pex.config.Config` Other `~lsst.pex.config.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 `~lsst.pex.config.RegistryField` fields and unselected choices of `~lsst.pex.config.ConfigChoiceField` fields are not considered by this method. Floating point comparisons are performed by `numpy.allclose`.
Definition at line 1618 of file config.py.
|
inherited |
Format a configuration field's history to a human-readable format. Parameters ---------- name : `str` Name of a `~lsst.pex.config.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
Definition at line 1523 of file config.py.
|
inherited |
Make this config, and all subconfigs, read-only.
Reimplemented in lsst.pex.config.configChoiceField.ConfigChoiceField, and lsst.pex.config.configChoiceField.ConfigInstanceDict.
Definition at line 1388 of file config.py.
|
inherited |
Get configurations as ``(field name, field value)`` pairs. Returns ------- items : `~collections.abc.ItemsView` Iterator of tuples for each configuration. Tuple items are: 0. Field name. 1. Field value.
Definition at line 997 of file config.py.
|
inherited |
Get field names. Returns ------- names : `~collections.abc.KeysView` List of `lsst.pex.config.Field` names.
Definition at line 977 of file config.py.
|
inherited |
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
Definition at line 1142 of file config.py.
|
inherited |
Modify this Config in place by executing the Python code in the provided stream. Parameters ---------- stream : file-like object, `str`, `bytes`, or `~types.CodeType` 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. extraLocals : `dict` of `str` to `object`, optional Any extra variables to include in local scope when loading. 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. 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
Definition at line 1174 of file config.py.
|
inherited |
Modify this Config in place by executing the Python code in the provided string. Parameters ---------- code : `str`, `bytes`, or `~types.CodeType` 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. extraLocals : `dict` of `str` to `object`, optional Any extra variables to include in local scope when loading. Raises ------ ValueError Raised if a key in extraLocals is the same value as the value of the root argument. 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
Definition at line 1221 of file config.py.
|
inherited |
Get all the field names in the config, recursively. Returns ------- names : `list` of `str` Field names.
Definition at line 1444 of file config.py.
|
inherited |
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
Reimplemented in lsst.pex.config.configChoiceField.ConfigChoiceField.
Definition at line 1277 of file config.py.
|
inherited |
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 : `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 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
Definition at line 1339 of file config.py.
|
inherited |
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
Definition at line 1311 of file config.py.
|
inherited |
Subclass hook for computing defaults. Notes ----- Derived `~lsst.pex.config.Config` classes that must compute defaults rather than using the `~lsst.pex.config.Field` instances's defaults should do so here. To correctly use inherited defaults, implementations of ``setDefaults`` must call their base class's ``setDefaults``.
Reimplemented in lsst.pipe.tasks.background.MaskObjectsConfig, lsst.pipe.tasks.dataFrameActions._actions.NanoJansky, lsst.ip.diffim.dipoleMeasurement.DipoleMeasurementConfig, lsst.ip.diffim.subtractImages.AlardLuptonSubtractBaseConfig, lsst.ip.isr.ampOffset.AmpOffsetConfig, lsst.meas.algorithms.computeExPsf.ComputeExPsfConfig, lsst.meas.algorithms.measureApCorr.MeasureApCorrConfig, lsst.meas.algorithms.noise_covariance.ComputeNoiseCorrelationConfig, lsst.meas.algorithms.normalizedCalibrationFlux.NormalizedCalibrationFluxConfig, lsst.meas.algorithms.scaleVariance.ScaleVarianceConfig, lsst.meas.base.forcedMeasurement.ForcedMeasurementConfig, lsst.meas.modelfit.cmodel.cmodelContinued.CModelForcedConfig, lsst.meas.modelfit.cmodel.cmodelContinued.CModelSingleFrameConfig, lsst.meas.modelfit.psf.psfContinued.GeneralShapeletPsfApproxForcedConfig, and lsst.meas.modelfit.psf.psfContinued.GeneralShapeletPsfApproxSingleFrameConfig.
Definition at line 1071 of file config.py.
|
inherited |
Make a dictionary of field names and their values. Returns ------- dict_ : `dict` Dictionary with keys that are `~lsst.pex.config.Field` names. Values are `~lsst.pex.config.Field` values. See Also -------- lsst.pex.config.Field.toDict Notes ----- This method uses the `~lsst.pex.config.Field.toDict` method of individual fields. Subclasses of `~lsst.pex.config.Field` may need to implement a ``toDict`` method for *this* method to work.
Reimplemented in lsst.pex.config.configChoiceField.ConfigChoiceField.
Definition at line 1420 of file config.py.
|
inherited |
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 `~lsst.pex.config.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!'
Definition at line 1084 of file config.py.
|
inherited |
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 `~lsst.pex.config.Field.validate` methods. Complex single-field validation can be defined by deriving new Field types. For convenience, some derived `lsst.pex.config.Field`-types (`~lsst.pex.config.ConfigField` and `~lsst.pex.config.ConfigChoiceField`) are defined in ``lsst.pex.config`` that handle recursing into subconfigs. Inter-field relationships should only be checked in derived `~lsst.pex.config.Config` classes after calling this method, and base validation is complete.
Reimplemented in lsst.fgcmcal.sedterms.Sedterm, lsst.pex.config.configChoiceField.ConfigChoiceField, lsst.pex.config.configurableActions.tests.ActionTest1, lsst.pex.config.configurableActions.tests.ActionTest2, lsst.pex.config.configurableActions.tests.ActionTest3, lsst.pex.config.configurableActions.tests.TestDivideAction, lsst.pipe.tasks.background.MaskObjectsConfig, lsst.pipe.tasks.measurementDriver.MeasurementDriverBaseConfig, lsst.afw.geom.transformConfig.RadialTransformConfig, lsst.meas.algorithms.gaussianPsfFactory.GaussianPsfFactory, lsst.meas.algorithms.measureApCorr.MeasureApCorrConfig, lsst.meas.algorithms.treecorrUtils.TreecorrConfig, lsst.meas.base.baseMeasurement.BaseMeasurementConfig, and lsst.meas.base.compensatedGaussian._compensatedTophat.SingleFrameCompensatedTophatFluxConfig.
Definition at line 1497 of file config.py.
|
inherited |
Get field values. Returns ------- values : `~collections.abc.ValuesView` Iterator of field values.
Definition at line 987 of file config.py.
|
protectedinherited |
|
protectedinherited |
|
staticprotectedinherited |
|
staticprotectedinherited |
|
protectedinherited |
|
protectedinherited |
|
staticprotectedinherited |
|
staticinherited |