Skip to content

CopyProcessor

Tiles processor that copies a channel

Implements the TilesProcessor protocol.

PARAMETER DESCRIPTION
channel_name

Channel name

TYPE: ChannelName | str

new_channel_name

New channel name

TYPE: ChannelName | str | 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_name: 'my_channel'
  new_channel_name: 'my_new_channel'
ATTRIBUTE DESCRIPTION
channel_name

Channel name

TYPE: ChannelName | str

new_channel_name

New channel name - defaults to None

TYPE: ChannelName | str | None