Skip to content

RemoveProcessor

Tiles processor that removes channels

Implements the TilesProcessor protocol.

PARAMETER DESCRIPTION
channel_names

Channel name, channel names, no channels (False or None), or all channels (True)

TYPE: ChannelName | str | ChannelNameSet | bool | None DEFAULT: True

from_config classmethod

Creates a remove processor from the configuration.

PARAMETER DESCRIPTION
config

Configuration

TYPE: RemoveProcessorConfig

RETURNS DESCRIPTION
RemoveProcessor

Remove processor

__call__

Removes the channels.

PARAMETER DESCRIPTION
tiles

Tiles

TYPE: Tiles

RETURNS DESCRIPTION
Tiles

Tiles


RemoveProcessorConfig

Bases: pydantic.BaseModel

Configuration for the from_config class method of RemoveProcessor

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: 'RemoveProcessor'
config:
  channel_names: true
ATTRIBUTE DESCRIPTION
channel_names

Channel name, channel names, no channels (False or None), or all channels (True) - defaults to True

TYPE: ChannelName | str | ChannelNameSet | bool | None