Shannon entropy (shannon_h_dp) — PolSARtools 0.8 documentation

Skip to main content
`Ctrl`+`K`

# Shannon entropy (`shannon_h_dp`)

polsartools.shannon_h_dp(infolder, window_size=1, outType='tif', cog_flag=False, cog_overviews=[2, 4, 8, 16], write_flag=True, max_workers=None, block_size=(512, 512), progress_callback=None)

  Computes Shannon entropy parameter, total entropy, SE, intensity (SEI) and polarimetry (SEP) from the input dual-polarization (dual-pol) C2 matrix data, and writes the output in various formats (GeoTIFF or binary). The computation is performed in parallel for efficiency.

  ## Example:

      >>> shannon_h_dp("path_to_C2_folder", window_size=5, outType="tif", cog_flag=True)
      This will compute Shannon entropy parameters from the C2 matrix in the specified folder,
      generating output in Geotiff format with Cloud Optimized GeoTIFF settings enabled.

  ## Parameters:

  infolderstr

    Path to the input folder containing C2 matrix data.

  window_sizeint, optional

    Size of the processing window (default is 1).

  outTypestr, optional

    Output format of the files; can be “tif” (GeoTIFF) or “bin” (binary) (default is “tif”).

  cog_flagbool, optional

    If True, outputs Cloud Optimized GeoTIFF (COG) (default is False).

  cog_overviewslist of int, optional

    List of overview levels to be used for COGs (default is [2, 4, 8, 16]).

  write_flagbool, optional

    Whether to write the computed output files (default is True).

  max_workersint, optional

    Number of parallel workers for processing (default is None, which uses one less than the number of available CPU cores).

  block_sizetuple of int, optional

    Size of each processing block (default is (512, 512)), defining the spatial chunk dimensions used in parallel computation.

  ## Returns:

  None

    The function writes the computed entropy parameters to the specified output format.

  ## Output Files:

  - “H_Shannon.tif” or “H_Shannon.bin”

  - “HI_Shannon.tif” or “HI_Shannon.bin”

  - “HP_Shannon.tif” or “HP_Shannon.bin”