SAGA-GIS Module Library Documentation (v2.2.2)

Module Get Grid from Virtual Point Cloud

The module allows one to retrieve a grid from a virtual point cloud dataset by applying the provided area-of-interest (AOI). The extent of the AOI can be provided either as polygon shapefile, grid or by coordinates. Optionally, an overlap can be added to the AOI. In case an overlap is used and the AOI is provided as polygon shapfile, only the bounding boxes of the polygons are used.
With polygon shapefiles additional functionality is available:
* in case one or more polygons are selected, only the selected polygons are used.
* in case the shapefile contains several polygons a grid dataset is outputted for each polygon. In case the 'Tilename' attribute is provided, the output files are named by this attribute. Otherwise the output file names are build from the lower left coordinate of each tile.
The derived datasets can be outputted either as grid list or written to an output directory. For the latter, you must provide a valid file path with the 'Optional Output Filepath' parameter.
Optionally, the query can be constrained by providing an attribute field and a value range that must be met.
A virtual point cloud dataset is a simple XML format with the file extension .spcvf, which can be created with the 'Create Virtual Point Cloud Dataset' module.

Parameters

 NameTypeIdentifierDescriptionConstraints
InputShape (*)Shapes (optional input)AOI_SHPShapefile describing the AOI.-
Grid (*)Grid (optional input)AOI_GRIDGrid describing the AOI.-
OutputGrid (*)Grid list (optional output)GRID_OUTThe output grid(s)-
OptionsFilenameFile pathFILENAMEThe full path and name of the .spcvf file-
Optional Output FilepathFile pathFILEPATHThe full path to which the output(s) should be written. Leave empty to output the datasets as grid list.-
Attribute Field to GridIntegerATTR_FIELD_GRIDThe attribute field to grid. Field numbers start with 1, so elevation is attribute field 3.Minimum: 3
Default: 1
CellsizeFloating pointCELL_SIZECellsize of the output grid [map units]Minimum: 0.001000
Default: 1.000000
Grid System FitChoiceGRID_SYSTEM_FITChoose how to align the ouput grid system to the AOIAvailable Choices:
[0] nodes
[1] cells
Default: 1
AggregationChoiceMETHODChoose how to aggregate the valuesAvailable Choices:
[0] lowest
[1] highest
Default: 1
Constrain QueryBooleanCONSTRAIN_QUERYCheck this parameter to constrain the query by an attribute range.Default: 0
Attribute FieldIntegerATTR_FIELDThe attribute field to use as constraint. Field numbers start with 1.Minimum: 1
Default: 1
Value RangeValue rangeVALUE_RANGEMinimum and maximum of attribute range [].-
Tilename (*)Table fieldFIELD_TILENAMEAttribute used for naming the output file(s)-
X-ExtentValue rangeAOI_XRANGEMinimum and maximum x-coordinate of AOI.-
Y-ExtentValue rangeAOI_YRANGEMinimum and maximum y-coordinate of AOI.-
Add OverlapBooleanAOI_ADD_OVERLAPAdd overlap to AOIDefault: 0
OverlapFloating pointOVERLAPOverlap [map units]Minimum: 0.000000
Default: 50.000000
(*) optional

Command-line

Usage: saga_cmd io_virtual 4 [-FILENAME <str>] [-GRID_OUT <str>] [-FILEPATH <str>] [-ATTR_FIELD_GRID <num>] [-CELL_SIZE <str>] [-GRID_SYSTEM_FIT <str>] [-METHOD <str>] [-CONSTRAIN_QUERY <str>] [-ATTR_FIELD <num>] [-VALUE_RANGE_MIN <str>] [-VALUE_RANGE_MAX <str>] [-AOI_SHP <str>] [-FIELD_TILENAME <str>] [-AOI_GRID <str>] [-AOI_XRANGE_MIN <str>] [-AOI_XRANGE_MAX <str>] [-AOI_YRANGE_MIN <str>] [-AOI_YRANGE_MAX <str>] [-AOI_ADD_OVERLAP <str>] [-OVERLAP <str>]
  -FILENAME:<str>       	Filename
	File path
  -GRID_OUT:<str>       	Grid
	Grid list (optional output)
  -FILEPATH:<str>       	Optional Output Filepath
	File path
  -ATTR_FIELD_GRID:<num>	Attribute Field to Grid
	Integer
	Minimum: 3
	Default: 1
  -CELL_SIZE:<str>      	Cellsize
	Floating point
	Minimum: 0.001000
	Default: 1.000000
  -GRID_SYSTEM_FIT:<str>	Grid System Fit
	Choice
	Available Choices:
	[0] nodes
	[1] cells
	Default: 1
  -METHOD:<str>         	Aggregation
	Choice
	Available Choices:
	[0] lowest
	[1] highest
	Default: 1
  -CONSTRAIN_QUERY:<str>	Constrain Query
	Boolean
	Default: 0
  -ATTR_FIELD:<num>     	Attribute Field
	Integer
	Minimum: 1
	Default: 1
  -VALUE_RANGE_MIN:<str>	Value Range
	Value range
  -VALUE_RANGE_MAX:<str>	Value Range
	Value range
  -AOI_SHP:<str>        	Shape
	Shapes (optional input)
  -FIELD_TILENAME:<str> 	Tilename
	Table field
  -AOI_GRID:<str>       	Grid
	Grid (optional input)
  -AOI_XRANGE_MIN:<str> 	X-Extent
	Value range
  -AOI_XRANGE_MAX:<str> 	X-Extent
	Value range
  -AOI_YRANGE_MIN:<str> 	Y-Extent
	Value range
  -AOI_YRANGE_MAX:<str> 	Y-Extent
	Value range
  -AOI_ADD_OVERLAP:<str>	Add Overlap
	Boolean
	Default: 0
  -OVERLAP:<str>        	Overlap
	Floating point
	Minimum: 0.000000
	Default: 50.000000