Model Free 4-Component decomposition (mf4cf)#
- polsartools.mf4cf(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]
Perform Model-Free 4-Component Decomposition for full-pol SAR data.
This function implements an advanced model-free four-component decomposition for full-polarimetric SAR data. It decomposes the total scattered power into surface (Ps), double-bounce (Pd), volume (Pv), and helix (Pc) scattering components, along with scattering type (Theta_FP) and helicity (Tau_FP) parameters.
Examples
>>> # Basic usage with default parameters >>> mf4cf("/path/to/fullpol_data")
>>> # Advanced usage with custom parameters >>> mf4cf( ... 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 T3 or C3 matrix files.
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 Cloud Optimized GeoTIFF (COG) outputs 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 six output files to disk: 1. Ps_mf4cf: Surface scattering power component 2. Pd_mf4cf: Double-bounce scattering power component 3. Pv_mf4cf: Volume scattering power component 4. Pc_mf4cf: Helix scattering power component 5. Theta_FP_mf4cf: Scattering type parameter 6. Tau_FP_mf4cf: Helicity parameter
- Return type:
None