piel.experimental.measurements.data.extract#

Attributes#

logger

Functions#

`extract_data_from_measurement_collection`(...)	The goal of this function is to compose the data from a collection of measurement references.
`extract_data_from_experiment`(...)	This function must be run after data has already been written within the `Experiment` directories
`load_experiment_data_from_directory`(...)	This function will load an Experiment from the metadata stored in the experiment.json directory.

Module Contents#

logger#

extract_data_from_measurement_collection(measurement_collection: piel.types.experimental.MeasurementCollectionTypes, measurement_to_data_map: dict = measurement_to_data_map, measurement_to_data_method_map: dict = measurement_to_data_method_map, skip_missing: bool = False, **kwargs) → piel.types.experimental.MeasurementDataCollectionTypes[source]#: The goal of this function is to compose the data from a collection of measurement references. Based on each type of measurement, it will apply an extraction function based on the data mapping accordingly. It will return a collection of data measurement which is inherent to the type of the measurement collection provided.

extract_data_from_experiment(experiment: piel.types.experimental.Experiment, experiment_directory: piel.types.PathTypes, composition_kwargs: dict = None, extraction_kwargs: dict = None, **kwargs) → piel.types.experimental.ExperimentData[source]#

This function must be run after data has already been written within the Experiment directories and the metadata has been created accordingly. This will extract all the corresponding measurements collection, and also extract the corresponding data from each setup accordingly. It will create a ExperimentData that collects both the metadata and measurement data.

Parameters:

experiment (Experiment) – The experiment object that contains the metadata of the experiment.
experiment_directory (PathTypes) – The directory where the experiment is located.
**kwargs – Extra keyword arguments passed to the class instantiation.

Returns:

ExperimentData – The data extracted from the experiment.

load_experiment_data_from_directory(experiment_directory: piel.types.PathTypes, **kwargs) → piel.types.experimental.ExperimentData[source]#: This function will load an Experiment from the metadata stored in the experiment.json directory.