Skip to main contentIBM Quantum Documentation
This page is from the dev version of Qiskit SDK. Go to the stable version

PulseQobj

class qiskit.qobj.PulseQobj(qobj_id, config, experiments, header=None)

GitHub

Bases: object

A Pulse Qobj.

Instantiate a new Pulse Qobj Object.

Each Pulse Qobj object is used to represent a single payload that will be passed to a Qiskit provider. It mirrors the Qobj the published Qobj specification for Pulse experiments.

Deprecated since version 1.2

The class qiskit.qobj.pulse_qobj.PulseQobj is deprecated as of Qiskit 1.2. It will be removed in the 2.0 release. The Qobj class and related functionality are part of the deprecated BackendV1 workflow, and no longer necessary for BackendV2. If a user workflow requires Qobj it likely relies on deprecated functionality and should be updated to use BackendV2.

Parameters


Methods

from_dict

classmethod from_dict(data)

GitHub

Create a new PulseQobj object from a dictionary.

Parameters

data (dict) – A dictionary representing the PulseQobj to create. It will be in the same format as output by to_dict().

Returns

The PulseQobj from the input dictionary.

Return type

PulseQobj

to_dict

to_dict()

GitHub

Return a dictionary format representation of the Pulse Qobj.

Note this dict is not in the json wire format expected by IBMQ and qobj specification because complex numbers are still of type complex. Also this may contain native numpy arrays. When serializing this output for use with IBMQ you can leverage a json encoder that converts these as expected. For example:

import json
import numpy
 
class QobjEncoder(json.JSONEncoder):
    def default(self, obj):
        if isinstance(obj, numpy.ndarray):
            return obj.tolist()
        if isinstance(obj, complex):
            return (obj.real, obj.imag)
        return json.JSONEncoder.default(self, obj)
 
json.dumps(qobj.to_dict(), cls=QobjEncoder)

Returns

A dictionary representation of the PulseQobj object

Return type

dict

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