## On this page # py\_os\_parameter Last update: 16.07.2025 ## *class* py\_os\_parameter.DProp #### \_\_init\_\_() ## *class* py\_os\_parameter.DPropList #### \_\_init\_\_() #### \_\_iter\_\_() → object #### dprop\_export\_list() → [DPropList](#py_os_parameter.DPropList) #### push\_back(arg2: [DPropPair](#py_os_parameter.DPropPair)) #### size() → int ## *class* py\_os\_parameter.DPropPair #### \_\_init\_\_() #### *property* first #### *property* second ## *class* py\_os\_parameter.ParameterList #### \_\_init\_\_() #### \_\_iter\_\_() → object #### param\_export\_list() → [ParameterList](#py_os_parameter.ParameterList) #### push\_back(arg2: [PyParameter](#py_os_parameter.PyParameter)) #### size() → int ## *class* py\_os\_parameter.PyParameter #### \_\_eq\_\_(arg2: PyParameter) → bool #### \_\_init\_\_() #### \_\_init\_\_(arg2: str) #### \_\_init\_\_(arg2: str, arg3: float, arg4: float, arg5: float, arg6: int) #### \_\_init\_\_(arg2: str, arg3: float, arg4: float, arg5: [PyOSDesignEntry](py_os_design.md#py_os_design.PyOSDesignEntry), arg6: int) #### \_\_init\_\_(arg2: str, arg3: [PyOSDesignEntryVec](py_os_design.md#py_os_design.PyOSDesignEntryVec), arg4: [DeterministicType](dynardo_py_algorithms.md#dynardo_py_algorithms.DeterministicType)) #### \_\_init\_\_(arg2: str, arg3: str) #### \_\_init\_\_(arg2: str, arg3: [RandomVariableType](dynardo_py_algorithms.md#dynardo_py_algorithms.RandomVariableType), arg4: [RandomVariableKind](dynardo_py_algorithms.md#dynardo_py_algorithms.RandomVariableKind), arg5: [PyOSDesignEntry](py_os_design.md#py_os_design.PyOSDesignEntry)) #### \_\_is\_equal\_\_(arg2: PyParameter) → bool #### \_\_is\_not\_equal\_\_(arg2: [PyParameter](#py_os_parameter.PyParameter)) → bool #### \_\_ne\_\_(arg2: [PyParameter](#py_os_parameter.PyParameter)) → bool #### erase\_det\_prop(name: str) #### get\_dependency\_expression() → str #### get\_det\_discrete\_states() → [PyOSDesignEntryVec](py_os_design.md#py_os_design.PyOSDesignEntryVec) #### get\_det\_kind() → [DeterministicType](dynardo_py_algorithms.md#dynardo_py_algorithms.DeterministicType) #### get\_det\_prop\_by\_index(index: int) → [DProp](#py_os_parameter.DProp) #### get\_det\_prop\_name(index: int) → object #### get\_det\_props() → [DPropList](#py_os_parameter.DPropList) #### get\_det\_type() → [EntryType](py_os_design.md#py_os_design.EntryType) #### get\_id() → [UUID](id.md#id.UUID) #### get\_lower\_bound() → [PyOSDesignEntry](py_os_design.md#py_os_design.PyOSDesignEntry) #### get\_mutable\_map() → object #### get\_name() → str #### get\_parameter\_type() → [ParameterType](dynardo_py_algorithms.md#dynardo_py_algorithms.ParameterType) #### get\_ran\_cov() → float #### get\_ran\_kind() → [RandomVariableKind](dynardo_py_algorithms.md#dynardo_py_algorithms.RandomVariableKind) #### get\_ran\_parameters() → [doubleVec](stdcpp_python_export.md#stdcpp_python_export.doubleVec) #### get\_ran\_prop() → [RanProp](#py_os_parameter.RanProp) #### get\_ran\_statistical\_moments() → [doubleVec](stdcpp_python_export.md#stdcpp_python_export.doubleVec) #### get\_ran\_type() → [RandomVariableType](dynardo_py_algorithms.md#dynardo_py_algorithms.RandomVariableType) #### get\_reference\_value() → [PyOSDesignEntry](py_os_design.md#py_os_design.PyOSDesignEntry) #### get\_upper\_bound() → [PyOSDesignEntry](py_os_design.md#py_os_design.PyOSDesignEntry) #### has\_continuous\_distribution() → bool #### has\_marginal\_distribution() → bool #### has\_set\_ran\_cov() → bool #### has\_set\_ran\_parameters() → bool #### has\_set\_ran\_statistical\_moments() → bool #### is\_active() → bool #### is\_const() → bool #### is\_continuous() → bool #### is\_dependent() → bool #### is\_empirical() → bool #### is\_mixed() → bool #### is\_modifiable() → bool #### is\_mutable(member: object) → bool #### is\_optimization() → bool #### is\_pure\_optimization() → bool #### is\_pure\_stochastic() → bool #### is\_ran\_prop\_validated() → bool #### is\_stochastic() → bool #### rename\_det\_prop(arg2: str) #### rename\_det\_prop(arg2: str, to: str) #### rename\_parameter(to: str) #### set\_active(active: bool) #### set\_bounds(lower\_bound: PyOSDesignEntry, upper\_bound: PyOSDesignEntry) #### set\_const(constant: bool) #### set\_dependent(expression: str) #### set\_det\_prop\_by\_index(value: [DProp](#py_os_parameter.DProp), index: int) #### set\_discrete\_states(states: PyOSDesignEntryVec) #### set\_kind(kind: [DeterministicType](dynardo_py_algorithms.md#dynardo_py_algorithms.DeterministicType)) #### set\_lower\_bound(value: PyOSDesignEntry) #### set\_modifiable(arg2: bool) #### set\_mutable(member: object, state: bool) #### set\_mutable\_map(arg2: object) #### set\_parameter\_type(type: [ParameterType](dynardo_py_algorithms.md#dynardo_py_algorithms.ParameterType)) #### set\_ran\_cov(cov: float) → float #### set\_ran\_kind(kind: [RandomVariableKind](dynardo_py_algorithms.md#dynardo_py_algorithms.RandomVariableKind)) #### set\_ran\_parameters(parameters: [doubleVec](stdcpp_python_export.md#stdcpp_python_export.doubleVec)) #### set\_ran\_prop\_validated(arg2: bool) #### set\_ran\_statistical\_moments(moments: [doubleVec](stdcpp_python_export.md#stdcpp_python_export.doubleVec)) #### set\_ran\_type(type: [RandomVariableType](dynardo_py_algorithms.md#dynardo_py_algorithms.RandomVariableType)) #### set\_reference\_value(value: PyOSDesignEntry) #### set\_type(type: [EntryType](py_os_design.md#py_os_design.EntryType)) #### set\_upper\_bound(value: PyOSDesignEntry) ## *class* py\_os\_parameter.PyParameterManager #### \_\_eq\_\_(arg2: PyParameterManager) → bool #### \_\_init\_\_() #### \_\_is\_equal\_\_(arg2: PyParameterManager) → bool #### \_\_is\_not\_equal\_\_(arg2: [PyParameterManager](#py_os_parameter.PyParameterManager)) → bool #### \_\_iter\_\_() → object #### \_\_len\_\_() → int #### \_\_ne\_\_(arg2: [PyParameterManager](#py_os_parameter.PyParameterManager)) → bool #### add\_dependent\_parameter(parameter\_name: str, expression: str) #### add\_deterministic\_continuous\_parameter(name: str, lower\_bound: float, upper\_bound: float, reference\_value: float) Add a new deterministic continuous parameter. A range\_mode of 1 or 2 sets a relative lower respectively upper bound. A range\_mode of 3 sets both bounds relative. ```python pm = PyParameterManager() pm.add_deterministic_continuous_parameter('a', 0., 3., 1.5) ``` #### add\_parameter(name: str) #### add\_stochastic\_parameter(name: str, type: [RandomVariableType](dynardo_py_algorithms.md#dynardo_py_algorithms.RandomVariableType), kind: [RandomVariableKind](dynardo_py_algorithms.md#dynardo_py_algorithms.RandomVariableKind), reference\_value: [PyOSDesignEntry](py_os_design.md#py_os_design.PyOSDesignEntry)) Add a new stochastic parameter. It is required to set a parameter type and random parameters afterwards. ```python pm = PyParameterManager() pm.add_stochastic_parameter('s1', RandomVariableType.NORMAL, RandomVariableKind.DETERMINISTIC, PyOSDesignEntry(0.72)) pm.set_parameter_type('s1', ParameterType.STOCHASTIC) pm.set_ran_parameters('s1', double_list_to_vec([0.72, 0.3])) # normal distribution: mu, sigmah ``` #### clear() #### contains\_parameter(name: str) → bool #### contains\_parameter(id: [UUID](id.md#id.UUID)) → bool #### empty() → bool #### erase\_correlation(arg2: str, parameter\_name: str) → bool #### erase\_correlations(parameter\_name\_b: str) → bool #### erase\_parameter(parameter\_name: str) #### get\_bounds(parameter\_name: str, lower\_bound: [PyOSDesignEntry](py_os_design.md#py_os_design.PyOSDesignEntry), upper\_bound: [PyOSDesignEntry](py_os_design.md#py_os_design.PyOSDesignEntry)) #### get\_bounds(parameter\_name: str) → tuple \[0\] Note, that lower\_bound and upper\_bound are output arguments. \[1\] Return a parameter’s boundaries as a tuple. #### get\_det\_props() → [DPropList](#py_os_parameter.DPropList) #### get\_det\_props\_by\_index(parameter\_name: str, index: int) → [DProp](#py_os_parameter.DProp) #### get\_parameter(parameter\_name: str) → [PyParameter](#py_os_parameter.PyParameter) #### get\_parameter(parameter\_id: [UUID](id.md#id.UUID)) → [PyParameter](#py_os_parameter.PyParameter) #### get\_parameter\_by\_index(index: int) → [PyParameter](#py_os_parameter.PyParameter) #### get\_parameters() → [ParameterList](#py_os_parameter.ParameterList) #### get\_ran\_prop(parameter\_name: str) → [RanProp](#py_os_parameter.RanProp) #### get\_ran\_props() → [RanPropList](#py_os_parameter.RanPropList) #### get\_reference\_design() → [PyOSDesignEntryVec](py_os_design.md#py_os_design.PyOSDesignEntryVec) #### get\_reference\_design\_point() → [PyOSDesignPoint](py_os_design.md#py_os_design.PyOSDesignPoint) #### get\_size() → int #### get\_unique\_name() → str #### import\_from\_csv(csv: Path path) Add parameters from csv to parameter manager. #### import\_from\_json(path: [Path](stdcpp_python_export.md#stdcpp_python_export.Path)) Add parameters from json to parameter manager. #### import\_from\_json\_string(content: str) Add parameters from json string to parameter manager. #### insert\_parameter(parameter: [PyParameter](#py_os_parameter.PyParameter)) #### rename\_det\_prop(parameter\_name: str, from: str, to: str) #### rename\_parameter(from: str, to: str) #### reset\_correlations() #### save\_to\_csv(csv: Path path) Save parameter manager to a csv file. #### save\_to\_json(path: [Path](stdcpp_python_export.md#stdcpp_python_export.Path)) Save parameter manager to a json file. #### set\_active(parameter\_name: str, active: bool) #### set\_bounds(parameter\_name: str, lower\_bound: PyOSDesignEntry, upper\_bound: PyOSDesignEntry) #### set\_const\_all\_in\_list(names: WStrList) → [PyParameterManager](#py_os_parameter.PyParameterManager) #### set\_const\_flag(parameter\_name: str) #### set\_correlation(parameter\_name\_a: str, parameter\_name\_b: str, value: float) → bool #### set\_dependent(parameter\_name: str, expression: str) #### set\_discrete\_states(parameter\_name: str, discrete\_states: [PyOSDesignEntryVec](py_os_design.md#py_os_design.PyOSDesignEntryVec)) #### set\_kind(parameter\_name: str, kind: [DeterministicType](dynardo_py_algorithms.md#dynardo_py_algorithms.DeterministicType)) #### set\_lower\_bound(parameter\_name: str, value: PyOSDesignEntry) #### set\_modifiable(parameter\_name: str, modifiable: bool) #### set\_parameter\_type(parameter\_name: str, type: [ParameterType](dynardo_py_algorithms.md#dynardo_py_algorithms.ParameterType)) #### set\_ran\_cov(parameter\_name: str, cov: float) → float #### set\_ran\_kind(parameter\_name: str, kind: [RandomVariableKind](dynardo_py_algorithms.md#dynardo_py_algorithms.RandomVariableKind)) #### set\_ran\_parameters(parameter\_name: str, parameters: [doubleVec](stdcpp_python_export.md#stdcpp_python_export.doubleVec)) #### set\_ran\_statistical\_moments(parameter\_name: str, moments: [doubleVec](stdcpp_python_export.md#stdcpp_python_export.doubleVec)) #### set\_ran\_type(parameter\_name: str, type: [RandomVariableType](dynardo_py_algorithms.md#dynardo_py_algorithms.RandomVariableType)) #### set\_reference\_design\_point(design\_point: [PyOSDesignPoint](py_os_design.md#py_os_design.PyOSDesignPoint)) #### set\_reference\_value(parameter\_name: str, value: PyOSDesignEntry) #### set\_type(parameter\_name: str, type: [EntryType](py_os_design.md#py_os_design.EntryType)) #### set\_upper\_bound(parameter\_name: str, value: PyOSDesignEntry) ## *class* py\_os\_parameter.RanProp #### \_\_init\_\_() ## *class* py\_os\_parameter.RanPropList #### \_\_init\_\_() #### \_\_iter\_\_() → object #### push\_back(arg2: [RanPropPair](#py_os_parameter.RanPropPair)) #### ran\_prop\_export\_list() → [RanPropList](#py_os_parameter.RanPropList) #### size() → int ## *class* py\_os\_parameter.RanPropPair #### \_\_init\_\_() #### *property* first #### *property* second ## py\_os\_parameter.get\_const\_parameter\_names(parameter\_manager: [PyParameterManager](#py_os_parameter.PyParameterManager), exclude\_dependent: bool) → [WStrList](stdcpp_python_export.md#stdcpp_python_export.WStrList) ## py\_os\_parameter.get\_dependent\_parameter\_names(parameter\_manager: [PyParameterManager](#py_os_parameter.PyParameterManager)) → [WStrList](stdcpp_python_export.md#stdcpp_python_export.WStrList) ## py\_os\_parameter.get\_lower\_bound\_values(parameter\_manager: [PyParameterManager](#py_os_parameter.PyParameterManager)) → [PyOSDesignPoint](py_os_design.md#py_os_design.PyOSDesignPoint) ## py\_os\_parameter.get\_non\_const\_det\_props(parameter\_manager: [PyParameterManager](#py_os_parameter.PyParameterManager)) → [DPropList](#py_os_parameter.DPropList) ## py\_os\_parameter.get\_non\_const\_parameter\_names(parameter\_manager: [PyParameterManager](#py_os_parameter.PyParameterManager), exclude\_dependent: bool) → [WStrList](stdcpp_python_export.md#stdcpp_python_export.WStrList) ## py\_os\_parameter.get\_non\_const\_ran\_props(parameter\_manager: [PyParameterManager](#py_os_parameter.PyParameterManager)) → [ParameterList](#py_os_parameter.ParameterList) ## py\_os\_parameter.get\_num\_non\_const\_det\_props(parameter\_manager: [PyParameterManager](#py_os_parameter.PyParameterManager)) → int ## py\_os\_parameter.get\_num\_non\_const\_ran\_props(parameter\_manager: [PyParameterManager](#py_os_parameter.PyParameterManager)) → int ## py\_os\_parameter.get\_parameter\_names(parameter\_manager: [PyParameterManager](#py_os_parameter.PyParameterManager)) → [WStrList](stdcpp_python_export.md#stdcpp_python_export.WStrList) ## py\_os\_parameter.get\_pure\_deterministic\_parameter\_names(parameter\_manager: [PyParameterManager](#py_os_parameter.PyParameterManager)) → [WStrList](stdcpp_python_export.md#stdcpp_python_export.WStrList) ## py\_os\_parameter.get\_pure\_stochastic\_parameter\_names(parameter\_manager: [PyParameterManager](#py_os_parameter.PyParameterManager)) → [WStrList](stdcpp_python_export.md#stdcpp_python_export.WStrList) ## py\_os\_parameter.get\_upper\_bound\_values(parameter\_manager: [PyParameterManager](#py_os_parameter.PyParameterManager)) → [PyOSDesignPoint](py_os_design.md#py_os_design.PyOSDesignPoint)