r.pi.rectangle

Generates a rectangle based on a corner coordinate.

r.pi.rectangle input=name output=name keyval=integer x=integer y=integer alignment=string [title="phrase"] [--overwrite] [--verbose] [--quiet] [--qq] [--ui]

Example:

r.pi.rectangle input=name output=name keyval=integer x=integer y=integer alignment=string

grass.script.run_command("r.pi.rectangle", input, output, keyval, x, y, alignment, title=None, overwrite=False, verbose=False, quiet=False, superquiet=False)

Example:

gs.run_command("r.pi.rectangle", input="name", output="name", keyval=integer, x=integer, y=integer, alignment="string")

Parameters

Command linePython (grass.script)

input=name [required]
    Raster map with single pixels representing sampling points
output=name [required]
    Name for output raster map
keyval=integer [required]
    Pixel value in the input raster to be used
x=integer [required]
    Extent of generated area on the x axis (width) in pixel
y=integer [required]
    Extent of generated area on the y axis (height) in pixel
alignment=string [required]
    Alignment of the rectangle relative to the input pixel. options: center, top-left, top-right, bottom
    Allowed values: center, top-left, top-right, bottom-left, bottom-right
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

input : str, required
    Raster map with single pixels representing sampling points
    Used as: input, raster, name
output : str, required
    Name for output raster map
    Used as: output, raster, name
keyval : int, required
    Pixel value in the input raster to be used
x : int, required
    Extent of generated area on the x axis (width) in pixel
y : int, required
    Extent of generated area on the y axis (height) in pixel
alignment : str, required
    Alignment of the rectangle relative to the input pixel. options: center, top-left, top-right, bottom
    Allowed values: center, top-left, top-right, bottom-left, bottom-right
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.rectangle converts sampling points (e.g. GPS coordinates) of the corner of a sampling site into an area by generating a defined rectangle. Generates a rectangle based on a corner coordinate.

This modules aims at generating sampling areas which are only known by the coordinate of one corner. The input are single points, while the output are areas representing the corresponding area for each of the single points/coordinates.

NOTES

The areas can only be generated horizontally, not diagonal. This can be added as wish and might be implemented in the future.

EXAMPLE

An example for the North Carolina sample dataset:

g.region -d
...

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.rectangle source code (history)
Latest change: Thursday Feb 20 13:02:26 2025 in commit 53de819