Start » Filter Reference » Basic

Basic

Box

Icon Name Description / Applications Modules
BoxCenter

Returns center of a box.

FoundationLite
BoxCharacteristicPoint

Returns a characteristic point (e.g. the top-left) of a box.

FoundationLite
BoxCharacteristicPoints

Computes the characteristic points of the box.

FoundationLite
BoxesBoundingBox

Computes the bounding box of given boxes.

FoundationLite
BoxesBoundingBox_OrNil

Computes the bounding box of given boxes; returns NIL if the array is empty.

FoundationLite
BoxIntersection

Computes the common part of two boxes.

FoundationLite
BoxToBoxDistance

Computes minimal distance between one of the points of the first box with one of the points of the second box.

FoundationLite
CreateBox

Creates a box.

FoundationLite
DilateBox

Performs a morphological dilation on a box using box kernel.

FoundationLite
ErodeBox

Performs a morphological erosion on a box using box kernel.

FoundationLite
RemoveEmptyBoxes

The input boxes which have both dimensions different from zero are copied to the output.


Secures against domain errors caused by empty boxes.

FoundationLite
ResizeBox

Changes the dimensions of a box.

FoundationLite
ResizeBox_Delta

Changes the dimensions of a box by adding some values.

FoundationLite
ResizeBox_Relative

Resizes a box to relatively defined dimensions.

FoundationLite
SkipEmptyBox

If the input box has both dimensions different from zero, then it is copied to the output; otherwise Nil is returned.


Secures against domain errors caused by empty boxes.

FoundationLite
SplitBox

Splits a box into two along a direction.

FoundationLite
TestBoxEmpty

Tests whether the box is empty.

FoundationLite
TestBoxEqualTo

Tests whether given boxes are equal.

FoundationLite
TestBoxInBox

Tests whether a box is contained in another one.

FoundationLite
TestBoxIntersectsWith

Tests whether two boxes have non-empty intersection.

FoundationLite
TestBoxNotEmpty

Tests whether the box is not empty.

FoundationLite
TranslateBox

Shifts a box by a discreet vector.

FoundationLite

Common

Icon Name Description / Applications Modules
CopyObject

Creates a copy of the input data.


Use this filter to create a source of data, e.g. that needs to be send to HMI or used in several places of a macrofilter.

FoundationLite
TestObjectEqualTo

Checks whether the input object is equal to another object.

FoundationLite
TestObjectNil

Produces 'True' if the input object is NOT present or 'False' otherwise.

FoundationLite
TestObjectNotNil

Produces 'True' if the input object is present or 'False' otherwise.

FoundationLite
TestObjectUnequalTo

Checks whether the input object is not equal to another object.

FoundationLite

Format

Icon Name Description / Applications Modules
FormatLocationToString

Converts a location to a string of format "(X, Y)".

FoundationLite
FormatPoint2DToString

Converts a 2D point to a string of format "(X, Y)".

FoundationLite
FormatPoint3DToString

Converts a 3D point to a string of format "(X, Y, Z)".

FoundationLite

Integer

Icon Name Description / Applications Modules
AbsoluteInteger

Computes the absolute value of a number.

FoundationLite
AverageIntegers

Returns the average of two numbers.

FoundationLite
AverageIntegers_OfArray

Returns the average value of integers.

FoundationLite
AverageIntegers_OfArray_OrNil

Returns the average value of integers; returns NIL if the array is empty.

FoundationLite
AverageIntegers_OfLoop

Returns the average of the numbers appearing in consecutive iterations.

FoundationLite
AverageLongIntegers

Returns the average of two Long numbers.

FoundationLite
AverageLongIntegers_OfArray

Returns the average value of Long integers.

FoundationLite
AverageLongIntegers_OfArray_OrNil

Returns the average value of Long integers; returns NIL if the array is empty.

FoundationLite
AverageLongIntegers_OfLoop

Returns the average of the Long numbers appearing in consecutive iterations.

FoundationLite
ClampInteger

Returns a value as close as possible to inValue, but in the specified range.

FoundationLite
ClampLongInteger

Returns a value as close as possible to inValue, but in the specified range.

FoundationLite
ConvertBinaryDigitsToInteger

