Skip to content

r.resample

GRASS raster map layer data resampling capability.

r.resample input=string output=string [--overwrite] [--verbose] [--quiet] [--qq] [--ui]

Example:

r.resample input=string output=string

grass.script.run_command("r.resample", input, output, overwrite=None, verbose=None, quiet=None, superquiet=None)

Example:

gs.run_command("r.resample", input="string", output="string")

grass.tools.Tools.r_resample(input, output, overwrite=None, verbose=None, quiet=None, superquiet=None)

Example:

tools = Tools()
tools.r_resample(input="string", output="string")

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

Parameters

input=string [required]
    Name of an input layer
output=string [required]
    Name of an output layer
--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 an input layer
    Used as: input, raster
output : str, required
    Name of an output layer
    Used as: output, raster
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 an input layer
    Used as: input, raster
output : str | type(np.ndarray) | type(np.array) | type(gs.array.array), required
    Name of an output layer
    Used as: output, raster
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

r.resample resamples the data values in a user-specified raster input map layer name (bounded by the current geographic region and masked by the current mask), and produces a new raster output map layer name containing the results of the resampling. The category values in the new raster output map layer will be the same as those in the original, except that the resolution and extent of the new raster output map layer will match those of the current geographic region settings (see g.region). r.resample is intended for resampling of discrete raster data (such as land cover, geology or soil type) to a different resolution. Continuous data (such as elevation or temperature) usually require reinterpolation when changing resolution, see r.resamp.interp.

NOTES

The method by which resampling is conducted is "nearest neighbor" (see r.neighbors). The resulting raster map layer will have the same resolution as the resolution of the current geographic region (set using g.region).

The resulting raster map layer may be identical to the original raster map layer. The r.resample program will copy the color table and history file associated with the original raster map layer for the resulting raster map layer and will create a modified category file which contains description of only those categories which appear in resampled file.

When the user resamples a GRASS reclass file, a true raster map is created by r.resample.

SEE ALSO

g.region, r.mapcalc, r.mfilter, r.neighbors, r.rescale, r.resamp.interp

Overview: Interpolation and Resampling in GRASS

AUTHOR

Michael Shapiro, U.S.Army Construction Engineering Research Laboratory

SOURCE CODE

Available at: r.resample source code (history)
Latest change: Friday Aug 08 09:39:19 2025 in commit ed72c71