SAGA-GIS Tool Library Documentation (v8.1.0)

Tool Mosaicking

The tool allows one to merge multiple grids into one single grid. This involves resampling if the input grids have different cell sizes or are not aligned to each other. Besides different resampling methods, the tool provides several options on how to handle overlapping areas. It is also possible to apply a histogram matching.

In order to be able to also merge a large amount of grids, which, for example, would exceed the maximum command line length, the tools has the option to provide a file list as input (instead of using the input grid list). This is a text file with the full path to an input grid on each line. Please note the limitiations: (i) the target grid system is set automatically in this case (the extent is calculated from all inputs and the cell size is set to the smallest one detected) and (ii) the input grids must still fit into memory, i.e. are all loaded at once.

Parameters

 NameTypeIdentifierDescriptionConstraints
InputGrids (*)Grid list, input, optionalGRIDS--
Target System (*)Grid, input, optional, CMDTARGET_TEMPLATEuse this grid's system for output grids-
OutputTarget GridGrid, outputTARGET_OUT_GRID--
OptionsInput File ListFile path, CMDFILE_LISTA text file with the full path to an input grid on each line-
NameTextNAME-Default: Mosaic
Data Storage TypeChoiceTYPE-Available Choices:
[0] 1 bit
[1] 1 byte unsigned integer
[2] 1 byte signed integer
[3] 2 byte unsigned integer
[4] 2 byte signed integer
[5] 4 byte unsigned integer
[6] 4 byte signed integer
[7] 4 byte floating point
[8] 8 byte floating point
[9] same as first grid in list
Default: 9
ResamplingChoiceRESAMPLING-Available Choices:
[0] Nearest Neighbour
[1] Bilinear Interpolation
[2] Bicubic Spline Interpolation
[3] B-Spline Interpolation
Default: 3
Overlapping AreasChoiceOVERLAP-Available Choices:
[0] first
[1] last
[2] minimum
[3] maximum
[4] mean
[5] blend boundary
[6] feathering
Default: 1
Blending DistanceFloating pointBLEND_DISTblending distance given in map unitsMinimum: 0.000000
Default: 10.000000
Blending BoundaryChoiceBLEND_BNDblending boundary for distance calculationAvailable Choices:
[0] valid data cells
[1] grid boundaries
[2] vertical grid boundaries
[3] horizontal grid boundaries
Default: 0
MatchChoiceMATCH-Available Choices:
[0] none
[1] match histogram of first grid in list
[2] match histogram of overlapping area
[3] regression
Default: 0
Target Grid SystemChoiceTARGET_DEFINITION-Available Choices:
[0] user defined
[1] grid or grid system
Default: 0
CellsizeFloating pointTARGET_USER_SIZE-Minimum: 0.000000
Default: 1.000000
WestFloating pointTARGET_USER_XMIN-Default: 0.000000
EastFloating pointTARGET_USER_XMAX-Default: 100.000000
SouthFloating pointTARGET_USER_YMIN-Default: 0.000000
NorthFloating pointTARGET_USER_YMAX-Default: 100.000000
ColumnsIntegerTARGET_USER_COLSNumber of cells in East-West direction.Minimum: 1
Default: 101
RowsIntegerTARGET_USER_ROWSNumber of cells in North-South direction.Minimum: 1
Default: 101
FitChoiceTARGET_USER_FITS-Available Choices:
[0] nodes
[1] cells
Default: 0
Grid SystemGrid systemTARGET_SYSTEM--
(*) optional

Command-line

Usage: saga_cmd grid_tools 3 [-GRIDS <str>] [-FILE_LIST <str>] [-NAME <str>] [-TYPE <str>] [-RESAMPLING <str>] [-OVERLAP <str>] [-BLEND_DIST <double>] [-BLEND_BND <str>] [-MATCH <str>] [-TARGET_DEFINITION <str>] [-TARGET_USER_SIZE <double>] [-TARGET_USER_XMIN <double>] [-TARGET_USER_XMAX <double>] [-TARGET_USER_YMIN <double>] [-TARGET_USER_YMAX <double>] [-TARGET_USER_COLS <num>] [-TARGET_USER_ROWS <num>] [-TARGET_USER_FITS <str>] [-TARGET_TEMPLATE <str>] [-TARGET_OUT_GRID <str>]
  -GRIDS:<str>              	Grids
	Grid list, input, optional
  -FILE_LIST:<str>          	Input File List
	File path, CMD
  -NAME:<str>               	Name
	Text
	Default: Mosaic
  -TYPE:<str>               	Data Storage Type
	Choice
	Available Choices:
	[0] 1 bit
	[1] 1 byte unsigned integer
	[2] 1 byte signed integer
	[3] 2 byte unsigned integer
	[4] 2 byte signed integer
	[5] 4 byte unsigned integer
	[6] 4 byte signed integer
	[7] 4 byte floating point
	[8] 8 byte floating point
	[9] same as first grid in list
	Default: 9
  -RESAMPLING:<str>         	Resampling
	Choice
	Available Choices:
	[0] Nearest Neighbour
	[1] Bilinear Interpolation
	[2] Bicubic Spline Interpolation
	[3] B-Spline Interpolation
	Default: 3
  -OVERLAP:<str>            	Overlapping Areas
	Choice
	Available Choices:
	[0] first
	[1] last
	[2] minimum
	[3] maximum
	[4] mean
	[5] blend boundary
	[6] feathering
	Default: 1
  -BLEND_DIST:<double>      	Blending Distance
	Floating point
	Minimum: 0.000000
	Default: 10.000000
  -BLEND_BND:<str>          	Blending Boundary
	Choice
	Available Choices:
	[0] valid data cells
	[1] grid boundaries
	[2] vertical grid boundaries
	[3] horizontal grid boundaries
	Default: 0
  -MATCH:<str>              	Match
	Choice
	Available Choices:
	[0] none
	[1] match histogram of first grid in list
	[2] match histogram of overlapping area
	[3] regression
	Default: 0
  -TARGET_DEFINITION:<str>  	Target Grid System
	Choice
	Available Choices:
	[0] user defined
	[1] grid or grid system
	Default: 0
  -TARGET_USER_SIZE:<double>	Cellsize
	Floating point
	Minimum: 0.000000
	Default: 1.000000
  -TARGET_USER_XMIN:<double>	West
	Floating point
	Default: 0.000000
  -TARGET_USER_XMAX:<double>	East
	Floating point
	Default: 100.000000
  -TARGET_USER_YMIN:<double>	South
	Floating point
	Default: 0.000000
  -TARGET_USER_YMAX:<double>	North
	Floating point
	Default: 100.000000
  -TARGET_USER_COLS:<num>   	Columns
	Integer
	Minimum: 1
	Default: 101
  -TARGET_USER_ROWS:<num>   	Rows
	Integer
	Minimum: 1
	Default: 101
  -TARGET_USER_FITS:<str>   	Fit
	Choice
	Available Choices:
	[0] nodes
	[1] cells
	Default: 0
  -TARGET_TEMPLATE:<str>    	Target System
	Grid, input, optional, CMD
  -TARGET_OUT_GRID:<str>    	Target Grid
	Grid, output