SAGA-GIS Module Library Documentation (v2.3.0)

Module Export Image (bmp, jpg, pcx, png, tif)

The module allows one to save a grid as image.
Optionally, a shade grid can be overlayed and it's transparency and brightness can be adjusted.

Parameters

 NameTypeIdentifierDescriptionConstraints
InputGridGrid (input)GRID--
Shade (*)Grid (optional input)SHADE--
Lookup Table (*)Table (optional input)LUT--
OptionsGrid systemGrid systemPARAMETERS_GRID_SYSTEMGrid system-
Image FileFile pathFILE--
Create KML FileBooleanFILE_KML-Default: 1
ColouringChoiceCOLOURING-Available Choices:
[0] stretch to grid's standard deviation
[1] stretch to grid's value range
[2] stretch to specified value range
[3] lookup table
[4] rgb coded values
Default: 0
Color PaletteChoiceCOL_PALETTE-Available Choices:
[0] DEFAULT
[1] DEFAULT_BRIGHT
[2] BLACK_WHITE
[3] BLACK_RED
[4] BLACK_GREEN
[5] BLACK_BLUE
[6] WHITE_RED
[7] WHITE_GREEN
[8] WHITE_BLUE
[9] YELLOW_RED
[10] YELLOW_GREEN
[11] YELLOW_BLUE
[12] RED_GREEN
[13] RED_BLUE
[14] GREEN_BLUE
[15] RED_GREY_BLUE
[16] RED_GREY_GREEN
[17] GREEN_GREY_BLUE
[18] RED_GREEN_BLUE
[19] RED_BLUE_GREEN
[20] GREEN_RED_BLUE
[21] RAINBOW
[22] NEON
[23] TOPOGRAPHY
[24] ASPECT_1
[25] ASPECT_2
[26] ASPECT_3
Default: 0
Number of ColorsIntegerCOL_COUNT-Default: 100
Revert PaletteBooleanCOL_REVERT-Default: 0
Standard DeviationFloating pointSTDDEV-Minimum: 0.000000
Default: 2.000000
Stretch to Value RangeValue rangeSTRETCH--
Shade Transparency [%]Floating pointSHADE_TRANSThe transparency of the shade [%]Minimum: 0.000000
Maximum: 100.000000
Default: 40.000000
Shade Brightness [%]Value rangeSHADE_BRIGHTAllows one to scale shade brightness [%]-
(*) optional

Command-line

Usage: saga_cmd io_grid_image 0 [-GRID <str>] [-SHADE <str>] [-FILE <str>] [-FILE_KML <str>] [-COLOURING <str>] [-COL_PALETTE <str>] [-COL_COUNT <num>] [-COL_REVERT <str>] [-STDDEV <double>] [-STRETCH_MIN <double>] [-STRETCH_MAX <double>] [-LUT <str>] [-SHADE_TRANS <double>] [-SHADE_BRIGHT_MIN <double>] [-SHADE_BRIGHT_MAX <double>]
  -GRID:<str>               	Grid
	Grid (input)
  -SHADE:<str>              	Shade
	Grid (optional input)
  -FILE:<str>               	Image File
	File path
  -FILE_KML:<str>           	Create KML File
	Boolean
	Default: 1
  -COLOURING:<str>          	Colouring
	Choice
	Available Choices:
	[0] stretch to grid's standard deviation
	[1] stretch to grid's value range
	[2] stretch to specified value range
	[3] lookup table
	[4] rgb coded values
	Default: 0
  -COL_PALETTE:<str>        	Color Palette
	Choice
	Available Choices:
	[0] DEFAULT
	[1] DEFAULT_BRIGHT
	[2] BLACK_WHITE
	[3] BLACK_RED
	[4] BLACK_GREEN
	[5] BLACK_BLUE
	[6] WHITE_RED
	[7] WHITE_GREEN
	[8] WHITE_BLUE
	[9] YELLOW_RED
	[10] YELLOW_GREEN
	[11] YELLOW_BLUE
	[12] RED_GREEN
	[13] RED_BLUE
	[14] GREEN_BLUE
	[15] RED_GREY_BLUE
	[16] RED_GREY_GREEN
	[17] GREEN_GREY_BLUE
	[18] RED_GREEN_BLUE
	[19] RED_BLUE_GREEN
	[20] GREEN_RED_BLUE
	[21] RAINBOW
	[22] NEON
	[23] TOPOGRAPHY
	[24] ASPECT_1
	[25] ASPECT_2
	[26] ASPECT_3
	Default: 0
  -COL_COUNT:<num>          	Number of Colors
	Integer
	Default: 100
  -COL_REVERT:<str>         	Revert Palette
	Boolean
	Default: 0
  -STDDEV:<double>          	Standard Deviation
	Floating point
	Minimum: 0.000000
	Default: 2.000000
  -STRETCH_MIN:<double>     	Stretch to Value Range
	Value range
  -STRETCH_MAX:<double>     	Stretch to Value Range
	Value range
  -LUT:<str>                	Lookup Table
	Table (optional input)
  -SHADE_TRANS:<double>     	Shade Transparency [%]
	Floating point
	Minimum: 0.000000
	Maximum: 100.000000
	Default: 40.000000
  -SHADE_BRIGHT_MIN:<double>	Shade Brightness [%]
	Value range
  -SHADE_BRIGHT_MAX:<double>	Shade Brightness [%]
	Value range