SAGA 9.11.3 | Tool Library Documentation

Export to Image File


Description

With this tool you can save a RGB to an image file. Optionally, a shade RGB can be overlaid using the specified transparency and brightness adjustment. If input rasters come with geographic coordinates an additionaloption for KML file creation (Google Earth) is selectable.


Parameters

 NameTypeIdentifierDescriptionConstraints
InputGRIDgrid, inputGRID--
Shadegrid, input, optionalSHADE--
OptionsGrid Systemgrid systemPARAMETERS_GRID_SYSTEM--
Image Filefile pathFILE--
Create World FilebooleanFILE_WORLDStore georeference along image to an additional file.Default: 1
Create KML FilebooleanFILE_KMLExpects that the input RGB uses geographic coordinates.Default: 0
ColoringchoiceCOLOURING-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
ColorscolorsCOL_PALETTE--
Number of Colorsinteger numberCOL_COUNTIgnored if zero.Minimum: 0 Default: 0
RevertbooleanCOL_REVERT-Default: 0
No-Data TransparencybooleanNO_DATA-Default: 1
No-Data ColorcolorNO_DATA_COL-Default: 16777215
Has Alpha ChannelbooleanALPHA-Default: 0
Color Depthinteger numberCOL_DEPTHNumber of color entries used when storing GIF.Minimum: 2 Maximum: 256 Default: 236
Color InterpolationchoiceGRADUATED-Available Choices: [0] Discrete Colors [1] Graduated Colors Default: 1
Standard Deviationfloating point numberSTDDEV-Minimum: 0.000000 Default: 2.000000
Percentilesvalue rangeLINEAR--
Value Rangevalue rangeSTRETCH--
ScalingchoiceSCALE_MODEScaling applied to coloring choices (i) RGB's standard deviation, (ii) RGB's value range, (iii) specified value rangeAvailable Choices: [0] linear intervals [1] increasing geometrical intervals [2] decreasing geometrical intervals Default: 0
Geometric Interval Factorfloating point numberSCALE_LOG-Minimum: 0.000000 Maximum: 16.000000 Default: 1.000000
Lookup Tablestatic tableLUT-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
Transparencyfloating point numberSHADE_TRANSThe transparency of the shade [%]Minimum: 0.000000 Maximum: 100.000000 Default: 75.000000
Histogram StretchchoiceSHADE_COLOURING-Available Choices: [0] Linear [1] Standard Deviation Default: 0
Linearvalue rangeSHADE_BRIGHTMinimum and maximum [%], the range for histogram stretch.-
Standard Deviationfloating point numberSHADE_STDDEV-Minimum: 0.000000 Default: 2.000000

Command Line


Usage: saga_cmd io_grid_image 0 [-GRID ] [-SHADE ] [-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
  -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