View source on GitHub

StandardizeProcessor

Tiles processor that standardizes a channel

Notes

• Standardizing 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
mean_value	Mean value TYPE: float
std_value	Standard deviation 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 standardize processor from the configuration.

PARAMETER	DESCRIPTION
config	Configuration TYPE: StandardizeProcessorConfig

RETURNS	DESCRIPTION
StandardizeProcessor	Standardize processor

__call__

Standardizes the channel.

PARAMETER	DESCRIPTION
tiles	Tiles TYPE: Tiles

RETURNS	DESCRIPTION
Tiles	Tiles

---

StandardizeProcessorConfig

Bases: pydantic.BaseModel

Configuration for the from_config class method of StandardizeProcessor

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: 'StandardizeProcessor'
config:
  channel_key: 'my_channel'
  mean_value: .5
  std_value: .25
  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
mean_value	Mean value TYPE: float
std_value	Standard deviation 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