base

class ConfiguredData

Bases: object

Represents a configured data object with associated configuration and data.

property cfg: Config

Property that returns the configuration object.

property data: dict[str, ndarray]

Returns a dictionary containing the a copy of the stored data.

Returns:

A dictionary containing the a copy of the stored data.

Raises:

ValueError – If the data has not been initialized.

items(*, exclude=None, copy=True)

Returns a tuple of (key, value) pairs for the data, optionally excluding some keys.

Parameters:
  • exclude (Iterable[str] | None, default: None) – Keys to exclude from the returned items; defaults to None.

  • copy (bool, default: True) – Whether to return a copy of the data; defaults to True.

Return type:

tuple[tuple[str, ndarray], ...]

Returns:

A tuple of (key, value) pairs for the data.

keys(*, exclude=None)

Returns the keys of the trajectory data, excluding specified keys.

Parameters:

exclude (Iterable[str] | None, default: None) – Keys to exclude from the returned set of keys; defaults to None.

Return type:

tuple[str, ...]

Returns:

A tuple of strings representing the keys of the trajectory data.

Raises:

ValueError – If the configuration is not initialized.

property sha1: str

Calculates the SHA1 hash of the configured data.

values(*, exclude=None, copy=True)

Returns the values of the configured data.

Parameters:
  • exclude (Iterable[str] | None, default: None) – Keys to exclude from the returned values; defaults to None.

  • copy (bool, default: True) – Whether to return a copy of the data; defaults to True.

Return type:

tuple[ndarray, ...]

Returns:

The values of the configured data.