Skip to content

i.in.probav

Imports PROBA-V NDVI data in netCDF format into a raster map with real NDVI data range.

i.in.probav input=name output=name [scale=float] [shift=float] [memory=integer] [--overwrite] [--verbose] [--quiet] [--qq] [--ui]

Example:

i.in.probav input=name output=name

grass.script.run_command("i.in.probav", input, output, scale=0.004, shift=-0.08, memory=300, overwrite=None, verbose=None, quiet=None, superquiet=None)

Example:

gs.run_command("i.in.probav", input="name", output="name")

grass.tools.Tools.i_in_probav(input, output, scale=0.004, shift=-0.08, memory=300, overwrite=None, verbose=None, quiet=None, superquiet=None)

Example:

tools = Tools()
tools.i_in_probav(input="name", output="name")

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

Parameters

input=name [required]
    Name of input PROBA-V NDVI .nc file
output=name [required]
    Name for output raster map
scale=float
    Scale factor for input
    Default: 0.004
shift=float
    Shift factor for input
    Offset factor for input
    Default: -0.08
memory=integer
    Maximum memory to be used in MB
    Allowed values: 0-2047
    Default: 300
--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
    Name of input PROBA-V NDVI .nc file
    Used as: input, file, name
output : str, required
    Name for output raster map
    Used as: output, raster, name
scale : float, optional
    Scale factor for input
    Used as: float
    Default: 0.004
shift : float, optional
    Shift factor for input
    Offset factor for input
    Used as: float
    Default: -0.08
memory : float, optional
    Maximum memory to be used in MB
    Used as: integer
    Allowed values: 0-2047
    Default: 300
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

input : str | io.StringIO, required
    Name of input PROBA-V NDVI .nc file
    Used as: input, file, name
output : str | type(np.ndarray) | type(np.array) | type(gs.array.array), required
    Name for output raster map
    Used as: output, raster, name
scale : float, optional
    Scale factor for input
    Used as: float
    Default: 0.004
shift : float, optional
    Shift factor for input
    Offset factor for input
    Used as: float
    Default: -0.08
memory : float, optional
    Maximum memory to be used in MB
    Used as: integer
    Allowed values: 0-2047
    Default: 300
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

i.in.probav imports Proba-V NDVI data sets. After the import the digital numbers (DN) are remapped to VEGETATION NDVI values and the NDVI color table is applied. The imported DN map is removed after remapping. It is also possible to change the scale and offset factor (default is scale: 0.004, offset: -0.08 for Proba-V) and to improve the memory usage (default is 300 MB).

Important for the Proba-V Data sets, is a user registration at the VITO portal necessary (Register Button in the Upper Right Corner).

NOTES

The Proba-V files are delivered in NetCDF (Network Common Data Form) format. It is required to have the GDAL libraries installed with NetCDF support. Also to check the necessary scale and offset factor with gdalinfo.

Before Import

When working with Proba-V NDVI, it it necessary to fix the range of the map because it exceeds the -180°..+180° range with entire world extent. You can shift the map slightly into the right position using gdal_translate. This example in Global datasets may help you.

EXAMPLE

# import of 300m NDVI
i.in.probav input=c_gls_NDVI300_201611010000_GLOBE_PROBAV_V1.0.1.nc \
            output=c_gls_NDVI300_201611010000_GLOBE_PROBAV_V1.0.1 memory=500

SEE ALSO

i.in.spotvgt, r.in.gdal

REFERENCES

AUTHOR

Jonas Strobel

SOURCE CODE

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