qiskit.pulse.Schedule.filter¶
-
Schedule.
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 thisSchedule
which pass though the provided filters; i.e. an instruction will be retained iff every function infilter_funcs
returnsTrue
, the instruction occurs on a channel type contained inchannels
, the instruction type is contained ininstruction_types
, and the period over which the instruction operates is fully contained in one specified intime_ranges
orintervals
.If no arguments are provided,
self
is returned.- Parameters
filter_funcs (
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 theCall
instruction.
- Return type
Schedule