Source code for pyaml.tuning_tools.response_matrix_data

from pathlib import Path
from typing import Optional

from pydantic import BaseModel, ConfigDict

from pyaml.common.element import __pyaml_repr__
from pyaml.configuration.factory import Factory

from .. import PyAMLException
from ..configuration.fileloader import load

PYAMLCLASS = "ResponseMatrixData"




class ConfigModel(BaseModel):
    """
    Base configuration model for response matrix

    Parameters
    ----------
    matrix : list[list[float]]
        Response matrix data (rows for observable, cols for variables)
    variable_names : list[str], optional
        Variable names, basically the actuators
    observables_names : list[str]
        Observable names, basically the measurements
    """

    matrix: list[list[float]]
    variable_names: Optional[list[str]]
    observable_names: list[str]





class ResponseMatrixData(object):
    """
    Generic response matrix loader
    """

    def __init__(self, cfg: ConfigModel):
        self._cfg = cfg



    @staticmethod
    def load(filename: str) -> "ResponseMatrixData":
        """
        Load a reponse matrix from a configuration file
        """
        path = Path(filename)
        if path.exists():
            config_dict = load(str(path.resolve()))
            return Factory.build(config_dict, ignore_external=False)
        else:
            raise PyAMLException(f"{filename}: file not found")


    def __repr__(self):
        return __pyaml_repr__(self)