pybop._dataset#

Module Contents#

Classes#

Dataset

Represents a collection of experimental observations.
class pybop._dataset.Dataset(data_dictionary)[source]#

Represents a collection of experimental observations.

This class provides a structured way to store and work with experimental data, which may include applying operations such as interpolation.

Parameters:

  • name (str) – The name of the dataset, providing a label for identification.

  • data (array-like) – The actual experimental data, typically in a structured form such as a NumPy array or a pandas DataFrame.

Interpolant()[source]#

Create an interpolation function of the dataset based on the independent variable.

Currently, only time-based interpolation is supported. This method modifies the instance’s Interpolant attribute to be an interpolation function that can be evaluated at different points in time.

Raises:

NotImplementedError – If the independent variable for interpolation is not supported.

__repr__()[source]#

Return a string representation of the Dataset instance.

Returns:

A string that includes the type and contents of the dataset.

Return type:

str