View source

CastProcessor

Bases: IDMixin

Tiles processor that casts a channel

Notes

• Requires a raster channel

Implements the TilesProcessor protocol.

PARAMETER	DESCRIPTION
channel_name	Channel name TYPE: ChannelName | str
dtype	Data type TYPE: DType
new_channel_name	New channel name TYPE: ChannelName | str | None DEFAULT: None
max_num_threads	Maximum number of threads TYPE: int | None DEFAULT: None

id property

RETURNS	DESCRIPTION
uuid.UUID	ID

from_config classmethod

Creates a cast processor from the configuration.

PARAMETER	DESCRIPTION
config	Configuration TYPE: CastProcessorConfig

RETURNS	DESCRIPTION
CastProcessor	Cast processor

__call__

Casts the channel.

PARAMETER	DESCRIPTION
tiles	Tiles TYPE: Tiles

RETURNS	DESCRIPTION
Tiles	Tiles

---

CastProcessorConfig

Bases: pydantic.BaseModel

Configuration for the from_config class method of CastProcessor

Create the configuration from a config file

• Use null instead of None

Usage

You can create the configuration from a config file.

config.yaml

package: 'aviary'
name: 'CastProcessor'
config:
  channel_name: 'my_channel'
  dtype: 'float32'
  new_channel_name: null
  max_num_threads: null

ATTRIBUTE	DESCRIPTION
channel_name	Channel name TYPE: ChannelName | str
dtype	Data type TYPE: DType
new_channel_name	New channel name - defaults to None TYPE: ChannelName | str | None
max_num_threads	Maximum number of threads - defaults to None TYPE: int | None