Skip to main contentIBM Quantum Documentation
You are viewing the API reference for an old version of Qiskit SDK. Switch to latest version

BackendProperties

qiskit.providers.models.BackendProperties(backend_name, backend_version, last_update_date, qubits, gates, general, **kwargs)

GitHub(opens in a new tab)

Bases: object(opens in a new tab)

Class representing backend properties

This holds backend properties measured by the provider. All properties which are provided optionally. These properties may describe qubits, gates, or other general properties of the backend.

Initialize a BackendProperties instance.

Parameters


Methods

faulty_gates

faulty_gates()

Return a list of faulty gates.

faulty_qubits

faulty_qubits()

Return a list of faulty qubits.

frequency

frequency(qubit)

Return the frequency of the given qubit.

Parameters

qubit (int(opens in a new tab)) – Qubit for which to return frequency of.

Returns

Frequency of the given qubit.

Return type

float(opens in a new tab)

from_dict

classmethod from_dict(data)

Create a new BackendProperties object from a dictionary.

Parameters

data (dict(opens in a new tab)) – A dictionary representing the BackendProperties to create. It will be in the same format as output by to_dict().

Returns

The BackendProperties from the input dictionary.

Return type

BackendProperties

gate_error

gate_error(gate, qubits)

Return gate error estimates from backend properties.

Parameters

Returns

Gate error of the given gate and qubit(s).

Return type

float(opens in a new tab)

gate_length

gate_length(gate, qubits)

Return the duration of the gate in units of seconds.

Parameters

Returns

Gate length of the given gate and qubit(s).

Return type

float(opens in a new tab)

gate_property

gate_property(gate, qubits=None, name=None)

Return the property of the given gate.

Parameters

Returns

Gate property as a tuple of the value and the time it was measured.

Raises

BackendPropertyError – If the property is not found or name is specified but qubit is not.

Return type

Tuple(opens in a new tab)[Any(opens in a new tab), datetime(opens in a new tab)]

is_gate_operational

is_gate_operational(gate, qubits=None)

Return the operational status of the given gate.

Parameters

Returns

Operational status of the given gate. True if the gate is operational, False otherwise.

Return type

bool(opens in a new tab)

is_qubit_operational

is_qubit_operational(qubit)

Return the operational status of the given qubit.

Parameters

qubit (int(opens in a new tab)) – Qubit for which to return operational status of.

Returns

Operational status of the given qubit.

Return type

bool(opens in a new tab)

qubit_property

qubit_property(qubit, name=None)

Return the property of the given qubit.

Parameters

Returns

Qubit property as a tuple of the value and the time it was measured.

Raises

BackendPropertyError – If the property is not found.

Return type

Tuple(opens in a new tab)[Any(opens in a new tab), datetime(opens in a new tab)]

readout_error

readout_error(qubit)

Return the readout error of the given qubit.

Parameters

qubit (int(opens in a new tab)) – Qubit for which to return the readout error of.

Returns

Readout error of the given qubit.

Return type

float(opens in a new tab)

readout_length

readout_length(qubit)

Return the readout length [sec] of the given qubit.

Parameters

qubit (int(opens in a new tab)) – Qubit for which to return the readout length of.

Returns

Readout length of the given qubit.

Return type

float(opens in a new tab)

t1

t1(qubit)

Return the T1 time of the given qubit.

Parameters

qubit (int(opens in a new tab)) – Qubit for which to return the T1 time of.

Returns

T1 time of the given qubit.

Return type

float(opens in a new tab)

t2

t2(qubit)

Return the T2 time of the given qubit.

Parameters

qubit (int(opens in a new tab)) – Qubit for which to return the T2 time of.

Returns

T2 time of the given qubit.

Return type

float(opens in a new tab)

to_dict

to_dict()

Return a dictionary format representation of the BackendProperties.

Returns

The dictionary form of the BackendProperties.

Return type

dict(opens in a new tab)

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