Single Grid Collection Layer Map

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

Description

Parameters

	Name	Type	Identifier	Description	Constraints
Input	Transparency Band	grid, input, optional	`TRANSPARENCY_GRID`	Band values used to define transparency. Transparency will be linearly scaled from full transparency to full opacity value range. Can be combined with overall transparency.	-
	External Grid	grid, input	`COMPOSITE_R_GRID`	-	-
	External Grid	grid, input	`COMPOSITE_G_GRID`	-	-
	External Grid	grid, input	`COMPOSITE_B_GRID`	-	-
	Grid Collection	grid collection, 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
	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 Default: 4
	Band	choice	`BAND`	-	Available Choices: [0] Default: 0
	Statistics	choice	`COMPOSITE_FIT`	-	Available Choices: [0] all bands [1] each band Default: 1
	Red	choice	`COMPOSITE_R`	-	Available Choices: Default: 0
	Green	choice	`COMPOSITE_G`	-	Available Choices: Default: 0
	Blue	choice	`COMPOSITE_B`	-	Available Choices: Default: 0
	Color	color	`SINGLE_COLOR`	-	Default: 32768
	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
	Red	value range	`STRETCH_RANGE_R`	-	Default: 0; 0
	Green	value range	`STRETCH_RANGE_G`	-	Default: 0; 0
	Blue	value range	`STRETCH_RANGE_B`	-	Default: 0; 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
	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
	Copy^*	boolean [GUI]	`FROM_GUI`	-	Default: 1

^* GUI only

Command Line


Usage: saga_cmd docs_map 1 [-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 ] [-SETTINGS_COLOR_SYMBOLS ] [-SETTINGS_BAND ] [-SETTINGS_COMPOSITE_FIT ] [-SETTINGS_COMPOSITE_R ] [-SETTINGS_COMPOSITE_G ] [-SETTINGS_COMPOSITE_B ] [-SETTINGS_SINGLE_COLOR ] [-SETTINGS_CLASSIFIED_LUT ] [-SETTINGS_CLASSIFIED_RESAMPLING ] [-SETTINGS_STRETCH_RANGE_R_MIN ] [-SETTINGS_STRETCH_RANGE_R_MAX ] [-SETTINGS_STRETCH_RANGE_G_MIN ] [-SETTINGS_STRETCH_RANGE_G_MAX ] [-SETTINGS_STRETCH_RANGE_B_MIN ] [-SETTINGS_STRETCH_RANGE_B_MAX ] [-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_STRETCH_RESAMPLING ] [-SETTINGS_TRANSPARENCY_GRID ] [-SETTINGS_TRANSPARENCY_GRID_STRETCH_MIN ] [-SETTINGS_TRANSPARENCY_GRID_STRETCH_MAX ] [-SETTINGS_COMPOSITE_R_GRID ] [-SETTINGS_COMPOSITE_G_GRID ] [-SETTINGS_COMPOSITE_B_GRID ] [-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:                    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
	Default: 4
  -SETTINGS_BAND:                               Band
	choice
	Available Choices:
	[0] 
	Default: 0
  -SETTINGS_COMPOSITE_FIT:                      Statistics
	choice
	Available Choices:
	[0] all bands
	[1] each band
	Default: 1
  -SETTINGS_COMPOSITE_R:                        Red
	choice
	Available Choices:
	Default: 0
  -SETTINGS_COMPOSITE_G:                        Green
	choice
	Available Choices:
	Default: 0
  -SETTINGS_COMPOSITE_B:                        Blue
	choice
	Available Choices:
	Default: 0
  -SETTINGS_SINGLE_COLOR:                       Color
	color
	Default: 32768
  -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_RANGE_R_MIN:             Red
	value range
	Default: 0; 0
  -SETTINGS_STRETCH_RANGE_R_MAX:             Red
	value range
	Default: 0; 0
  -SETTINGS_STRETCH_RANGE_G_MIN:             Green
	value range
	Default: 0; 0
  -SETTINGS_STRETCH_RANGE_G_MAX:             Green
	value range
	Default: 0; 0
  -SETTINGS_STRETCH_RANGE_B_MIN:             Blue
	value range
	Default: 0; 0
  -SETTINGS_STRETCH_RANGE_B_MAX:             Blue
	value range
	Default: 0; 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_STRETCH_RESAMPLING:                 Resampling
	choice
	Available Choices:
	[0] Nearest Neighbour
	[1] Bilinear
	[2] Cubic 1
	[3] Cubic 2
	Default: 0
  -SETTINGS_TRANSPARENCY_GRID:                  Transparency Band
	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_COMPOSITE_R_GRID:                   External Grid
	grid, input
  -SETTINGS_COMPOSITE_G_GRID:                   External Grid
	grid, input
  -SETTINGS_COMPOSITE_B_GRID:                   External Grid
	grid, input
  -LAYER:                                       Grid Collection
	grid collection, input