Skip to content

SieveProcessor

Vector processor that sieves a layer

Implements the VectorProcessor protocol.

PARAMETER DESCRIPTION
layer_name

Layer name

TYPE: str

threshold

Threshold (the minimum area of the polygon to retain) in square meters

TYPE: float

new_layer_name

New layer name

TYPE: str | None DEFAULT: None

from_config classmethod

Creates a sieve processor from the configuration.

PARAMETER DESCRIPTION
config

Configuration

TYPE: SieveProcessorConfig

RETURNS DESCRIPTION
SieveProcessor

Sieve processor

__call__

Sieves the layer.

PARAMETER DESCRIPTION
vector

Vector

TYPE: Vector

RETURNS DESCRIPTION
vector

Vector

TYPE: Vector


SieveProcessorConfig

Bases: pydantic.BaseModel

Configuration for the from_config class method of SieveProcessor

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: 'SieveProcessor'
config:
  layer_name: 'my_layer'
  threshold: 1.
  new_layer_name: 'my_new_layer'
ATTRIBUTE DESCRIPTION
layer_name

Layer name

TYPE: str

threshold

Threshold (the minimum area of the polygon to retain) in square meters

TYPE: float

new_layer_name

New layer name - defaults to None

TYPE: str | None