PulseQobj
class PulseQobj(qobj_id, config, experiments, header=None)
A Pulse Qobj.
Instatiate 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.
Parameters
- qobj_id (str) – An identifier for the qobj
- config (PulseQobjConfig) – A config for the entire run
- header (QobjHeader) – A header for the entire run
- experiments (list) – A list of lists of
PulseQobjExperimentobjects representing an experiment
Methods
from_dict
classmethod PulseQobj.from_dict(data)
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
to_dict
PulseQobj.to_dict(validate=False)
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)Parameters
validate (bool) – When set to true validate the output dictionary against the jsonschema for qobj spec.
Returns
A dictionary representation of the QasmQobj object
Return type
dict