View source

ObjectExporter

Bases: IDMixin

Tiles processor that exports an object channel

The object data is exported to a geopackage.

Experimental

ObjectExporter is experimental since 1.9.0 and may change without notice.

Notes

• Requires an object channel

Implements the TilesProcessor protocol.

PARAMETER	DESCRIPTION
channel_name	Channel name TYPE: ChannelName | str
epsg_code	EPSG code TYPE: EPSGCode
path	Path to the geopackage (.gpkg file) TYPE: Path
mode	Object exporter mode (BOX or POINT) TYPE: ObjectExporterMode DEFAULT: ObjectExporterMode.BOX
remove_channel	If True, the channel is removed TYPE: bool DEFAULT: True

id property

RETURNS	DESCRIPTION
uuid.UUID	ID

from_config classmethod

Creates an object exporter from the configuration.

PARAMETER	DESCRIPTION
config	Configuration TYPE: ObjectExporterConfig

RETURNS	DESCRIPTION
ObjectExporter	Object exporter

__call__

Exports the object channel.

PARAMETER	DESCRIPTION
tiles	Tiles TYPE: Tiles

RETURNS	DESCRIPTION
Tiles	Tiles

---

ObjectExporterConfig

Bases: pydantic.BaseModel

Configuration for the from_config class method of ObjectExporter

Create the configuration from a config file

• Use 'box' or 'point' instead of ObjectExporterMode.BOX or ObjectExporterMode.POINT
• Use false or true instead of False or True

Usage

You can create the configuration from a config file.

config.yaml

package: 'aviary'
name: 'ObjectExporter'
config:
  channel_name: 'my_channel'
  epsg_code: 25832
  path: 'path/to/my_channel.gpkg'
  mode: 'box'
  remove_channel: true

ATTRIBUTE	DESCRIPTION
channel_name	Channel name TYPE: ChannelName | str
epsg_code	EPSG code TYPE: EPSGCode
path	Path to the geopackage (.gpkg file) TYPE: Path
mode	Object exporter mode (BOX or POINT) - defaults to BOX TYPE: ObjectExporterMode
remove_channel	If True, the channel is removed - defaults to True TYPE: bool