Export to Image File

Author(s)	O.Conrad (c) 2005
Library ID	io_grid_image
Tool ID	0
Version	1.0
Menu	File \| Grid \| Export

Description

The tool allows one to convert a grid to an image file, RGB coded grid or an RGB composite grid collection with various coloring options. Optionally, a shading can be overlaid using the specified transparency and brightness adjustment. If the input grid comes with geographic coordinates, an additional option to create a KML file (Google Earth) is available.

Parameters

	Name	Type	Identifier	Description	Constraints
Input	Grid	grid, input	`GRID`	-	-
Input	Shade	grid, input, optional	`SHADE`	-	-
Output	Grid	grid, output, optional	`GRID_OUT`	-	-
Output	Grid Collection	grid collection, output, optional	`GRIDS_OUT`	-	-
Options	Grid System	grid system	`PARAMETERS_GRID_SYSTEM`	-	-
	Image File	file path	`FILE`	-	-
	Create World File	boolean	`FILE_WORLD`	Store georeference along image to an additional file.	Default: 1
	Create KML File	boolean	`FILE_KML`	Expects that the input grid uses geographic coordinates.	Default: 0
	Coloring	choice	`COLOURING`	-	Available Choices: [0] adjust to standard deviation [1] adjust to percentiles [2] adjust to value range [3] lookup table [4] rgb coded values Default: 0
	Colors	colors	`COL_PALETTE`	-	-
	Number of Colors	integer number	`COL_COUNT`	Ignored if zero.	Minimum: 0 Default: 0
	Revert	boolean	`COL_REVERT`	-	Default: 0
	No-Data Transparency	boolean	`NO_DATA`	-	Default: 1
	No-Data Color	color	`NO_DATA_COL`	-	Default: 16777215
	Has Alpha Channel	boolean	`ALPHA`	-	Default: 0
	Color Depth	integer number	`COL_DEPTH`	Number of color entries used when storing GIF.	Minimum: 2 Maximum: 256 Default: 236
	Color Interpolation	choice	`GRADUATED`	-	Available Choices: [0] Discrete Colors [1] Graduated Colors Default: 1
	Standard Deviation	floating point number	`STDDEV`	-	Minimum: 0.000000 Default: 2.000000
	Percentiles	value range	`LINEAR`	-	-
	Value Range	value range	`STRETCH`	-	-
	Scaling	choice	`SCALE_MODE`	Scaling applied to coloring choices (i) RGB's standard deviation, (ii) RGB's value range, (iii) specified value range	Available Choices: [0] linear intervals [1] increasing geometrical intervals [2] decreasing geometrical intervals Default: 0
	Geometric Interval Factor	floating point number	`SCALE_LOG`	-	Minimum: 0.000000 Maximum: 16.000000 Default: 1.000000
	Lookup Table	static table	`LUT`	-	5 Fields: - 1. [color] Color - 2. [string] Name - 3. [string] Description - 4. [8 byte floating point number] Minimum - 5. [8 byte floating point number] Maximum
	Transparency	floating point number	`SHADE_TRANS`	The transparency of the shade [%]	Minimum: 0.000000 Maximum: 100.000000 Default: 75.000000
	Histogram Stretch	choice	`SHADE_COLOURING`	-	Available Choices: [0] Linear [1] Standard Deviation Default: 0
	Linear	value range	`SHADE_BRIGHT`	Minimum and maximum [%], the range for histogram stretch.	-
	Standard Deviation	floating point number	`SHADE_STDDEV`	-	Minimum: 0.000000 Default: 2.000000

Command Line


Usage: saga_cmd io_grid_image 0 [-GRID ] [-SHADE ] [-GRID_OUT ] [-GRIDS_OUT ] [-FILE ] [-FILE_WORLD ] [-FILE_KML ] [-COLOURING ] [-COL_PALETTE ] [-COL_COUNT ] [-COL_REVERT ] [-NO_DATA ] [-NO_DATA_COL ] [-ALPHA ] [-COL_DEPTH ] [-GRADUATED ] [-STDDEV ] [-LINEAR_MIN ] [-LINEAR_MAX ] [-STRETCH_MIN ] [-STRETCH_MAX ] [-SCALE_MODE ] [-SCALE_LOG ] [-LUT ] [-SHADE_TRANS ] [-SHADE_COLOURING ] [-SHADE_BRIGHT_MIN ] [-SHADE_BRIGHT_MAX ] [-SHADE_STDDEV ]
  -GRID:                  Grid
	grid, input
  -SHADE:                 Shade
	grid, input, optional
  -GRID_OUT:              Grid
	grid, output, optional
  -GRIDS_OUT:             Grid Collection
	grid collection, output, optional
  -FILE:                  Image File
	file path
  -FILE_WORLD:            Create World File
	boolean
	Default: 1
  -FILE_KML:              Create KML File
	boolean
	Default: 0
  -COLOURING:
                               Coloring
                               	choice
                               	Available Choices:
                               	[0] adjust to standard deviation
                               	[1] adjust to percentiles
                               	[2] adjust to value range
                               	[3] lookup table
                               	[4] rgb coded values
                               	Default: 0
  -COL_PALETTE:           Colors
	colors
  -COL_COUNT:             Number of Colors
	integer number
	Minimum: 0
	Default: 0
  -COL_REVERT:            Revert
	boolean
	Default: 0
  -NO_DATA:               No-Data Transparency
	boolean
	Default: 1
  -NO_DATA_COL:           No-Data Color
	color
	Default: 16777215
  -ALPHA:                 Has Alpha Channel
	boolean
	Default: 0
  -COL_DEPTH:             Color Depth
	integer number
	Minimum: 2
	Maximum: 256
	Default: 236
  -GRADUATED:             Color Interpolation
	choice
	Available Choices:
	[0] Discrete Colors
	[1] Graduated Colors
	Default: 1
  -STDDEV:             Standard Deviation
	floating point number
	Minimum: 0.000000
	Default: 2.000000
  -LINEAR_MIN:         Percentiles
	value range
  -LINEAR_MAX:         Percentiles
	value range
  -STRETCH_MIN:        Value Range
	value range
  -STRETCH_MAX:        Value Range
	value range
  -SCALE_MODE:
                               Scaling
                               	choice
                               	Available Choices:
                               	[0] linear intervals
                               	[1] increasing geometrical intervals
                               	[2] decreasing geometrical intervals
                               	Default: 0
  -SCALE_LOG:          Geometric Interval Factor
	floating point number
	Minimum: 0.000000
	Maximum: 16.000000
	Default: 1.000000
  -LUT:
                               Lookup Table
                               	static table
                               	5 Fields:
                               	- 1. [color] Color
                               	- 2. [string] Name
                               	- 3. [string] Description
                               	- 4. [8 byte floating point number] Minimum
                               	- 5. [8 byte floating point number] Maximum
                               	
  -SHADE_TRANS:        Transparency
	floating point number
	Minimum: 0.000000
	Maximum: 100.000000
	Default: 75.000000
  -SHADE_COLOURING:       Histogram Stretch
	choice
	Available Choices:
	[0] Linear
	[1] Standard Deviation
	Default: 0
  -SHADE_BRIGHT_MIN:   Linear
	value range
  -SHADE_BRIGHT_MAX:   Linear
	value range
  -SHADE_STDDEV:       Standard Deviation
	floating point number
	Minimum: 0.000000
	Default: 2.000000