r.green.biomassfor.recommended
Estimates potential bioenergy according to environmental restriction
r.green.biomassfor.recommended hfmap=name cmap=name output_basename=name management=name treatment=name [restrictions=name [,name,...]] [hydro=name] [buffer_hydro=integer] [zone_less=name] [energy_tops_hf=float] [energy_cormometric_vol_hf=float] [energy_tops_cop=float] [--overwrite] [--verbose] [--quiet] [--qq] [--ui]
Example:
r.green.biomassfor.recommended hfmap=name cmap=name output_basename=name management=name treatment=name
grass.script.run_command("r.green.biomassfor.recommended", hfmap, cmap, output_basename, management, treatment, restrictions=None, hydro=None, buffer_hydro=0, zone_less=None, energy_tops_hf=0.49, energy_cormometric_vol_hf=1.97, energy_tops_cop=0.55, overwrite=None, verbose=None, quiet=None, superquiet=None)
Example:
gs.run_command("r.green.biomassfor.recommended", hfmap="name", cmap="name", output_basename="name", management="name", treatment="name")
grass.tools.Tools.r_green_biomassfor_recommended(hfmap, cmap, output_basename, management, treatment, restrictions=None, hydro=None, buffer_hydro=0, zone_less=None, energy_tops_hf=0.49, energy_cormometric_vol_hf=1.97, energy_tops_cop=0.55, overwrite=None, verbose=None, quiet=None, superquiet=None)
Example:
tools = Tools()
tools.r_green_biomassfor_recommended(hfmap="name", cmap="name", output_basename="name", management="name", treatment="name")
This grass.tools API is experimental in version 8.5 and expected to be stable in version 8.6.
Parameters
hfmap=name [required]
Bioenergy potential map for High Forest in MWh/m3
cmap=name [required]
Bioenergy potential map for Coppice in MWh/m3
output_basename=name [required]
Basename for final recommended maps of bioenergy (HF,CC and total)
management=name [required]
Map of forest management (1: high forest, 2:coppice)
treatment=name [required]
Map of forest treatment (1: final felling, 2:thinning)
restrictions=name [,name,...]
Area with absolute restrictions (protected areas, urban parks etc.)
hydro=name
Rivers network
buffer_hydro=integer
Buffer area for rivers
Default: 0
zone_less=name
Civic use
energy_tops_hf=float
Energy for tops and branches in high forest in MWh/m3
Default: 0.49
energy_cormometric_vol_hf=float
Energy for tops and branches for high forest in MWh/m3
Default: 1.97
energy_tops_cop=float
Energy for tops and branches for Coppices in MWh/m3
Default: 0.55
--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
hfmap : str, required
Bioenergy potential map for High Forest in MWh/m3
Used as: input, raster, name
cmap : str, required
Bioenergy potential map for Coppice in MWh/m3
Used as: input, raster, name
output_basename : str, required
Basename for final recommended maps of bioenergy (HF,CC and total)
Used as: output, , name
management : str, required
Map of forest management (1: high forest, 2:coppice)
Used as: input, raster, name
treatment : str, required
Map of forest treatment (1: final felling, 2:thinning)
Used as: input, raster, name
restrictions : str | list[str], optional
Area with absolute restrictions (protected areas, urban parks etc.)
Used as: input, raster, name
hydro : str, optional
Rivers network
Used as: input, raster, name
buffer_hydro : int, optional
Buffer area for rivers
Default: 0
zone_less : str, optional
Civic use
Used as: input, raster, name
energy_tops_hf : float, optional
Energy for tops and branches in high forest in MWh/m3
Default: 0.49
energy_cormometric_vol_hf : float, optional
Energy for tops and branches for high forest in MWh/m3
Default: 1.97
energy_tops_cop : float, optional
Energy for tops and branches for Coppices in MWh/m3
Default: 0.55
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
hfmap : str | np.ndarray, required
Bioenergy potential map for High Forest in MWh/m3
Used as: input, raster, name
cmap : str | np.ndarray, required
Bioenergy potential map for Coppice in MWh/m3
Used as: input, raster, name
output_basename : str, required
Basename for final recommended maps of bioenergy (HF,CC and total)
Used as: output, , name
management : str | np.ndarray, required
Map of forest management (1: high forest, 2:coppice)
Used as: input, raster, name
treatment : str | np.ndarray, required
Map of forest treatment (1: final felling, 2:thinning)
Used as: input, raster, name
restrictions : str | list[str], optional
Area with absolute restrictions (protected areas, urban parks etc.)
Used as: input, raster, name
hydro : str | np.ndarray, optional
Rivers network
Used as: input, raster, name
buffer_hydro : int, optional
Buffer area for rivers
Default: 0
zone_less : str | np.ndarray, optional
Civic use
Used as: input, raster, name
energy_tops_hf : float, optional
Energy for tops and branches in high forest in MWh/m3
Default: 0.49
energy_cormometric_vol_hf : float, optional
Energy for tops and branches for high forest in MWh/m3
Default: 1.97
energy_tops_cop : float, optional
Energy for tops and branches for Coppices in MWh/m3
Default: 0.55
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 | None
If the tool produces text as standard output, a ToolResult object will be returned. Otherwise, None
will be returned.
DESCRIPTION
Compute the biomass forestry residual potential considering extra constraints.
NOTES
EXAMPLE
REFERENCE
SEE ALSO
AUTHORS
Francesco Geri, Pietro Zambelli, Sandro Sacchelli, Marco Ciolli
SOURCE CODE
Available at: r.green.biomassfor.recommended source code
(history)
Latest change: Thursday Feb 20 13:02:26 2025 in commit 53de819