Dual-pol Radar Vegetation Index for GRD (dprvic)#

polsartools.dprvic(cpFile, xpFile, 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)[source]

Compute dual-pol Radar Vegetation Index (DpRVIc) from Dual-pol GRD data.

This function calculates the DpRVIc using co-polarized (cpFile) and cross-polarized (xpFile) SAR raster files. The index is valuable for vegetation monitoring and biomass estimation. Processing is performed in parallel blocks for efficiency.

Examples

>>> # Basic usage with default parameters
>>> dprvic("/path/to/copol_file.tif", "/path/to/crosspol_file.tif")

>>> # Advanced usage with custom parameters
>>> dprvic(
...     cpFile="/path/to/copol_file.tif",
...     xpFile="/path/to/crosspol_file.tif",
...     window_size=3,
...     outType="tif",
...     cog_flag=True,
...     block_size=(1024, 1024)
... )
Parameters:

  • cpFile (str) – Path to the co-polarized backscatter (linear) SAR raster file.

  • xpFile (str) – Path to the cross-polarized backscatter (linear) SAR raster file.

  • 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:

Results are written to disk as either ‘dprvic.tif’ or ‘dprvic.bin’ in the input folder.

Return type:

None

This Page