Shannon entropy (shannon_h_fp)#

polsartools.shannon_h_fp(in_dir, win=1, fmt='tif', cog=False, ovr=[2, 4, 8, 16], comp=False, max_workers=None, block_size=(512, 512), progress_callback=None)[source]

Calculate Shannon Entropy parameters from full-pol SAR data.

This function computes three Shannon Entropy-based parameters from full-polarimetric SAR data: total Shannon Entropy (H), intensity contribution (HI), and polarimetric contribution (HP). These parameters provide information about the complexity and disorder of the scattered wave field.

Examples

>>> # Basic usage with default parameters
>>> shannon_h_fp("/path/to/fullpol_data")

>>> # Advanced usage with custom parameters
>>> shannon_h_fp(
...     in_dir="/path/to/fullpol_data",
...     win=5,
...     fmt="tif",
...     cog=True,
...     block_size=(1024, 1024)
... )
Parameters:

  • in_dir (str) – Path to the input folder containing full-pol T3 or C3 matrix files.

  • window_size (int, default=1) – Size of the spatial averaging window. Larger windows provide better entropy estimation but decrease spatial resolution.

  • fmt ({'tif', 'bin'}, default='tif') – Output file format: - ‘tif’: GeoTIFF format with georeferencing information - ‘bin’: Raw binary format

  • cog (bool, default=False) – If True, creates Cloud Optimized GeoTIFF (COG) outputs with internal tiling and overviews for efficient web access.

  • ovr (list[int], default=[2, 4, 8, 16]) – Overview levels for COG creation. Each number represents the decimation factor for that overview level.

  • comp (bool, default=False) – If True, uses LZW compression for GeoTIFF outputs.

  • max_workers (int | None, default=None) – Maximum number of parallel processing workers. If None, uses CPU count - 1 workers.

  • block_size (tuple[int, int], default=(512, 512)) – Size of processing blocks (rows, cols) for parallel computation. Larger blocks use more memory but may be more efficient.

Returns:

Writes three output files to disk:

  1. H_Shannon: Total Shannon Entropy

  2. HI_Shannon: Intensity contribution

  3. HP_Shannon: Polarimetric contribution

Return type:

None

This Page