ogcmaps package

Submodules

ogcmaps.collections module

ogcmaps.collections.collection_styled_map_tile_matrix(collection_id, style_id, tile_matrix_set_id, f='json', **kwargs) → dict

Retrieve the map tileset metadata for the specified collection, style and tiling scheme (tile matrix set).

Parameters:

  • collection_id (str) – Local identifier of a collection

  • style_id (str) – An identifier representing a specific style

  • tile_matrix_set_id (str) – Identifier for a supported TileMatrixSet

  • collections (array[str], optional) – The collections that should be included in the response. The parameter value is a comma-separated list of collection identifiers. If the parameters is missing, some or all collections will be included. The collection will be rendered in the order specified, with the last one showing on top, unless the priority is overridden by styling rules.

  • f (str, optional) –

    The format of the response. If no value is provided, the accept header is used to determine the format. Accepted values are ‘json’ or ‘html’.

    Available values : json, html

Returns:

Description of the tileset

Return type:

JSON

Raises:

ValueError – If parameter is invalid

ogcmaps.collections.get_collection(collection_id, f='json') → dict

Retrieve the description of a collection available from this service.

Parameters:

  • collection_id (str) – Local identifier of a collection

  • f (str, optional) –

    The format of the response. If no value is provided, the accept header is used to determine the format. Accepted values are ‘json’ or ‘html’.

    Available values : json, html

Returns:

Information about a particular collection of (mostly geospatial) data available from this API. The collection is accessible via one or more OGC API set of specifications, for which a link to relevant accessible resources, e.g. /collections/{collectionId}/(items, coverage, map, tiles...) is contained in the response, with the corresponding relation type, as well as key information about the collection. This information includes:

  • A local identifier for the collection that is unique for the dataset.

  • A list of coordinate reference systems (CRS) in which data may be returned by the server. The first CRS is the default coordinate reference system (the default is always WGS 84 with axis order longitude/latitude).

  • An optional title and description for the collection.

  • An optional extent that can be used to provide an indication of the spatial and temporal extent of the collection - typically derived from the data.

  • For collections accessible via the Features or Records API, an optional indicator about the type of the items in the collection (the default value, if the indicator is not provided, is ‘feature’).

Return type:

JSON

Raises:

None –

ogcmaps.collections.get_collection_map(collection_id, file_name, f='png', **kwargs) → dict

Retrieve a map for the specified collection.

