Skip to content

WMSFetcher

Bases: FromConfigMixin

Data fetcher for web map services

Implements the DataFetcher protocol.

PARAMETER DESCRIPTION
url

url of the web map service

TYPE: str

version

version of the web map service (V1_1_1 or V1_3_0)

TYPE: WMSVersion

layer

name of the layer

TYPE: str

epsg_code

EPSG code

TYPE: EPSGCode

response_format

format of the response (MIME type, e.g., 'image/png')

TYPE: str

tile_size

tile size in meters

TYPE: TileSize

ground_sampling_distance

ground sampling distance in meters

TYPE: GroundSamplingDistance

style

name of the style

TYPE: str | None DEFAULT: None

buffer_size

buffer size in meters (specifies the area around the tile that is additionally fetched)

TYPE: BufferSize DEFAULT: 0

drop_channels

channel indices to drop (supports negative indexing)

TYPE: list[int] | None DEFAULT: None

from_config classmethod

Creates a wms fetcher from the configuration.

PARAMETER DESCRIPTION
config

configuration

TYPE: WMSFetcherConfig

RETURNS DESCRIPTION
WMSFetcher

wms fetcher

__call__

Fetches data from the web map service.

PARAMETER DESCRIPTION
x_min

minimum x coordinate

TYPE: Coordinate

y_min

minimum y coordinate

TYPE: Coordinate

RETURNS DESCRIPTION
npt.NDArray

data


WMSFetcherConfig

Bases: pydantic.BaseModel

Configuration for the from_config class method of WMSFetcher

ATTRIBUTE DESCRIPTION
url

url of the web map service

TYPE: str

version

version of the web map service ('1.1.1' or '1.3.0')

TYPE: WMSVersion

layer

name of the layer

TYPE: str

epsg_code

EPSG code

TYPE: EPSGCode

response_format

format of the response (MIME type, e.g., 'image/png')

TYPE: str

tile_size

tile size in meters

TYPE: TileSize

ground_sampling_distance

ground sampling distance in meters

TYPE: GroundSamplingDistance

style

name of the style

TYPE: str | None

buffer_size

buffer size in meters (specifies the area around the tile that is additionally fetched)

TYPE: BufferSize

drop_channels

channel indices to drop (supports negative indexing)

TYPE: list[int] | None