r.surf.gauss

Generates a raster map using gaussian random number generator.

Mean and standard deviation of gaussian deviates can be expressed by the user.

Command linePython (grass.script)

r.surf.gauss output=name [mean=float] [sigma=float] [seed=integer] [--overwrite] [--verbose] [--quiet] [--qq] [--ui]

Example:

r.surf.gauss output=name

grass.script.run_command("r.surf.gauss", output, mean=0.0, sigma=1.0, seed=None, overwrite=False, verbose=False, quiet=False, superquiet=False)

Example:

gs.run_command("r.surf.gauss", output="name")

Parameters

Command linePython (grass.script)

output=name [required]
    Name for output raster map
mean=float
    Distribution mean
    Default: 0.0
sigma=float
    Standard deviation
    Default: 1.0
seed=integer
    Seed value for the random number generator
    Using the same seed ensures identical results, while a randomly generated seed produces different outcomes in each run.
--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

output : str, required
    Name for output raster map
    Used as: output, raster, name
mean : float, optional
    Distribution mean
    Default: 0.0
sigma : float, optional
    Standard deviation
    Default: 1.0
seed : int, optional
    Seed value for the random number generator
    Using the same seed ensures identical results, while a randomly generated seed produces different outcomes in each run.
overwrite: bool, optional
    Allow output files to overwrite existing files
    Default: False
verbose: bool, optional
    Verbose module output
    Default: False
quiet: bool, optional
    Quiet module output
    Default: False
superquiet: bool, optional
    Very quiet module output
    Default: False

DESCRIPTION

r.surf.gauss produces a raster map of Gaussian deviates whose mean and standard deviation can be expressed by the user. It uses a Gaussian random number generator. It is essentially the same as r.surf.random, but uses a Gaussian random number generator instead.

EXAMPLE

g.region -p n=228500 s=215000 w=630000 e=645000 res=10
r.surf.gauss out=gauss mean=0 sigma=10

# check result
r.univar gauss

Figure: Random Gaussian surface example (mean: 0; sigma: 10)

With the histogram tool the cell values versus count can be shown.

Figure: Histogram of random Gaussian surface example (mean: 0; sigma: 10)

AUTHOR

Jo Wood, ASSIST's home

SOURCE CODE

Available at: r.surf.gauss source code (history)
Latest change: Thursday Mar 06 19:23:31 2025 in commit 5fd4234