View source on GitHub

CopyProcessor

Tiles processor that copies a channel

Notes

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

Implements the TilesProcessor protocol.

PARAMETER	DESCRIPTION
channel_key	Channel name or channel name and time step combination TYPE: ChannelName | str | ChannelKey
new_channel_key	New channel name or channel name and time step combination TYPE: ChannelName | str | ChannelKey | None DEFAULT: None

from_config classmethod

Creates a copy processor from the configuration.

PARAMETER	DESCRIPTION
config	Configuration TYPE: CopyProcessorConfig

RETURNS	DESCRIPTION
CopyProcessor	Copy processor

__call__

Copies the channel.

PARAMETER	DESCRIPTION
tiles	Tiles TYPE: Tiles

RETURNS	DESCRIPTION
Tiles	Tiles

---

CopyProcessorConfig

Bases: pydantic.BaseModel

Configuration for the from_config class method of CopyProcessor

Create the configuration from a config file

• Use null instead of None

Example

You can create the configuration from a config file.

config.yaml

package: 'aviary'
name: 'CopyProcessor'
config:
  channel_key: 'my_channel'
  new_channel_key: 'my_new_channel'

ATTRIBUTE	DESCRIPTION
channel_key	Channel name or channel name and time step combination TYPE: ChannelName | str | ChannelKey
new_channel_key	New channel name or channel name and time step combination - defaults to None TYPE: ChannelName | str | ChannelKey | None