Skip to content

v.in.region

Creates a vector polygon from the current region extent.

v.in.region [-d] output=name [type=string] [cat=integer] [--overwrite] [--verbose] [--quiet] [--qq] [--ui]

Example:

v.in.region output=name

grass.script.run_command("v.in.region", output, type="area", cat=1, flags=None, overwrite=None, verbose=None, quiet=None, superquiet=None)

Example:

gs.run_command("v.in.region", output="name")

grass.tools.Tools.v_in_region(output, type="area", cat=1, flags=None, overwrite=None, verbose=None, quiet=None, superquiet=None)

Example:

tools = Tools()
tools.v_in_region(output="name")

This grass.tools API is experimental in version 8.5 and expected to be stable in version 8.6.

Parameters

output=name [required]
    Name for output vector map
type=string
    Select type: line or area
    Allowed values: line, area
    Default: area
cat=integer
    Category value
    Default: 1
-d
    Densify lines using region resolution
--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 vector map
    Used as: output, vector, name
type : str, optional
    Select type: line or area
    Allowed values: line, area
    Default: area
cat : int, optional
    Category value
    Used as: input, cats
    Default: 1
flags : str, optional
    Allowed values: d
    d
        Densify lines using region resolution
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

output : str, required
    Name for output vector map
    Used as: output, vector, name
type : str, optional
    Select type: line or area
    Allowed values: line, area
    Default: area
cat : int, optional
    Category value
    Used as: input, cats
    Default: 1
flags : str, optional
    Allowed values: d
    d
        Densify lines using region resolution
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

DESCRIPTION

v.in.region creates a new vector map from current region extent.

If the output of v.in.region is to be used for raster reprojection, the -d flag should be used after setting the region to the raster map to be reprojected with r.proj.

EXAMPLE

The example is based on the North Carolina sample data. To create a bounding box vector map based on a raster map, the computational region is first set to the raster map. Then a vector bounding box is created based on the actual computational region (in this case precisely reflecting the pixel geometry of the raster map), resulting in a new vector polygon:

g.region raster=soils_Kfactor -p
v.in.region output=soils_Kfactor_bbox
v.info map=soils_Kfactor_bbox

SEE ALSO

g.region, r.proj, v.info

AUTHOR

Radim Blazek

SOURCE CODE

Available at: v.in.region source code (history)
Latest change: Friday Feb 07 19:16:09 2025 in commit a82a39f