Converts binary digits to integer using least significant bit order.

FoundationLite
ConvertBinaryDigitsToLongInteger

Converts binary digits to LongInteger using least significant bit order.

FoundationLite
ConvertIntegerToBinaryDigits

Converts integer to binary digits using least significant bit order.

FoundationLite
ConvertLongIntegerToBinaryDigits

Converts LongInteger to binary digits using least significant bit order.

FoundationLite
CreateIntegerSequence

Creates an arithmetic sequence of integer numbers.

FoundationLite
DivideIntegers

Computes the quotient of two numbers.

FoundationLite
DivideLongIntegers

Computes the quotient of two numbers.

FoundationLite
IntegerDifference

Computes the absolute value of two numbers difference.

FoundationLite
LerpIntegers

Linearly interpolates between two integers.

FoundationLite
LongDifference

Computes the absolute value of two Long numbers difference.

FoundationLite
MaximumInteger

Returns the higher of two numbers.

FoundationLite
MaximumInteger_OfArray

Returns the greatest value in an array of integer numbers.

FoundationLite
MaximumInteger_OfArray_OrNil

Returns the greatest value in an array of integer numbers; returns NIL if the array is empty.

FoundationLite
MaximumInteger_OfLoop

Returns the greatest of numbers appearing in consecutive iterations.

FoundationLite
MaximumLongIntegers

Returns the higher of two Long Integer numbers.

FoundationLite
MaximumLongIntegers_OfArray

Returns the greatest value in an array of Long Integer numbers.

FoundationLite
MaximumLongIntegers_OfArray_OrNil

Returns the greatest value in an array of Long Integer numbers; returns NIL if the array is empty.

FoundationLite
MaximumLongIntegers_OfLoop

Returns the greatest of Long Integer numbers appearing in consecutive iterations.

FoundationLite
MinimumInteger

Returns the lower of two numbers.

FoundationLite
MinimumInteger_OfArray

Returns the smallest value in an array of Long Integer numbers.

FoundationLite
MinimumInteger_OfArray_OrNil

Returns the smallest value in an array of Long Integer numbers; returns NIL if the array is empty.

FoundationLite
MinimumInteger_OfLoop

Returns the smallest of numbers appearing in consecutive iterations.

FoundationLite
MinimumLongIntegers

Returns the lower of two Long Integer numbers.

FoundationLite
MinimumLongIntegers_OfArray

Returns the smallest value in an array of Long Integer numbers.

FoundationLite
MinimumLongIntegers_OfArray_OrNil

Returns the smallest value in an array of Long Integer numbers; returns NIL if the array is empty.

FoundationLite
MinimumLongIntegers_OfLoop

Returns the smallest of Long Integer numbers appearing in consecutive iterations.

FoundationLite
Modulo

Computes remainder of integer division of two numbers.

FoundationLite
NegateInteger

Computes the negation of a number.

FoundationLite
ParseInteger

Returns the integer number represented by a string.

FoundationLite
ParseLongInteger

Returns the long integer number represented by a string.

FoundationLite
SubtractIntegers

Computes the difference of two numbers.

FoundationLite
SubtractLongIntegers

Computes the difference of two Long numbers.

FoundationLite
TestIntegerEqualTo

Checks whether two integers are equal.

FoundationLite
TestIntegerGreaterOrEqual

Compares two integers with the >= operator.

FoundationLite
TestIntegerGreaterThan

Compares two integers with the > operator.

FoundationLite
TestIntegerInRange

Checks whether an integers is in the specified range.

FoundationLite
TestIntegerLessOrEqual

Compares two integers with the <= operator.

FoundationLite
TestIntegerLessThan

Compares two integers with the < operator.

FoundationLite
TestIntegerUnequalTo

Checks whether two integers are unequal.

FoundationLite
TestLongIntegerEqualTo

Checks whether two Long integers are equal.

FoundationLite
TestLongIntegerGreaterOrEqual

Compares two Long integers with the >= operator.

FoundationLite
TestLongIntegerGreaterThan

Compares two Long integers with the > operator.

FoundationLite
TestLongIntegerInRange

Checks whether Long integers is in the specified range.

FoundationLite
TestLongIntegerLessOrEqual

