Skip to content

r.pi.nlm.circ

Creates a random landscape with defined attributes.

r.pi.nlm.circ output=name size=x,y landcover=float count=integer [seed=integer] [title="phrase"] [--overwrite] [--verbose] [--quiet] [--qq] [--ui]

Example:

r.pi.nlm.circ output=name size=x,y landcover=float count=integer

grass.script.run_command("r.pi.nlm.circ", output, size, landcover, count, seed=None, title=None, overwrite=False, verbose=False, quiet=False, superquiet=False)

Example:

gs.run_command("r.pi.nlm.circ", output="name", size=x,y, landcover=float, count=integer)

Parameters

output=name [required]
    Name for output raster map
size=x,y [required]
    Size of the map
landcover=float [required]
    Landcover in percent
count=integer [required]
    Number of the patches to create
seed=integer
    Seed for random number generator
title="phrase"
    Title for resultant raster map
--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
size : tuple[int, int] | list[int] | str, required
    Size of the map
    Used as: x,y
landcover : float, required
    Landcover in percent
count : int, required
    Number of the patches to create
seed : int, optional
    Seed for random number generator
title : str, optional
    Title for resultant raster map
    Used as: "phrase"
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.pi.nlm.circ is a random patch generator. It creates a random landscape with defined attributes.

NOTES

The user must specify the names of the raster map layers to be used for input and output, the landcover, the size, the count used, the keyval of the class of interest of the input raster map.

  • Input
    The Input is potentially used for Landcover, size and count.
  • keyval
    The keyval is used to compute landcover and count if not declared.
  • landcover
    The landcover defines the amount of cover, if not declared, the landcover of keyval of input is used.
  • count
    The count defines the amount of patches in the landscape, if not defined, the amount of patches in the input is used, if 0 is inserted, random amount of patches are created. Values from 1-n can be defined for a fixed number of patches.
  • size
    The size defines the size of the artificial landscape. If not declared the size of the actual region is taken.
  • seed
    The seed defiens the seed of random points. If all settings and the seed is fixed, then the patches won't be random anymore, but fixed. The user will receive everytime the same landscape.
  • xxx
    The xxx ....
  • xxx
    The xxx ....

EXAMPLE

An example for the North Carolina sample dataset:

g.region -d
...

SEE ALSO

r.pi.nlm, r.pi.nlm.stats, r.pi

AUTHORS

Programming: Elshad Shirinov
Scientific concept: Dr. Martin Wegmann
Department of Remote Sensing
Remote Sensing and Biodiversity Unit
University of Wuerzburg, Germany

Port to GRASS GIS 7: Markus Metz

SOURCE CODE

Available at: r.pi.nlm.circ source code (history)
Latest change: Friday Feb 21 10:10:05 2025 in commit 7d78fe3