ParameterShifter.py

Go to the documentation of this file.

"""Mutable parameter shifter for nuisance/scan workflows."""
 
from __future__ import annotations
 
from typing import Union
 
from pyhyperiso.phyperiso.pyhyperiso.core import ParameterShifter as _CppParameterShifter
from pyhyperiso.core.Common.ParamId import ParamId
from pyhyperiso.core.Core.Parameter import ParameterMode
from pyhyperiso.core.Math.scalar import Scalar, _to_scalar
 
 
class ParameterShifter:
    """Python wrapper around the C++ ``ParameterShifter``.
 
    This class exposes the same Python surface as ``ParameterSetter`` but is
    backed by the C++ shifter object. It is useful for workflows that treat
    parameter changes as shifts rather than direct value replacement in the C++
    parameter layer.
    """
 
    def __init__(self) -> None:
        """Create a shifter bound to the current C++ parameter storage."""
        self._cpp_obj = _CppParameterShifter()
 
    def mutate(self, pid: ParamId, value: Union[float, complex, Scalar]) -> None:
        """Apply a new shifted value to a parameter.
 
        Args:
            pid: Parameter to shift.
            value: Shifted value. Numeric inputs are converted to ``Scalar``.
        """
        self._cpp_obj.mutate(pid._cpp_obj, _to_scalar(value)._cpp_obj)
 
    def change_mode(self, pid: ParamId, mode: ParameterMode) -> None:
        """Change a parameter update mode.
 
        Args:
            pid: Parameter to update.
            mode: New mode, such as ``ParameterMode.FIXED`` or
                ``ParameterMode.SHIFTABLE``.
        """
        self._cpp_obj.change_mode(pid._cpp_obj, mode.value)
 
 
__all__ = ["ParameterShifter"]