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.

ExperimentData.child_data

ExperimentData.child_data(index=None)[source]

Return child experiment data.

Parameters:

index (Union[int, slice, str, None]) –

Index of the child experiment data to be returned. Several types are accepted for convenience:

  • None: Return all child data.

  • int: Specific index of the child data.

  • slice: A list slice of indexes.

  • str: experiment ID of the child data.

Return type:

Union[ExperimentData, List[ExperimentData]]

Returns:

The requested single or list of child experiment data.

Raises:

QiskitError – If the index or ID of the child experiment data cannot be found.