remotior_sensus.tools.band_stack module

Band stack.

This tool allows for stacking single bands in a multiband raster.

Typical usage example:

>>> # import Remotior Sensus and start the session
>>> import remotior_sensus
>>> rs = remotior_sensus.Session()
>>> # start the process
>>> stack = rs.band_stack(input_bands=['path_1', 'path_2'],
... output_path='output_path')
remotior_sensus.tools.band_stack.band_stack(input_bands: list | int | BandSet, output_path: None | str = None, overwrite: bool | None = False, extent_list: list | None = None, bandset_catalog: BandSetCatalog | None = None, n_processes: None | int = None, virtual_output: bool | None = None, progress_message: bool | None = True) → OutputManager

Stack single bands.

This tool allows for stacking single bands in a multiband raster.

Parameters:

  • input_bands – list of paths of input rasters, or number of BandSet, or BandSet object.

  • output_path – string of output path.

  • overwrite – if True, output overwrites existing files.

  • extent_list – list of boundary coordinates left top right bottom.

  • bandset_catalog – BandSetCatalog object required if input_bands is a BandSet number.

  • n_processes – number of parallel processes.

  • virtual_output – if True (and output_path is directory), save output as virtual raster.

  • progress_message – if True then start progress message, if False does not start the progress message (useful if launched from other tools).

Returns:

object OutputManager() with

  • path = output path

Examples

Perform band stack
>>> stack = band_stack(input_bands=['path_1', 'path_2'],
... output_path='output_path')