Parameters:

  • collection_id (str) – Local identifier of a collection

  • file_name (str) – Name of file to save the map image

  • bbox (array[int], optional) –

    Only features that have a geometry that intersects the bounding box are selected. The bounding box is provided as four or six numbers, depending on whether the coordinate reference system includes a vertical axis (height or depth):

    • Lower left corner, coordinate axis 1

    • Lower left corner, coordinate axis 2

    • Minimum value, coordinate axis 3 (optional)

    • Upper right corner, coordinate axis 1

    • Upper right corner, coordinate axis 2

    • Maximum value, coordinate axis 3 (optional)

    The coordinate reference system of the values is WGS 84 longitude/latitude (http://www.opengis.net/def/crs/OGC/1.3/CRS84) unless a different coordinate reference system is specified in the parameter bbox-crs. For WGS 84 longitude/latitude the values are in most cases the sequence of minimum longitude, minimum latitude, maximum longitude and maximum latitude. However, in cases where the box spans the antimeridian the first value (west-most box edge) is larger than the third value (east-most box edge). If the vertical axis is included, the third and the sixth number are the bottom and the top of the 3-dimensional bounding box. If a feature has multiple spatial geometry properties, it is the decision of the server whether only a single spatial geometry property is used to determine the extent or all relevant geometries.

  • datetime (str, optional) –

    Either a date-time or an interval, half-bounded or bounded. Date and time expressions adhere to RFC 3339. Half-bounded intervals are expressed using double-dots.

    Examples:

    • A date-time: “2018-02-12T23:20:50Z”

    • A bounded interval: “2018-02-12T00:00:00Z/2018-03-18T12:31:12Z”

    • Half-bounded intervals: “2018-02-12T00:00:00Z/..” or “../ 2018-03-18T12:31:12Z”

  • collections (array[str], optional) – The collections that should be included in the response. The parameter value is a comma-separated list of collection identifiers. If the parameters is missing, some or all collections will be included. The collection will be rendered in the order specified, with the last one showing on top, unless the priority is overridden by styling rules.

  • subset (array[str], optional) – Retrieve only part of the data by slicing or trimming along one or more axis For trimming: {axisAbbrev}({low}:{high}) (preserves dimensionality) An asterisk (*) can be used instead of {low} or {high} to indicate the minimum/maximum value. For slicing: {axisAbbrev}({value}) (reduces dimensionality).

  • crs (str, optional) – Reproject the output to the given crs

  • bbox-crs (str, optional) – Crs for the specified bbox

  • subset-crs (str, optional) – Crs for the specified subset

  • bgcolor (str, optional) –

    Web color name or hexadecimal 0x[AA]RRGGBB color value for the background color (default to 0x9C9C9C gray). If alpha is not specified, full opacity is assumed.

    Default value : 0xFFFFFF

  • transparent (boolean, optional) –

    Background transparency of map (default=true).

    Default value : true

  • width (int, optional) – Width of the map in pixel. If omitted and height is specified, defaults to the width maintaining a 1:1 aspect ratio. If both width and height are omitted, the server will select a default dimensions.

  • height (int, optional) – Height of the map in pixel. If omitted and width is specified, defaults to the height maintaining a 1:1 aspect ratio. If both width and height are omitted, the server will select a default dimensions.

  • f (str, optional) –

    The format of the map response (e.g. png). Accepted values are ‘png’, ‘jpg’ or ‘tiff’ (GeoTIFF).

    Available values : png, jpg, tiff

Returns:

Status message and file name

Return type:

JSON

Raises:

ValueError – If parameter is invalid

ogcmaps.collections.get_collection_map_tile(collection_id, tile_matrix_set_id, tile_matrix, tile_row, tile_col, file_name, f='png', **kwargs) → dict

Retrieve a map tile from the specified collection.

Parameters:

  • collection_id (str) – Local identifier of a collection

  • tile_matrix_set_id (str) – Identifier for a supported TileMatrixSet

  • tile_matrix (str) –

    Identifier selecting one of the scales defined in the TileMatrixSet and representing the scaleDenominator the tile. For example, Ireland is fully within the Tile at WebMercatorQuad tileMatrix=5, tileRow=10 and tileCol=15.

    Example : 5

  • tile_row (int) –

    Row index of the tile on the selected TileMatrix. It cannot exceed the MatrixWidth-1 for the selected TileMatrix. For example, Ireland is fully within the Tile at WebMercatorQuad tileMatrix=5, tileRow=10 and tileCol=15.

    Example : 10

  • tile_col (int) –

    Column index of the tile on the selected TileMatrix. It cannot exceed the MatrixHeight-1 for the selected TileMatrix. For example, Ireland is fully within the Tile at WebMercatorQuad tileMatrix=5, tileRow=10 and tileCol=15.

    Example : 15

  • file_name (str) – Name of file to save the map image

  • datetime (str, optional) –

    Either a date-time or an interval, half-bounded or bounded. Date and time expressions adhere to RFC 3339. Half-bounded intervals are expressed using double-dots.

    Examples:

    • A date-time: “2018-02-12T23:20:50Z”

    • A bounded interval: “2018-02-12T00:00:00Z/2018-03-18T12:31:12Z”

    • Half-bounded intervals: “2018-02-12T00:00:00Z/..” or “../ 2018-03-18T12:31:12Z”

  • collections (array[str], optional) – The collections that should be included in the response. The parameter value is a comma-separated list of collection identifiers. If the parameters is missing, some or all collections will be included. The collection will be rendered in the order specified, with the last one showing on top, unless the priority is overridden by styling rules.

  • subset (array[str], optional) – Retrieve only part of the data by slicing or trimming along one or more axis For trimming: {axisAbbrev}({low}:{high}) (preserves dimensionality) An asterisk (*) can be used instead of {low} or {high} to indicate the minimum/maximum value. For slicing: {axisAbbrev}({value}) (reduces dimensionality).

  • crs (str, optional) – Reproject the output to the given crs

  • subset-crs (str, optional) – Crs for the specified subset

  • bgcolor (str, optional) –

    Web color name or hexadecimal 0x[AA]RRGGBB color value for the background color (default to 0x9C9C9C gray). If alpha is not specified, full opacity is assumed.

    Default value : 0xFFFFFF

  • transparent (boolean, optional) –

    Background transparency of map (default=true).

    Default value : true

  • f (str, optional) –

    The format of the map response (e.g. png). Accepted values are ‘png’, ‘jpg’ or ‘tiff’ (GeoTIFF).

    Available values : png, jpg, tiff

Returns:

Status message and file name

Return type:

JSON

Raises:

ValueError – If parameter is invalid

ogcmaps.collections.get_collection_map_tile_matrix(collection_id, tile_matrix_set_id, f='json') → dict

Retrieve a map tile set metadata for the specified collection and tiling scheme (tile matrix set)

Parameters:

  • collection_id (str) – Local identifier of a collection

  • tile_matrix_set_id (str) – Identifier for a supported TileMatrixSet

  • f (str, optional) –

    The format of the response. If no value is provided, the accept header is used to determine the format. Accepted values are ‘json’ or ‘html’.

    Available values : json, html

Returns:

Description of the tileset.

Return type:

JSON

Raises:

None –

ogcmaps.collections.get_collection_map_tiles(collection_id, f='json') → dict

Retrieve a list of all map tilesets for specified collection.

Parameters:

  • collection_id (str) – Local identifier of a collection

  • f (str, optional) –

    The format of the response. If no value is provided, the accept header is used to determine the format. Accepted values are ‘json’ or ‘html’.

    Available values : json, html

Returns:

List of available tilesets.

Return type:

JSON

Raises:

None –

ogcmaps.collections.get_collection_style(collection_id, style_id, f='json') → dict

Retrieve the style data for a style in a collection.

Parameters:

  • collection_id (str) – Local identifier of a collection

  • style_id (str) – An identifier representing a specific style.

  • f (str, optional) –

    The format of the response. If no value is provided, the accept header is used to determine the format. Accepted values are ‘json’ or ‘html’.

    Available values : json, html

Returns:

Style data of a particular style

Return type:

JSON

Raises:

None –

ogcmaps.collections.get_collection_styled_map(collection_id, style_id, file_name, f='png', **kwargs) → dict

Retrieve a map for a specified collection and style.

Parameters:

  • collection_id (str) – Local identifier of a collection

  • style_id (str) – An identifier representing a specific style

  • file_name (str) – Name of file to save the map image

  • bbox (array[int], optional) –

    Only features that have a geometry that intersects the bounding box are selected. The bounding box is provided as four or six numbers, depending on whether the coordinate reference system includes a vertical axis (height or depth):

    • Lower left corner, coordinate axis 1

    • Lower left corner, coordinate axis 2

    • Minimum value, coordinate axis 3 (optional)

    • Upper right corner, coordinate axis 1

    • Upper right corner, coordinate axis 2

    • Maximum value, coordinate axis 3 (optional)

    The coordinate reference system of the values is WGS 84 longitude/latitude (http://www.opengis.net/def/crs/OGC/1.3/CRS84) unless a different coordinate reference system is specified in the parameter bbox-crs. For WGS 84 longitude/latitude the values are in most cases the sequence of minimum longitude, minimum latitude, maximum longitude and maximum latitude. However, in cases where the box spans the antimeridian the first value (west-most box edge) is larger than the third value (east-most box edge). If the vertical axis is included, the third and the sixth number are the bottom and the top of the 3-dimensional bounding box. If a feature has multiple spatial geometry properties, it is the decision of the server whether only a single spatial geometry property is used to determine the extent or all relevant geometries.

  • datetime (str, optional) –

    Either a date-time or an interval, half-bounded or bounded. Date and time expressions adhere to RFC 3339. Half-bounded intervals are expressed using double-dots.

    Examples:

    • A date-time: “2018-02-12T23:20:50Z”

    • A bounded interval: “2018-02-12T00:00:00Z/2018-03-18T12:31:12Z”

    • Half-bounded intervals: “2018-02-12T00:00:00Z/..” or “../ 2018-03-18T12:31:12Z”

  • collections (array[str], optional) – The collections that should be included in the response. The parameter value is a comma-separated list of collection identifiers. If the parameters is missing, some or all collections will be included. The collection will be rendered in the order specified, with the last one showing on top, unless the priority is overridden by styling rules.

  • subset (array[str], optional) – Retrieve only part of the data by slicing or trimming along one or more axis For trimming: {axisAbbrev}({low}:{high}) (preserves dimensionality) An asterisk (*) can be used instead of {low} or {high} to indicate the minimum/maximum value. For slicing: {axisAbbrev}({value}) (reduces dimensionality).

  • crs (str, optional) – Reproject the output to the given crs

  • bbox-crs (str, optional) – Crs for the specified bbox

  • subset-crs (str, optional) – Crs for the specified subset

  • bgcolor (str, optional) –

    Web color name or hexadecimal 0x[AA]RRGGBB color value for the background color (default to 0x9C9C9C gray). If alpha is not specified, full opacity is assumed.

    Default value : 0xFFFFFF

  • transparent (boolean, optional) –

    Background transparency of map (default=true).

    Default value : true

  • width (int, optional) – Width of the map in pixel. If omitted and height is specified, defaults to the width maintaining a 1:1 aspect ratio. If both width and height are omitted, the server will select a default dimensions.

  • height (int, optional) – Height of the map in pixel. If omitted and width is specified, defaults to the height maintaining a 1:1 aspect ratio. If both width and height are omitted, the server will select a default dimensions.

  • f (str, optional) –

    The format of the map response (e.g. png). Accepted values are ‘png’, ‘jpg’ or ‘tiff’ (GeoTIFF).

    Available values : png, jpg, tiff

Returns:

Status message and file name

Return type:

JSON

Raises:

ValueError – If parameter is invalid

ogcmaps.collections.get_collection_styled_map_tile(collection_id, style_id, tile_matrix_set_id, tile_matrix, tile_row, tile_col, file_name, f='png', **kwargs) → dict

Retrieve a map tile for a specified collection and style

Parameters:

  • collection_id (str) – Local identifier of a collection

  • style_id (str) – An identifier representing a specific style

  • tile_matrix_set_id (str) – Identifier for a supported TileMatrixSet

  • tile_matrix (str) –

    Identifier selecting one of the scales defined in the TileMatrixSet and representing the scaleDenominator the tile. For example, Ireland is fully within the Tile at WebMercatorQuad tileMatrix=5, tileRow=10 and tileCol=15.

    Example : 5

  • tile_row (int) –

    Row index of the tile on the selected TileMatrix. It cannot exceed the MatrixWidth-1 for the selected TileMatrix. For example, Ireland is fully within the Tile at WebMercatorQuad tileMatrix=5, tileRow=10 and tileCol=15.

    Example : 10

  • tile_col (int) –

    Column index of the tile on the selected TileMatrix. It cannot exceed the MatrixHeight-1 for the selected TileMatrix. For example, Ireland is fully within the Tile at WebMercatorQuad tileMatrix=5, tileRow=10 and tileCol=15.

    Example : 15

  • file_name (str) – Name of file to save the map image

  • datetime (str, optional) –

    Either a date-time or an interval, half-bounded or bounded. Date and time expressions adhere to RFC 3339. Half-bounded intervals are expressed using double-dots.

    Examples:

    • A date-time: “2018-02-12T23:20:50Z”

    • A bounded interval: “2018-02-12T00:00:00Z/2018-03-18T12:31:12Z”

    • Half-bounded intervals: “2018-02-12T00:00:00Z/..” or “../ 2018-03-18T12:31:12Z”

  • collections (array[str], optional) – The collections that should be included in the response. The parameter value is a comma-separated list of collection identifiers. If the parameters is missing, some or all collections will be included. The collection will be rendered in the order specified, with the last one showing on top, unless the priority is overridden by styling rules.

  • subset (array[str], optional) – Retrieve only part of the data by slicing or trimming along one or more axis For trimming: {axisAbbrev}({low}:{high}) (preserves dimensionality) An asterisk (*) can be used instead of {low} or {high} to indicate the minimum/maximum value. For slicing: {axisAbbrev}({value}) (reduces dimensionality).

  • crs (str, optional) – Reproject the output to the given crs

  • subset-crs (str, optional) – Crs for the specified subset

  • bgcolor (str, optional) –

    Web color name or hexadecimal 0x[AA]RRGGBB color value for the background color (default to 0x9C9C9C gray). If alpha is not specified, full opacity is assumed.

    Default value : 0xFFFFFF

  • transparent (boolean, optional) –

    Background transparency of map (default=true).

    Default value : true

  • f (str, optional) –

    The format of the map response (e.g. png). Accepted values are ‘png’, ‘jpg’ or ‘tiff’ (GeoTIFF).

    Available values : png, jpg, tiff

Returns:

Status message and file name

Return type:

JSON

Raises:

ValueError – If parameter is invalid

ogcmaps.collections.get_collection_styled_tiles(collection_id, style_id, f='json') → dict

Retrieve a list of styled map tilesets for the specified collection

Parameters:

  • collection_id (str) – Local identifier of a collection

  • style_id (str) – An identifier representing a specific style

  • f (str, optional) –

    The format of the response. If no value is provided, the accept header is used to determine the format. Accepted values are ‘json’ or ‘html’.

    Available values : json, html

Returns:

List of available tilesets

Return type:

JSON

Raises:

None –

ogcmaps.collections.get_collection_styles(collection_id, f='json') → dict

Retrieve the list of all styles for a particular collection.

Parameters:

  • collection_id (str) – Local identifier of a collection

  • f (str, optional) –

    The format of the response. If no value is provided, the accept header is used to determine the format. Accepted values are ‘json’ or ‘html’.

    Available values : json, html

Returns:

A list of styles and the style data

Return type:

JSON

Raises:

None –

ogcmaps.collections.metadata(f='json', **kwargs) → dict

Retrieve the list of geospatial data collections available from this service.

Parameters:

  • datetime (str, optional) –

    Either a date-time or an interval, half-bounded or bounded. Date and time expressions adhere to RFC 3339. Half-bounded intervals are expressed using double-dots.

    Examples:

    • A date-time: “2018-02-12T23:20:50Z”

    • A bounded interval: “2018-02-12T00:00:00Z/2018-03-18T12:31:12Z”

    • Half-bounded intervals: “2018-02-12T00:00:00Z/..” or “../ 2018-03-18T12:31:12Z”

  • bbox (array[int], optional) –

    Only features that have a geometry that intersects the bounding box are selected. The bounding box is provided as four or six numbers,depending on whether the coordinate reference system includes a vertical axis (height or depth):

    • Lower left corner, coordinate axis 1

    • Lower left corner, coordinate axis 2

    • Minimum value, coordinate axis 3 (optional)

    • Upper right corner, coordinate axis 1

    • Upper right corner, coordinate axis 2

    • Maximum value, coordinate axis 3 (optional)

    The coordinate reference system of the values is WGS 84 longitude/ latitude (http://www.opengis.net/def/crs/OGC/1.3/CRS84) unless a different coordinate reference system is specified in the parameter bbox-crs. For WGS 84 longitude/latitude the values are in most cases the sequence of minimum longitude, minimum latitude, maximum longitude and maximum latitude. However, in cases where the box spans the antimeridian the first value (west-most box edge) is larger than the third value (east-most box edge). If the vertical axis is included, the third and the sixth number are the bottom and the top of the 3-dimensional bounding box. If a feature has multiple spatial geometry properties, it is the decision of the server whether only a single spatial geometry property is used to determine the extent or all relevant geometries.

  • limit (int, optional) –

    The optional limit parameter limits the number of collections that are presented in the response document. Only items are counted that are on the first level of the collection in the response document. Nested objects contained within the explicitly requested items shall not be counted.

    • Minimum = 1 * Maximum = 10000 * Default = 10

    Default value : 10

  • f (str, optional) –

    The format of the response. If no value is provided, the accept header is used to determine the format. Accepted values are ‘json’ or ‘html’.

    Available values : json, html

Returns:

The collections of (mostly geospatial) data available from this API. The dataset contains one or more collections. This resource provides information about and access to the collections. The response contains the list of collections. Each collection is accessible via one or more OGC API set of specifications, for which a link to relevant accessible resources, e.g. /collections/{collectionId}/(items, coverage, map, tiles...) is provided, with the corresponding relation type, as well as key information about the collection. This information includes:

  • A local identifier for the collection that is unique for the dataset.

  • A list of coordinate reference systems (CRS) in which data may be returned by the server. The first CRS is the default coordinate reference system (the default is always WGS 84 with axis order longitude/latitude).

  • An optional title and description for the collection.

  • An optional extent that can be used to provide an indication of the spatial and temporal extent of the collection - typically derived from the data.

  • For collections accessible via the Features or Records API, an optional indicator about the type of the items in the collection (the default value, if the indicator is not provided, is ‘feature’).

Return type:

JSON

Raises:

ValueError – If parameter is invalid

ogcmaps.conformance module

ogcmaps.conformance.metadata(f='json') → dict

Retrieve the set of OGC API conformance classes that are supported by this service.

Parameters:

f (str, optional) –

The format of the response. If no value is provided, the accept header is used to determine the format. Accepted values are ‘json’ or ‘html’.

Available values : json, html

Returns:

The URIs of all conformance classes supported by the server

Return type:

JSON

Raises:

None –

ogcmaps.landing module

ogcmaps.landing.metadata(f='json') → dict

Retrieve the OGC API landing page for this service.

Parameters:

f (str, optional) –

The format of the response. If no value is provided, the accept header is used to determine the format. Accepted values are ‘json’ or ‘html’.

Available values : json, html

Returns:

Links to the API definition, the conformance statements and to the feature collections in the dataset.

Return type:

JSON

Raises:

None –

ogcmaps.maps module

ogcmaps.maps.get_map(file_name, f='png', **kwargs) → dict

Retrieve a default map of the whole dataset

Parameters:

  • file_name (str) – Name of file to save the map image

  • bbox (array[int], optional) –

    Only features that have a geometry that intersects the bounding box are selected. The bounding box is provided as four or six numbers, depending on whether the coordinate reference system includes a vertical axis (height or depth):

    • Lower left corner, coordinate axis 1

    • Lower left corner, coordinate axis 2

    • Minimum value, coordinate axis 3 (optional)

    • Upper right corner, coordinate axis 1

    • Upper right corner, coordinate axis 2

    • Maximum value, coordinate axis 3 (optional)

    The coordinate reference system of the values is WGS 84 longitude/latitude (http://www.opengis.net/def/crs/OGC/1.3/CRS84) unless a different coordinate reference system is specified in the parameter bbox-crs. For WGS 84 longitude/latitude the values are in most cases the sequence of minimum longitude, minimum latitude, maximum longitude and maximum latitude. However, in cases where the box spans the antimeridian the first value (west-most box edge) is larger than the third value (east-most box edge). If the vertical axis is included, the third and the sixth number are the bottom and the top of the 3-dimensional bounding box. If a feature has multiple spatial geometry properties, it is the decision of the server whether only a single spatial geometry property is used to determine the extent or all relevant geometries.

  • datetime (str, optional) –

    Either a date-time or an interval, half-bounded or bounded. Date and time expressions adhere to RFC 3339. Half-bounded intervals are expressed using double-dots.

    Examples:

    • A date-time: “2018-02-12T23:20:50Z”

    • A bounded interval: “2018-02-12T00:00:00Z/2018-03-18T12:31:12Z”

    • Half-bounded intervals: “2018-02-12T00:00:00Z/..” or “../ 2018-03-18T12:31:12Z”

  • collections (array[str], optional) – The collections that should be included in the response. The parameter value is a comma-separated list of collection identifiers. If the parameters is missing, some or all collections will be included. The collection will be rendered in the order specified, with the last one showing on top, unless the priority is overridden by styling rules.

  • subset (array[str], optional) – Retrieve only part of the data by slicing or trimming along one or more axis For trimming: {axisAbbrev}({low}:{high}) (preserves dimensionality) An asterisk (*) can be used instead of {low} or {high} to indicate the minimum/maximum value. For slicing: {axisAbbrev}({value}) (reduces dimensionality).

  • crs (str, optional) – Reproject the output to the given crs

  • bbox-crs (str, optional) – Crs for the specified bbox

  • subset-crs (str, optional) – Crs for the specified subset

  • bgcolor (str, optional) –

    Web color name or hexadecimal 0x[AA]RRGGBB color value for the background color (default to 0x9C9C9C gray). If alpha is not specified, full opacity is assumed.

    Default value : 0xFFFFFF

  • transparent (boolean, optional) –

    Background transparency of map (default=true).

    Default value : true

  • width (int, optional) – Width of the map in pixel. If omitted and height is specified, defaults to the width maintaining a 1:1 aspect ratio. If both width and height are omitted, the server will select a default dimensions.

  • height (int, optional) – Height of the map in pixel. If omitted and width is specified, defaults to the height maintaining a 1:1 aspect ratio. If both width and height are omitted, the server will select a default dimensions.

  • f (str, optional) –

    The format of the map response (e.g. png). Accepted values are ‘png’, ‘jpg’ or ‘tiff’ (GeoTIFF).

    Available values : png, jpg, tiff

Returns:

Status message and File name

Return type:

JSON

Raises:

None –

ogcmaps.maps.get_map_tile(tile_matrix_set_id, tile_matrix, tile_row, tile_col, file_name, f='png', **kwargs) → dict

Retrieve a default map tile of the whole dataset

Parameters:

  • tile_matrix_set_id (str) – Identifier for a supported TileMatrixSet

  • tile_matrix (str) –

    Identifier selecting one of the scales defined in the TileMatrixSet and representing the scaleDenominator the tile. For example, Ireland is fully within the Tile at WebMercatorQuad tileMatrix=5, tileRow=10 and tileCol=15.

    Example : 5

  • tile_row (int) –

    Row index of the tile on the selected TileMatrix. It cannot exceed the MatrixWidth-1 for the selected TileMatrix. For example, Ireland is fully within the Tile at WebMercatorQuad tileMatrix=5, tileRow=10 and tileCol=15.

    Example : 10

  • tile_col (int) –

    Column index of the tile on the selected TileMatrix. It cannot exceed the MatrixHeight-1 for the selected TileMatrix. For example, Ireland is fully within the Tile at WebMercatorQuad tileMatrix=5, tileRow=10 and tileCol=15.

    Example : 15

  • file_name (str) – Name of file to save the map image

  • datetime (str, optional) –

    Either a date-time or an interval, half-bounded or bounded. Date and time expressions adhere to RFC 3339. Half-bounded intervals are expressed using double-dots.

    Examples:

    • A date-time: “2018-02-12T23:20:50Z”

    • A bounded interval: “2018-02-12T00:00:00Z/2018-03-18T12:31:12Z”

    • Half-bounded intervals: “2018-02-12T00:00:00Z/..” or “../ 2018-03-18T12:31:12Z”

  • collections (array[str], optional) – The collections that should be included in the response. The parameter value is a comma-separated list of collection identifiers. If the parameters is missing, some or all collections will be included. The collection will be rendered in the order specified, with the last one showing on top, unless the priority is overridden by styling rules.

  • subset (array[str], optional) – Retrieve only part of the data by slicing or trimming along one or more axis For trimming: {axisAbbrev}({low}:{high}) (preserves dimensionality) An asterisk (*) can be used instead of {low} or {high} to indicate the minimum/maximum value. For slicing: {axisAbbrev}({value}) (reduces dimensionality).

  • crs (str, optional) – Reproject the output to the given crs

  • subset-crs (str, optional) – Crs for the specified subset

  • bgcolor (str, optional) –

    Web color name or hexadecimal 0x[AA]RRGGBB color value for the background color (default to 0x9C9C9C gray). If alpha is not specified, full opacity is assumed.

    Default value : 0xFFFFFF

  • transparent (boolean, optional) –

    Background transparency of map (default=true).

    Default value : true

  • f (str, optional) –

    The format of the map response (e.g. png). Accepted values are ‘png’, ‘jpg’ or ‘tiff’ (GeoTIFF).

    Available values : png, jpg, tiff

Returns:

Status message and file name

Return type:

JSON

Raises:

ValueError – If parameter is invalid

ogcmaps.maps.get_map_tile_matrix_set(tile_matrix_set_id, f='json', **kwargs) → dict

Retrieve a default map tileset of the whole dataset for the specified tiling scheme (tile matrix set)

Parameters:

  • tile_matrix_set_id (str) – Identifier for a supported TileMatrixSet

  • collections (array[str], optional) – The collections that should be included in the response. The parameter value is a comma-separated list of collection identifiers. If the parameters is missing, some or all collections will be included. The collection will be rendered in the order specified, with the last one showing on top, unless the priority is overridden by styling rules.

  • f (str, optional) –

    The format of the response. If no value is provided, the accept header is used to determine the format. Accepted values are ‘json’ or ‘html’.

    Available values : json, html

Returns:

Description of the tileset

Return type:

JSON

Raises:

ValueError – If parameter is invalid

ogcmaps.maps.get_map_tiles(f='json') → dict

Retrieve the list of all default map tilesets for the whole dataset

Parameters:

f (str, optional) –

The format of the response. If no value is provided, the accept header is used to determine the format. Accepted values are ‘json’ or ‘html’.

Available values : json, html

Returns:

List of available tilesets

Return type:

JSON

Raises:

None –

ogcmaps.styles module

ogcmaps.styles.get_styled_map(style_id, file_name, f='png', **kwargs) → dict

Retrieve a styled map of the whole dataset.

Parameters:

  • style_id (str) – An identifier representing a specific style.

  • file_name (str) – Name of file to save the map image

  • bbox (array[int], optional) –

    Only features that have a geometry that intersects the bounding box are selected. The bounding box is provided as four or six numbers, depending on whether the coordinate reference system includes a vertical axis (height or depth):

    • Lower left corner, coordinate axis 1

    • Lower left corner, coordinate axis 2

    • Minimum value, coordinate axis 3 (optional)

    • Upper right corner, coordinate axis 1

    • Upper right corner, coordinate axis 2

    • Maximum value, coordinate axis 3 (optional)

    The coordinate reference system of the values is WGS 84 longitude/latitude (http://www.opengis.net/def/crs/OGC/1.3/CRS84) unless a different coordinate reference system is specified in the parameter bbox-crs. For WGS 84 longitude/latitude the values are in most cases the sequence of minimum longitude, minimum latitude, maximum longitude and maximum latitude. However, in cases where the box spans the antimeridian the first value (west-most box edge) is larger than the third value (east-most box edge). If the vertical axis is included, the third and the sixth number are the bottom and the top of the 3-dimensional bounding box. If a feature has multiple spatial geometry properties, it is the decision of the server whether only a single spatial geometry property is used to determine the extent or all relevant geometries.

  • datetime (str, optional) –

    Either a date-time or an interval, half-bounded or bounded. Date and time expressions adhere to RFC 3339. Half-bounded intervals are expressed using double-dots.

    Examples:

    • A date-time: “2018-02-12T23:20:50Z”

    • A bounded interval: “2018-02-12T00:00:00Z/2018-03-18T12:31:12Z”

    • Half-bounded intervals: “2018-02-12T00:00:00Z/..” or “../ 2018-03-18T12:31:12Z”

  • collections (array[str], optional) – The collections that should be included in the response. The parameter value is a comma-separated list of collection identifiers. If the parameters is missing, some or all collections will be included. The collection will be rendered in the order specified, with the last one showing on top, unless the priority is overridden by styling rules.

  • subset (array[str], optional) – Retrieve only part of the data by slicing or trimming along one or more axis For trimming: {axisAbbrev}({low}:{high}) (preserves dimensionality) An asterisk (*) can be used instead of {low} or {high} to indicate the minimum/maximum value. For slicing: {axisAbbrev}({value}) (reduces dimensionality).

  • crs (str, optional) – Reproject the output to the given crs

  • bbox-crs (str, optional) – Crs for the specified bbox

  • subset-crs (str, optional) – Crs for the specified subset

  • bgcolor (str, optional) –

    Web color name or hexadecimal 0x[AA]RRGGBB color value for the background color (default to 0x9C9C9C gray). If alpha is not specified, full opacity is assumed.

    Default value : 0xFFFFFF

  • transparent (boolean, optional) –

    Background transparency of map (default=true).

    Default value : true

  • width (int, optional) – Width of the map in pixel. If omitted and height is specified, defaults to the width maintaining a 1:1 aspect ratio. If both width and height are omitted, the server will select a default dimensions.

  • height (int, optional) – Height of the map in pixel. If omitted and width is specified, defaults to the height maintaining a 1:1 aspect ratio. If both width and height are omitted, the server will select a default dimensions.

  • f (str, optional) –

    The format of the map response (e.g. png). Accepted values are ‘png’, ‘jpg’ or ‘tiff’ (GeoTIFF).

    Available values : png, jpg, tiff

Returns:

Status message and File name

Return type:

JSON

Raises:

ValueError – If parameter is invalid

ogcmaps.styles.get_styled_map_tile(style_id, tile_matrix_set_id, tile_matrix, tile_row, tile_col, file_name, f='png', **kwargs)

Retrieve a styled map tiles

Parameters:

  • style_id (str) – An identifier representing a specific style

  • tile_matrix_set_id (str) – Identifier for a supported TileMatrixSet

  • tile_matrix (str) –

    Identifier selecting one of the scales defined in the TileMatrixSet and representing the scaleDenominator the tile. For example, Ireland is fully within the Tile at WebMercatorQuad tileMatrix=5, tileRow=10 and tileCol=15.

    Example : 5

  • tile_row (int) –

    Row index of the tile on the selected TileMatrix. It cannot exceed the MatrixWidth-1 for the selected TileMatrix. For example, Ireland is fully within the Tile at WebMercatorQuad tileMatrix=5, tileRow=10 and tileCol=15.

    Example : 10

  • tile_col (int) –

    Column index of the tile on the selected TileMatrix. It cannot exceed the MatrixHeight-1 for the selected TileMatrix. For example, Ireland is fully within the Tile at WebMercatorQuad tileMatrix=5, tileRow=10 and tileCol=15.

    Example : 15

  • file_name (str) – Name of file to save the map image

  • datetime (str, optional) –

    Either a date-time or an interval, half-bounded or bounded. Date and time expressions adhere to RFC 3339. Half-bounded intervals are expressed using double-dots.

    Examples:

    • A date-time: “2018-02-12T23:20:50Z”

    • A bounded interval: “2018-02-12T00:00:00Z/2018-03-18T12:31:12Z”

    • Half-bounded intervals: “2018-02-12T00:00:00Z/..” or “../ 2018-03-18T12:31:12Z”

  • collections (array[str], optional) – The collections that should be included in the response. The parameter value is a comma-separated list of collection identifiers. If the parameters is missing, some or all collections will be included. The collection will be rendered in the order specified, with the last one showing on top, unless the priority is overridden by styling rules.

  • subset (array[str], optional) – Retrieve only part of the data by slicing or trimming along one or more axis For trimming: {axisAbbrev}({low}:{high}) (preserves dimensionality) An asterisk (*) can be used instead of {low} or {high} to indicate the minimum/maximum value. For slicing: {axisAbbrev}({value}) (reduces dimensionality).

  • crs (str, optional) – Reproject the output to the given crs

  • subset-crs (str, optional) – Crs for the specified subset

  • bgcolor (str, optional) –

    Web color name or hexadecimal 0x[AA]RRGGBB color value for the background color (default to 0x9C9C9C gray). If alpha is not specified, full opacity is assumed.

    Default value : 0xFFFFFF

  • transparent (boolean, optional) –

    Background transparency of map (default=true).

    Default value : true

  • f (str, optional) –

    The format of the map response (e.g. png). Accepted values are ‘png’, ‘jpg’ or ‘tiff’ (GeoTIFF).

    Available values : png, jpg, tiff

Returns:

Status message and file name

Return type:

JSON

Raises:

ValueError – If parameter is invalid

ogcmaps.styles.get_styled_map_tiles(style_id, f='json') → dict

Retrieve the list of styled map tilesets for the whole dataset

Parameters:

  • style_id (str) – An identifier representing a specific style.

  • f (str, optional) –

    The format of the response. If no value is provided, the accept header is used to determine the format. Accepted values are ‘json’ or ‘html’.

    Available values : json, html

Returns:

List of available tilesets

Return type:

JSON

Raises:

None –

ogcmaps.styles.styled_map_tiles_matrix(style_id, tile_matrix_set_id, f='json', **kwargs) → dict

Retrieve a styled map tileset of the whole dataset for the specified tiling scheme (tile matrix set)

Parameters:

  • style_id (str) – An identifier representing a specific style

  • tile_matrix_set_id (str) – Identifier for a supported TileMatrixSet

  • collections (array[str]) – The collections that should be included in the response. The parameter value is a comma-separated list of collection identifiers. If the parameters is missing, some or all collections will be included. The collection will be rendered in the order specified, with the last one showing on top, unless the priority is overridden by styling rules.

  • f (str, optional) –

    The format of the response. If no value is provided, the accept header is used to determine the format. Accepted values are ‘json’ or ‘html’.

    Available values : json, html

Returns:

Description of the tileset

Return type:

JSON

Raises:

ValueError – If parameter is invalid