Tiling.with_output
- Tiling.with_output(outputdir: str = '.', output_basename: str = '{}_tile{}', output_subdir: str | None = None)[source]
Set up the output.
- Parameters:
outputdir (str, optional, default=".") – Output dir where to store results.
output_basename (str, optional, default="{}_tile{}") – Basename for the output file as a formatted string. By default, the basename is the name of the original file followed by “_tile” followed by the tile index. In the formatted string, tile index is at position 1 and original filename is at position 0. For instance, tile{1}.tif will generate the following name tile75.tif for the tile id = 75
output_subdir (str, optional, default=None) – When each tile must be generated in a different subdir, output_subdir defines the naming convention for the subdir. It is a formatted string with one positional parameter corresponding to the tile index. For instance, tile{} will generate the following subdir name: tile75/ for the tile id = 75. If None, output files will be generated directly in the outputdir.
- Returns:
The current instance so that it is possible to chain the with… calls (fluent API)
- Return type: