Note
This is the documentation for the current state of the development branch of Qiskit Experiments. The documentation or APIs here can change prior to being released.
TphiAnalysis¶
- class TphiAnalysis(analyses=None)[source]¶
A class to analyze
experiments.Analysis options
These are the keyword arguments of
run()
method.- Options
Defined in the class
BaseAnalysis
:figure_names (str or List[str])
Default value:None
Identifier of figures that appear in the experiment data to sort figures by name.
See also
qiskit_experiments.library.characterization.analysis.T1Analysis
qiskit_experiments.library.characterization.analysis.T2HahnAnalysis
qiskit_experiments.library.characterization.analysis.T2RamseyAnalysis
Initialization
Initialize a composite analysis class.
- Parameters:
analyses – a list of component experiment analysis objects.
flatten_results – If True flatten all component experiment results into a single ExperimentData container, including nested composite experiments. If False save each component experiment results as a separate child ExperimentData container.
Attributes
Return the analysis options for
run()
method.Methods
TphiAnalysis.component_analysis
([index])Return the component experiment Analysis instance.
Return the config dataclass for this analysis
Return a copy of the analysis
TphiAnalysis.from_config
(config)Initialize an analysis class from analysis config
TphiAnalysis.run
(experiment_data[, ...])Run analysis and update ExperimentData with analysis result.
TphiAnalysis.set_options
(**fields)Set the analysis options for
run()
method.