Degree of Polarization (dopfp)#
- polsartools.dopfp(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)[source]
Calculate Barakat Degree of Polarization from full-pol SAR coherency/covariance matrix.
This function computes the Barakat Degree of Polarization (DoP) from full-polarimetric SAR data using either the coherency (T3) or covariance (C3) matrix. The Barakat DoP provides a generalized measure of the polarization state for partially polarized waves in full-pol SAR systems.
Examples
>>> # Basic usage with default parameters >>> dopfp("/path/to/fullpol_data")
>>> # Advanced usage with custom parameters >>> dopfp( ... infolder="/path/to/fullpol_data", ... window_size=5, ... outType="tif", ... cog_flag=True, ... block_size=(1024, 1024) ... )
- Parameters:
infolder (str) – Path to the input folder containing full-pol C3 or T3 matrix files.
window_size (int, default=1) – Size of the spatial averaging window. Larger windows improve DoP estimation accuracy 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: - ‘dop_fp.tif’ or ‘dop_fp.bin’: Barakat Degree of Polarization image
- Return type:
None
Further details on the Barakat Degree of polarization can be found in [[10]](#10)