SAGA-GIS Module Library Documentation (v2.3.0)

Module Point Cloud Attribute Calculator

The Point Cloud Attribute Calculator calculates a new attribute based on existing attributes and a mathematical formula. Attribute fields are addressed by the character 'f' (for 'field') followed by the field number (i.e.: f1, f2, ..., fn) or by the field name in square brackets (e.g.: [Field Name]).
Examples:
sin(f1) * f2 + f3
[intensity] / 1000

The following operators are available for the formula definition:

+Addition
-Subtraction
*Multiplication
/Division
abs(x)Absolute Value
mod(x, y)Returns the floating point remainder of x/y
int(x)Returns the integer part of floating point value x
sqr(x)Square
sqrt(x)Square Root
exp(x)Exponential
pow(x, y)Returns x raised to the power of y
x ^ yReturns x raised to the power of y
ln(x)Natural Logarithm
log(x)Base 10 Logarithm
pi()Returns the value of Pi
sin(x)Sine
cos(x)Cosine
tan(x)Tangent
asin(x)Arcsine
acos(x)Arccosine
atan(x)Arctangent
atan2(x, y)Arctangent of x/y
gt(x, y)Returns true (1), if x is greater than y, else false (0)
x > yReturns true (1), if x is greater than y, else false (0)
lt(x, y)Returns true (1), if x is less than y, else false (0)
x < yReturns true (1), if x is less than y, else false (0)
eq(x, y)Returns true (1), if x equals y, else false (0)
x = yReturns true (1), if x equals y, else false (0)
and(x, y)Returns true (1), if both x and y are true (i.e. not 0)
or(x, y)Returns true (1), if at least one of both x and y is true (i.e. not 0)
ifelse(c, x, y)Returns x, if condition c is true (i.e. not 0), else y
rand_u(x, y)Random number, uniform distribution with minimum x and maximum y
rand_g(x, y)Random number, Gaussian distribution with mean x and standard deviation y

Parameters

 NameTypeIdentifierDescriptionConstraints
InputPoint CloudPoint Cloud (input)PC_INInput-
OutputResult (*)Point Cloud (optional output)PC_OUTOutput-
OptionsFormulaTextFORMULA-Default: f1+f2
Output Field NameTextNAME-Default: Calculation
Field data typeChoiceTYPE-Available Choices:
[0] 1 bit
[1] 1 byte unsigned integer
[2] 1 byte signed integer
[3] 2 byte unsigned integer
[4] 2 byte signed integer
[5] 4 byte unsigned integer
[6] 4 byte signed integer
[7] 4 byte floating point
[8] 8 byte floating point
Default: 7
Use NoDataBooleanUSE_NODATACheck this in order to include NoData points in the calculation.Default: 0
(*) optional

Command-line

Usage: saga_cmd pointcloud_tools 10 [-PC_IN <str>] [-PC_OUT <str>] [-FORMULA <str>] [-NAME <str>] [-TYPE <str>] [-USE_NODATA <str>]
  -PC_IN:<str>     	Point Cloud
	Point Cloud (input)
  -PC_OUT:<str>    	Result
	Point Cloud (optional output)
  -FORMULA:<str>   	Formula
	Text
	Default: f1+f2
  -NAME:<str>      	Output Field Name
	Text
	Default: Calculation
  -TYPE:<str>      	Field data type
	Choice
	Available Choices:
	[0] 1 bit
	[1] 1 byte unsigned integer
	[2] 1 byte signed integer
	[3] 2 byte unsigned integer
	[4] 2 byte signed integer
	[5] 4 byte unsigned integer
	[6] 4 byte signed integer
	[7] 4 byte floating point
	[8] 8 byte floating point
	Default: 7
  -USE_NODATA:<str>	Use NoData
	Boolean
	Default: 0