SAGA-GIS Tool Library Documentation (v7.8.2)

Tool Get Subset from Virtual Point Cloud

The tool allows one to retrieve a point cloud 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 and a spcvf tile info file can be outputted. The latter can be used to remove the overlap later.
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 and the 'One Point Cloud per Polygon' parameter is checked, a point cloud 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 point cloud 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' tool.

Parameters

 NameTypeIdentifierDescriptionConstraints
InputShape (*)Shapes, input, optionalAOI_SHPShapefile describing the AOI.-
Grid (*)Grid, input, optionalAOI_GRIDGrid describing the AOI.-
OutputPoint Cloud (*)Point Cloud list, output, optionalPC_OUTThe output point cloud(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 point cloud list.-
Copy existing AttributesBooleanCOPY_ATTRCopy attributes from input to output point cloud.Default: 1
Copy AttributesTextATTRIBUTE_LISTField numbers (starting from 1) of the attributes to copy, separated by semicolon; fields one to three (x;y;z) are mandatory.Default: 1;2;3
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)-
Grid systemGrid systemAOI_GRID_GRIDSYSTEM--
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 Tile Info FilenameFile pathFILENAME_TILE_INFOThe full path and name of an optional spcvf tile info file. Such a file contains information about the bounding boxes without overlap and can be used to remove the overlap from the tiles later. Leave empty to not output such a file.-
One Point Cloud per PolygonBooleanONE_PC_PER_POLYGONWrite one point cloud dataset for each polygonDefault: 0
(*) optional

Command-line

Usage: saga_cmd io_virtual 1 [-FILENAME <str>] [-PC_OUT <str>] [-FILEPATH <str>] [-COPY_ATTR <str>] [-ATTRIBUTE_LIST <str>] [-CONSTRAIN_QUERY <str>] [-ATTR_FIELD <num>] [-VALUE_RANGE_MIN <double>] [-VALUE_RANGE_MAX <double>] [-AOI_SHP <str>] [-FIELD_TILENAME <str>] [-AOI_GRID <str>] [-AOI_XRANGE_MIN <double>] [-AOI_XRANGE_MAX <double>] [-AOI_YRANGE_MIN <double>] [-AOI_YRANGE_MAX <double>] [-AOI_ADD_OVERLAP <str>] [-OVERLAP <double>] [-FILENAME_TILE_INFO <str>] [-ONE_PC_PER_POLYGON <str>]
  -FILENAME:<str>          	Filename
	File path
  -PC_OUT:<str>            	Point Cloud
	Point Cloud list, output, optional
  -FILEPATH:<str>          	Optional Output Filepath
	File path
  -COPY_ATTR:<str>         	Copy existing Attributes
	Boolean
	Default: 1
  -ATTRIBUTE_LIST:<str>    	Copy Attributes
	Text
	Default: 1;2;3
  -CONSTRAIN_QUERY:<str>   	Constrain Query
	Boolean
	Default: 0
  -ATTR_FIELD:<num>        	Attribute Field
	Integer
	Minimum: 1
	Default: 1
  -VALUE_RANGE_MIN:<double>	Value Range
	Value range
  -VALUE_RANGE_MAX:<double>	Value Range
	Value range
  -AOI_SHP:<str>           	Shape
	Shapes, input, optional
  -FIELD_TILENAME:<str>    	Tilename
	Table field
  -AOI_GRID:<str>          	Grid
	Grid, input, optional
  -AOI_XRANGE_MIN:<double> 	X-Extent
	Value range
  -AOI_XRANGE_MAX:<double> 	X-Extent
	Value range
  -AOI_YRANGE_MIN:<double> 	Y-Extent
	Value range
  -AOI_YRANGE_MAX:<double> 	Y-Extent
	Value range
  -AOI_ADD_OVERLAP:<str>   	Add Overlap
	Boolean
	Default: 0
  -OVERLAP:<double>        	Overlap
	Floating point
	Minimum: 0.000000
	Default: 50.000000
  -FILENAME_TILE_INFO:<str>	Optional Tile Info Filename
	File path
  -ONE_PC_PER_POLYGON:<str>	One Point Cloud per Polygon
	Boolean
	Default: 0