lsst.pipe.base
19.0.0-17-g9c22e3c+7
|
Public Member Functions | |
def | __init__ (self) |
def | addFileOverride (self, filename) |
def | addValueOverride (self, field, value) |
def | addPythonOverride |
def | addInstrumentOverride |
def | applyTo (self, config) |
Defines a set of overrides to be applied to a task config. Overrides for task configuration need to be applied by activator when creating task instances. This class represents an ordered set of such overrides which activator receives from some source (e.g. command line or some other configuration). Methods ---------- addFileOverride(filename) Add overrides from a specified file. addValueOverride(field, value) Add override for a specific field. applyTo(config) Apply all overrides to a `config` instance. Notes ----- Serialization support for this class may be needed, will add later if necessary.
Definition at line 37 of file configOverrides.py.
def lsst.pipe.base.configOverrides.ConfigOverrides.__init__ | ( | self | ) |
Definition at line 60 of file configOverrides.py.
def lsst.pipe.base.configOverrides.ConfigOverrides.addFileOverride | ( | self, | |
filename | |||
) |
Add overrides from a specified file. Parameters ---------- filename : str Path to the override file.
Definition at line 63 of file configOverrides.py.
def lsst.pipe.base.configOverrides.ConfigOverrides.addInstrumentOverride | ( | self, | |
instrument | |||
) |
Definition at line 102 of file configOverrides.py.
def lsst.pipe.base.configOverrides.ConfigOverrides.addPythonOverride | ( | self, | |
python_snippet | |||
) |
Definition at line 91 of file configOverrides.py.
def lsst.pipe.base.configOverrides.ConfigOverrides.addValueOverride | ( | self, | |
field, | |||
value | |||
) |
Add override for a specific field. This method is not very type-safe as it is designed to support use cases where input is given as string, e.g. command line activators. If `value` has a string type and setting of the field fails with `TypeError` the we'll attempt `eval()` the value and set the field with that value instead. Parameters ---------- field : str Fully-qualified field name. value : Value to be given to a filed.
Definition at line 73 of file configOverrides.py.
def lsst.pipe.base.configOverrides.ConfigOverrides.applyTo | ( | self, | |
config | |||
) |
Apply all overrides to a task configuration object. Parameters ---------- config : `pex.Config` Raises ------ `Exception` is raised if operations on configuration object fail.
Definition at line 117 of file configOverrides.py.