mapchete.formats package

Subpackages

Submodules

Module contents

mapchete.formats.available_input_formats() → Dict

Return all available input formats.

Returns
formatslist

all available input formats

mapchete.formats.available_output_formats() → Dict

Return all available output formats.

Returns
formatslist

all available output formats

mapchete.formats.compare_metadata_params(params1: Dict, params2: Dict) → None

Verify that both mappings of output metadata parameters are compatible.

Parameters
params1dict

Output metadata parameters.

params2dict

Output metadata parameters.

mapchete.formats.data_type_from_extension(file_extension: str) → str

Guess data_type (raster or vector) from file extension.

Returns
driver data typestring

driver data type

mapchete.formats.driver_from_extension(file_extension: str) → str

Guess driver name from file extension.

Returns
driverstring

driver name

mapchete.formats.driver_from_file(input_file: str, quick: bool = True) → str

Guess driver from file by opening it.

Parameters
input_filestr

Path to file.

quickbool

Try to guess driver from known file extensions instead of trying to open with fiona and rasterio. (default: True)

Returns
driverstring

driver name

mapchete.formats.driver_metadata(driver_name: str) → Dict

Return driver metadata.

Parameters
driver_namestr

Name of driver.

Returns
Driver metadata as dictionary.
mapchete.formats.dump_metadata(params: Dict, parse_datetime=True) → Dict

Transform params to JSON-serializable dictionary for a metadata.json file.

This also converts the BufferedTilePyramid to a dictionary and any datetime objects into strings.

Parameters
paramsdict

Mapping of process parameters

Returns
Dictionary of output parameters ready to be written as metadata.json.
mapchete.formats.load_input_reader(input_params: Dict, readonly: bool = False, input_key: Optional[str] = None) → InputData

Return input class of driver.

Parameters
input_paramsdict

Input parameters as given in mapchete configuration.

readonlybool

Initialize as readonly. (default: False)

input_keystr

Pass on unique input key assigned by mapchete.

Returns
input_paramsInputData

input parameters

mapchete.formats.load_metadata(params: Dict, parse_known_types=True) → Dict

Parse output metadata dictionary.

This function raises DeprecationWarning instances if needed and initializes the BufferedTilePyramid as well as datetime objects.

Parameters
paramsdict

Output metadata parameters.

Returns
out_paramsdict

Output metadata parameters with initialized BufferedTilePyramid.

mapchete.formats.load_output_reader(output_params: Dict) → OutputDataReader

Return OutputReader class of driver.

Parameters
output_paramsdict

Output parameters as given in mapchete configuration.

Returns
outputOutputDataReader

output reader object

mapchete.formats.load_output_writer(output_params: Dict, readonly: bool = False) → OutputDataWriter

Return output class of driver.

Parameters
output_paramsdict

Output parameters as given in mapchete configuration.

readonlybool

Initialize as readonly. (default: False)

Returns
outputOutputDataWriter

output writer object

mapchete.formats.read_output_metadata(metadata_json: str, **kwargs: str) → Dict

Read and parse metadata.json.

Parameters
metadata_jsonstr

Path to metadata.json file.

Returns
Parsed output metadata.
mapchete.formats.write_output_metadata(output_params: Dict) → None

Write output JSON and verify parameters if output metadata exist.

Parameters
output_paramsdict

Output parameters