View source

AspectProcessor

Bases: IDMixin

Tiles processor that computes the aspect from a channel

Experimental

AspectProcessor is experimental since 1.3.0 and may change without notice.

Notes

• Requires a raster channel

Implements the TilesProcessor protocol.

PARAMETER	DESCRIPTION
channel_name	Channel name TYPE: ChannelName | str DEFAULT: ChannelName.DEM
new_channel_name	New channel name TYPE: ChannelName | str DEFAULT: ChannelName.ASPECT
max_num_threads	Maximum number of threads TYPE: int | None DEFAULT: None

id property

RETURNS	DESCRIPTION
uuid.UUID	ID

from_config classmethod

Creates an aspect processor from the configuration.

PARAMETER	DESCRIPTION
config	Configuration TYPE: AspectProcessorConfig

RETURNS	DESCRIPTION
AspectProcessor	Aspect processor

__call__

Computes the aspect from the channel.

PARAMETER	DESCRIPTION
tiles	Tiles TYPE: Tiles

RETURNS	DESCRIPTION
Tiles	Tiles

---

AspectProcessorConfig

Bases: pydantic.BaseModel

Configuration for the from_config class method of AspectProcessor

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: 'AspectProcessor'
config:
  channel_name: 'dem'
  new_channel_name: 'aspect'
  max_num_threads: null

ATTRIBUTE	DESCRIPTION
channel_name	Channel name - defaults to 'dem' TYPE: ChannelName | str
new_channel_name	New channel name - defaults to 'aspect' TYPE: ChannelName | str
max_num_threads	Maximum number of threads - defaults to None TYPE: int | None