i.hyper.export

Export 3D hyperspectral 3D raster map (for now, only available compressed multi-band GeoTIFF)

Command linePython (grass.script)Python (grass.tools)

i.hyper.export input=name output=name [--overwrite] [--verbose] [--quiet] [--qq] [--ui]

Example:

i.hyper.export input=name output=name

grass.script.run_command("i.hyper.export", input, output, overwrite=None, verbose=None, quiet=None, superquiet=None)

Example:

gs.run_command("i.hyper.export", input="name", output="name")

grass.tools.Tools.i_hyper_export(input, output, overwrite=None, verbose=None, quiet=None, superquiet=None)

Example:

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

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

Parameters

Command linePython (grass.script)Python (grass.tools)

input=name [required]
    Input 3D raster map
output=name [required]
    Output file name
--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
    Input 3D raster map
    Used as: input, raster_3d, name
output : str, required
    Output file name
    Used as: output, file, name
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.

Raises:

grass.tools.ToolError: When the tool ended with an error.

DESCRIPTION

i.hyper.export exports a hyperspectral 3D raster map (raster_3d) from GRASS to an external file. At present, the module supports export to a compressed multi-band GeoTIFF only.

The export process converts the 3D raster map into 2D raster slices using r3.to.rast, creates a temporary imagery group, and writes all bands into a single multi-band GeoTIFF file with r.out.gdal. All temporary rasters and groups are automatically removed after export.

FUNCTIONALITY

Exports the complete hyperspectral 3D raster map as a single multi-band GeoTIFF.
Preserves the spectral band order and spatial alignment of the input map.
Uses DEFLATE compression with PREDICTOR=3 for efficient floating-point storage.
Handles null values as -9999.
Automatically sets the computational region to match the input 3D raster map.

NOTES

Currently, only multi-band GeoTIFF export is supported.
All intermediate rasters and imagery groups are temporary and removed automatically after export.
The exported GeoTIFF contains spectral data only; wavelength and other metadata remain inside GRASS.
The output file can be opened in software such as QGIS, ENVI, or Python libraries (rasterio, gdal).

OPTIONS

input -- Input 3D raster map (required).
output -- Output file name (required). Example: output=prisma_3d.tif.

EXAMPLES

::: code

# Example 1: Export PRISMA 3D raster map to compressed GeoTIFF
i.hyper.export input=prisma@PERMANENT \
               output=/data/prisma_3d.tif

:::

OUTPUT

The output is a multi-band GeoTIFF file containing one band per spectral layer of the 3D raster map. Compression (DEFLATE + PREDICTOR=3) ensures compact and precise floating-point storage. Large files are automatically written as BigTIFF when necessary.

AUTHORS

Alen Mangafić and Tomaž Žagar, Geodetic Institute of Slovenia

SOURCE CODE

Available at: i.hyper.export source code (history)
Latest change: Monday Nov 17 15:45:17 2025 in commit 615887d