piel.types.experimental.experiment

Classes

ExperimentInstance	This is a specific instance of an measurement configuration. It can be the result of serialization a given
Experiment	This represents the fundamental data structure of an element in connectivity
ExperimentCollection	This class contains a collection of different experiments,

Module Contents

class ExperimentInstance(/, **data: Any)

Bases: piel.types.connectivity.core.Instance

This is a specific instance of an measurement configuration. It can be the result of serialization a given experiment configuration. The experiment contains all devices that correspond a specific setup. Each device contains a particular configuration, or may have information about the environment, etc.

components: list[piel.types.connectivity.generic.ComponentTypes] | tuple[piel.types.connectivity.generic.ComponentTypes] = []

Contains all references to the instantiated devices.

connections: list[piel.types.connectivity.generic.ConnectionTypes] | tuple[piel.types.connectivity.generic.ConnectionTypes] = []

All the connectivity information is stored here.

goal: str = ''

The goal of the experiment test.

parameters: dict

A dictionary of reference parameters in this measurement instance. Does not contain all the serialised measurement data.

index: int = 0

A defined index of the experiment instance tuple.

date_configured: str = ''

The date the experiment was configured.

date_measured: str = ''

The date the experiment was measured.

measurement_configuration_list: list[piel.types.experimental.measurements.generic.MeasurementConfigurationTypes] = []

class Experiment(/, **data: Any)

Bases: piel.types.connectivity.core.Instance

This represents the fundamental data structure of an element in connectivity

name: str = ''

Every experiment is required to have a name.

goal: str = ''

The goal of the complete experiment.

experiment_instances: list[ExperimentInstance] = []

Contains all the experiment instances.

parameters_list: list[dict]

List of basic important parameters in dictionaries used to do basic metadata analysis of the experiment.

parent_directory: piel.types.core.PathTypes = ''

Optional parameter to specify the parent_directory of the Experiment, where the directories containing the data and metadata of the ExperimentInstances are constructed.

__getitem__

property parameters

class ExperimentCollection(/, **data: Any)

Bases: piel.types.connectivity.core.Instance

This class contains a collection of different experiments, each which may contain a large set of measurements internally.

experiment_list: list[Experiment] = []