metrics.analysis.experiment module
- class Experiment(comparison: dict, samples: Dict[str, dict], simulation: metrics.analysis.simulation.Simulation)[source]
Bases:
object
Workflow for creating a dictionary of objects for analysis.
- comparison
The comparison to perform analysis on.
- Type
dict
- comparison_group
The names of objects compared.
- Type
str
- samples
Information about sample parameters.
- Type
Dict[str, dict]
- simulation
Simulation object.
- Type
- create_experiment_dict() dict [source]
Create sample objects.
- Returns
object_dict – The dictionary with objects for comparison.
- Return type
Dict[str,Union[Simulation, SampleNeedle, SamplePunch]]