--- title: TimeBlockade (v1.1) description: API reference for qiskit.pulse.instructions.TimeBlockade in qiskit v1.1 source: https://eu-de.quantum.cloud.ibm.com/docs/en/api/qiskit/1.1/qiskit.pulse.instructions.TimeBlockade --- # TimeBlockade *class* `qiskit.pulse.instructions.TimeBlockade(duration, channel, name=None)` [GitHub](https://github.com/Qiskit/qiskit/tree/stable/1.1/qiskit/pulse/instructions/directives.py#L61-L146) Bases: `Directive` Pulse `TimeBlockade` directive. This instruction is intended to be used internally within the pulse builder, to convert [`Schedule`](/docs/api/qiskit/1.1/qiskit.pulse.Schedule "qiskit.pulse.Schedule") into [`ScheduleBlock`](/docs/api/qiskit/1.1/qiskit.pulse.ScheduleBlock "qiskit.pulse.ScheduleBlock"). Because [`ScheduleBlock`](/docs/api/qiskit/1.1/qiskit.pulse.ScheduleBlock "qiskit.pulse.ScheduleBlock") cannot take an absolute instruction time interval, this directive helps the block representation to find the starting time of an instruction. **Example** This schedule plays constant pulse at t0 = 120. ```python schedule = Schedule() schedule.insert(120, Play(Constant(10, 0.1), DriveChannel(0))) ``` This schedule block is expected to be identical to above at a time of execution. ```python block = ScheduleBlock() block.append(TimeBlockade(120, DriveChannel(0))) block.append(Play(Constant(10, 0.1), DriveChannel(0))) ``` Such conversion may be done by ```python from qiskit.pulse.transforms import block_to_schedule, remove_directives schedule = remove_directives(block_to_schedule(block)) ``` > **Note** > > The TimeBlockade instruction behaves almost identically to [`Delay`](/docs/api/qiskit/1.1/qiskit.pulse.instructions.Delay "qiskit.pulse.instructions.Delay") instruction. However, the TimeBlockade is just a compiler directive and must be removed before execution. This may be done by [`remove_directives()`](/docs/api/qiskit/1.1/pulse#qiskit.pulse.transforms.remove_directives "qiskit.pulse.transforms.remove_directives") transform. Once these directives are removed, occupied timeslots are released and user can insert another instruction without timing overlap. Create a time blockade directive. **Parameters** - **duration** ([*int*](https://docs.python.org/3/library/functions.html#int)) – Length of time of the occupation in terms of dt. - **channel** (*chans.Channel*) – The channel that will be the occupied. - **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str) *| None*) – Name of the time blockade for display purposes. ## Attributes ### channel Return the [`Channel`](/docs/api/qiskit/1.1/pulse#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel") that this instruction is scheduled on. ### channels Returns the channels that this schedule uses. ### duration Duration of this instruction. ### id Unique identifier for this instruction. ### instructions Iterable for getting instructions from Schedule tree. ### name Name of this instruction. ### operands Return instruction operands. ### parameters Parameters which determine the instruction behavior. ### start\_time Relative begin time of this instruction. ### stop\_time Relative end time of this instruction. ## Methods ### append `append(schedule, name=None)` [GitHub](https://github.com/Qiskit/qiskit/tree/stable/1.1/qiskit/pulse/instructions/instruction.py#L185-L198) Return a new [`Schedule`](/docs/api/qiskit/1.1/qiskit.pulse.Schedule "qiskit.pulse.Schedule") with `schedule` inserted at the maximum time over all channels shared between `self` and `schedule`. **Parameters** - **schedule** (*Union\['Schedule', 'Instruction']*) – Schedule or instruction to be appended - **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str) *| None*) – Name of the new schedule. Defaults to name of self **Returns** A new schedule with `schedule` a this instruction at t=0. **Return type** [Schedule](/docs/api/qiskit/1.1/qiskit.pulse.Schedule "qiskit.pulse.Schedule") ### ch\_duration `ch_duration(*channels)` [GitHub](https://github.com/Qiskit/qiskit/tree/stable/1.1/qiskit/pulse/instructions/instruction.py#L112-L118) Return duration of the supplied channels in this Instruction. **Parameters** **\*channels** ([*Channel*](/docs/api/qiskit/1.1/pulse#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel")) – Supplied channels **Return type** [int](https://docs.python.org/3/library/functions.html#int) ### ch\_start\_time `ch_start_time(*channels)` [GitHub](https://github.com/Qiskit/qiskit/tree/stable/1.1/qiskit/pulse/instructions/instruction.py#L120-L127) Return minimum start time for supplied channels. **Parameters** **\*channels** ([*Channel*](/docs/api/qiskit/1.1/pulse#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel")) – Supplied channels **Return type** [int](https://docs.python.org/3/library/functions.html#int) ### ch\_stop\_time `ch_stop_time(*channels)` [GitHub](https://github.com/Qiskit/qiskit/tree/stable/1.1/qiskit/pulse/instructions/instruction.py#L129-L137) Return maximum start time for supplied channels. **Parameters** **\*channels** ([*Channel*](/docs/api/qiskit/1.1/pulse#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel")) – Supplied channels **Return type** [int](https://docs.python.org/3/library/functions.html#int) ### insert `insert(start_time, schedule, name=None)` [GitHub](https://github.com/Qiskit/qiskit/tree/stable/1.1/qiskit/pulse/instructions/instruction.py#L167-L183) Return a new [`Schedule`](/docs/api/qiskit/1.1/qiskit.pulse.Schedule "qiskit.pulse.Schedule") with `schedule` inserted within `self` at `start_time`. **Parameters** - **start\_time** ([*int*](https://docs.python.org/3/library/functions.html#int)) – Time to insert the schedule schedule - **schedule** (*Union\['Schedule', 'Instruction']*) – Schedule or instruction to insert - **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str) *| None*) – Name of the new schedule. Defaults to name of self **Returns** A new schedule with `schedule` inserted with this instruction at t=0. **Return type** [Schedule](/docs/api/qiskit/1.1/qiskit.pulse.Schedule "qiskit.pulse.Schedule") ### is\_parameterized `is_parameterized()` [GitHub](https://github.com/Qiskit/qiskit/tree/stable/1.1/qiskit/pulse/instructions/instruction.py#L219-L221) Return True iff the instruction is parameterized. **Return type** [bool](https://docs.python.org/3/library/functions.html#bool) ### shift `shift(time, name=None)` [GitHub](https://github.com/Qiskit/qiskit/tree/stable/1.1/qiskit/pulse/instructions/instruction.py#L151-L165) Return a new schedule shifted forward by time. **Parameters** - **time** ([*int*](https://docs.python.org/3/library/functions.html#int)) – Time to shift by - **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str) *| None*) – Name of the new schedule. Defaults to name of self **Returns** The shifted schedule. **Return type** [Schedule](/docs/api/qiskit/1.1/qiskit.pulse.Schedule "qiskit.pulse.Schedule")