r.popgrowth
Set of population models (fisheries science)
r.popgrowth [-i] n_initial=string timesteps=integer [exponential_output=name] [r_exp_value=float] [r_exp_map=string] [ricker_output=name] [k_value=integer] [k_map=string] [r_rick_value=float] [r_rick_map=string] [population_patches=string] [seed=integer] [--overwrite] [--verbose] [--quiet] [--qq] [--ui]
Example:
r.popgrowth n_initial=string timesteps=1
grass.script.run_command("r.popgrowth", n_initial, timesteps=1, exponential_output=None, r_exp_value=None, r_exp_map=None, ricker_output=None, k_value=None, k_map=None, r_rick_value=None, r_rick_map=None, population_patches=None, seed=None, flags=None, overwrite=None, verbose=None, quiet=None, superquiet=None)
Example:
gs.run_command("r.popgrowth", n_initial="string", timesteps=1)
grass.tools.Tools.r_popgrowth(n_initial, timesteps=1, exponential_output=None, r_exp_value=None, r_exp_map=None, ricker_output=None, k_value=None, k_map=None, r_rick_value=None, r_rick_map=None, population_patches=None, seed=None, flags=None, overwrite=None, verbose=None, quiet=None, superquiet=None)
Example:
tools = Tools()
tools.r_popgrowth(n_initial="string", timesteps=1)
This grass.tools API is experimental in version 8.5 and expected to be stable in version 8.6.
Parameters
n_initial=string [required]
Map of number of individuals per cell at time t0 (initial population size)
timesteps=integer [required]
Number of time steps
Default: 1
exponential_output=name
Name for exponential model output map
r_exp_value=float
Cell-specific fixed value of intrinsic rate of increase, log(finite rate of increase, lambda)
r_exp_map=string
Map of cell-specific intrinsic rate of increase, log(finite rate of increase, lambda)
ricker_output=name
Name for Ricker model output map
k_value=integer
Fixed value of carrying capacity of the environment (per cell)
k_map=string
Map of carrying capacity of the environment (per cell)
r_rick_value=float
Cell-specific fixed value of intrinsic rate of increase (Ricker)
r_rick_map=string
Map of cell-specific intrinsic rate of increase (Ricker)
population_patches=string
Optional raster map of patches of single populations. If provided, growth models are calculated based on these patches (patch-averaged r and cumulated k).
seed=integer
fixed seed for random rounding
-i
Calculate models with rounded integer values
--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
n_initial : str, required
Map of number of individuals per cell at time t0 (initial population size)
Used as: input, raster
timesteps : int, required
Number of time steps
Default: 1
exponential_output : str, optional
Name for exponential model output map
Used as: output, raster, name
r_exp_value : float, optional
Cell-specific fixed value of intrinsic rate of increase, log(finite rate of increase, lambda)
r_exp_map : str, optional
Map of cell-specific intrinsic rate of increase, log(finite rate of increase, lambda)
Used as: input, raster
ricker_output : str, optional
Name for Ricker model output map
Used as: output, raster, name
k_value : int, optional
Fixed value of carrying capacity of the environment (per cell)
k_map : str, optional
Map of carrying capacity of the environment (per cell)
Used as: input, raster
r_rick_value : float, optional
Cell-specific fixed value of intrinsic rate of increase (Ricker)
r_rick_map : str, optional
Map of cell-specific intrinsic rate of increase (Ricker)
Used as: input, raster
population_patches : str, optional
Optional raster map of patches of single populations. If provided, growth models are calculated based on these patches (patch-averaged r and cumulated k).
Used as: input, raster
seed : int, optional
fixed seed for random rounding
flags : str, optional
Allowed values: i
i
Calculate models with rounded integer values
overwrite : bool, optional
Allow output files to overwrite existing files
Default: None
verbose : bool, optional
Verbose module output
Default: None
quiet : bool, optional
Quiet module output
Default: None
superquiet : bool, optional
Very quiet module output
Default: None
n_initial : str | np.ndarray, required
Map of number of individuals per cell at time t0 (initial population size)
Used as: input, raster
timesteps : int, required
Number of time steps
Default: 1
exponential_output : str | type(np.ndarray) | type(np.array) | type(gs.array.array), optional
Name for exponential model output map
Used as: output, raster, name
r_exp_value : float, optional
Cell-specific fixed value of intrinsic rate of increase, log(finite rate of increase, lambda)
r_exp_map : str | np.ndarray, optional
Map of cell-specific intrinsic rate of increase, log(finite rate of increase, lambda)
Used as: input, raster
ricker_output : str | type(np.ndarray) | type(np.array) | type(gs.array.array), optional
Name for Ricker model output map
Used as: output, raster, name
k_value : int, optional
Fixed value of carrying capacity of the environment (per cell)
k_map : str | np.ndarray, optional
Map of carrying capacity of the environment (per cell)
Used as: input, raster
r_rick_value : float, optional
Cell-specific fixed value of intrinsic rate of increase (Ricker)
r_rick_map : str, optional
Map of cell-specific intrinsic rate of increase (Ricker)
Used as: input, raster
population_patches : str | np.ndarray, optional
Optional raster map of patches of single populations. If provided, growth models are calculated based on these patches (patch-averaged r and cumulated k).
Used as: input, raster
seed : int, optional
fixed seed for random rounding
flags : str, optional
Allowed values: i
i
Calculate models with rounded integer values
overwrite : bool, optional
Allow output files to overwrite existing files
Default: None
verbose : bool, optional
Verbose module output
Default: None
quiet : bool, optional
Quiet module output
Default: None
superquiet : bool, optional
Very quiet module output
Default: None
Returns:
result : grass.tools.support.ToolResult | np.ndarray | tuple[np.ndarray] | None
If the tool produces text as standard output, a ToolResult object will be returned. Otherwise, None
will be returned. If an array type (e.g., np.ndarray) is used for one of the raster outputs, the result will be an array and will have the shape corresponding to the computational region. If an array type is used for more than one raster output, the result will be a tuple of arrays.
DESCRIPTION
r.popgrow calculates classical models of population growths. The module creates a new raster map of population size (abundance) after a specified number of time steps based on an intial populations size (input raster).
Available models for populations growth: Exponential growth and the Ricker model.
EXAMPLES
TBD.
SEE ALSO
AUTHOR
Johannes Radinger
Leibniz-Institute of Freshwater Ecology and Inland Fisheries (IGB)
Berlin, Germany
SOURCE CODE
Available at: r.popgrowth source code
(history)
Latest change: Thursday Feb 20 13:02:26 2025 in commit 53de819