Compares two Long integers with the <= operator.

FoundationLite
TestLongIntegerLessThan

Compares two Long integers with the < operator.

FoundationLite
TestLongIntegerUnequalTo

Checks whether two Long integers are unequal.

FoundationLite

Location

Icon Name Description / Applications Modules
LocationCenter

Returns the center point of a pixel indicated by the provided location.

FoundationLite
TranslateLocation

Shifts a Location by a given number of pixels along each axis.

FoundationLite

Logic

Icon Name Description / Applications Modules
Iff

Returns True if (and only if) the input arguments are both True or both False.

FoundationLite
Not

Returns True if (and only if) the input argument is False.

FoundationLite
NotAnd

Returns True if (and only if) at least one of the arguments is False.

FoundationLite
NotOr

Returns True if (and only if) both arguments are False.

FoundationLite

Math

Icon Name Description / Applications Modules
Ceil

Computes the ceil of a number.

FoundationLite
Cosine

Computes the cosine of an angle.

FoundationLite
Cotangent

Computes the cotangent of an angle.

FoundationLite
Floor

Computes the floor of a number.

FoundationLite
Logarithm

Computes the logarithm of a number in a given base.

FoundationLite
Power

Computes the power of a number.

FoundationLite
Round

Computes rounded value of a number.

FoundationLite
Signum

Computes the sign of a number.

FoundationLite
Sine

Computes the sine of an angle.

FoundationLite
SquareRoot

Computes the square root of a number.

FoundationLite
Tangent

Computes the tangent of an angle.

FoundationLite

Matrix

Icon Name Description / Applications Modules
AccessMatrix

Returns matrix dimensions and its elements row-by-row as a real array.

FoundationLite
AddMatrices

Adds two matrices element by element.

FoundationLite
CombineMatrices

Combines two matrices horizontally.

FoundationLite
ConcatenateMatrices

Combines two matrices horizontally.

FoundationLite
CreateIdentityMatrix

Creates a square matrix with ones on the main diagonal, and zeros elsewhere.

FoundationLite
CreateUniformMatrix

Creates a matrix with the specified dimensions and filled with a uniform element value.

FoundationLite
GetMatrixColumn

Gets the values from a single column of a matrix.

FoundationLite
GetMatrixElement

Gets the value of a single element of a matrix.

FoundationLite
GetMatrixRow

Gets the values from a single row of a matrix.

FoundationLite
InvertMatrix

Finds the inverse of a square matrix.

FoundationLite
MakeMatrix

Creates a matrix of specified dimensions with initial elements given row-by-row.

FoundationLite
MatrixToRealArrayArray

Converts a matrix to an array of its rows.

FoundationLite
MultiplyMatrices

Multiplies two matrices element by element.

FoundationLite
MultiplyMatrixByReal

Multiplies all elements of a matrix by a value.

FoundationLite
SetMatrixColumn

Sets elements of a matrix column.

FoundationLite
SetMatrixElement

Sets a single element of a matrix.

FoundationLite
SetMatrixRow

Sets elements of a matrix row.

FoundationLite
SkipEmptyMatrix

If the input matrix dimensions are non-zero, then the matrix is copied to the output; otherwise Nil value is returned.


Secures against domain errors caused by empty matrices.

FoundationLite
StackMatrices

Combines two matrices vertically.

FoundationLite
SubtractMatrices

Subtracts two matrices element by element.

FoundationLite
TransposeMatrix

Swaps rows with columns in a matrix.

FoundationLite

Random

Icon Name Description / Applications Modules
CreateRandomArray

Creates array with random values.

FoundationLite
CreateRandomMatrix

Creates matrix with random values in closed interval.

FoundationLite
RandomInteger

Creates random integer value in given closed interval.

FoundationLite
RandomReal

Creates random real value in given closed interval.

FoundationLite
ShuffleArray

Creates an array by setting input array values in the random positions.

FoundationLite

Real

Icon Name Description / Applications Modules
AbsoluteReal

Computes the absolute value of a number.

FoundationLite
AverageDoubles

Returns the average of two doubles.

FoundationLite
AverageDoubles_OfArray

Returns the average value of doubles.

FoundationLite
AverageDoubles_OfArray_OrNil

