Skip to content

r.plane

Creates raster plane map given dip (inclination), aspect (azimuth) and one point.

r.plane output=name dip=float azimuth=float easting=float northing=float elevation=float [type=string] [--overwrite] [--verbose] [--quiet] [--qq] [--ui]

Example:

r.plane output=name dip=0.0 azimuth=0.0 easting=float northing=float elevation=float

grass.script.run_command("r.plane", output, dip=0.0, azimuth=0.0, easting, northing, elevation, type="FCELL", overwrite=False, verbose=False, quiet=False, superquiet=False)

Example:

gs.run_command("r.plane", output="name", dip=0.0, azimuth=0.0, easting=float, northing=float, elevation=float)

Parameters

output=name [required]
    Name for output raster map
dip=float [required]
    Dip of plane in degrees
    Default: 0.0
azimuth=float [required]
    Azimuth of the plane in degrees
    Default: 0.0
easting=float [required]
    Easting coordinate of a point on the plane
northing=float [required]
    Northing coordinate of a point on the plane
elevation=float [required]
    Elevation coordinate of a point on the plane
type=string
    Type of raster map to be created
    Storage type for resultant raster map
    Allowed values: CELL, FCELL, DCELL
    Default: FCELL
    CELL: Integer
    FCELL: Single precision floating point
    DCELL: Double precision floating point
--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
dip : float, required
    Dip of plane in degrees
    Used as:
    Default: 0.0
azimuth : float, required
    Azimuth of the plane in degrees
    Used as:
    Default: 0.0
easting : float, required
    Easting coordinate of a point on the plane
northing : float, required
    Northing coordinate of a point on the plane
elevation : float, required
    Elevation coordinate of a point on the plane
type : str, optional
    Type of raster map to be created
    Storage type for resultant raster map
    Allowed values: CELL, FCELL, DCELL
    CELL: Integer
    FCELL: Single precision floating point
    DCELL: Double precision floating point
    Default: FCELL
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.plane creates a tilted plane raster map given user-specified parameters for inclination, azimuth, and the geographic location of a point on the plane.
The angle orientations of the azimuth parameter increase counter-clockwise, i.e., 0 degree = N, 45 degree = NW, 90 degree = W etc.

Increasing values of the dip parameter progressively lower (or dip) the northern half of the plane, and incline the southern half, assuming the azimuth parameter is held constant at 0 degrees.

NOTES

g.region -c provides the easting and northing coordinates for the center of the current region.

CELL (integer) maps take less disk space than FCELLs (floating point), which in turn take up less space than DCELLs (double precision floating point).

EXAMPLE

A tilted plane in the North Carolina sample dataset region:

# set computational region
g.region raster=elev_lid792_1m -p

# get center coordinates as an example
g.region -c
# get terrain height at point
r.what map=elev_lid792_1m coordinates=638650.0,220375.0
# shows elevation: 116.7734

# generate tilted plane
r.plane myplane30 dip=30 az=75 east=638650.0 north=220375.0 \
        elev=116.7734 type=FCELL

r.plane example
Figure: Tilted plane shown in NVIZ along with elevation map

AUTHORS

Stefan Jäger (1994), University of Heidelberg during a stay at USGS
Updated to GRASS 5.7 by Michael Barton, Arizona State University
Full rewrite for GRASS 7 by Glynn Clements

SOURCE CODE

Available at: r.plane source code (history)
Latest change: Wednesday Feb 12 23:02:46 2025 in commit 9c11460