View source

ClipProcessor

Vector processor that clips a layer

Implements the VectorProcessor protocol.

PARAMETER	DESCRIPTION
layer_name	Layer name TYPE: str
mask_layer_name	Mask layer name TYPE: str
new_layer_name	New layer name TYPE: str | None DEFAULT: None

from_config classmethod

Creates a clip processor from the configuration.

PARAMETER	DESCRIPTION
config	Configuration TYPE: ClipProcessorConfig

RETURNS	DESCRIPTION
ClipProcessor	Clip processor

__call__

Clips the layer.

PARAMETER	DESCRIPTION
vector	Vector TYPE: Vector

RETURNS	DESCRIPTION
Vector	Vector

---

ClipProcessorConfig

Bases: pydantic.BaseModel

Configuration for the from_config class method of ClipProcessor

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: 'ClipProcessor'
config:
  layer_name: 'my_layer'
  mask_layer_name: 'my_mask_layer'
  new_layer_name: 'my_new_layer'

ATTRIBUTE	DESCRIPTION
layer_name	Layer name TYPE: str
mask_layer_name	Mask layer name TYPE: str
new_layer_name	New layer name - defaults to None TYPE: str | None