braket.pulse.frame module

class braket.pulse.frame.Frame(frame_id: str, port: Port, frequency: float, phase: float = 0, is_predefined: bool = False, properties: dict[str, Any] | None = None)

Bases: object

Frame tracks the frame of reference, when interacting with the qubits, throughout the execution of a program. See https://openqasm.com/language/openpulse.html#frames for more details.

Initializes a Frame.

Parameters:

• frame_id (str) – str identifying a unique frame.

• port (Port) – port that this frame is attached to.

• frequency (float) – frequency to which this frame should be initialized.

• phase (float) – phase to which this frame should be initialized. Defaults to 0.

• is_predefined (bool) – bool indicating whether this is a predefined frame on the device. Defaults to False.

• properties (Optional[dict[str, Any]]) – Dict containing properties of this frame. Defaults to None.

property id: str

Returns a str indicating the frame id.