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.

CompositeAnalysis.component_analysis

CompositeAnalysis.component_analysis(index=None)

Return the component experiment Analysis instance.

Parameters:

index (Optional[int]) – Optional, the component index to return analysis for. If None return a list of all component analysis instances.

Return type:

Union[BaseAnalysis, List[BaseAnalysis]]

Returns:

The analysis instance for the specified index, or a list of all analysis instances if index is None.