Skip to main content
IBM Quantum Platform
This page is from the dev version of Qiskit Runtime client. Go to the stable version.

TwirledSliceSpan

class TwirledSliceSpan(start, stop, data_slices)

GitHub

Bases: ExecutionSpan

An ExecutionSpan for data stored in a sliceable format when twirling.

This type of execution span references pub result data that came from a twirled sampler experiment which was executed by either prepending or appending an axis to parameter values to account for twirling. Concretely, data_slices is a map from pub slices to tuples (twirled_shape, at_front, shape_slice, shots_slice) where

  • twirled_shape is the shape tuple including a twirling axis, and where the last axis is shots per randomization,
  • at_front is whether num_randomizations is at the front of the tuple, as opposed to right before the shots axis at the end,
  • shape_slice is a slice of an array of shape twirled_shape[:-1], flattened,
  • and shots_slice is a slice of twirled_shape[-1].

Parameters

  • start (datetime) – The start time of the span, in UTC.
  • stop (datetime) – The stop time of the span, in UTC.
  • data_slices (Mapping[int, tuple[ShapeType, bool, slice, slice]]) – A map from pub indices to length-4 tuples described above.

Attributes

duration

The duration of this span, in seconds.

pub_idxs

Which pubs, by index, have dependence on one or more execution spans present.

size

The total number of results with dependence on this execution span, across all pubs.

start

The start time of the span, in UTC.

stop

The stop time of the span, in UTC.


Methods

contains_pub

contains_pub(pub_idx)

GitHub

Return whether the pub with the given index has data with dependence on this span.

Parameters

pub_idx (int | Iterable[int]) – One or more pub indices from the original primitive call.

Returns

Whether there is dependence on this span.

Return type

bool

filter_by_pub

filter_by_pub(pub_idx)

GitHub

Return a new set of spans where each one has been filtered to the specified pubs.

Parameters

pub_idx (int | Iterable[int])

Return type

TwirledSliceSpan

mask

mask(pub_idx)

GitHub

Return array-valued mask specifying which parts of a pub result depend on this span.

Parameters

pub_idx (int)

Return type

ndarray[tuple[int, …], dtype[bool]]

Was this page helpful?
Report a bug, typo, or request content on GitHub.