pyaml.tuning_tools.response_matrix_data#

Serializable response-matrix data models.

The ResponseMatrixData model stores a numerical response matrix and the names of the variables and observables represented by its columns and rows. It is used to persist and exchange measured or calculated accelerator response data.

Classes

ResponseMatrixData(matrix, observable_names)

Response matrix data and its associated variable and observable names.
class pyaml.tuning_tools.response_matrix_data.ResponseMatrixData(matrix, observable_names, variable_names=None)#

Bases: DynamicValidation

Response matrix data and its associated variable and observable names.

Parameters:

  • matrix (list[list[float]]) – Response matrix values. Each row corresponds to an observable and each column corresponds to a variable. Each value has units of the corresponding observable divided by the corresponding variable.

  • variable_names (list[str] or None) – Names of the variables represented by the matrix columns, typically actuators. May be None if the names are unavailable.

  • observable_names (list[str]) – Names of the observables represented by the matrix rows, typically measured quantities.

Methods

load()

Load response matrix data from a configuration file.
static load(filename)#

Load response matrix data from a configuration file.

Parameters:

filename (str) – Path to the response matrix configuration file.

Returns:

ResponseMatrixData – Response matrix data constructed from the configuration file.

Raises:

PyAMLException – If the specified file does not exist.

Return type:

ResponseMatrixData