reVX.setbacks.setbacks_cli.merge_setbacks
- merge_setbacks(node_out_path, node_pattern, are_partial_inclusions=None, purge_chunks=False)[source]
Combine many input setback GeoTIFFs into a single layer.
- Parameters:
node_out_path (str) – Path to output GeoTIFF file.
node_pattern (str) – Input GeoTIFF file pattern.
are_partial_inclusions (bool, optional) – Flag indicating wether the inputs are partial inclusion values or boolean exclusions. If
None
, will try to infer automatically from the input file’s GeoTIFF profile (dtype != uint8
). By default,None
.purge_chunks (bool, optional) – Flag indicating wether individual “chunk” files should be deleted after a successful merge (
True
), or if they should be stored in a “chunk_files” directory (False
). By default,False
.
- Raises:
FileNotFoundError – If no input files found on disk matching the input pattern.
RuntimeError – If the
are_partial_inclusions
cannot be inferred (GeoTIFF profile does not have “dtype” field).