Data Types
AnnotatedPoint2D
A two-dimensional point in the Cartesian system with grid indices (used for Calibration patterns).
Type variations : AnnotatedPoint2DArray, AnnotatedPoint2DArrayArray, AnnotatedPoint2DNull, AnnotatedPoint2DNullArray, AnnotatedPoint2DNullArrayArray
Properties
| Name | Type | Description |
|---|---|---|
| Point | Point2D | Point. |
| Annotation | Point2D | Annotation connected to the point. |
Arc2D
A two-dimensional arc represented in the Cartesian system.
Type variations : Arc2DArray, Arc2DArrayArray, Arc2DNull, Arc2DNullArray, Arc2DNullArrayArray
Properties
| Name | Type | Description |
|---|---|---|
| Center | Point2D | Center. |
| Radius | Float | Radius. |
| StartAngle | Float | Start angle. |
| SweepAngle | Float | Sweep angle. |
ArcFittingField
Describes an arc-shaped area used to create an ArcFittingMap.
Type variations : ArcFittingFieldArray, ArcFittingFieldArrayArray, ArcFittingFieldNull, ArcFittingFieldNullArray, ArcFittingFieldNullArrayArray
Properties
| Name | Type | Description |
|---|---|---|
| Axis | Arc2D | Base shape of the fitting field. |
| Width | Float | Width along the axis transversal direction. |
ArcFittingMap
Arc-shaped map typically used to fit arcs to points acquired through edge detection.
Type variations : ArcFittingMapArray, ArcFittingMapArrayArray, ArcFittingMapNull, ArcFittingMapNullArray, ArcFittingMapNullArrayArray
Barcode
Holds information about barcode: its position, format and text which is encoded.
Type variations : BarcodeArray, BarcodeArrayArray, BarcodeNull, BarcodeNullArray, BarcodeNullArrayArray
Properties
| Name | Type | Description |
|---|---|---|
| Position | Rectangle2D | Position of found barcode. |
| Text | String | Decoded text of barcode. |
| Format | Enum < BarcodeFormat > | Barcode format. |
BlobSplittingParams
Groups all the parameters used to segment an image into blobs.
Type variations : BlobSplittingParamsArray, BlobSplittingParamsArrayArray, BlobSplittingParamsNull, BlobSplittingParamsNullArray, BlobSplittingParamsNullArrayArray
Properties
| Name | Type | Description |
|---|---|---|
| Connectivity | Enum < RegionConnectivity > | Type of connectivity used for splitting region into blobs. |
| MinArea | Int | Minimal area of a resulting blob. Range 〔0, +inf〕. |
| MaxArea | Int | Maximal area of a resulting blob, Range 〔-1, +inf〕. In negative, the value is neglected. |
| RemoveBoundaryBlobs | Bool | If true, the blobs touching the region boundary will be removed. |
Bool
Represents a Boolean value (true / false)
Type variations : BoolArray, BoolArrayArray, BoolNull, BoolNullArray, BoolNullArrayArray
Box
A discrete, axis-aligned, rectangular region.
Type variations : BoxArray, BoxArrayArray, BoxNull, BoxNullArray, BoxNullArrayArray
Properties
| Name | Type | Description |
|---|---|---|
| X | Int | X coordinate of top-left corner. |
| Y | Int | Y coordinate of top-right corner. |
| Width | Int | Width of the rectangular region. Range: 〔0, +inf）. |
| Height | Int | Height of the rectangular region. Range: 〔0, +inf）. |
Buffer
A pointer to memory location.It can be used to serialize / deserialized objects and work with binary data
Type variations : BufferArray, BufferArrayArray, BufferNull, BufferNullArray, BufferNullArrayArray
Byte
Represents an 8-bit unsigned integer
Type variations : ByteArray, ByteArrayArray, ByteNull, ByteNullArray, ByteNullArrayArray
CalibrationMap
Represents the output of a calibration function, extending the ImageMap but containing also the pixel resolution.
Type variations : CalibrationMapArray, CalibrationMapArrayArray, CalibrationMapNull, CalibrationMapNullArray, CalibrationMapNullArrayArray
Properties
| Name | Type | Description |
|---|---|---|
| UM_ON_PIXEL | PixelResolution | Resolution in unit measure per pixel （the same specified in FeatureStep during calibration）. |
CalibrationParams
Parameters for calibrate().
Type variations : CalibrationParamsArray, CalibrationParamsArrayArray, CalibrationParamsNull, CalibrationParamsNullArray, CalibrationParamsNullArrayArray
Properties
| Name | Type | Description |
|---|---|---|
| CameraModel | Enum < CameraCalibration > | Camera model. |
| OptimizeCenter | Bool | Whether to optimize the input center. |
| TelecentricCalibrationMode | Enum < CalibrationMode > | Telecentric calibration mode. |
CalibrationTransform
Calibration transform used to move geometric figures from/to image/world coordinates.
Type variations : CalibrationTransformArray, CalibrationTransformNull, CalibrationTransformNullArray
CameraCalibrationModel
Class containing a generic camera calibration model.
Type variations : CameraCalibrationModelArray, CameraCalibrationModelArrayArray, CameraCalibrationModelNull, CameraCalibrationModelNullArray, CameraCalibrationModelNullArrayArray
Char
Represents a character as a UTF-16 code unit
Type variations : CharArray, CharArrayArray, CharNull, CharNullArray, CharNullArrayArray
CharacterSample
A pair composed by the character representation (as a Region) and its corresponding text (as a string). Note: This object can be created in groups using the function makeCharacterSamples().
Type variations : CharacterSampleArray, CharacterSampleArrayArray, CharacterSampleNull, CharacterSampleNullArray, CharacterSampleNullArrayArray
Properties
| Name | Type | Description |
|---|---|---|
| Character | String | Single character describing the region. |
| Sample | Region | Graphical representation of the character. |
Circle2D
The 2D representation of a circle on the Cartesian system.
Type variations : Circle2DArray, Circle2DArrayArray, Circle2DNull, Circle2DNullArray, Circle2DNullArrayArray
Properties
| Name | Type | Description |
|---|---|---|
| Center | Point2D | Center of the circle. |
| Radius | Float | Radius of the circle. Range: 〔0, +inf）. |
CircleFittingField
Describes a circle-shaped area used to create a CircleFittingMap.
Type variations : CircleFittingFieldArray, CircleFittingFieldArrayArray, CircleFittingFieldNull, CircleFittingFieldNullArray, CircleFittingFieldNullArrayArray
Properties
| Name | Type | Description |
|---|---|---|
| Axis | Circle2D | Base shape of the fitting field. |
| Width | Float | Width along the axis transversal direction. |
CircleFittingMap
Circle-shaped map typically used to fit circles to points acquired through edge detection.
Type variations : CircleFittingMapArray, CircleFittingMapArrayArray, CircleFittingMapNull, CircleFittingMapNullArray, CircleFittingMapNullArrayArray
ColorThresholdParams
Groups all the parameters used to perform a color-based thresholding.
Type variations : ColorThresholdParamsArray, ColorThresholdParamsArrayArray, ColorThresholdParamsNull, ColorThresholdParamsNullArray, ColorThresholdParamsNullArrayArray
Properties
| Name | Type | Description |
|---|---|---|
| RgbColor | Pixel | Color to compare the image to. |
| ChromaAmount | Float | Proportion of chromatic information in distance computation. Range 〔0, 1〕. |
| MaxDifference | Float | Maximum difference between image pixel and model color. Range 〔0, +inf〕. |
| Hysteresis | Float | Defines how much the threshold criterion is lowered for pixels neighboring with other foreground pixels. Range 〔0, +inf〕. |
CUDAProviderOptions
Options for configuring the CUDA execution provider in ONNX runtime.
Type variations : CUDAProviderOptionsArray, CUDAProviderOptionsArrayArray, CUDAProviderOptionsNull, CUDAProviderOptionsNullArray, CUDAProviderOptionsNullArrayArray
Properties
| Name | Type | Description |
|---|---|---|
| GpuMemoryLimit | UInt64 | Maximum GPU memory （in bytes） allowed for allocation. |
| ArenaExtendStrategy | Int | Strategy used to extend memory arenas. |
| DoCopyInDefaultStream | Bool | Whether to perform memory copy operations on the default CUDA stream. |
| EnableTunableOp | Bool | Enable support for tunable operators. |
| EnableTunableOpTuning | Bool | Enable support for tunable operators. |
| TunableOpMaxTuningDurationMs | Int | Maximum allowed tuning duration for tunable operators （in milliseconds） |
DataCode
Holds information about a data code: its position and decoded text.
Type variations : DataCodeArray, DataCodeArrayArray, DataCodeNull, DataCodeNullArray, DataCodeNullArrayArray
Properties
| Name | Type | Description |
|---|---|---|
| Position | Path | Data code position. |
| Text | String | Decoded text. |
| Center | Point2D | Center of data code. |
DataModel
Class containing a machine learning model.
Type variations : DataModelArray, DataModelArrayArray, DataModelNull, DataModelNullArray, DataModelNullArrayArray
DataModel_KNN
Class containing a K-Nearest Neighbors model.
Type variations : DataModel_KNNArray, DataModel_KNNArrayArray, DataModel_KNNNull, DataModel_KNNNullArray, DataModel_KNNNullArrayArray
DataModel_MLP
Class containing a Multi-Layer Perceptron model.
Type variations : DataModel_MLPArray, DataModel_MLPArrayArray, DataModel_MLPNull, DataModel_MLPNullArray, DataModel_MLPNullArrayArray
DataModel_SVM
Class containing a Support Vector Machine model.
Type variations : DataModel_SVMArray, DataModel_SVMArrayArray, DataModel_SVMNull, DataModel_SVMNullArray, DataModel_SVMNullArrayArray
Dataset
Dataset containing features, classes and labels useful for classification purpose. Note: It can also manage the splitting into training and testing sets.
Type variations : DatasetNull
Properties
| Name | Type | Description |
|---|---|---|
| FEATURES | FloatArrayArray | All samples, each described by an array of features. |
| CLASSES | IntArray | Corresponding classes for each of the samples （can be empty） |
| LABELS | StringArray | Labels for every existing class （can be empty） |
| HEADER | StringArray | Header of the CSV file, excluding the class column （can be empty） |
DimensionGeometry
Describes geometry data that can be used when drawing a 2D shape dimension.The struct stores the list of points, the label position and text data
Type variations : DimensionGeometryArray, DimensionGeometryArrayArray
DimensionTolerance
Describes a tolerance for dimension.Two format types can be used: Nominal +/- Tolerance or Range[Min - Max].
Type variations : DimensionToleranceArray, DimensionToleranceArrayArray
Double
Represents a double precision floating-point number
Type variations : DoubleArray, DoubleArrayArray, DoubleNull, DoubleNullArray, DoubleNullArrayArray
DrawingStyle
Defines the style of objects to be drawn on an image.
Type variations : DrawingStyleArray, DrawingStyleArrayArray, DrawingStyleNull, DrawingStyleNullArray, DrawingStyleNullArrayArray
Properties
| Name | Type | Description |
|---|---|---|
| Thickness | Int | Line thickness. Range: 〔1, +inf）. |
| Filled | Bool | Whether to fill the object or not. |
DynamicEnum
Allows to select a string value from a defined collection.
DynamicThresholdParams
Groups all the parameters used to perform dynamic thresholding.
Type variations : DynamicThresholdParamsArray, DynamicThresholdParamsArrayArray, DynamicThresholdParamsNull, DynamicThresholdParamsNullArray, DynamicThresholdParamsNullArrayArray
Properties
| Name | Type | Description |
|---|---|---|
| Radius | Int | Radius of dynamic threshold internal blur. Range 〔0, +inf〕. |
| MinRelativeValue | Float | Minimal relative value of a pixel that is considered foreground. Range 〔0, +inf〕. If negative, the parameter is neglected. |
| MaxRelativeValue | Float | Maximal relative value of a pixel that is considered foreground. Range 〔-1, +inf〕. If negative, the parameter is neglected. |
| Hysteresis | Float | Defines how much the threshold criteria are lowered for pixels neighboring with other foreground pixels. Range 〔0, +inf〕. |
Edge1D
Groups all the parameters used to describe an edge found during the 1D scanning process.
Type variations : Edge1DArray, Edge1DArrayArray, Edge1DNull, Edge1DNullArray, Edge1DNullArrayArray
Properties
| Name | Type | Description |
|---|---|---|
| Position | Float | Position of the edge on the brightness profile. |
| Magnitude | Float | Magnitude of the edge. |
| Transition | Enum < EdgeTransition > | Type of transition the edge is describing. |
| Point | Point2D | Position of the edge on the image. |
EdgeScanParams
Groups all the parameters used to control the edge scanning process.
Type variations : EdgeScanParamsArray, EdgeScanParamsArrayArray, EdgeScanParamsNull, EdgeScanParamsNullArray, EdgeScanParamsNullArrayArray
Properties
| Name | Type | Description |
|---|---|---|
| ProfileInterpolation | Enum < InterpolationMethod1D > | Sub-pixel edge detection method. |
| SmoothingStdDev | Float | Gaussian smoothing of the brightness profile. Range 〔0, +inf〕. |
| MinMagnitude | Float | Minimum acceptable edge strength. Range 〔0, +inf〕. |
| EdgeTransition | Enum < EdgeTransition > | Type of transition that will be detected. |
Ellipse2D
The 2D representation of an ellipse on the Cartesian system.
Type variations : Ellipse2DArray, Ellipse2DArrayArray, Ellipse2DNull, Ellipse2DNullArray, Ellipse2DNullArrayArray
Properties
| Name | Type | Description |
|---|---|---|
| Center | Point2D | Ellipse center point. |
| Angle | Float | Orientation angle 〔deg〕. |
| Width | Float | Ellipse width. Range: 〔0, +inf）. |
| Height | Float | Ellipse height. Range: 〔0, +inf）. |
Enum
Represents a generic enumerated value
Type variations : EnumArray, EnumArrayArray, EnumNull, EnumNullArray, EnumNullArrayArray
ErrorState
Identifies an error state providing useful informations about the error message and its code.
Properties
| Name | Type | Description |
|---|---|---|
| ERROR_CODE | Int | The error code associated with the current error state. 0 indicates no error. |
| ERROR_MESSAGE | String | The error message associated with the current error state. |
Extremum1D
Represent the extremum found in a Profile. Note: Can be found as the output of Profile::getLocalExtrema.
Type variations : Extremum1DArray, Extremum1DArrayArray, Extremum1DNull, Extremum1DNullArray, Extremum1DNullArrayArray
Properties
| Name | Type | Description |
|---|---|---|
| Index | Int | Index. |
| Coordinate | Float | X coordinate. |
| Value | Float | Value. |
| Type | Enum < ExtremumType > | Type of extremum （maximum or minimum） |
Extremum2D
An extremum found in an image. Note: Represents the output of functions like Image::getLocalMinima or Image::getLocalMaxima.
Type variations : Extremum2DArray, Extremum2DArrayArray, Extremum2DNull, Extremum2DNullArray, Extremum2DNullArrayArray
Properties
| Name | Type | Description |
|---|---|---|
| Point | Point2D | Position with subpixel-precision. |
| Value | Float | Value. |
| Polarity | Enum < Polarity > | Polarity （a dark pixel if the extremum represents a minimum, a bright one otherwise）. |
FittingMap
Class used as a base for all the specialized fitting maps. Note: This class should not be used directly. Only use the derived classes.
Type variations : FittingMapArray, FittingMapArrayArray, FittingMapNull, FittingMapNullArray, FittingMapNullArrayArray
Float
Represents a single precision floating-point number
Type variations : FloatArray, FloatArrayArray, FloatNull, FloatNullArray, FloatNullArrayArray
Gap1D
Groups all the parameters used to describe a gap between two 1D structures.
Type variations : Gap1DArray, Gap1DArrayArray, Gap1DNull, Gap1DNullArray, Gap1DNullArrayArray
Properties
| Name | Type | Description |
|---|---|---|
| Point1 | Point2D | Starting point of the gap. |
| Point2 | Point2D | Ending point of the gap. |
| Width | Float | Distance between the two points. |
GenICamParameter
Identifies a GenICam parameter, filtered by specified NodeTypes
Type variations : GenICamParameterArray, GenICamParameterArrayArray
Histogram
Represents the distribution of a numeric variable's values. Note: It is made by: - an array of numeric values (representing the frequency in every bin), - the domain start that represents the lowest value for which frequency is measured, - the bin size that determines the width of every histogram's bin.
Type variations : HistogramArray, HistogramNull, HistogramNullArray
Properties
| Name | Type | Description |
|---|---|---|
| DomainStart | Float | Start value. |
| BinSize | Float | Bin size. |
| BinCount | Int | Number of bins. Range: 〔1, +inf）. |
| Values | DoubleArray | Default value for all bins. |
HistogramExtremum
An extremum found in a histogram. Note: Contains the output of functions like Histogram::getLocalExtrema.
Type variations : HistogramExtremumArray, HistogramExtremumArrayArray, HistogramExtremumNull, HistogramExtremumNullArray, HistogramExtremumNullArrayArray
Properties
| Name | Type | Description |
|---|---|---|
| Index | Int | Index of the histogram's array. |
| Point | Float | Subpixel position. |
| Value | Double | Value. |
| Type | Enum < ExtremumType > | Extremum type. |
HttpClient
Allow to send and receive messages in string or binary format using HTTP protocol
Type variations : HttpClientArray, HttpClientArrayArray
IEnumerable
Exposes the enumerator, which supports a simple iteration over a collection of a specified type.
Image
Represent an image as a two-dimensional grid of pixels. Note: Supports both monochromatic and multichannel images with 6 possible pixel types (UInt8, Int8, UInt16, Int16, Int32 or Float) and several channels varying from 1 to 4.
Type variations : ImageArray, ImageArrayArray, ImageNull, ImageNullArray, ImageNullArrayArray
Properties
| Name | Type | Description |
|---|---|---|
| WIDTH | Int | Width of the image. Range: 〔0, +inf）. |
| HEIGHT | Int | Height of the image. Range: 〔0, +inf）. |
| CHANNELS | Int | Number of inChannels. Range: 〔1, 4〕. |
| TYPE | Enum < ImageType > | Pixel type. |
| IS_EMPTY | Bool | Gets if the image is empty （i.e. Width=0, Height=0） |
ImageFormat
Stores information about dimensions and pixel format of an image.
Type variations : ImageFormatArray, ImageFormatArrayArray, ImageFormatNull, ImageFormatNullArray, ImageFormatNullArrayArray
Properties
| Name | Type | Description |
|---|---|---|
| Width | Int | Image width. |
| Height | Int | Image height. |
| Type | Enum < PixelType > | Type of pixel components. |
| Depth | Int | Number of pixel components. |
ImageMap
ImageMap class.
Type variations : ImageMapArray, ImageMapArrayArray, ImageMapNull, ImageMapNullArray, ImageMapNullArrayArray
Int
Represents a 32-bit signed integer
Type variations : IntArray, IntArrayArray, IntNull, IntNullArray, IntNullArrayArray
Int16
Represents a 16-bit signed integer
Type variations : Int16Array, Int16ArrayArray, Int16Null, Int16NullArray, Int16NullArrayArray
Int64
Represents a 64-bit signed integer
Type variations : Int64Array, Int64ArrayArray, Int64Null, Int64NullArray, Int64NullArrayArray
IntensityThresholdParams
Groups all the parameters used to perform intensity thresholding.
Type variations : IntensityThresholdParamsArray, IntensityThresholdParamsArrayArray, IntensityThresholdParamsNull, IntensityThresholdParamsNullArray, IntensityThresholdParamsNullArrayArray
Properties
| Name | Type | Description |
|---|---|---|
| MinIntensity | Float | Minimal intensity of a pixel that is considered foreground. Range 〔0, +inf〕. If negative, the parameter is neglected. |
| MaxIntensity | Float | Maximal intensity of a pixel that is considered foreground. Range 〔-1, +inf〕. If negative, the parameter is neglected. |
| Hysteresis | Float | Defines how much the threshold criteria are lowered for pixels neighboring with other foreground pixels |
Interval
Range of values.
Type variations : IntervalArray, IntervalArrayArray, IntervalNull, IntervalNullArray, IntervalNullArrayArray
Properties
| Name | Type | Description |
|---|---|---|
| Begin | Float | The interval's starting value. |
| End | Float | The interval's ending value. |
JoiningParams
Groups all the parameters used to control the joining process of nearby Path objects.
Type variations : JoiningParamsArray, JoiningParamsArrayArray, JoiningParamsNull, JoiningParamsNullArray, JoiningParamsNullArrayArray
Properties
| Name | Type | Description |
|---|---|---|
| MaxDistance | Float | Edges with a distance bigger than this value will not be joined. Range 〔0, +inf〕. |
| MaxAngle | Float | Edges creating an angle bigger than this value will not be joined. Range 〔0, +inf〕. |
| EdgeEndingLength | Int | Range 〔1, +inf〕. |
Line2D
The 2D representation of a straight line on the Cartesian system. Note: The line is described using the general form Ax + By + C = 0. In addition, the coefficients are normalized so that their squared sum is 1.
Type variations : Line2DArray, Line2DArrayArray, Line2DNull, Line2DNullArray, Line2DNullArrayArray
Properties
| Name | Type | Description |
|---|---|---|
| A | Float | A coefficient of the general form. |
| B | Float | B coefficient of the general form. |
| C | Float | C coefficient of the general form. |
LocalBlindness
Contains parameters used in the 1D scanning process to prevent the detection of weak edges in the vicinity of stronger ones.
Type variations : LocalBlindnessArray, LocalBlindnessArrayArray, LocalBlindnessNull, LocalBlindnessNullArray, LocalBlindnessNullArrayArray
Properties
| Name | Type | Description |
|---|---|---|
| Radius | Float | Blindness radius, in the range 〔0,+inf〕. Set to -1 equals +inf. |
| Threshold | Float | The fraction of a strong edge magnitude that a weaker edge needs to be detected. Range 〔0, 1〕. |
| Fuzziness | Float | Decreases effective threshold linearly from 'Threshold' at distance 'Radius - Radius * Fuzziness' to zero at distance 'Radius + Radius * Fuzziness'. Range 〔0, 1〕. |
Matrix
A two-dimensional array of real numbers (float). Note: A Matrix can be used for example for image convolution (Image::convolve) or a more generic transformation (Image::transform).
Type variations : MatrixArray, MatrixNull, MatrixNullArray
Properties
| Name | Type | Description |
|---|---|---|
| Rows | Int | Number of rows. Range: 〔0, +inf）. |
| Cols | Int | Number of columns. Range: 〔0, +inf）. |
| Data | FloatArray | Data pointer. |
Model_Edge
Template model, used to find similar objects during (edge-based) template matching.
Type variations : Model_EdgeArray, Model_EdgeArrayArray, Model_EdgeNull, Model_EdgeNullArray, Model_EdgeNullArrayArray
Model_NCC
Template model, used to find similar objects during (NCC-based) template matching.
Type variations : Model_NCCArray, Model_NCCArrayArray, Model_NCCNull, Model_NCCNullArray, Model_NCCNullArrayArray
ModelParams_Edge
Parameters for model creating in edge-based template matching.
Type variations : ModelParams_EdgeArray, ModelParams_EdgeArrayArray, ModelParams_EdgeNull, ModelParams_EdgeNullArray, ModelParams_EdgeNullArrayArray
Properties
| Name | Type | Description |
|---|---|---|
| SmoothingStdDev | Float | Standard deviation of the gaussian smoothing applied before edge extraction. Range: 〔0, +inf）. |
| MinPyramidLevel | Int | Index of the lowest reduced resolution level （used to speed up computations）. Range: 〔0, 12〕. |
| MinEdgeThreshold | Float | Lower threshold for edge magnitude. Range: （-inf, +inf）. |
| MaxEdgeThreshold | Float | Higher threshold for edge magnitude. Range: （-inf, +inf）. |
| EdgeCompleteness | Float | What fraction of the edges will be present in the created model. Range: 〔0.01, 1〕. |
| MinAngle | Float | Start of range of possible rotations. Range: （-inf, +inf）. |
| MaxAngle | Float | End of range of possible rotations. Range: （-inf, +inf）. |
| AngleStep | Float | Angular step in the matching process. Range: 〔0.0001, +inf〕. |
| MinScale | Float | Start of range of possible scales. Range: （0, +inf）. |
| MaxScale | Float | End of range of possible scales. Range: （0, +inf）. |
| ScaleStep | Float | Scale step in the matching process. Range: 〔0.0001, +inf〕. |
ModelParams_NCC
Parameters for model creation in NCC-based template matching.
Type variations : ModelParams_NCCArray, ModelParams_NCCArrayArray, ModelParams_NCCNull, ModelParams_NCCNullArray, ModelParams_NCCNullArrayArray
Properties
| Name | Type | Description |
|---|---|---|
| MinPyramidLevel | Int | Index of the lowest reduced resolution level （used to speed up computations）. Range: 〔0, 12〕. |
| MaxPyramidLevel | Int | Number of reduced resolution levels （used to speed up computations） （max 12）. Range: 〔0, 12〕. |
| MinAngle | Float | Start of range of possible rotations. Range: （-inf, +inf）. |
| MaxAngle | Float | End of range of possible rotations. Range: （-inf, +inf）. |
| AnglePrecision | Float | Angular precision in the matching process. Range: 〔0.001, +inf〕. |
| MinScale | Float | Start of range of possible scales. Range: （0, +inf）. |
| MaxScale | Float | End of range of possible scales. Range: （0, +inf）. |
| ScalePrecision | Float | Scale precision in the matching process. Range: 〔0.001, +inf〕. |
OCR_MLP_Model
Model using Artificial Neural Networks.
Type variations : OCR_MLP_ModelNull, OCR_MLP_ModelNullArray, OCR_MLP_ModelNullArrayArray, OCR_MLP_ModelArray, OCR_MLP_ModelArrayArray
OCR_Model
Class containing OCR model data used to recognize text.
Type variations : OCR_ModelNull, OCR_ModelNullArray, OCR_ModelNullArrayArray, OCR_ModelArray, OCR_ModelArrayArray
OCR_SVM_Model
Model using Support Vector Machines.
Type variations : OCR_SVM_ModelNull, OCR_SVM_ModelNullArray, OCR_SVM_ModelNullArrayArray, OCR_SVM_ModelArray, OCR_SVM_ModelArrayArray
OnnxModel
ONNX Model.
Type variations : OnnxModelArray, OnnxModelArrayArray
OnnxModelConfig
Configuration settings for ONNX models.
Type variations : OnnxModelConfigArray, OnnxModelConfigArrayArray
OPCUANamespace
Identifies a OPCUA namespace
Type variations : OPCUANamespaceArray, OPCUANamespaceArrayArray
Path
Path struct, based on an Array of Point2D.
Type variations : PathNull, PathNullArray, PathNullArrayArray, PathArray, PathArrayArray
PathFile
Identifies a path in file system which can be a file or folder and defines also the operation type (Load/Save)
PathFittingField
Describes a path-shaped area used to create a PathFittingMap.
Type variations : PathFittingFieldNull, PathFittingFieldNullArray, PathFittingFieldNullArrayArray, PathFittingFieldArray, PathFittingFieldArrayArray
Properties
| Name | Type | Description |
|---|---|---|
| Axis | Path | Base shape of the fitting field. |
| Width | Float | Width along the axis transversal direction. |
PathFittingMap
Path-shaped map typically used to fit paths to points acquired through edge detection.
Type variations : PathFittingMapNull, PathFittingMapNullArray, PathFittingMapNullArrayArray, PathFittingMapArray, PathFittingMapArrayArray
PatternFinderParams
Parameters for findCalibrationPatterns().
Type variations : PatternFinderParamsNull, PatternFinderParamsNullArray, PatternFinderParamsNullArrayArray, PatternFinderParamsArray, PatternFinderParamsArrayArray
Properties
| Name | Type | Description |
|---|---|---|
| Type | Enum < PatternFinder > | Pattern type. |
| FeatureStep | Float | Pattern features step. |
| Tolerance | Float | Tolerance. |
| MinGaussianScore | Float | Minimum Gaussian score. |
| FeatureQuality | Float | Corner quality level. Decrease it for lowering the detection threshold, but consider it may lead to slower performances. Range: 〔0,1〕. |
| FeatureMinDistance | Float | Minimum distance between found features （in image coordinates） |
| MarkerStep | Float | ChArUco marker step. |
| CharucoBoardSize | Size | Size of the ChArUco board. |
| Dictionary | Enum < CharucoDictionary > | ChArUco dictionary. |
Pixel
Pixel of an Image, containing 4 floating-point values.
Type variations : PixelNull, PixelNullArray, PixelNullArrayArray, PixelArray, PixelArrayArray
Properties
| Name | Type | Description |
|---|---|---|
| X | Float | Value of the first pixel component. |
| Y | Float | Value of the second pixel component. |
| Z | Float | Value of the third pixel component. |
| A | Float | Value of the fourth pixel component. |
PixelFormat
Represents how the color information for a pixel is stored in memory. Note: It includes the pixel type (the bits occupied in memory) and the number of channels.
Type variations : PixelFormatNull, PixelFormatNullArray, PixelFormatNullArrayArray, PixelFormatArray, PixelFormatArrayArray
Properties
| Name | Type | Description |
|---|---|---|
| Type | Enum < PixelType > | Type of pixel （UInt8, Int8, UInt16, Int16, Int32 or Float）. |
| Channels | Int | Number of channels. Range: 〔1, 4〕. |
PixelLUT
Pixel LookUpTable.
Type variations : PixelLUTNull, PixelLUTNullArray, PixelLUTNullArrayArray, PixelLUTArray, PixelLUTArrayArray
Properties
| Name | Type | Description |
|---|---|---|
| Rows | Int | Number of rows. Range: 〔1, +inf）. |
| InputType | Enum < PixelType > | Input pixel type （defines the number of columns）. |
| OutputType | Enum < PixelType > | Output pixel type. |
PixelResolution
Represents a single-precision floating point specifically used to define pixel resolution with camera calibration
Type variations : PixelResolutionArray, PixelResolutionArrayArray, PixelResolutionNull, PixelResolutionNullArray, PixelResolutionNullArrayArray
Point2D
A two-dimensional point in the Cartesian system.
Type variations : Point2DNull, Point2DNullArray, Point2DNullArrayArray, Point2DArray, Point2DArrayArray
Properties
| Name | Type | Description |
|---|---|---|
| X | Float | X coordinate. |
| Y | Float | Y coordinate. |
Point2Di
A 2D point in the discrete space. Note: Typically used to identify pixel position inside an Image.
Type variations : Point2DiNull, Point2DiNullArray, Point2DiNullArrayArray, Point2DiArray, Point2DiArrayArray
Properties
| Name | Type | Description |
|---|---|---|
| X | Int | X coordinate. |
| Y | Int | Y coordinate. |
PointsSequence
Compressed representation of a contiguous series of points with the same y coordinate.
Type variations : PointsSequenceNull, PointsSequenceNullArray, PointsSequenceNullArrayArray, PointsSequenceArray, PointsSequenceArrayArray
Properties
| Name | Type | Description |
|---|---|---|
| X | Int | X coordinate of the starting point. |
| Y | Int | Y coordinate. |
| L | Int | Sequence length. Range: 〔0, +inf）. |
PolarizationChannels
Structure containing the 4 polarization channels obtained by the demosaicing process.
Type variations : PolarizationChannelsNull, PolarizationChannelsNullArray, PolarizationChannelsNullArrayArray, PolarizationChannelsArray, PolarizationChannelsArrayArray
Profile
Represents the discrete approximation of a continuous real function or the output of some analysis on images. Note: It is used for describing the projection of an image's pixels or a geometric object, to define the distances between two paths, but mostly to represent the outputs of 1D edge detections.
Type variations : ProfileNull, ProfileNullArray, ProfileArray
Properties
| Name | Type | Description |
|---|---|---|
| XOffset | Float | X offset. |
| XScale | Float | X scale. Range: 〔0, +inf）. |
| Values | FloatArray | Array of values. |
ProfileEdge
Edges found in a Profile. Note: Can be found as the output of Profile::findProfileEdges.
Type variations : ProfileEdgeNull, ProfileEdgeNullArray, ProfileEdgeNullArrayArray, ProfileEdgeArray, ProfileEdgeArrayArray
Properties
| Name | Type | Description |
|---|---|---|
| Position | Float | X coordinate. |
| Magnitude | Float | Magnitude. |
| Transition | Enum < EdgeTransition > | Type of pixel transition considered as an edge. |
ProfileRidge
Ridges found in a Profile. Note: Can be found as the output of Profile::findProfileRidges.
Type variations : ProfileRidgeNull, ProfileRidgeNullArray, ProfileRidgeNullArrayArray, ProfileRidgeArray, ProfileRidgeArrayArray
Properties
| Name | Type | Description |
|---|---|---|
| Position | Float | X coordinate. |
| Magnitude | Float | Magnitude. |
| Polarity | Enum < Polarity > | Which pixels have been considered （dark or bright） |
ProfileSection
Sections found in a Profile. Note: Can be found as the output of Profile::divideInSections.
Type variations : ProfileSectionNull, ProfileSectionNullArray, ProfileSectionNullArrayArray, ProfileSectionArray, ProfileSectionArrayArray
Properties
| Name | Type | Description |
|---|---|---|
| Position1 | Float | First X coordinate. |
| Position2 | Float | Second X coordinate. |
| Width | Float | Section width. |
ProfileStripe
Stripes found in a Profile. Note: Can be found as the output of Profile::findProfileStripes.
Type variations : ProfileStripeNull, ProfileStripeNullArray, ProfileStripeNullArrayArray, ProfileStripeArray, ProfileStripeArrayArray
Properties
| Name | Type | Description |
|---|---|---|
| Position1 | Float | First X coordinate. |
| Position2 | Float | Second X coordinate. |
| Width | Float | Width. |
| Magnitude | Float | Magnitude. |
| Polarity | Enum < Polarity > | Which pixels have been considered （dark or bright） |
QRCode
Holds information about QR code: its position, version and text which is encoded.
Type variations : QRCodeNull, QRCodeNullArray, QRCodeNullArrayArray, QRCodeArray, QRCodeArrayArray
Properties
| Name | Type | Description |
|---|---|---|
| Position | Path | QR code position. |
| Text | String | Decoded text. |
| Version | Int | QR code version （from 1 to 40） |
Random
Generator of pseudo-random numbers.
Type variations : RandomNull, RandomNullArray, RandomNullArrayArray, RandomArray, RandomArrayArray
Range
Integer range on a numeric axis.
Type variations : RangeNull, RangeNullArray, RangeNullArrayArray, RangeArray, RangeArrayArray
Properties
| Name | Type | Description |
|---|---|---|
| Start | Int | Start. |
| Length | Int | Length. |
Rectangle2D
A 2D representation of a rectangle in the Cartesian space.
Type variations : Rectangle2DNull, Rectangle2DNullArray, Rectangle2DNullArrayArray, Rectangle2DArray, Rectangle2DArrayArray
Properties
| Name | Type | Description |
|---|---|---|
| Origin | Point2D | The top-left corner of the rectangle. |
| Angle | Float | Orientation angle 〔deg〕. |
| Width | Float | Rectangle width. Range: 〔0, +inf）. |
| Height | Float | Rectangle height. Range: 〔0, +inf）. |
Region
Compact representation of a monochromatic image. Note: It is described by two elements: 1. A frame, defined by a Size, which delimits the maximum dimension of the Region 2. An array of PointsSequences, which describes the points contained in the Region. A Region is considered valid only if the array has the following characteristics: 1. Its points sequences are ordered with increasing y coordinate. 2. Its points sequences are ordered with increasing x coordinate. 3. Its points sequences have positive length. 4. Its points sequences do not overlap and are not contiguous. 5. It does not contain points outside its frame.
Type variations : RegionNull, RegionNullArray, RegionNullArrayArray, RegionArray, RegionArrayArray
RegionProcessingParams
Groups all the parameters used to process a region with morphology operations.
Type variations : RegionProcessingParamsNull, RegionProcessingParamsNullArray, RegionProcessingParamsNullArrayArray, RegionProcessingParamsArray, RegionProcessingParamsArrayArray
Properties
| Name | Type | Description |
|---|---|---|
| Kernel | Enum < KernelShape > | Kernel shape for morphological operations. |
| OpeningRadius | Int | Radius used for morphological opening of a region. |
| ClosingRadius | Int | Radius used for morphological closing of a region. |
Ridge1D
Groups all the parameters used to describe a ridge found during the 1D scanning process.
Type variations : Ridge1DNull, Ridge1DNullArray, Ridge1DNullArrayArray, Ridge1DArray, Ridge1DArrayArray
Properties
| Name | Type | Description |
|---|---|---|
| Position | Float | Position of the ridge on the brightness profile. |
| Magnitude | Float | Magnitude of the ridge. |
| Polarity | Enum < Polarity > | Polarity of the ridge. |
| Point | Point2D | Position of the ridge on the image. |
RidgeScanParams
Groups all the parameters used to control the ridge scanning process.
Type variations : RidgeScanParamsNull, RidgeScanParamsNullArray, RidgeScanParamsNullArrayArray, RidgeScanParamsArray, RidgeScanParamsArrayArray
Properties
| Name | Type | Description |
|---|---|---|
| SmoothingStdDev | Float | Gaussian smoothing of the brightness profile. Range 〔0, +inf〕. |
| MinMagnitude | Float | Minimum acceptable ridge strength. Range 〔0, +inf〕. |
| RidgePolarity | Enum < Polarity > | Polarity of ridges that will be detected. |
Ring2D
A 2D representation of a ring in the Cartesian space.
Type variations : Ring2DNull, Ring2DNullArray, Ring2DNullArrayArray, Ring2DArray, Ring2DArrayArray
Properties
| Name | Type | Description |
|---|---|---|
| Center | Point2D | Center point of the ring. |
| Radius1 | Float | Inner radius. Range: 〔0, +inf）. |
| Radius2 | Float | Outer radius. Range: 〔0, +inf）. |
RunOptions
Runtime options for ONNX model execution.
Type variations : RunOptionsArray, RunOptionsArrayArray
SamplingParams
Groups all the parameters used to control the image sampling along a path.
Type variations : SamplingParamsNull, SamplingParamsNullArray, SamplingParamsNullArrayArray, SamplingParamsArray, SamplingParamsArrayArray
Properties
| Name | Type | Description |
|---|---|---|
| Interpolation | Enum < InterpolationMethod2D > | Method of sub-pixel image sampling. |
| SamplingStep | Float | Distance between two consecutive sampling places on a path. Range 〔0.5, +inf〕. |
| SampleCount | Int | Number of points at a single sampling place. When 0, the number of points is determined by the function. Range: 〔0, +inf〕. |
SByte
Represents an 8-bit signed integer
Type variations : SByteArray, SByteArrayArray, SByteNull, SByteNullArray, SByteNullArrayArray
ScanTemplate
Structure created expanding a scanning path along its normal direction, used to speed up the 1D scanning process.
Type variations : ScanTemplateNull, ScanTemplateNullArray, ScanTemplateNullArrayArray, ScanTemplateArray, ScanTemplateArrayArray
Script
String value which is used to build scripts in specific tools and can be used in dedicated code editors
Type variations : ScriptArray, ScriptArrayArray
SearchParams_Edge
Parameters for object search in edge-based template matching.
Type variations : SearchParams_EdgeNull, SearchParams_EdgeNullArray, SearchParams_EdgeNullArrayArray, SearchParams_EdgeArray, SearchParams_EdgeArrayArray
Properties
| Name | Type | Description |
|---|---|---|
| GradientThreshold | Float | Minimum gradient value used. Range: 〔0.01, +inf）. |
| EdgePolarity | Enum < EdgePolarity > | How edges with reversed polarity will contribute to the object score. |
| MinScore | Float | Minimum score of object candidates accepted at the top level. Range: 〔0, 1〕. |
| MinDistance | Float | Minimum distance between the centers of two found object frames. Range: 〔0, +inf）. |
| MaxOverlap | Float | Maximum overlap allowed between two found objects （considered only when minDistance is 0.0f）. Range: 〔0, 1〕. |
| Greediness | Float | Minimum ratio between the score at the upper levels and the one at level 0 （used to detect whether the upper levels have to be examined）. Range: 〔0, 1〕. |
| MaxDeformation | Int | Maximum deformation allowed. Range: 〔0, +inf）. |
SearchParams_NCC
Parameters for object search in NCC-based template matching.
Type variations : SearchParams_NCCNull, SearchParams_NCCNullArray, SearchParams_NCCNullArrayArray, SearchParams_NCCArray, SearchParams_NCCArrayArray
Properties
| Name | Type | Description |
|---|---|---|
| MinScore | Float | Minimum score of object candidates accepted at the top level. Range: 〔0, 1〕. |
| MinDistance | Float | Minimum distance between the centers of two found object frames. Range: 〔0, +inf）. |
| MaxOverlap | Float | Maximum overlap allowed between two found objects （considered only when minDistance is 0.0f）. Range: 〔0, 1〕. |
Segment2D
A 2D representation of a segment in the Cartesian space.
Type variations : Segment2DNull, Segment2DNullArray, Segment2DNullArrayArray, Segment2DArray, Segment2DArrayArray
Properties
| Name | Type | Description |
|---|---|---|
| Point1 | Point2D | Starting point. |
| Point2 | Point2D | Ending point. |
SegmentFittingField
Describes a segment-shaped area used to create a SegmentFittingMap.
Type variations : SegmentFittingFieldNull, SegmentFittingFieldNullArray, SegmentFittingFieldNullArrayArray, SegmentFittingFieldArray, SegmentFittingFieldArrayArray
Properties
| Name | Type | Description |
|---|---|---|
| Axis | Segment2D | Base shape of the fitting field. |
| Width | Float | Width along the axis transversal direction. |
SegmentFittingMap
Segment-shaped map typically used to fit segments to points acquired through edge detection.
Type variations : SegmentFittingMapNull, SegmentFittingMapNullArray, SegmentFittingMapNullArrayArray, SegmentFittingMapArray, SegmentFittingMapArrayArray
SerialPort
Allow to send and receive messages on a serial port
Type variations : SerialPortArray, SerialPortArrayArray
ShapeRegion
Container that encapsulate information about the shape of a region.
Type variations : ShapeRegionNull, ShapeRegionNullArray, ShapeRegionNullArrayArray, ShapeRegionArray, ShapeRegionArrayArray
Size
Structure containing width and height of an object.
Type variations : SizeNull, SizeNullArray, SizeNullArrayArray, SizeArray, SizeArrayArray
Properties
| Name | Type | Description |
|---|---|---|
| Width | Int | Width. |
| Height | Int | Height. |
Socket
Allow to send and receive messages in string or binary format using Socket
Type variations : SocketArray, SocketArrayArray
StokesVector
Structure containing the three components of the Stokes vector. Note: The Stokes vector is computed starting from the demosaicked polarization components. The pixel type of each component is always Float, independently of the component's pixel type.
Type variations : StokesVectorNull, StokesVectorNullArray, StokesVectorNullArrayArray, StokesVectorArray, StokesVectorArrayArray
String
Represents text as sequence of UTF-16 code units
Type variations : StringArray, StringArrayArray, StringNull, StringNullArray, StringNullArrayArray
Stripe1D
Groups all the parameters used to describe a stripe found during the 1D scanning process.
Type variations : Stripe1DNull, Stripe1DNullArray, Stripe1DNullArrayArray, Stripe1DArray, Stripe1DArrayArray
Properties
| Name | Type | Description |
|---|---|---|
| Position1 | Float | Position of the first stripe point on the brightness profile. |
| Position2 | Float | Position of the second stripe point on the brightness profile. |
| Width | Float | 1D distance between the two points. |
| Magnitude | Float | Magnitude of the stripe. |
| Polarity | Enum < Polarity > | Polarity of the stripe. |
| Point1 | Point2D | Position of the first stripe point on the image. |
| Point2 | Point2D | Position of the second stripe point on the image. |
StripeScanParams
Groups all the parameters used to control the stripe scanning process.
Type variations : StripeScanParamsNull, StripeScanParamsNullArray, StripeScanParamsNullArrayArray, StripeScanParamsArray, StripeScanParamsArrayArray
Properties
| Name | Type | Description |
|---|---|---|
| ProfileInterpolation | Enum < InterpolationMethod1D > | Sub-pixel edge detection method. |
| SmoothingStdDev | Float | Gaussian smoothing of the brightness profile. Range 〔0, +inf〕. |
| MinMagnitude | Float | Minimum acceptable stripe strength. Range 〔0, +inf〕. |
| MaxInnerEdgeMagnitude | Float | Maximum strength of edges appearing between the two ends of a stripe. Range 〔-1, +inf〕. If negative, the quantity is disabled. |
| StripePolarity | Enum < Polarity > | Polarity of the stripes that will be searched. |
| MinStripeWidth | Float | Minimum acceptable stripe width, in pixels. Range 〔0, +inf〕. |
| MaxStripeWidth | Float | Maximum acceptable stripe width, in pixels. Range 〔-1, +inf〕. If negative, the value is neglected. |
TemplateObject
Object describing the output of a template matching.
Type variations : TemplateObjectNull, TemplateObjectNullArray, TemplateObjectNullArrayArray, TemplateObjectArray, TemplateObjectArrayArray
Properties
| Name | Type | Description |
|---|---|---|
| Match | Rectangle2D | Rectangle of the match. |
| Alignment | UCS2D | Alignment of the match. |
| Center | Point2D | Center of the match. |
| Angle | Float | Angle of the match. |
| Scale | Float | Scale of the match. |
| Score | Float | Score of the match. |
| MinPyramidScore | Float | Score of the match. |
| Level | Int | Pyramid level where the match was found. |
Tensor
Represents a multidimensional array (Tensor) for ONNX models.
Type variations : TensorArray, TensorArrayArray
TensorConfig
Encapsulates all the necessary parameters for constructing a Tensor from an Image, specifying how the image data should be scaled, normalized, and arranged in memory to produce a Tensor.
Type variations : TensorConfigArray, TensorConfigArrayArray
TensorElement
Represents a view to an individual element of a Tensor. Note: Any modification through this view directly affects the underlying Tensor data.
Type variations : TensorElementArray, TensorElementArrayArray
TensorTypeInfo
Describes the type and shape information for a tensor in an ONNX model.
Type variations : TensorTypeInfoArray, TensorTypeInfoArrayArray
TextSegmentation
Defines how text should be split.
Type variations : TextSegmentationNull, TextSegmentationNullArray, TextSegmentationNullArrayArray, TextSegmentationArray, TextSegmentationArrayArray
Properties
| Name | Type | Description |
|---|---|---|
| Segmentation | TextSegmentationMethod | Segmentation method. |
| Thresholding | TextThresholdingMethod | Thresholding method. |
TextSegmentationMethod
Parameters for text segmentation algorithms.
Type variations : TextSegmentationMethodNull, TextSegmentationMethodNullArray, TextSegmentationMethodNullArrayArray, TextSegmentationMethodArray, TextSegmentationMethodArrayArray
Properties
| Name | Type | Description |
|---|---|---|
| Algorithm | Enum < SegmentationAlgorithm > | Segmentation algorithm. |
| MinBlobSize | Int | Minimum blob area. Range: 〔0, +inf）. |
| MaxBlobSize | Int | Maximum blob area. Range: 〔-1, +inf）. If negative, the parameter is neglected. |
| CharacterSize | Int | Characters' width. Range: 〔1, +inf）. |
| SmoothProjection | Float | Smoothing value to apply before extracting the characters. Range: 〔0, +inf）. |
| MaxDistance | Float | Maximal distance between character parts （closer parts are glued together）. Range: 〔0, +inf）. |
| DistanceBalance | Float | Ratio between X and Y axis to use when computing distance between regions. If 0 the distance is computed on Y axis, if 1 on the X axis. When the value is in the middle a weighted average is computed. Range: 〔0, 1〕. |
| Sorting | Enum < CharacterSortingOrder > | Type of sorting. |
TextThresholdingMethod
Parameters of text extraction algorithm.
Type variations : TextThresholdingMethodNull, TextThresholdingMethodNullArray, TextThresholdingMethodNullArrayArray, TextThresholdingMethodArray, TextThresholdingMethodArrayArray
Properties
| Name | Type | Description |
|---|---|---|
| Algorithm | Enum < ThresholdingAlgorithm > | Thresholding algorithm. |
| Smoothing | Float | Value used in Image smoothing. Range: 〔0, +inf）. |
| Shearing | Float | De-skewing character. Range: 〔0, 1〕. |
| Dilation | Int | Dilation value on Y axis. Range: 〔0, +inf）. |
| Hysteresis | Float | Hysteresis value. Range: 〔0, +inf）. |
| Radius | Int | Determines the number of neighboring pixels. Range: 〔1, +inf）. |
| HysteresisDynamic | Float | Hysteresis value. Range: 〔0, +inf）. |
| AutomaticMethod | Enum < ThresholdSelectionMethod > | Algorithm to find automatic threshold. |
| BlackText | Bool | Whether to search for black text on a brighter background. |
| HysteresisAutomatic | Float | Hysteresis value. Range: 〔0, +inf）. |
UCS2D
A 2D representation of a universal coordinate system in the Cartesian space.
Type variations : UCS2DNull, UCS2DNullArray, UCS2DNullArrayArray, UCS2DArray, UCS2DArrayArray
Properties
| Name | Type | Description |
|---|---|---|
| Origin | Point2D | Coordinate system origin. |
| Angle | Float | Coordinate system orientation 〔deg〕. |
| Scale | Float | Coordinate system scale. Range （0, +inf）. |
UInt16
Represents a 16-bit unsigned integer
Type variations : UInt16Array, UInt16ArrayArray, UInt16Null, UInt16NullArray, UInt16NullArrayArray
UInt64
Represents a 64-bit unsigned integer
Type variations : UInt64Array, UInt64ArrayArray, UInt64Null, UInt64NullArray, UInt64NullArrayArray
Vector2D
A 2D representation of a vector in the Cartesian space.
Type variations : Vector2DNull, Vector2DNullArray, Vector2DNullArrayArray, Vector2DArray, Vector2DArrayArray
Properties
| Name | Type | Description |
|---|---|---|
| DeltaX | Float | Vector length along the X axis. |
| DeltaY | Float | Vector length along the Y axis. |
WebSocketClient
Allow to send and receive messages in string or binary format using WebSocket
Type variations : WebSocketClientArray, WebSocketClientArrayArray