View source on GitHub

NormalizeProcessor

Tiles processor that normalizes a channel

Notes

• Normalizing a channel by its name assumes the time step is None
• Requires a raster channel

Implements the TilesProcessor protocol.

PARAMETER	DESCRIPTION
channel_key	Channel name or channel name and time step combination TYPE: ChannelName | str | ChannelKey
min_value	Minimum value TYPE: float
max_value	Maximum value TYPE: float
new_channel_key	New channel name or channel name and time step combination TYPE: ChannelName | str | ChannelKey | None DEFAULT: None
max_num_threads	Maximum number of threads TYPE: int | None DEFAULT: None

from_config classmethod

Creates a normalize processor from the configuration.

PARAMETER	DESCRIPTION
config	Configuration TYPE: NormalizeProcessorConfig

RETURNS	DESCRIPTION
NormalizeProcessor	Normalize processor

__call__

Normalizes the channel.

PARAMETER	DESCRIPTION
tiles	Tiles TYPE: Tiles

RETURNS	DESCRIPTION
Tiles	Tiles

---

NormalizeProcessorConfig

Bases: pydantic.BaseModel

Configuration for the from_config class method of NormalizeProcessor

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: 'NormalizeProcessor'
config:
  channel_key: 'my_channel'
  min_value: 0.
  max_value: 255.
  new_channel_key: null
  max_num_threads: null

ATTRIBUTE	DESCRIPTION
channel_key	Channel name or channel name and time step combination TYPE: ChannelName | str | ChannelKey
min_value	Minimum value TYPE: float
max_value	Maximum value TYPE: float
new_channel_key	New channel name or channel name and time step combination - defaults to None TYPE: ChannelName | str | ChannelKey | None
max_num_threads	Maximum number of threads - defaults to None TYPE: int | None