0.29.1
Languages
English
Japanese
German
Korean
Portuguese, Brazilian
French
Tamil
Previous Releases
0.19
0.24
0.25
0.26
0.27
0.28
0.29
Table of Contents
Shortcuts

qiskit.pulse.ScheduleBlock.filter

ScheduleBlock.filter(*filter_funcs, channels=None, instruction_types=None, time_ranges=None, intervals=None, check_subroutine=True)[source]

Return a new Schedule with only the instructions from this ScheduleBlock which pass though the provided filters; i.e. an instruction will be retained iff every function in filter_funcs returns True, the instruction occurs on a channel type contained in channels, the instruction type is contained in instruction_types, and the period over which the instruction operates is fully contained in one specified in time_ranges or intervals.

If no arguments are provided, self is returned.

Note

This method is currently not supported. Support will be soon added please create an issue if you believe this must be prioritized.

Parameters

  • filter_funcs (List[Callable]) – A list of Callables which take a (int, Union[‘Schedule’, Instruction]) tuple and return a bool.

  • channels (Optional[Iterable[Channel]]) – For example, [DriveChannel(0), AcquireChannel(0)].

  • instruction_types (Union[Iterable[ABCMeta], ABCMeta, None]) – For example, [PulseInstruction, AcquireInstruction].

  • time_ranges (Optional[Iterable[Tuple[int, int]]]) – For example, [(0, 5), (6, 10)].

  • intervals (Optional[Iterable[Tuple[int, int]]]) – For example, [(0, 5), (6, 10)].

  • check_subroutine (bool) – Set True to individually filter instructions inside of a subroutine defined by the Call instruction.

Returns

Schedule consisting of instructions that matches with filtering condition.

Raises

PulseError – When this method is called. This method will be supported soon.