Returns the average value of doubles; returns NIL if the array is empty.

FoundationLite
AverageDoubles_OfLoop

Returns the average of numbers appearing in consecutive iterations.

FoundationLite
AverageReals

Returns the average of two numbers.

FoundationLite
AverageReals_OfArray

Returns the average value of reals.

FoundationLite
AverageReals_OfArray_OrNil

Returns the average value of reals; returns NIL if the array is empty.

FoundationLite
AverageReals_OfLoop

Returns the average of numbers appearing in consecutive iterations.

FoundationLite
ClampDouble

Returns a value as close as possible to inValue, but in the specified range.

FoundationLite
ClampReal

Returns a value as close as possible to inValue, but in the specified range.

FoundationLite
CreateRealSequence

Creates an arithmetic sequence of real numbers.

FoundationLite
DivideDoubles

Computes the quotient of two numbers.

FoundationLite
DivideReals

Computes the quotient of two numbers.

FoundationLite
DoubleDifference

Computes the absolute value of two doubles difference.

FoundationLite
LerpReals

Linearly interpolates between two reals.

FoundationLite
MaximumDouble_OfArray

Returns the greatest value in an array of double numbers.

FoundationLite
MaximumDouble_OfArray_OrNil

Returns the greatest value in an array of double numbers; returns NIL if the array is empty.

FoundationLite
MaximumDouble_OfLoop

Returns the greatest of numbers appearing in consecutive iterations.

FoundationLite
MaximumReal

Returns the higher of two numbers.

FoundationLite
MaximumReal_OfArray

Returns the greatest value in an array of real numbers.

FoundationLite
MaximumReal_OfArray_OrNil

Returns the greatest value in an array of real numbers; returns NIL if the array is empty.

FoundationLite
MaximumReal_OfLoop

Returns the greatest of numbers appearing in consecutive iterations.

FoundationLite
MinimumDouble_OfArray

Returns the smallest value in an array of double numbers.

FoundationLite
MinimumDouble_OfArray_OrNil

Returns the smallest value in an array of double numbers; returns NIL if the array is empty.

FoundationLite
MinimumDouble_OfLoop

Returns the smallest of numbers appearing in consecutive iterations.

FoundationLite
MinimumReal

Returns the lower of two numbers.

FoundationLite
MinimumReal_OfArray

Returns the smallest value in an array of real numbers.

FoundationLite
MinimumReal_OfArray_OrNil

Returns the smallest value in an array of real numbers; returns NIL if the array is empty.

FoundationLite
MinimumReal_OfLoop

Returns the smallest of numbers appearing in consecutive iterations.

FoundationLite
NegateReal

Computes the negation of a number.

FoundationLite
ParseDouble

Returns the double number represented by a string.

FoundationLite
ParseReal

Returns the real number represented by a string.

FoundationLite
RealDifference

Computes the absolute value of two numbers difference.

FoundationLite
SubtractDoubles

Computes the difference of two doubles.

FoundationLite
SubtractReals

Computes the difference of two numbers.

FoundationLite
TestDoubleEqualTo

Checks whether two doubles are equal.

FoundationLite
TestDoubleGreaterOrEqual

Compares two doubles with the >= operator.

FoundationLite
TestDoubleGreaterThan

Compares two doubles with the > operator.

FoundationLite
TestDoubleInRange

Checks whether a double value is in the specified range.

FoundationLite
TestDoubleLessOrEqual

Compares two doubles with the <= operator.

FoundationLite
TestDoubleLessThan

Compares two doubles with the < operator.

FoundationLite
TestDoubleUnequalTo

Checks whether two doubles are unequal.

FoundationLite
TestRealEqualTo

Checks whether two reals are equal.

FoundationLite
TestRealGreaterOrEqual

Compares two reals with the >= operator.

FoundationLite
TestRealGreaterThan

Compares two reals with the > operator.

FoundationLite
TestRealInRange

Checks whether a real value is in the specified range.

FoundationLite
TestRealLessOrEqual

Compares two reals with the <= operator.

FoundationLite
TestRealLessThan

Compares two reals with the < operator.

FoundationLite
TestRealUnequalTo

Checks whether two reals are unequal.

FoundationLite

Statistics

