pygsti.baseobjs.errorgenbasis

Defines the ElementaryErrorgenBasis class and supporting functionality.

Module Contents

Classes

ElementaryErrorgenBasis	A basis for error-generator space defined by a set of elementary error generators.
ExplicitElementaryErrorgenBasis	A basis for error-generator space defined by a set of elementary error generators.
CompleteElementaryErrorgenBasis	Spanned by the elementary error generators of given type(s) (e.g. "Hamiltonian" and/or "other")

class pygsti.baseobjs.errorgenbasis.ElementaryErrorgenBasis

Bases: object

A basis for error-generator space defined by a set of elementary error generators.

Elements are ordered (have definite indices) and labeled. Intersection and union can be performed as a set.

label_indices(labels, ok_if_missing=False)

TODO: docstring

class pygsti.baseobjs.errorgenbasis.ExplicitElementaryErrorgenBasis(state_space, labels, basis1q=None)

Bases: ElementaryErrorgenBasis

A basis for error-generator space defined by a set of elementary error generators.

Elements are ordered (have definite indices) and labeled. Intersection and union can be performed as a set.

property labels

property elemgen_supports_and_matrices

label_index(label, ok_if_missing=False)

TODO: docstring

Parameters

label

ok_if_missingbool

If True, then returns None instead of an integer when the given label is not present.

create_subbasis(must_overlap_with_these_sslbls)

Create a sub-basis of this basis by including only the elements that overlap the given support (state space labels)

union(other_basis)

intersection(other_basis)

difference(other_basis)

class pygsti.baseobjs.errorgenbasis.CompleteElementaryErrorgenBasis(basis_1q, state_space, elementary_errorgen_types=('H', 'S', 'C', 'A'), max_ham_weight=None, max_other_weight=None, must_overlap_with_these_sslbls=None)

Bases: ElementaryErrorgenBasis

Spanned by the elementary error generators of given type(s) (e.g. “Hamiltonian” and/or “other”) and with elements corresponding to a Basis, usually of Paulis.

property labels

property elemgen_supports_and_dual_matrices

property elemgen_supports_and_matrices

to_explicit_basis()

label_index(elemgen_label, ok_if_missing=False)

TODO: docstring

Parameters

elemgen_label

ok_if_missingbool

If True, then returns None instead of an integer when the given label is not present.

create_subbasis(must_overlap_with_these_sslbls, retain_max_weights=True)

Create a sub-basis of this basis by including only the elements that overlap the given support (state space labels)

union(other_basis)

intersection(other_basis)

difference(other_basis)