Skip to content

r.futures.potsurface

Module for computing development potential surface from CSV file created by r.futures.potential and predictors

r.futures.potsurface input=name subregions=name output=name [separator=character] [--overwrite] [--verbose] [--quiet] [--qq] [--ui]

Example:

r.futures.potsurface input=name subregions=name output=name

grass.script.run_command("r.futures.potsurface", input, subregions, output, separator="comma", overwrite=False, verbose=False, quiet=False, superquiet=False)

Example:

gs.run_command("r.futures.potsurface", input="name", subregions="name", output="name")

Parameters

input=name [required]
    CSV file with coefficients
subregions=name [required]
    Raster map of subregions
output=name [required]
    Output probability raster
separator=character
    Separator used in input CSV file
    Special characters: pipe, comma, space, tab, newline
    Default: comma
--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
    CSV file with coefficients
    Used as: input, file, name
subregions : str, required
    Raster map of subregions
    Used as: input, raster, name
output : str, required
    Output probability raster
    Used as: output, raster, name
separator : str, optional
    Separator used in input CSV file
    Special characters: pipe, comma, space, tab, newline
    Used as: input, separator, character
    Default: comma
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

Module r.futures.potsurface is a support tool for computing development probability surface based on maps and coefficients selected by r.futures.potential. It computes the initial probability surface used in the patch growing algorithm in r.futures.pga. It is not necessary to use this module, however it is useful to inspect the potential surface to better understand the input data and how the predictors influence the probability. The values range from 0 (unlikely to be developed) to 1 (high probability of development).

The inputs are the output file from r.futures.potential and the name of the subregions raster map.

EXAMPLES

r.futures.potsurface input=potential.csv subregions=counties output=pot_surface

image-alt

Figure: We can visualize the potential surface in 3D and drape raster representing developed (red) and undeveloped (green) cells over it.

SEE ALSO

FUTURES, r.futures.pga, r.futures.potential, r.futures.devpressure, r.futures.demand, r.futures.calib, r.sample.category

REFERENCES

AUTHOR

Anna Petrasova, NCSU GeoForAll

SOURCE CODE

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