Icon Name Description / Applications Modules
AccessLinearFunction

Returns coefficients of a linear function.

FoundationLite
Average

Computes the average of an array of real numbers. The array must be not empty.

FoundationLite
MakeLinearFunction

Creates a linear function with given coefficients.

FoundationLite
Median

Computes the median of an array of real numbers. The array must be not empty. Optional weights, when supplied, must be positive.

FoundationLite
NthValue

Computes n-th smallest value in an array (0-indexed). The array must be not empty.

FoundationLite
PearsonCorrelation

Computes Pearson product-moment correlation coefficient. The array must be not empty.

FoundationLite
Quantile

Computes the specified quantile of an array of real numbers. The array must be not empty.

FoundationLite
StandardDeviation

Computes the standard deviation of an array of real numbers. The array must be not empty.

FoundationLite
Variance

Computes the variance of an array of real numbers. The array must be not empty.

FoundationLite

String

Icon Name Description / Applications Modules
ConcatenateStrings_OfArray

Joins multiple strings into a single one.

FoundationLite
EraseString

Removes a part of a string.

FoundationLite
FindInString

Finds first occurrence of a substring in the input string.

FoundationLite
FindLastInString

Finds last occurrence of a substring in the input string.

FoundationLite
FormatDoubleToString

Creates a string from a double number using a proper format.


Useful for preparing a number for display or communication with specific number of fractional digits, sign etc.

FoundationLite
FormatIntegerToString

Creates a string from an integer number using a proper format.


Useful for preparing a number for display or communication with specific number of digits, sign etc.

FoundationLite
FormatRealToString

Creates a string from a real number using a proper format.


Useful for preparing a number for display or communication with specific number of fractional digits, sign etc.

FoundationLite
FormatString

Creates a string according to the given format and data.

FoundationLite
InsertToString

Inserts a string into another one at the given position.

FoundationLite
LoadText

Loads a text from a file.

FoundationLite
LoadTextLines

Loads text lines from a file.

FoundationLite
NumericCodesToString

Converts an integer array of character codes (UTF-16) into a string.

FoundationLite
PadString

Extends a string if it is too short.

FoundationLite
RegexReplaceInString

Replaces all matching occurrences of the pattern with a replacement string. Uses ECMAScript regular expression grammar (https://en.cppreference.com/w/cpp/regex/ecmascript).

FoundationLite
RegexSearchInString

Finds all occurrences of the pattern in the input string. Uses ECMAScript regular expression grammar (https://en.cppreference.com/w/cpp/regex/ecmascript).

FoundationLite
ReplaceInString

Replaces all occurrences of the searched string with a replacement string.

FoundationLite
SaveText

Saves a text to a file.

FoundationLite
SaveTextLines

Saves text lines to a file.

FoundationLite
SkipEmptyString

If the input string has at least one character, it is copied to the output; otherwise NIL is returned.


Used before operations that given an empty string would raise a domain error.

FoundationLite
SplitString

Divides the input string into an array of strings using the specified delimiters.

FoundationLite
SplitStringIntoCharacters

Splits the input string into individual characters.

FoundationLite
StringLength

Returns the number of characters in a string.

FoundationLite
StringToLowerCase

Makes a string lowercase.

FoundationLite
StringToNumericCodes

Converts string to an integer array of character codes (UTF-16).

FoundationLite
StringToUpperCase

Makes a string uppercase.

FoundationLite
Substring

Creates a string from a fragment of the input string.

FoundationLite
TestStringEarlierThan

Checks whether the input string is earlier alphabetically than a reference string.

FoundationLite
TestStringEmpty

Tests whether the length of a string equals zero.

FoundationLite
TestStringEqualTo

Compares two strings character by character.

FoundationLite
TestStringUnequalTo

Compares two strings character by character.

FoundationLite

Unit Conversions

Icon Name Description / Applications Modules
DegreesToRadians

Converts degrees to radians.

FoundationLite
MillimetresToPixels

Converts a length in millimetres to pixels using the given scale [px / mm].

FoundationLite
PixelsToMillimetres

Converts a length in pixels to millimetres using the given scale [px / mm].

FoundationLite
RadiansToDegrees

Converts radians to degrees.

FoundationLite