SAGA-GIS Tool Library Documentation (v9.0.1)

Tool Formatted Text

With this tool you can create new text field contents from the contents of other fields. To address other field's contents you have some format options as listed below.
Fields are addressed either by their zero based column number or by their name.
If the use no-data flag is unchecked and a no-data value appears in a record's input fields, the result will be an empty text string.
Field contents can be combined using the '+' operator. Free text arguments have to be added in quota.
A simple example:
"No. " + index(1) + ": the value of '" + upper(0) + "' is " + number(1, 2)

index(offset = 0)record's index
string(field)field's content as it is
lower(field)field's content as lower case text
upper(field)field's content as upper case text
integer(field)field's content as integer number
real(field, precision)field's content as real number with optional precision argument

Parameters

 NameTypeIdentifierDescriptionConstraints
InputTableTable, inputTABLE--
OutputResult (*)Table, output, optionalRESULT--
OptionsField (*)Table fieldFIELD--
Field NameTextNAME-Default: New Field
FormatTextFORMAT-Default: "Index: " + index(1)
SelectionBooleanSELECTION-Default: 1
Use No-DataBooleanUSE_NODATA-Default: 0
(*) optional

Command-line

Usage: saga_cmd table_tools 24 [-TABLE <str>] [-RESULT <str>] [-FIELD <str>] [-NAME <str>] [-FORMAT <str>] [-SELECTION <str>] [-USE_NODATA <str>]
  -TABLE:<str>     	Table
	Table, input
  -RESULT:<str>    	Result
	Table, output, optional
  -FIELD:<str>     	Field
	Table field
  -NAME:<str>      	Field Name
	Text
	Default: New Field
  -FORMAT:<str>    	Format
	Text
	Default: "Index: " + index(1)
  -SELECTION:<str> 	Selection
	Boolean
	Default: 1
  -USE_NODATA:<str>	Use No-Data
	Boolean
	Default: 0