Single Grid Layer Map

Author(s)
Library ID	docs_map
Tool ID	0
Version	1.0
Menu	File \| Map Production

Description

Parameters

	Name	Type	Identifier	Description	Constraints
Input	Transparency Grid	grid, input, optional	`TRANSPARENCY_GRID`	Grid values used to define transparency. Transparency will be linearly scaled from full transparency to full opacity value range. Can be combined with overall transparency.	-
	Red	grid, input, optional	`COMPOSITE_R`	-	-
	Green	grid, input, optional	`COMPOSITE_G`	-	-
	Blue	grid, input, optional	`COMPOSITE_B`	-	-
	Grid	grid, input	`LAYER`	-	-
Options	File	file path	`FILE`	-	-
	Size	choice	`MAP_SIZE`	-	Available Choices: [0] width and height [1] width and fitted height [2] height and fitted width Default: 0
	Width	integer number	`MAP_WIDTH`	-	Minimum: 1 Default: 1000
	Height	integer number	`MAP_HEIGHT`	-	Minimum: 1 Default: 1000
	Map Legends	boolean	`LEGEND_SHOW`	Include in map legends.	Default: 1
	Orientation	choice	`LEGEND_ORIENTATION`	-	Available Choices: [0] vertical [1] horizontal Default: 0
	Title	choice	`LEGEND_TITLE`	-	Available Choices: [0] data set [1] user defined [2] none Default: 0
	User Defined	text	`LEGEND_TITLE_TEXT`	-	Default: Title
	Show at all scales	boolean	`SHOW_ALWAYS`	-	Default: 1
	Scale Range	value range	`SHOW_RANGE`	only show within scale range; values are given as extent measured in map units	Default: 100; 1000
	Overlay Mode	choice	`TRANSPARENCY_MODE`	-	Available Choices: [0] Transparency/Opacity [1] Hachure Default: 0
	Transparency	floating point number	`TRANSPARENCY`	Transparency specified as percentage.	Minimum: 0.000000 Maximum: 100.000000 Default: 0
	Type	choice	`COLOR_SYMBOLS`	-	Available Choices: [0] Single Symbol [1] Classification [2] Discrete Colors [3] Graduated Colors [4] RGB Composite [5] RGB Coded Values Default: 3
	Color	color	`SINGLE_COLOR`	-	Default: 8421376
	Look-up Table	static table	`CLASSIFIED_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
	Resampling	choice	`CLASSIFIED_RESAMPLING`	-	Available Choices: [0] Nearest Neighbour [1] Bilinear [2] Cubic 1 [3] Cubic 2 Default: 0
	Colors	colors	`STRETCH_COLORS`	-	-
	Stretch Type	choice	`STRETCH`	Specify how to adjust histogram stretch.	Available Choices: [0] Minimum Maximum [1] Standard Deviation [2] Percent Clip [3] Manual Default: 1
	Minimum Maximum	value range	`STRETCH_LINEAR`	Apply the stretch between the minimum and maximum values specified as percentage of the full value range.	Default: 0; 100
	Standard Deviation	floating point number	`STRETCH_STDDEV`	Apply the stretch between a specified number of standard deviations.	Minimum: 0.000000 Default: 2
	Keep in Range	boolean	`STRETCH_STDDEV_RANGE`	Prevents that minimum or maximum stretch values fall outside of the actual data value range.	Default: 1
	Percent Clip	value range	`STRETCH_PERCENT`	Adjust the stretch to the percentiles specified here.	Default: 1; 99
	Range	value range	`STRETCH_RANGE`	-	Default: 0; 0
	Scaling	choice	`STRETCH_INTERVALS`	-	Available Choices: [0] linear intervals [1] increasing geometric intervals [2] decreasing geometric intervals [3] histogram equalize Default: 0
	Geometric Interval Factor	floating point number	`STRETCH_INTERVALS_LOG`	-	Minimum: 0.000000 Maximum: 16.000000 Default: 1
	Show Cell Values	boolean	`VALUES`	Show cell values when zoomed.	Default: 0
	Font	font	`VALUES_FONT`	-	-
	Size	floating point number	`VALUES_SIZE`	-	Minimum: 0.000000 Maximum: 100.000000 Default: 15
	Decimals	integer number	`VALUES_DECIMALS`	-	Default: 2
	Boundary Effect	choice	`VALUES_EFFECT`	-	Available Choices: [0] none [1] full frame [2] top [3] top left [4] left [5] bottom left [6] bottom [7] bottom right [8] right [9] top right Default: 1
	Color	color	`VALUES_EFFECT_COLOR`	-	Default: 16777215
	Resampling	choice	`STRETCH_RESAMPLING`	-	Available Choices: [0] Nearest Neighbour [1] Bilinear [2] Cubic 1 [3] Cubic 2 Default: 0
	Full Transparency	floating point number	`TRANSPARENCY_GRID_STRETCH.MIN`	-	Default: 0
	Full Opacity	floating point number	`TRANSPARENCY_GRID_STRETCH.MAX`	-	Default: 0
	Shading	choice	`SHADING`	-	Available Choices: [0] none [1] traditional [2] multidirectional Default: 0
	Azimuth	floating point number	`SHADING_AZIMUTH`	Direction of the light source, measured in degree clockwise from the North direction.	Minimum: 0.000000 Maximum: 360.000000 Default: 315
	Height	floating point number	`SHADING_HEIGHT`	Height of the light source, measured in degree above the horizon.	Minimum: 0.000000 Maximum: 90.000000 Default: 45
	Exaggeration	floating point number	`SHADING_EXAGG`	-	Default: 1
	Minimum	floating point number	`SHADING_MIN`	-	Default: 0
	Maximum	floating point number	`SHADING_MAX`	-	Default: 1.5
	Alpha Channel	boolean	`RGB_ALPHA`	-	Default: 0
	This Color	choice	`COMPOSITE_THIS`	-	Available Choices: [0] Red [1] Green [2] Blue Default: 0
	Copy^*	boolean [GUI]	`FROM_GUI`	-	Default: 1

^* GUI only

Command Line


Usage: saga_cmd docs_map 0 [-FILE ] [-MAP_SIZE ] [-MAP_WIDTH ] [-MAP_HEIGHT ] [-SETTINGS_LEGEND_SHOW ] [-SETTINGS_LEGEND_ORIENTATION ] [-SETTINGS_LEGEND_TITLE ] [-SETTINGS_LEGEND_TITLE_TEXT ] [-SETTINGS_SHOW_ALWAYS ] [-SETTINGS_SHOW_RANGE_MIN ] [-SETTINGS_SHOW_RANGE_MAX ] [-SETTINGS_TRANSPARENCY_MODE ] [-SETTINGS_TRANSPARENCY ] [-SETTINGS_COLOR_SYMBOLS ] [-SETTINGS_SINGLE_COLOR ] [-SETTINGS_CLASSIFIED_LUT ] [-SETTINGS_CLASSIFIED_RESAMPLING ] [-SETTINGS_STRETCH_COLORS ] [-SETTINGS_STRETCH ] [-SETTINGS_STRETCH_LINEAR_MIN ] [-SETTINGS_STRETCH_LINEAR_MAX ] [-SETTINGS_STRETCH_STDDEV ] [-SETTINGS_STRETCH_STDDEV_RANGE ] [-SETTINGS_STRETCH_PERCENT_MIN ] [-SETTINGS_STRETCH_PERCENT_MAX ] [-SETTINGS_STRETCH_RANGE_MIN ] [-SETTINGS_STRETCH_RANGE_MAX ] [-SETTINGS_STRETCH_INTERVALS ] [-SETTINGS_STRETCH_INTERVALS_LOG ] [-SETTINGS_VALUES ] [-SETTINGS_VALUES_SIZE ] [-SETTINGS_VALUES_DECIMALS ] [-SETTINGS_VALUES_EFFECT ] [-SETTINGS_VALUES_EFFECT_COLOR ] [-SETTINGS_STRETCH_RESAMPLING ] [-SETTINGS_TRANSPARENCY_GRID ] [-SETTINGS_TRANSPARENCY_GRID_STRETCH_MIN ] [-SETTINGS_TRANSPARENCY_GRID_STRETCH_MAX ] [-SETTINGS_SHADING ] [-SETTINGS_SHADING_AZIMUTH ] [-SETTINGS_SHADING_HEIGHT ] [-SETTINGS_SHADING_EXAGG ] [-SETTINGS_SHADING_MIN ] [-SETTINGS_SHADING_MAX ] [-SETTINGS_RGB_ALPHA ] [-SETTINGS_COMPOSITE_THIS ] [-SETTINGS_COMPOSITE_R ] [-SETTINGS_COMPOSITE_G ] [-SETTINGS_COMPOSITE_B ] [-LAYER ]
  -FILE:                                        File
	file path
  -MAP_SIZE:
                                                     Size
                                                     	choice
                                                     	Available Choices:
                                                     	[0] width and height
                                                     	[1] width and fitted height
                                                     	[2] height and fitted width
                                                     	Default: 0
  -MAP_WIDTH:                                   Width
	integer number
	Minimum: 1
	Default: 1000
  -MAP_HEIGHT:                                  Height
	integer number
	Minimum: 1
	Default: 1000
  -SETTINGS_LEGEND_SHOW:                        Map Legends
	boolean
	Default: 1
  -SETTINGS_LEGEND_ORIENTATION:
                                                     Orientation
                                                     	choice
                                                     	Available Choices:
                                                     	[0] vertical
                                                     	[1] horizontal
                                                     	Default: 0
  -SETTINGS_LEGEND_TITLE:
                                                     Title
                                                     	choice
                                                     	Available Choices:
                                                     	[0] data set
                                                     	[1] user defined
                                                     	[2] none
                                                     	Default: 0
  -SETTINGS_LEGEND_TITLE_TEXT:                  User Defined
	text
	Default: Title
  -SETTINGS_SHOW_ALWAYS:                        Show at all scales
	boolean
	Default: 1
  -SETTINGS_SHOW_RANGE_MIN:                  Scale Range
	value range
	Default: 100; 1000
  -SETTINGS_SHOW_RANGE_MAX:                  Scale Range
	value range
	Default: 100; 1000
  -SETTINGS_TRANSPARENCY_MODE:
                                                     Overlay Mode
                                                     	choice
                                                     	Available Choices:
                                                     	[0] Transparency/Opacity
                                                     	[1] Hachure
                                                     	Default: 0
  -SETTINGS_TRANSPARENCY:
                                                     Transparency
                                                     	floating point number
                                                     	Minimum: 0.000000
                                                     	Maximum: 100.000000
                                                     	Default: 0
  -SETTINGS_COLOR_SYMBOLS:
                                                     Type
                                                     	choice
                                                     	Available Choices:
                                                     	[0] Single Symbol
                                                     	[1] Classification
                                                     	[2] Discrete Colors
                                                     	[3] Graduated Colors
                                                     	[4] RGB Composite
                                                     	[5] RGB Coded Values
                                                     	Default: 3
  -SETTINGS_SINGLE_COLOR:                       Color
	color
	Default: 8421376
  -SETTINGS_CLASSIFIED_LUT:
                                                     Look-up 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
                                                     	
  -SETTINGS_CLASSIFIED_RESAMPLING:
                                                     Resampling
                                                     	choice
                                                     	Available Choices:
                                                     	[0] Nearest Neighbour
                                                     	[1] Bilinear
                                                     	[2] Cubic 1
                                                     	[3] Cubic 2
                                                     	Default: 0
  -SETTINGS_STRETCH_COLORS:                     Colors
	colors
  -SETTINGS_STRETCH:
                                                     Stretch Type
                                                     	choice
                                                     	Available Choices:
                                                     	[0] Minimum Maximum
                                                     	[1] Standard Deviation
                                                     	[2] Percent Clip
                                                     	[3] Manual
                                                     	Default: 1
  -SETTINGS_STRETCH_LINEAR_MIN:              Minimum Maximum
	value range
	Default: 0; 100
  -SETTINGS_STRETCH_LINEAR_MAX:              Minimum Maximum
	value range
	Default: 0; 100
  -SETTINGS_STRETCH_STDDEV:
                                                     Standard Deviation
                                                     	floating point number
                                                     	Minimum: 0.000000
                                                     	Default: 2
  -SETTINGS_STRETCH_STDDEV_RANGE:               Keep in Range
	boolean
	Default: 1
  -SETTINGS_STRETCH_PERCENT_MIN:             Percent Clip
	value range
	Default: 1; 99
  -SETTINGS_STRETCH_PERCENT_MAX:             Percent Clip
	value range
	Default: 1; 99
  -SETTINGS_STRETCH_RANGE_MIN:               Range
	value range
	Default: 0; 0
  -SETTINGS_STRETCH_RANGE_MAX:               Range
	value range
	Default: 0; 0
  -SETTINGS_STRETCH_INTERVALS:
                                                     Scaling
                                                     	choice
                                                     	Available Choices:
                                                     	[0] linear intervals
                                                     	[1] increasing geometric intervals
                                                     	[2] decreasing geometric intervals
                                                     	[3] histogram equalize
                                                     	Default: 0
  -SETTINGS_STRETCH_INTERVALS_LOG:
                                                     Geometric Interval Factor
                                                     	floating point number
                                                     	Minimum: 0.000000
                                                     	Maximum: 16.000000
                                                     	Default: 1
  -SETTINGS_VALUES:                             Show Cell Values
	boolean
	Default: 0
  -SETTINGS_VALUES_SIZE:
                                                     Size
                                                     	floating point number
                                                     	Minimum: 0.000000
                                                     	Maximum: 100.000000
                                                     	Default: 15
  -SETTINGS_VALUES_DECIMALS:                    Decimals
	integer number
	Default: 2
  -SETTINGS_VALUES_EFFECT:
                                                     Boundary Effect
                                                     	choice
                                                     	Available Choices:
                                                     	[0] none
                                                     	[1] full frame
                                                     	[2] top
                                                     	[3] top left
                                                     	[4] left
                                                     	[5] bottom left
                                                     	[6] bottom
                                                     	[7] bottom right
                                                     	[8] right
                                                     	[9] top right
                                                     	Default: 1
  -SETTINGS_VALUES_EFFECT_COLOR:                Color
	color
	Default: 16777215
  -SETTINGS_STRETCH_RESAMPLING:
                                                     Resampling
                                                     	choice
                                                     	Available Choices:
                                                     	[0] Nearest Neighbour
                                                     	[1] Bilinear
                                                     	[2] Cubic 1
                                                     	[3] Cubic 2
                                                     	Default: 0
  -SETTINGS_TRANSPARENCY_GRID:                  Transparency Grid
	grid, input, optional
  -SETTINGS_TRANSPARENCY_GRID_STRETCH_MIN:   Full Transparency
	floating point number
	Default: 0
  -SETTINGS_TRANSPARENCY_GRID_STRETCH_MAX:   Full Opacity
	floating point number
	Default: 0
  -SETTINGS_SHADING:
                                                     Shading
                                                     	choice
                                                     	Available Choices:
                                                     	[0] none
                                                     	[1] traditional
                                                     	[2] multidirectional
                                                     	Default: 0
  -SETTINGS_SHADING_AZIMUTH:
                                                     Azimuth
                                                     	floating point number
                                                     	Minimum: 0.000000
                                                     	Maximum: 360.000000
                                                     	Default: 315
  -SETTINGS_SHADING_HEIGHT:
                                                     Height
                                                     	floating point number
                                                     	Minimum: 0.000000
                                                     	Maximum: 90.000000
                                                     	Default: 45
  -SETTINGS_SHADING_EXAGG:                   Exaggeration
	floating point number
	Default: 1
  -SETTINGS_SHADING_MIN:                     Minimum
	floating point number
	Default: 0
  -SETTINGS_SHADING_MAX:                     Maximum
	floating point number
	Default: 1.5
  -SETTINGS_RGB_ALPHA:                          Alpha Channel
	boolean
	Default: 0
  -SETTINGS_COMPOSITE_THIS:
                                                     This Color
                                                     	choice
                                                     	Available Choices:
                                                     	[0] Red
                                                     	[1] Green
                                                     	[2] Blue
                                                     	Default: 0
  -SETTINGS_COMPOSITE_R:                        Red
	grid, input, optional
  -SETTINGS_COMPOSITE_G:                        Green
	grid, input, optional
  -SETTINGS_COMPOSITE_B:                        Blue
	grid, input, optional
  -LAYER:                                       Grid
	grid, input