View source on GitHub

SelectProcessor

Tiles processor that selects channels

Notes

• Selecting a channel by its name assumes the time step is None

Implements the TilesProcessor protocol.

PARAMETER	DESCRIPTION
channel_keys	Channel name, channel name and time step combination, channel names, channel name and time step combinations, no channels (False or None), or all channels (True) TYPE: ChannelName | str | ChannelKey | ChannelNameSet | ChannelKeySet | ChannelNameKeySet | bool | None DEFAULT: True

from_config classmethod

Creates a select processor from the configuration.

PARAMETER	DESCRIPTION
config	Configuration TYPE: SelectProcessorConfig

RETURNS	DESCRIPTION
SelectProcessor	Select processor

__call__

Selects the channels.

PARAMETER	DESCRIPTION
tiles	Tiles TYPE: Tiles

RETURNS	DESCRIPTION
Tiles	Tiles

---

SelectProcessorConfig

Bases: pydantic.BaseModel

Configuration for the from_config class method of SelectProcessor

Create the configuration from a config file

• Use null instead of None
• Use false or true instead of False or True

Example

You can create the configuration from a config file.

config.yaml

package: 'aviary'
name: 'SelectProcessor'
config:
  channel_keys: true

ATTRIBUTE	DESCRIPTION
channel_keys	Channel name, channel name and time step combination, channel names, channel name and time step combinations, no channels (False or None), or all channels (True) - defaults to True TYPE: ChannelName | str | ChannelKey | ChannelNameSet | ChannelKeySet | ChannelNameKeySet | bool | None