Skip to content

i.wavelet

Decompostion/Recomposition in temporal dimension using wavelets

i.wavelet [-iHD] [input_group_to_decompose=name] [output_lp1_from_decomposition=name] [output_lp2_from_decomposition=name] [output_hp1_from_decomposition=name] [output_hp2_from_decomposition=name] [input_lp2_group_for_recomposition=name] [input_hp1_group_for_recomposition=name] [input_hp2_group_for_recomposition=name] [output_from_recomposition=name] [wavelet_sample_rate=integer] [--overwrite] [--verbose] [--quiet] [--qq] [--ui]

Example:

i.wavelet

grass.script.run_command("i.wavelet", input_group_to_decompose=None, output_lp1_from_decomposition=None, output_lp2_from_decomposition=None, output_hp1_from_decomposition=None, output_hp2_from_decomposition=None, input_lp2_group_for_recomposition=None, input_hp1_group_for_recomposition=None, input_hp2_group_for_recomposition=None, output_from_recomposition=None, wavelet_sample_rate=None, flags=None, overwrite=None, verbose=None, quiet=None, superquiet=None)

Example:

gs.run_command("i.wavelet")

grass.tools.Tools.i_wavelet(input_group_to_decompose=None, output_lp1_from_decomposition=None, output_lp2_from_decomposition=None, output_hp1_from_decomposition=None, output_hp2_from_decomposition=None, input_lp2_group_for_recomposition=None, input_hp1_group_for_recomposition=None, input_hp2_group_for_recomposition=None, output_from_recomposition=None, wavelet_sample_rate=None, flags=None, overwrite=None, verbose=None, quiet=None, superquiet=None)

Example:

tools = Tools()
tools.i_wavelet()

This grass.tools API is experimental in version 8.5 and expected to be stable in version 8.6.

Parameters

input_group_to_decompose=name
    Name of input imagery group
output_lp1_from_decomposition=name
    Name for output raster map
output_lp2_from_decomposition=name
    Name for output raster map
output_hp1_from_decomposition=name
    Name for output raster map
output_hp2_from_decomposition=name
    Name for output raster map
input_lp2_group_for_recomposition=name
    Name of input imagery group
input_hp1_group_for_recomposition=name
    Name of input imagery group
input_hp2_group_for_recomposition=name
    Name of input imagery group
output_from_recomposition=name
    Name of input raster map
wavelet_sample_rate=integer
    4,6,8,10,12,14,16,18,20
-i
    Recomposition (Default: Decomposition)
-H
    Use Haar wavelets
-D
    Use Daubechies wavelets (specify resolution=4,6,8,10,12,14,16,18,20
--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_group_to_decompose : str, optional
    Name of input imagery group
    Used as: input, group, name
output_lp1_from_decomposition : str, optional
    Name for output raster map
    Used as: output, raster, name
output_lp2_from_decomposition : str, optional
    Name for output raster map
    Used as: output, raster, name
output_hp1_from_decomposition : str, optional
    Name for output raster map
    Used as: output, raster, name
output_hp2_from_decomposition : str, optional
    Name for output raster map
    Used as: output, raster, name
input_lp2_group_for_recomposition : str, optional
    Name of input imagery group
    Used as: input, group, name
input_hp1_group_for_recomposition : str, optional
    Name of input imagery group
    Used as: input, group, name
input_hp2_group_for_recomposition : str, optional
    Name of input imagery group
    Used as: input, group, name
output_from_recomposition : str, optional
    Name of input raster map
    Used as: input, raster, name
wavelet_sample_rate : int, optional
    4,6,8,10,12,14,16,18,20
    Used as: integer
flags : str, optional
    Allowed values: i, H, D
    i
        Recomposition (Default: Decomposition)
    H
        Use Haar wavelets
    D
        Use Daubechies wavelets (specify resolution=4,6,8,10,12,14,16,18,20
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_group_to_decompose : str, optional
    Name of input imagery group
    Used as: input, group, name
output_lp1_from_decomposition : str | type(np.ndarray) | type(np.array) | type(gs.array.array), optional
    Name for output raster map
    Used as: output, raster, name
output_lp2_from_decomposition : str | type(np.ndarray) | type(np.array) | type(gs.array.array), optional
    Name for output raster map
    Used as: output, raster, name
output_hp1_from_decomposition : str | type(np.ndarray) | type(np.array) | type(gs.array.array), optional
    Name for output raster map
    Used as: output, raster, name
output_hp2_from_decomposition : str | type(np.ndarray) | type(np.array) | type(gs.array.array), optional
    Name for output raster map
    Used as: output, raster, name
input_lp2_group_for_recomposition : str, optional
    Name of input imagery group
    Used as: input, group, name
input_hp1_group_for_recomposition : str, optional
    Name of input imagery group
    Used as: input, group, name
input_hp2_group_for_recomposition : str, optional
    Name of input imagery group
    Used as: input, group, name
output_from_recomposition : str | np.ndarray, optional
    Name of input raster map
    Used as: input, raster, name
wavelet_sample_rate : int, optional
    4,6,8,10,12,14,16,18,20
    Used as: integer
flags : str, optional
    Allowed values: i, H, D
    i
        Recomposition (Default: Decomposition)
    H
        Use Haar wavelets
    D
        Use Daubechies wavelets (specify resolution=4,6,8,10,12,14,16,18,20
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

i.wavelet Decomposes the time-series with the requested wavelet. The output will have 4 components, High-Pass Level 1 and 2, Low-Pass Level 1 and 2. Low Pass Level 1 can be recomposed using HP2 and LP2 using the recomposition mode.
This module is designed to make a temporal fusion from multi-sources.

NOTES

TODO

More wavelet families to be included.

SEE ALSO

r.hants, i.lmf

AUTHOR

Yann Chemin, International Water Management Institute

SOURCE CODE

Available at: i.wavelet source code (history)
Latest change: Thursday Feb 20 13:02:26 2025 in commit 53de819