Touzi decomposition (tsvm) — PolSARtools 0.9 documentation

Skip to main content
`Ctrl`+`K`

# Touzi decomposition (`tsvm`)

polsartools.tsvm(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)

  Perform Touzi Decomposition for full-pol SAR data.

  Examples

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

      >>> # Advanced usage with custom parameters
      >>> tsvm(
      ...     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.

    - win (int, default=1) – Size of the spatial averaging window. Larger windows reduce speckle noise 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 the follwing files to disk:

    1. TSVM_alpha1

    2. TSVM_alpha2

    3. TSVM_alpha3

    4. TSVM_phi1

    5. TSVM_phi2

    6. TSVM_phi3

    7. TSVM_tau1

    8. TSVM_tau2

    9. TSVM_tau3

    10. TSVM_psi1

    11. TSVM_psi2

    12. TSVM_psi3

    13. TSVM_alphas

    14. TSVM_phis

    15. TSVM_taus

    16. TSVM_psis

  Return type:

    None