Inheritance diagram for pyhyperiso.core.Core.Parameter.Parameter:

Public Member Functions
None	__init__ (self, ParamId pid, Union[float, complex, Scalar] expected, Union[float, complex, Scalar] stat, Union[float, complex, Scalar] syst, Optional[float] scale=None, Optional[List] bin=None)

Scalar	value (self)

Tuple[Scalar, Scalar]	std (self)

Scalar	combined_std (self)

ParamId	pid (self)

None	set_expected (self, Union[float, complex, Scalar] val)

None	set_std (self, Union[float, complex, Scalar] stat, Union[float, complex, Scalar] syst)

None	set_shift (self, Union[float, complex, Scalar] shift)

None	set_mode (self, ParameterMode mode)

str	__repr__ (self)

Static Public Member Functions
"Parameter"	from_cpp (cpp_obj)

Protected Attributes
	_cpp_obj

Detailed Description

Python wrapper around the C++ ``Parameter`` object.

Parameters store a central value and statistical/systematic uncertainties.
They may also carry optional metadata such as a scale or bin range. Numeric
inputs are converted to the package ``Scalar`` type before crossing the
pybind boundary.

Args:
    pid: Parameter identifier.
    expected: Central value.
    stat: Statistical uncertainty.
    syst: Systematic uncertainty.
    scale: Optional scale metadata.
    bin: Optional bin metadata forwarded to the C++ object.

Examples:
    >>> pid = ParamId(type=ParameterType.SM, block="MASS", code=25)
    >>> p = Parameter(pid, expected=125.0, stat=0.1, syst=0.2)
    >>> p.combined_std
    Scalar(...)

Definition at line 27 of file Parameter.py.

Constructor & Destructor Documentation

◆ init()

None pyhyperiso.core.Core.Parameter.Parameter.__init__	(		self,
		ParamId	pid,
		Union[float, complex, Scalar]	expected,
		Union[float, complex, Scalar]	stat,
		Union[float, complex, Scalar]	syst,
		Optional[float]	scale = `None`,
		Optional[List]	bin = `None`
	)

Reimplemented in pyhyperiso.core.Core.Parameter.PyDependentParameter.

Definition at line 50 of file Parameter.py.

Member Function Documentation

◆ repr()

str pyhyperiso.core.Core.Parameter.Parameter.__repr__ ( self )

Return a readable representation for debugging.

Definition at line 128 of file Parameter.py.

◆ combined_std()

Scalar pyhyperiso.core.Core.Parameter.Parameter.combined_std ( self )

Combined uncertainty according to the C++ parameter rules.

Definition at line 82 of file Parameter.py.

◆ from_cpp()

"Parameter" pyhyperiso.core.Core.Parameter.Parameter.from_cpp ( cpp_obj )

static

Wrap an existing bound C++ ``Parameter``.

Args:
    cpp_obj: Bound C++ parameter instance.

Returns:
    Python wrapper sharing the provided C++ object.

Definition at line 136 of file Parameter.py.

◆ pid()

ParamId pyhyperiso.core.Core.Parameter.Parameter.pid ( self )

Identifier of this parameter.

Definition at line 87 of file Parameter.py.

◆ set_expected()

None pyhyperiso.core.Core.Parameter.Parameter.set_expected	(		self,
		Union[float, complex, Scalar]	val
	)

Set the central value.

Args:
    val: New expected value.

Definition at line 91 of file Parameter.py.

◆ set_mode()

None pyhyperiso.core.Core.Parameter.Parameter.set_mode	(		self,
		ParameterMode	mode
	)

Set whether the parameter is fixed or shiftable.

Args:
    mode: New parameter mode.

Definition at line 120 of file Parameter.py.

◆ set_shift()

None pyhyperiso.core.Core.Parameter.Parameter.set_shift	(		self,
		Union[float, complex, Scalar]	shift
	)

Set the active shift value for a shiftable parameter.

Args:
    shift: Shift value forwarded to C++.

Definition at line 112 of file Parameter.py.

◆ set_std()

None pyhyperiso.core.Core.Parameter.Parameter.set_std	(		self,
		Union[float, complex, Scalar]	stat,
		Union[float, complex, Scalar]	syst
	)

Set statistical and systematic uncertainties.

Args:
    stat: Statistical uncertainty.
    syst: Systematic uncertainty.

Definition at line 99 of file Parameter.py.

◆ std()

Tuple[Scalar, Scalar] pyhyperiso.core.Core.Parameter.Parameter.std ( self )

Statistical and systematic uncertainties as ``(stat, syst)``.

Definition at line 76 of file Parameter.py.

◆ value()

Scalar pyhyperiso.core.Core.Parameter.Parameter.value ( self )

Current parameter value after any active shift.

Definition at line 71 of file Parameter.py.

Member Data Documentation

◆ _cpp_obj

pyhyperiso.core.Core.Parameter.Parameter._cpp_obj

protected

Definition at line 59 of file Parameter.py.

The documentation for this class was generated from the following file:

/home/runner/work/Hyperiso/Hyperiso/Hyperiso/Hyperiso/pyhyperiso/core/Core/Parameter.py

Public Member Functions

Static Public Member Functions

Protected Attributes