create_filtering

eolab.georastertools.cli.filtering.create_filtering(output: str, window_size: int, pad: str, argsdict: dict, filter: str, bands: list, kernel_size: int, all_bands: bool) Filtering[source]

This function initializes a Filtering tool instance and configures it with specified settings.

It selects the filter type, kernel size, output settings, and processing bands. If all_bands is set to True, the filter will apply to all bands in the raster; otherwise, it applies only to specified bands.

Parameters:
  • output (str) – The path for the filtered output file.

  • window_size (int) – Size of the processing window used by the filter.

  • pad (str) – Padding method used for windowing (default : ‘edge’).

  • argsdict (dict) – Dictionary of additional filter configuration arguments.

  • filter (str) – The filter type to apply (must be a valid name in Filtering filters).

  • bands (list) – List of bands to process. If empty and all_bands is False, defaults to [1].

  • kernel_size (int) – Size of the kernel used by the filter.

  • all_bands (bool) – Whether to apply the filter to all bands (True) or specific bands (False).

Returns:

A configured Filtering instance ready for execution.

Return type:

eolab.georastertools.Filtering