i.sar.speckle
Remove speckle from SAR image
i.sar.speckle input=name output=name method=string size=integer [--overwrite] [--verbose] [--quiet] [--qq] [--ui]
Example:
i.sar.speckle input=name output=name method=lee size=11
grass.script.run_command("i.sar.speckle", input, output, method="lee", size=11, overwrite=None, verbose=None, quiet=None, superquiet=None)
Example:
gs.run_command("i.sar.speckle", input="name", output="name", method="lee", size=11)
grass.tools.Tools.i_sar_speckle(input, output, method="lee", size=11, overwrite=None, verbose=None, quiet=None, superquiet=None)
Example:
tools = Tools()
tools.i_sar_speckle(input="name", output="name", method="lee", size=11)
This grass.tools API is experimental in version 8.5 and expected to be stable in version 8.6.
Parameters
input=name [required]
Name of input image
output=name [required]
Name of output image
method=string [required]
Method for speckle removal
Allowed values: lee
Default: lee
size=integer [required]
Size of neighborhood
Default: 11
--overwrite
Allow output files to overwrite existing files
--help
Print usage summary
--verbose
Verbose module output
--quiet
Quiet module output
--qq
Very quiet module output
--ui
Force launching GUI dialog
input : str, required
Name of input image
Used as: input, raster, name
output : str, required
Name of output image
Used as: output, raster, name
method : str, required
Method for speckle removal
Allowed values: lee
Default: lee
size : int, required
Size of neighborhood
Default: 11
overwrite : bool, optional
Allow output files to overwrite existing files
Default: None
verbose : bool, optional
Verbose module output
Default: None
quiet : bool, optional
Quiet module output
Default: None
superquiet : bool, optional
Very quiet module output
Default: None
input : str | np.ndarray, required
Name of input image
Used as: input, raster, name
output : str | type(np.ndarray) | type(np.array) | type(gs.array.array), required
Name of output image
Used as: output, raster, name
method : str, required
Method for speckle removal
Allowed values: lee
Default: lee
size : int, required
Size of neighborhood
Default: 11
overwrite : bool, optional
Allow output files to overwrite existing files
Default: None
verbose : bool, optional
Verbose module output
Default: None
quiet : bool, optional
Quiet module output
Default: None
superquiet : bool, optional
Very quiet module output
Default: None
Returns:
result : grass.tools.support.ToolResult | np.ndarray | tuple[np.ndarray] | None
If the tool produces text as standard output, a ToolResult object will be returned. Otherwise, None
will be returned. If an array type (e.g., np.ndarray) is used for one of the raster outputs, the result will be an array and will have the shape corresponding to the computational region. If an array type is used for more than one raster output, the result will be a tuple of arrays.
DESCRIPTION
A simple procedure to reduce speckle noise in SAR images.
So far, the only algorithm implemented is the Lee filter. So, the method parameter is set to lee by default.
The size parameter is the one used in r.neighbors and is used to calculate local mean and local square mean. It must be odd.
REFERENCES
Lee, J. S. (1986). Speckle suppression and analysis for synthetic aperture radar images. Optical engineering, 25(5), 255636.
SEE ALSO
AUTHOR
Margherita Di Leo
SOURCE CODE
Available at: i.sar.speckle source code
(history)
Latest change: Thursday Feb 20 13:02:26 2025 in commit 53de819