Example Datasets

Factory functions that return a TileClient pre-loaded with publicly available sample data. These are used throughout the documentation and are handy for quick experimentation.

localtileserver.examples.get_bahamas(port: int | str = 'default', debug: bool = False, client_port: int | None = None, client_host: str | None = None, client_prefix: str | None = None)

Template signature for example TileClient factory functions.

Parameters:

• port (int or str, optional) – The port on which to serve tiles. Default is "default".

• debug (bool, optional) – Whether to enable debug mode. Default is False.

• client_port (int or None, optional) – The port for the client to connect to.

• client_host (str or None, optional) – The host for the client to connect to.

• client_prefix (str or None, optional) – The URL prefix for the client.

localtileserver.examples.get_blue_marble(port: int | str = 'default', debug: bool = False, client_port: int | None = None, client_host: str | None = None, client_prefix: str | None = None)

Template signature for example TileClient factory functions.

Parameters:

• port (int or str, optional) – The port on which to serve tiles. Default is "default".

• debug (bool, optional) – Whether to enable debug mode. Default is False.

• client_port (int or None, optional) – The port for the client to connect to.

• client_host (str or None, optional) – The host for the client to connect to.

• client_prefix (str or None, optional) – The URL prefix for the client.

localtileserver.examples.get_virtual_earth(port: int | str = 'default', debug: bool = False, client_port: int | None = None, client_host: str | None = None, client_prefix: str | None = None)

Template signature for example TileClient factory functions.

Parameters:

• port (int or str, optional) – The port on which to serve tiles. Default is "default".

• debug (bool, optional) – Whether to enable debug mode. Default is False.

• client_port (int or None, optional) – The port for the client to connect to.

• client_host (str or None, optional) – The host for the client to connect to.

• client_prefix (str or None, optional) – The URL prefix for the client.

localtileserver.examples.get_arcgis(port: int | str = 'default', debug: bool = False, client_port: int | None = None, client_host: str | None = None, client_prefix: str | None = None)

Template signature for example TileClient factory functions.

Parameters:

• port (int or str, optional) – The port on which to serve tiles. Default is "default".

• debug (bool, optional) – Whether to enable debug mode. Default is False.

• client_port (int or None, optional) – The port for the client to connect to.

• client_host (str or None, optional) – The host for the client to connect to.

• client_prefix (str or None, optional) – The URL prefix for the client.

localtileserver.examples.get_elevation(port: int | str = 'default', debug: bool = False, client_port: int | None = None, client_host: str | None = None, client_prefix: str | None = None)

Template signature for example TileClient factory functions.

Parameters:

• port (int or str, optional) – The port on which to serve tiles. Default is "default".

• debug (bool, optional) – Whether to enable debug mode. Default is False.

• client_port (int or None, optional) – The port for the client to connect to.

• client_host (str or None, optional) – The host for the client to connect to.

• client_prefix (str or None, optional) – The URL prefix for the client.

localtileserver.examples.get_elevation_us(port: int | str = 'default', debug: bool = False, client_port: int | None = None, client_host: str | None = None, client_prefix: str | None = None)

Template signature for example TileClient factory functions.

Parameters:

• port (int or str, optional) – The port on which to serve tiles. Default is "default".

• debug (bool, optional) – Whether to enable debug mode. Default is False.

• client_port (int or None, optional) – The port for the client to connect to.

• client_host (str or None, optional) – The host for the client to connect to.

• client_prefix (str or None, optional) – The URL prefix for the client.

localtileserver.examples.get_co_elevation(port: int | str = 'default', debug: bool = False, client_port: int | None = None, client_host: str | None = None, client_prefix: str | None = None)

Template signature for example TileClient factory functions.

Parameters:

• port (int or str, optional) – The port on which to serve tiles. Default is "default".

• debug (bool, optional) – Whether to enable debug mode. Default is False.

• client_port (int or None, optional) – The port for the client to connect to.

• client_host (str or None, optional) – The host for the client to connect to.

• client_prefix (str or None, optional) – The URL prefix for the client.

localtileserver.examples.get_landsat(port: int | str = 'default', debug: bool = False, client_port: int | None = None, client_host: str | None = None, client_prefix: str | None = None)

Template signature for example TileClient factory functions.

Parameters:

• port (int or str, optional) – The port on which to serve tiles. Default is "default".

• debug (bool, optional) – Whether to enable debug mode. Default is False.

• client_port (int or None, optional) – The port for the client to connect to.

• client_host (str or None, optional) – The host for the client to connect to.

• client_prefix (str or None, optional) – The URL prefix for the client.

localtileserver.examples.get_landsat7(port: int | str = 'default', debug: bool = False, client_port: int | None = None, client_host: str | None = None, client_prefix: str | None = None)

Template signature for example TileClient factory functions.

Parameters:

• port (int or str, optional) – The port on which to serve tiles. Default is "default".

• debug (bool, optional) – Whether to enable debug mode. Default is False.

• client_port (int or None, optional) – The port for the client to connect to.

• client_host (str or None, optional) – The host for the client to connect to.

• client_prefix (str or None, optional) – The URL prefix for the client.

localtileserver.examples.get_san_francisco(port: int | str = 'default', debug: bool = False, client_port: int | None = None, client_host: str | None = None, client_prefix: str | None = None)

Template signature for example TileClient factory functions.

Parameters:

• port (int or str, optional) – The port on which to serve tiles. Default is "default".

• debug (bool, optional) – Whether to enable debug mode. Default is False.

• client_port (int or None, optional) – The port for the client to connect to.

• client_host (str or None, optional) – The host for the client to connect to.

• client_prefix (str or None, optional) – The URL prefix for the client.

localtileserver.examples.get_oam2(port: int | str = 'default', debug: bool = False, client_port: int | None = None, client_host: str | None = None, client_prefix: str | None = None)

Template signature for example TileClient factory functions.

Parameters:

• port (int or str, optional) – The port on which to serve tiles. Default is "default".

• debug (bool, optional) – Whether to enable debug mode. Default is False.

• client_port (int or None, optional) – The port for the client to connect to.

• client_host (str or None, optional) – The host for the client to connect to.

• client_prefix (str or None, optional) – The URL prefix for the client.

localtileserver.examples.load_presidio()

Load Presidio of San Francisco boundary as a Shapely Polygon.

Returns:

The Presidio boundary polygon.

Return type:

shapely.geometry.BaseGeometry