mapchete.formats.default.gtiff module

Handles writing process output into a pyramid of GeoTIFF files or a single GeoTIFF file.

output configuration parameters

mandatory

bands: integer

number of output bands to be written

path: string

output directory

dtype: string

numpy datatype

optional

tiled: bool

internal TIFF tiling (default: True)

blockxsize: integer

internal tile width (default: 256)

blockysize:

internal tile height (default: 256)

nodata: integer or float

nodata value used for writing

compress: string

compression method (default: lzw): lzw, jpeg, packbits, deflate, CCITTRLE, CCITTFAX3, CCITTFAX4, lzma

class mapchete.formats.default.gtiff.DefaultGTiffProfile(*args: Any, **kwargs: Any)

Bases: Profile

Tiled, band-interleaved, DEFLATE-compressed, 8-bit GTiff.

defaults = {'blockxsize': 512, 'blockysize': 512, 'compress': 'deflate', 'driver': 'GTiff', 'dtype': 'uint8', 'interleave': 'band', 'nodata': 0, 'predictor': 2, 'tiled': True}

class mapchete.formats.default.gtiff.GTiffOutputReaderFunctions

Bases: object

Common functions.

METADATA = {'data_type': 'raster', 'driver_name': 'GTiff', 'mode': 'rw'}

empty(process_tile)

Return empty data.

Parameters

process_tileBufferedTile

must be member of process TilePyramid

Returns

empty dataarray

empty array with data type provided in output profile

for_web(data)

Convert data to web output (raster only).

Parameters

dataarray

Returns

web dataarray

is_valid_with_config(config)

Check if output format is valid with other process parameters.

Parameters

configdictionary

output configuration parameters

Returns

is_validbool

open(**kwargs)

class mapchete.formats.default.gtiff.GTiffSingleFileOutputWriter(output_params, **kwargs)

Bases: GTiffOutputReaderFunctions, SingleFileOutputWriter

close(exc_type=None, exc_value=None, exc_traceback=None)

Build overviews and write file.

get_path(tile=None)

Determine target file path.

Parameters

tileBufferedTile

must be member of output TilePyramid

Returns

pathstring

prepare(process_area=None, **kwargs)

profile(tile=None)

Create a metadata dictionary for rasterio.

Returns

metadatadictionary

output profile dictionary used for rasterio.

read(output_tile, **kwargs)

Read existing process output.

Parameters

output_tileBufferedTile

must be member of output TilePyramid

Returns

NumPy array

property stac_asset_type

GeoTIFF media type.

tiles_exist(process_tile=None, output_tile=None)

Check whether output tiles of a tile (either process or output) exists.

Parameters

process_tileBufferedTile

must be member of process TilePyramid

output_tileBufferedTile

must be member of output TilePyramid

Returns

existsbool

write(process_tile, data)

Write data from process tiles into GeoTIFF file(s).

Parameters

process_tileBufferedTile

must be member of process TilePyramid

write_in_parent_process = True

class mapchete.formats.default.gtiff.GTiffTileDirectoryOutputReader(output_params, **kwargs)

Bases: GTiffOutputReaderFunctions, TileDirectoryOutputReader

empty(process_tile)

Return empty data.

Parameters

process_tileBufferedTile

must be member of process TilePyramid

Returns

empty dataarray

empty array with data type provided in output profile

profile(tile=None)

Create a metadata dictionary for rasterio.

Parameters

tileBufferedTile

Returns

metadatadictionary

output profile dictionary used for rasterio.

read(output_tile, **kwargs)

Read existing process output.

Parameters

output_tileBufferedTile

must be member of output TilePyramid

Returns

NumPy array

class mapchete.formats.default.gtiff.GTiffTileDirectoryOutputWriter(output_params, **kwargs)

Bases: GTiffTileDirectoryOutputReader, TileDirectoryOutputWriter

property stac_asset_type

GeoTIFF media type.

use_stac = True

write(process_tile, data)

Write data from process tiles into GeoTIFF file(s).

Parameters

process_tileBufferedTile

must be member of process TilePyramid

datanp.ndarray

class mapchete.formats.default.gtiff.InputTile(tile, process)

Bases: InputTile

Target Tile representation of input data.

Parameters

tileTile

processMapcheteProcess

resamplingstring

rasterio resampling method

Attributes

tileTile

processMapcheteProcess

resamplingstring

rasterio resampling method

pixelbufferinteger

is_empty(indexes=None)

Check if there is data within this tile.

Returns

is emptybool

read(indexes=None, **kwargs)

Read reprojected & resampled input data.

Parameters

indexesinteger or list

band number or list of band numbers

Returns

dataarray

class mapchete.formats.default.gtiff.OutputDataReader(output_params, **kwargs)

Bases: object

Constructor class which returns GTiffTileDirectoryOutputReader.

Parameters

output_paramsdictionary

output parameters from Mapchete file

Attributes

pathstring

path to output directory

file_extensionstring

file extension for output files (.tif)

output_paramsdictionary

output parameters from Mapchete file

nodatainteger or float

nodata value used when writing GeoTIFFs

pixelbufferinteger

buffer around output tiles

pyramidtilematrix.TilePyramid

output TilePyramid

crsrasterio.crs.CRS

object describing the process coordinate reference system

sridstring

spatial reference ID of CRS (e.g. “{‘init’: ‘epsg:4326’}”)

class mapchete.formats.default.gtiff.OutputDataWriter(output_params, **kwargs)

Bases: object

Constructor class which either returns GTiffSingleFileOutputWriter or GTiffTileDirectoryOutputWriter.

Parameters

output_paramsdictionary

output parameters from Mapchete file

Attributes

pathstring

path to output directory

file_extensionstring

file extension for output files (.tif)

output_paramsdictionary

output parameters from Mapchete file

nodatainteger or float

nodata value used when writing GeoTIFFs

pixelbufferinteger

buffer around output tiles

pyramidtilematrix.TilePyramid

output TilePyramid

crsrasterio.crs.CRS

object describing the process coordinate reference system

sridstring

spatial reference ID of CRS (e.g. “{‘init’: ‘epsg:4326’}”)