Full-pol H-alpha clusters (cluster_h_alpha_fp) — PolSARtools 0.10 documentation

Skip to main content
`Ctrl`+`K`

# Full-pol H-alpha clusters (`cluster_h_alpha_fp`)

polsartools.cluster_h_alpha_fp(hFile, alphaFile, 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)

  Perform H-alpha clustering on given H-alpha files for full-pol SAR data.

  Examples

      >>> # Basic usage with default parameters
      >>> cluster_h_alpha_fp("h_fp.tif", "alpha_fp.tif")

      >>> # Advanced usage with custom parameters
      >>> halpha_cluster_fp(
      ...     hFile="h_fp.tif",
      ...     alphaFile="alpha_fp.tif",
      ...     window_size=5,
      ...     outType="tif",
      ...     cog_flag=True,
      ...     block_size=(1024, 1024)
      ... )

  Parameters:

    - hFile (str) – Path to the input Entropy file, H (polarimetric entropy).

    - alphaFile (str) – Path to the input alpha file (average scattering angle).

    - window_size (int, default=1) – Size of the spatial averaging window. Larger windows reduce speckle noise but decrease spatial resolution.

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

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

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

    - write_flag (bool, default=True) – If True, writes results to disk. If False, only processes data in memory.

    - 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 one output file to disk: - ‘ha_cluster.tif’ or ‘ha_cluster.bin’ - ‘ha_cluster.png’

  Return type:

    None