Radar Vegetation Index (rvi_dp)#
- polsartools.rvi_dp(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]
Computes Radar vegetation index 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:#
>>> rvi_dp("path_to_C2_folder", win=5, fmt="tif", cog=True) This will compute Radar vegetation index from the C2 matrix in the specified folder, generating output in Geotiff format with Cloud Optimized GeoTIFF settings enabled.
Parameters:#
- in_dirstr
Path to the input folder containing C2 matrix data.
- winint, optional
Size of the processing window (default is 1).
- fmtstr, optional
Output format of the files; can be “tif” (GeoTIFF) or “bin” (binary) (default is “tif”).
- cogbool, optional
If True, outputs Cloud Optimized GeoTIFF (COG) (default is False).
- ovrlist of int, optional
List of overview levels to be used for COGs (default is [2, 4, 8, 16]).
- compbool, optional
If True, applies LZW compression to the output GeoTIFF files. (default is False).
- 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 Radar vegetation index to the specified output format.
Output Files:#
“rvidp.tif” or “rvidp.bin”
The formulation of RVI is as follows:
where, \(\sigma^\circ_{\text{XX}}\) is co-pol backscatter intensity and \(\sigma^\circ_{\text{XY}}\) is corss-pol backscatter intensity