pygsti.modelmembers.povms.fulleffect

The FullPOVMEffect class and supporting functionality.

Module Contents

Classes

FullPOVMEffect

A "fully parameterized" effect vector where each element is an independent parameter.

class pygsti.modelmembers.povms.fulleffect.FullPOVMEffect(vec, basis=None, evotype='default', state_space=None)

Bases: pygsti.modelmembers.povms.conjugatedeffect.ConjugatedStatePOVMEffect

A “fully parameterized” effect vector where each element is an independent parameter.

Parameters

vecarray_like or POVMEffect

a 1D numpy array representing the POVM effect. The shape of this array sets the dimension of the POVM effect.

evotypeEvotype or str, optional

The evolution type. The special value “default” is equivalent to specifying the value of pygsti.evotypes.Evotype.default_evotype.

state_spaceStateSpace, optional

The state space for this POVM effect. If None a default state space with the appropriate number of qubits is used.

Initialize a new POVM effect Vector

set_dense(vec)

Set the dense-vector value of this POVM effect vector.

Attempts to modify this POVM effect vector’s parameters so that the raw POVM effect vector becomes vec. Will raise ValueError if this operation is not possible.

Parameters

vecarray_like or POVMEffect

A numpy array representing a POVM effect vector, or a POVMEffect object.

Returns

None

depolarize(amount)

Depolarize this effect vector (as though it were a states) by the given amount.

Parameters

amountfloat or tuple

The amount to depolarize by. If a tuple, it must have length equal to one less than the dimension of the gate. All but the first element of the spam vector (often corresponding to the identity element) are multiplied by amount (if a float) or the corresponding amount[i] (if a tuple).

Returns

None