Function pmtiles

python/rio-pmtiles/rio_pmtiles/scripts/cli.py:226–484

Export a dataset to PMTiles. The input dataset may have any coordinate reference system. It must have at least three bands, which will be become the red, blue, and green bands of the output image tiles. An optional fourth alpha band may be copied to the output tiles by using th

(
    ctx,
    files,
    output,
    name,
    description,
    attribution,
    layer_type,
    img_format,
    tile_size,
    zoom_levels,
    num_workers,
    src_nodata,
    dst_nodata,
    resampling,
    rgba,
    silent,
    cutline,
    open_options,
    creation_options,
    warp_options,
    exclude_empty_tiles,
)

)
@click.pass_context
def pmtiles(
    ctx,
    files,
    output,
    name,
    description,
    attribution,
    layer_type,
    img_format,
    tile_size,
    zoom_levels,
    num_workers,
    src_nodata,
    dst_nodata,
    resampling,
    rgba,
    silent,
    cutline,
    open_options,
    creation_options,
    warp_options,
    exclude_empty_tiles,
):
    """Export a dataset to PMTiles.

    The input dataset may have any coordinate reference system. It must
    have at least three bands, which will be become the red, blue, and
    green bands of the output image tiles.

    An optional fourth alpha band may be copied to the output tiles by
    using the --rgba option in combination with the PNG or WEBP formats.
    This option requires that the input dataset has at least 4 bands.

    The default quality for JPEG and WEBP output (possible range:
    10-100) is 75. This value can be changed with the use of the QUALITY
    creation option, e.g. `--co QUALITY=90`.  The default zlib
    compression level for PNG output (possible range: 1-9) is 6. This
    value can be changed like `--co ZLEVEL=8`.  Lossless WEBP can be
    chosen with `--co LOSSLESS=TRUE`.

    If no zoom levels are specified, the defaults are the zoom levels
    nearest to the one at which one tile may contain the entire source
    dataset.

    If a name or description for the output file are not provided,
    they will be taken from the input dataset's filename.

    This command is suited for small to medium (~1 GB) sized sources.

    Python package: rio-pmtiles (https://github.com/protomaps/PMTiles).

    """
    log = logging.getLogger(__name__)

    output, files = resolve_inout(
        files=files, output=output, num_inputs=1,
    )
    inputfile = files[0]