Enum Types
AccumulationMode
How the values in a profile will be combined.
| Name |
Value |
Description |
| Average |
0 |
|
| Maximum |
1 |
|
| Minimum |
2 |
|
| Sum |
3 |
|
| Median |
4 |
|
| Middle |
5 |
|
ActionParam
| Name |
Value |
Description |
| ADD |
0 |
|
| REMOVE |
1 |
|
ActionType
| Name |
Value |
Description |
| Load |
0 |
|
| Unload |
1 |
|
| Update |
2 |
|
ActivationFunction
Function used to activate neurons in Multi-Layer Perceptrons.
| Name |
Value |
Description |
| Identity |
0 |
Identity function: \f$ f(x) = x \f$. |
| Sigmoid |
1 |
Symmetrical sigmoid: \f$ f(x) = \beta \cdot \frac{1 - e^{-\alpha x}}{1 + e^{-\alpha x}} \f$. |
| Tanh |
2 |
Hyperbolic tangent function: \f$ f(x) = \frac{e^x - e^{-x}}{e^x + e^{-x}} \f$. |
| Gaussian |
3 |
Gaussian function: \f$ f(x) = \beta e^{-\alpha x} \cdot x \f$. |
Anchor2D
The relative position of an object.
| Name |
Value |
Description |
| TopLeft |
0 |
|
| TopCenter |
1 |
|
| TopRight |
2 |
|
| MiddleLeft |
3 |
|
| MiddleCenter |
4 |
|
| MiddleRight |
5 |
|
| BottomLeft |
6 |
|
| BottomCenter |
7 |
|
| BottomRight |
8 |
|
AngleMeasure
Defines the unit of measurement for angles
| Name |
Value |
Description |
| Degree |
0 |
Degrees |
| Radians |
1 |
Radians |
AngleMetric
Angle measurement methods.
| Name |
Value |
Description |
| VectorClockwise |
0 |
|
| VectorCounterClockwise |
1 |
|
| PolygonClockwise |
2 |
|
| PolygonCounterClockwise |
3 |
|
AngleRange
Range of angle calculation or normalization.
| Name |
Value |
Description |
| _0_90 |
0 |
|
| _0_180 |
1 |
|
| _0_360 |
2 |
|
ApproximationType
Defines approximation types
| Name |
Value |
Description |
| Ceil |
0 |
Round up to the nearest integer |
| Floor |
1 |
Round to the nearest integer |
Axis
Name of the axis in the Cartesian space.
| Name |
Value |
Description |
| X |
0 |
|
| Y |
1 |
|
Barcode standards.
| Name |
Value |
Description |
| EAN13 |
0 |
|
| EAN13Addon2 |
1 |
|
| EAN13Addon5 |
2 |
|
| EAN8 |
3 |
|
| EAN8Addon2 |
4 |
|
| EAN8Addon5 |
5 |
|
| UPCA |
6 |
|
| UPCAAddon2 |
7 |
|
| UPCAAddon5 |
8 |
|
| UPCE |
9 |
|
| UPCEAddon2 |
10 |
|
| UPCEAddon5 |
11 |
|
| CODE128 |
12 |
|
| CODE39 |
13 |
|
| CODE93 |
14 |
|
| Interleaved2of5 |
15 |
|
BayerType
Bayer-encoding type.
| Name |
Value |
Description |
| GR |
0 |
|
| RG |
1 |
|
| GB |
2 |
|
| BG |
3 |
|
BitshiftDirection
Defines the bitshift direction
| Name |
Value |
Description |
| None |
0 |
No bitshift applied |
| Left |
1 |
Bits are shifted to the left |
| Right |
2 |
Bits are shifted to the right |
BlendingMethod
Describes how two images are blended together in overlapping sections (see concatenateImages).
| Name |
Value |
Description |
| OverimposeFirst |
0 |
Pixels from the first image are used in the overlapping sections. |
| OverimposeSecond |
1 |
Pixels from the second image are used in the overlapping sections. |
| Average |
2 |
An average of the pixels from the first and the second image is taken. |
| CrossFade |
3 |
A dissolve transition (based on transparency adjustment) is used to give a smooth transition. |
BorderPadding
The type of padding added to each border during a math operation.
| Name |
Value |
Description |
| Reflect |
0 |
|
| Reflect101 |
1 |
|
| Replicate |
2 |
|
| Wrap |
3 |
|
| Zero |
4 |
|
BorderPosition
Border position with respect to the provided radius.
| Name |
Value |
Description |
| Internal |
0 |
|
| External |
1 |
|
| Centered |
2 |
|
CalibrationMode
Calibration mode type.
| Name |
Value |
Description |
| Cropped |
0 |
Cropped. |
| FullFOV |
1 |
Full Field-Of-View. |
CameraCalibration
Defines the possible camera calibration models.
| Name |
Value |
Description |
| Pinhole_Divisional |
0 |
Pinhole camera model with divisional lens distortion model. |
| Pinhole_Polynomial |
1 |
Pinhole camera model with polynomial lens distortion model. |
| Pinhole_PolynomialWithThinPrism |
2 |
Pinhole camera model with polynomial with thin prism lens distortion model. |
| Telecentric |
3 |
Telecentric camera model. |
| Radial |
4 |
Radial camera model. |
ChangeScope
| Name |
Value |
Description |
| Tool |
0 |
|
| Property |
1 |
|
| Enum |
2 |
|
| System |
3 |
|
ChangeSeverity
| Name |
Value |
Description |
| Low |
0 |
|
| Mid |
1 |
|
| High |
2 |
|
ChangeType
| Name |
Value |
Description |
| None |
0 |
|
| Renamed |
1 |
|
| Removed |
2 |
|
| Added |
4 |
|
| Deprecated |
8 |
|
| Modified |
16 |
|
ChannelsLayout
Possible tensor channel layout formats.
| Name |
Value |
Description |
| NCHW |
0 |
BatchId, Channels, Height, Width. |
| NHWC |
1 |
BatchId, Height, Width, Channels. |
| CHW |
2 |
Channels, Height, Width. |
| HWC |
3 |
Height, Width, Channels. |
CharacterFeaturesType
Possible character features to use for OCR.
| Name |
Value |
Description |
| Pixels |
0 |
Normalized grayscale level of all pixels. |
| Convexity |
1 |
Character convexity value. |
| Circularity |
2 |
Character circularity value. |
| NumberOfHoles |
3 |
Number of holes. |
| AspectRatio |
4 |
Aspect ratio of character. |
| Width |
5 |
Maximal width of character. |
| Height |
6 |
Maximal height of character. |
| AreaRatio |
7 |
Area of character. |
| DiameterRatio |
8 |
Normalized diameter of the character. |
| Elongation |
9 |
Aspect ratio of bounding ellipse diameters. |
| Orientation |
10 |
Orientation of the character. |
| HorizontalProjection |
11 |
Character projection on the Y axis. |
| VerticalProjection |
12 |
Character projection on the X axis. |
| HoughCircles |
13 |
Circles found in characteristic points of letters. |
| Zoning4x4 |
14 |
Downsampled to 4x4 pixels image of character. |
| Moment_XY |
15 |
M11 moment of character. |
| Moment_YY |
16 |
M02 moment of character. |
| Moment_XX |
17 |
M20 moment of character. |
CharacterSortingOrder
Decides whether and how to sort character.
| Name |
Value |
Description |
| None |
0 |
Sorting will not be performed. |
| LeftToRight |
1 |
From left to right. |
| RightToLeft |
2 |
From right to left. |
| TopToBottom |
3 |
From top to bottom. |
| MultiLines_LeftToRight |
4 |
Detect different lines and sort the characters in each one from left to right. |
| MultiLines_RightToLeft |
5 |
Detect different lines and sort the characters in each one from right to left. |
CharucoDictionary
ChArUco dictionary.
| Name |
Value |
Description |
| DICT_4X4_50 |
0 |
4x4 bits, minimum hamming distance between any two codes = 4, 50 codes |
| DICT_4X4_100 |
1 |
4x4 bits, minimum hamming distance between any two codes = 3, 100 codes |
| DICT_4X4_250 |
2 |
4x4 bits, minimum hamming distance between any two codes = 3, 250 codes |
| DICT_4X4_1000 |
3 |
4x4 bits, minimum hamming distance between any two codes = 2, 1000 codes |
| DICT_5X5_50 |
4 |
5x5 bits, minimum hamming distance between any two codes = 8, 50 codes |
| DICT_5X5_100 |
5 |
5x5 bits, minimum hamming distance between any two codes = 7, 100 codes |
| DICT_5X5_250 |
6 |
5x5 bits, minimum hamming distance between any two codes = 6, 250 codes |
| DICT_5X5_1000 |
7 |
5x5 bits, minimum hamming distance between any two codes = 5, 1000 codes |
| DICT_6X6_50 |
8 |
6x6 bits, minimum hamming distance between any two codes = 13, 50 codes |
| DICT_6X6_100 |
9 |
6x6 bits, minimum hamming distance between any two codes = 12, 100 codes |
| DICT_6X6_250 |
10 |
6x6 bits, minimum hamming distance between any two codes = 11, 250 codes |
| DICT_6X6_1000 |
11 |
6x6 bits, minimum hamming distance between any two codes = 9, 1000 codes |
| DICT_7X7_50 |
12 |
7x7 bits, minimum hamming distance between any two codes = 19, 50 codes |
| DICT_7X7_100 |
13 |
7x7 bits, minimum hamming distance between any two codes = 18, 100 codes |
| DICT_7X7_250 |
14 |
7x7 bits, minimum hamming distance between any two codes = 17, 250 codes |
| DICT_7X7_1000 |
15 |
7x7 bits, minimum hamming distance between any two codes = 14, 1000 codes |
| DICT_ARUCO_ORIGINAL |
16 |
6x6 bits, minimum hamming distance between any two codes = 3, 1024 codes |
| DICT_APRILTAG_16h5 |
17 |
4x4 bits, minimum hamming distance between any two codes = 5, 30 codes |
| DICT_APRILTAG_25h9 |
18 |
5x5 bits, minimum hamming distance between any two codes = 9, 35 codes |
| DICT_APRILTAG_36h10 |
19 |
6x6 bits, minimum hamming distance between any two codes = 10, 2320 codes |
| DICT_APRILTAG_36h11 |
20 |
6x6 bits, minimum hamming distance between any two codes = 11, 587 codes |
CircleFittingMethod
Algorithms used for fitting a circle to a set of points.
| Name |
Value |
Description |
| AlgebraicKasa |
0 |
Minimizes the average squared pseudo-distance between the result circle and the given points. It is the fastest method, but may be less accurate when the input points are sampled along small arc only. |
| AlgebraicPratt |
1 |
Minimizes the average squared distance between the result circle and the given points. |
| AlgebraicTaubin |
2 |
Minimizes the average squared distance between the result circle and the given points. |
| GeometricLandau |
3 |
Iterative method improving an initial guess basing on distances between the result circle and the given points. |
CircleToCircleDistance
Type of distance measurement between circles.
| Name |
Value |
Description |
| CenterToCenter |
0 |
Distance between circle centers. |
| Min |
1 |
Minimum distance between parallel tangents to both circles. |
| Max |
2 |
Maximum distance between parallel tangents to both circles. |
CircularityMeasure
Reference region used to calculate circularity.
| Name |
Value |
Description |
| BoundingCirclePreserving |
0 |
Minimal bounding circle. |
| PerimeterPreserving |
1 |
Circular region with perimeter length equal to input region. |
| RadiusPreserving |
2 |
Circular region that has radius equal to input regions' radius. |
ColorConversionCode
Color Space Conversions codes.
| Name |
Value |
Description |
| RGB_TO_HSI |
0 |
|
| RGB_TO_HSL |
1 |
|
| RGB_TO_HSV |
2 |
|
| RGB_TO_XYZ |
3 |
|
| RGB_TO_YUV |
4 |
|
| RGB_TO_CMYK |
5 |
|
| RGB_TO_YCoCg |
6 |
|
| RGB_TO_RGB565 |
7 |
|
| RGB_TO_BGR |
8 |
|
| RGBA_TO_BGRA |
9 |
|
| HSI_TO_RGB |
10 |
|
| HSL_TO_RGB |
11 |
|
| HSV_TO_RGB |
12 |
|
| XYZ_TO_RGB |
13 |
|
| YUV_TO_RGB |
14 |
|
| CMYK_TO_RGB |
15 |
|
| YCoCg_TO_RGB |
16 |
|
| RGB565_TO_RGB |
17 |
|
| BGR_TO_RGB |
18 |
|
| BGRA_TO_RGBA |
19 |
|
ConcatDirection
Directions in which two objects will be concatenated.
| Name |
Value |
Description |
| Horizontal |
0 |
|
| Vertical |
1 |
|
ConfrontationType
Defines comparison types
| Name |
Value |
Description |
| Greater |
0 |
Greater than comparison |
| GreaterOrEqual |
1 |
Greater than or equal to comparison |
| Smaller |
2 |
Less than comparison |
| SmallerOrEqual |
3 |
Less than or equal to comparison |
| Equal |
4 |
Equal to comparison |
| NotEqual |
5 |
Not equal to comparison |
ConnectionProtocols
Defines the type of connection
| Name |
Value |
Description |
| TCP |
0 |
Connection over TCP/IP protocol |
| Serial |
1 |
Connection over Serial protocol |
CorrelationMeasure
How to compute image correlation.
| Name |
Value |
Description |
| NormalizedCrossCorrelation |
0 |
Result is the sum of products of corresponding pixel values of the images. |
| CrossCorrelation |
1 |
Result is the normalized sum of products of corresponding pixel values of the images. This value always lies in closed interval [-1,1], with 1 indicating the images ideal correlation. |
CropScale
Possible scales for the output image.
| Name |
Value |
Description |
| InputScale |
0 |
Keep the scale unchanged. |
| AlignedScale |
1 |
Rescale according to the input alignment scale. |
Defines the type of DateTime to use
| Name |
Value |
Description |
| LongDate |
0 |
Long Date format () |
| LongTime |
1 |
Long Time format |
| ShortDate |
2 |
Short Date format |
| ShortTime |
3 |
Short Time format |
DebayeringMethod
Method to be used for debayering (in other words the decoding of a Bayer-encoded image). DebayeringMethod::Bilinear is a good choice for images that are not expected to contain sharp edges or high spatial frequency variations, otherwise, DebayeringMethod::VNG is more suitable.
| Name |
Value |
Description |
| Bilinear |
0 |
Bilinear interpolation (simple and efficient, but can produce color artifacts). |
| VNG |
1 |
Interpolation with a Variable Number of Gradients (slowest but produces highest quality results). |
DemosaicingAlgorithm
Selects the demosaicing algorithm for polarization analysis.
| Name |
Value |
Description |
| None |
0 |
|
| NearestNeighbour |
1 |
|
| Bilinear |
2 |
|
| WeightedBilinear |
3 |
|
DifferentiationMethod
Determines which values are considered when approximating derivatives.
| Name |
Value |
Description |
| Forward |
0 |
Considers values at the current point and one step ahead. |
| Backward |
1 |
Considers values at the current point and one step behind. |
| Central |
2 |
Considers values at the current point, one step ahead and one step behind. |
Dimension
Chooses a dimension where the operation will be performed.
| Name |
Value |
Description |
| Width |
0 |
|
| Height |
1 |
|
DistanceAlignment
| Name |
Value |
Description |
| Default |
0 |
Distance measured along a line connecting the two objects. |
| X |
1 |
Distance measured along the X axis of the provided coordinate system. |
| Y |
2 |
Distance measured along the Y axis of the provided coordinate system. |
DistanceMeasure
Determines how to measure the distance between two objects (like profiles, histograms or images).
| Name |
Value |
Description |
| MeanError |
0 |
Less sensitive to outliers (more suitable for anomalies detection). |
| MeanSquaredError |
1 |
Gives more impact to larger errors and is more efficient. |
DistanceType
Defines how distance is calculated
| Name |
Value |
Description |
| Center |
0 |
Center distance between entities |
| Minumum |
1 |
Minimum distance between entities |
| Maximum |
2 |
Maximum distance between entities |
DownsampleRegionMode
Methods used by Region::downsample to determine which pixels to maintain.
| Name |
Value |
Description |
| Any |
0 |
Any of 4 pixels has to be present. |
| All |
1 |
All of 4 pixels have to be present. |
DynamicThresholdMethod
Determines which value to consider (inside a local neighborhood) for the dynamic version of Image::threshold / Image::thresholdToRegion.
| Name |
Value |
Description |
| Mean |
0 |
|
| Median |
1 |
|
| Middle |
2 |
|
EdgeFilter
Selects the method for computing image gradients in findEdges2D. Both filters are based on the derivative of a Gaussian function, but they differ in the way that they are implemented.
| Name |
Value |
Description |
| Canny |
0 |
Accurate edge detection with a good noise suppression. |
| Deriche |
1 |
More efficient and less likely to produce false edges in high contrast areas. |
EdgePolarity
Defines if and how the polarity of an edge is considered in findObjects.
| Name |
Value |
Description |
| Enable |
0 |
Edges found in the same place but with different polarity are not considered. |
| IgnoreGlobally |
1 |
Objects match regardless of their polarity. |
| IgnoreLocally |
2 |
Like IgnoreGlobally, but also partially brighter or darker objects are considered. |
EdgeTransition
Decides which edges have to be considered.
| Name |
Value |
Description |
| BrightToDark |
0 |
Only changes from bright pixels to dark ones are accepted. |
| DarkToBright |
1 |
Only changes from dark pixels to bright ones are accepted. |
| Any |
2 |
Any change in pixel intensity is accepted. |
EncodingText
Defines the text encoding format
| Name |
Value |
Description |
| ASCII |
0 |
Text is encoded using ASCII Encoding |
| UTF8 |
1 |
Text is encoded using UTF-8 Encoding |
| HEX |
2 |
Text represents a hexadecimal value (i.e. "0xF5") and must be parsed accordingly |
EndiannessTypes
Defines order in which bytes and words are stored and transmitted
| Name |
Value |
Description |
| LittleEndian |
0 |
Little Endian byte order |
| BigEndian |
1 |
Big Endian byte order |
ErrorClassType
Defines the types of erros that can be handled. Each error type allows to specify a block of 1000 error codes to handle specific exceptions.
| Name |
Value |
Description |
| RuntimeError |
0 |
Identifies execution related errors.These errors occur during tools execution (eg. runtime exceptions, oevislib errors, etc.). Codes [0...999]. |
| LicenseError |
1 |
Identifies license related errors (eg. add-on license issues). Codes [1000...1999]. |
| DeviceError |
2 |
Identifies device related errors.These errors occur at low level (eg. hardware malfunctions, camera issues, etc).Codes [2000...2999]. |
| UserError |
9 |
Identifies user custom error. User can use this type to define their own error codes. Codes [9000...9999]. |
| GenericError |
-1 |
Generic error type which can be used to handle all types of errors. |
ErrorCode
Identifies the error meaning with a specific code.
| Name |
Value |
Description |
| NoError |
0 |
No error. |
| LibRuntimeError |
1 |
Exception that happens inside a function, during runtime in oevislib. |
| LibOutOfMemoryError |
2 |
Exception caused when accessing unavailable memory in oevislib. |
| LibIOError |
3 |
Exception caused by failure during input/output operations in oevislib. |
| LibOSError |
4 |
Operating system exception in oevislib. |
| LibDomainError |
5 |
Exception caused when an input parameter is outside the constraints defined in oevislib. |
| LibFatalError |
6 |
Exception occurred for unknown reasons in oevislib. |
| SerializationError |
20 |
Exception caused project save/load operations. |
| AssemblyError |
30 |
Exception caused during assembly operations ( dynamic object creation, method invocation etc.). |
| LibLicenseError |
99 |
Exception thrown in case of problems with the license in oevislib. |
| LibNullPtrError |
100 |
Exception caused by a null pointer access in oevislib. |
| LibUnexpectedError |
101 |
Exception caused by an unexpected error in oevislib. |
| LibUnknownError |
102 |
Exception caused by an unknown error code in oevislib. |
| LibAssemblyLoadError |
103 |
Exception caused when an assembly fails to load in oevislib. |
| ToolExecutionError |
200 |
Exception caused during tool execution. |
| ToolInvalidArgumentError |
201 |
Exception caused by invalid arguments passed to a tool. |
| LicenseInvalidError |
1000 |
The license is not found or corrupted. |
| LicenseAddOnError |
1001 |
The add-on license is not found or corrupted. |
| DeviceGenericError |
2000 |
Generic device error. |
| DeviceAcquisitionError |
2001 |
Error related during device acquisition. |
| DeviceAcquisitionTimeoutError |
2002 |
Device acquisition timeout. |
| DeviceNotImplementedError |
2003 |
Feature or command not implemented or not available in device. |
| DeviceArgumentError |
2004 |
Invalid argument provided to device for the parameter. |
| GenApiGenericError |
2100 |
Generic GenApi error. |
| GenApiBadAllocError |
2101 |
Bad allocation in GenApi. |
| GenApiInvalidArgumentError |
2102 |
Invalid argument error in GenApi |
| GenApiOutOfRangeError |
2103 |
Out of range error in GenApi |
| GenApiPropertyError |
2104 |
Property access error in GenApi |
| GenApiRuntimeError |
2105 |
Runtime error in GenApi |
| GenApiLogicError |
2106 |
Logic error in GenApi |
| GenApiAccessError |
2107 |
Access error in GenApi |
| GenApiTimeoutError |
2108 |
Timeout error in GenApi |
| GenTLGenericError |
2200 |
Generic GenTL error. |
| CTILoadError |
2201 |
CTI load error. |
| CTIMissingMethodError |
2202 |
CTI missing method error. |
| InvalidParameterError |
2203 |
Invalid parameter error in GenTL. |
| NotInitializedConsumerError |
2204 |
Consumer is not initialized in GenTL. |
| GC_GenericError |
2205 |
GenICam generic error. |
| GC_NotInitializedError |
2206 |
GenICam not initialized error. |
| GC_NotImplementedError |
2207 |
GenICam not implemented error. |
| GC_ResourceInUseError |
2208 |
GenICam resource in use error. |
| GC_AccessDeniedError |
2209 |
GenICam access denied error. |
| GC_InvalidHandleError |
2210 |
GenICam invalid handle error. |
| GC_InvalidIDError |
2211 |
GenICam invalid ID error. |
| GC_NoDataError |
2212 |
GenICam no data error. |
| GC_InvalidParameterError |
2213 |
GenICam invalid parameter error. |
| GC_IOError |
2214 |
GenICam I/O error. |
| GC_TimeoutError |
2215 |
GenICam timeout error. |
| GC_AbortError |
2216 |
GenICam abort error. |
| GC_InvalidBufferError |
2217 |
GenICam invalid buffer error. |
| GC_NotAvailableError |
2218 |
GenICam not available error. |
| GC_InvalidAddressError |
2219 |
GenICam invalid address error. |
| GC_BufferTooSmallError |
2220 |
GenICam buffer too small error. |
| GC_InvalidIndexError |
2221 |
GenICam invalid index error. |
| GC_ParsingChunkError |
2222 |
GenICam parsing chunk error. |
| GC_InvalidValueError |
2223 |
GenICam invalid value error. |
| GC_ResourceExhaustedError |
2224 |
GenICam resource exhausted error. |
| GC_OutOfMemoryError |
2225 |
GenICam out of memory error. |
| GC_BusyError |
2226 |
GenICam busy error. |
| GC_CustomIDError |
2227 |
GenICam custom ID error. |
| ModbusGenericError |
2300 |
Generic Modbus error. |
| ModbusSerialPortNotOpenedError |
2301 |
Serial port is not opened. |
| ModbusConnectionError |
2302 |
Connection to Modbus device failed. |
| ModbusFunctionCodeNotSupportedError |
2303 |
Modbus server returned error: function code not supported. |
| ModbusQuantityInvalidError |
2304 |
Modbus server returned error: quantity invalid. |
| ModbusStartingAddressInvalidError |
2305 |
Modbus server returned error: starting address and quantity invalid. |
| ModbusCRCCheckFailedError |
2306 |
Modbus CRC check failed. |
| GenericUserError |
9000 |
Generic user error. |
| Generic |
-1 |
Generic error with undefined error code or related to System generic exceptions. |
EuresysDestionation
Defines the type of Euresys destination
| Name |
Value |
Description |
| Board |
0 |
Data is sent to the entire board |
| Channel |
1 |
Data is sent to a specific channel |
ExceptionType
Types of possible exceptions.
| Name |
Value |
Description |
| NO_ERROR |
0 |
|
| RUNTIME_ERROR |
1 |
Error that occurs during runtime. |
| OUT_OF_MEMORY_ERROR |
2 |
Error caused trying to access some memory that is not available. |
| IO_ERROR |
3 |
Error caused by input/output operations. |
| OS_ERROR |
4 |
Error caused from the interaction with the operating system. |
| DOMAIN_ERROR |
5 |
Error caused by a parameter having a value outside the allowed range. |
| FATAL_ERROR |
6 |
|
| LICENSE_ERROR |
7 |
Error related to the licensing. |
| NULLPTR_ERROR |
8 |
Error caused by handling unassigned pointers. |
| UNEXPECTED_ERROR |
9 |
Error not expected during the function execution. |
ExecutionProvider
Defines backends for ONNX Runtime model execution.
| Name |
Value |
Description |
| CPU |
0 |
CPU execution provider. |
| CUDA |
1 |
NVIDIA CUDA execution provider for GPU-accelerated inference. |
| OpenVINO |
2 |
Intel OpenVINO execution provider for optimized cross-platform inference. |
ExtremumType
Decides what kind of extremum has to be found or returned by Histogram::getLocalExtrema / Profile::getLocalExtrema.
| Name |
Value |
Description |
| Maximum |
0 |
|
| Minimum |
1 |
|
| Any |
2 |
Both Minima and Maxima values. |
FifoOverflowBehavior
Defines how FIFO behaves when overflowing
| Name |
Value |
Description |
| Discard |
0 |
New data is discarded when FIFO is full |
| OverrideLast |
1 |
Old data is overwritten when FIFO is full |
| OverrideFirst |
2 |
New data is overwritten when FIFO is full |
FileOperation
Defines the operation to be performed on files
| Name |
Value |
Description |
| Save |
0 |
Saves the file |
| Load |
1 |
Loads the file |
FileType
Defines the type of files to be processed
| Name |
Value |
Description |
| All |
0 |
All file types |
| Image |
1 |
Image files |
| Dxf |
2 |
DXF files |
| Text |
3 |
Text files |
| Ini |
4 |
INI files |
FilterLogic
Defines the logic used for filtering
| Name |
Value |
Description |
| None |
0 |
No filtering is applied |
| And |
1 |
All conditions must be met |
| Or |
2 |
At least one condition must be met |
FilterOperation
Defines the operation used for filtering
| Name |
Value |
Description |
| Include |
0 |
Values that match the filter are included |
| Exclude |
1 |
Values that match the filter are excluded |
FindStopCondition
| Name |
Value |
Description |
| None |
0 |
|
| First |
1 |
|
| Last |
2 |
|
FourierNormalization
Type of normalization applied after a direct or inverse Fourier transform.
| Name |
Value |
Description |
| None |
0 |
Normalization is not applied. |
| Sqrt |
1 |
Normalization is applied using the square root of the number of pixels. |
| N |
2 |
Normalization is applied using the number of pixels. |
GaussianKernel
Possible sizes of Gaussian kernel used to smooth images (in Image::gaussianSmooth and Image::gaussianPyramidDownsample).
| Name |
Value |
Description |
| _2x2 |
0 |
|
| _3x3 |
1 |
|
| _5x5 |
2 |
|
| _7x7 |
3 |
|
| _9x9 |
4 |
|
| _11x11 |
5 |
|
GenICamTree
Defines the type of GenICam node
| Name |
Value |
Description |
| System |
0 |
System level node |
| Interface |
1 |
Interface level node |
| Device |
2 |
Device level node |
| Device_TL |
3 |
Transport Layer device level node |
| Datastream |
4 |
Data stream level node |
GenICamVisibility
Defines the visibility level of GenICam nodes
| Name |
Value |
Description |
| Beginner |
1 |
Beginner level node |
| Expert |
2 |
Intermediate level node |
| Guru |
3 |
Advanced level node |
GradientMethod
Describes methods for computing image gradients. The first three operators all use a weighted sum of the neighboring pixels to calculate the gradient (considering all the 8 neighbors), while Central and Foward use only a subset of the neighborhood. The first three guarantee better accuracy, while the last two are more efficient.
| Name |
Value |
Description |
| Sobel |
0 |
More sensitive to edges. |
| Prewitt |
1 |
Recommended when speed is more important than accuracy. |
| Scharr |
2 |
Less sensitive to noise (but also to edges). |
| Central |
3 |
Only two direct neighbors of a pixel are considered (the ones at its left and right) |
| Forward |
4 |
Only one direct neighbor of a pixel is considered (the one at its right) |
GradientOrientation
Possible gradient's orientation.
| Name |
Value |
Description |
| Horizontal |
0 |
|
| Vertical |
1 |
|
GraphOptimizationLevel
ONNX Runtime graph optimization levels for model compilation.
| Name |
Value |
Description |
| DisableAll |
0 |
No graph optimization applied to the ONNX model. |
| EnableBasic |
1 |
Basic level graph optimization including constant folding and operator fusion. |
| EnableExtended |
2 |
Extended level graph optimization with additional transformations beyond basic. |
| EnableAll |
3 |
All available graph optimization techniques applied to maximize performance. |
HSxModel
Color models for HSx images (HSV, HSL, HSI).
| Name |
Value |
Description |
| HSV |
0 |
Hue-Saturation-Value. |
| HSL |
1 |
Hue-Saturation-Lightness. |
| HSI |
2 |
Hue-Saturation-Intensity. |
Available formats when saving an image to a file (see Image::save).
| Name |
Value |
Description |
| BMP |
0 |
Best for uncompressed images (lossless). |
| JPEG |
1 |
Best for photos or images with lots of color and details (lossy). |
| PNG |
2 |
Best for images with sharp edges or text (lossless). Supports also UInt16 images and 4-channels images. |
| PNM |
3 |
Portable image formats. |
| TIFF |
4 |
Used for both lossy and lossless compressed images. Supports also UInt16 and Float images. |
| WEBP |
5 |
Used for both lossy and lossless compressed images. |
ImageMoment
Possible image moment descriptors.
| Name |
Value |
Description |
| _00 |
0 |
\f$ M_{00} = \sum_{(x, y) \in ROI} I(x, y) \f$ |
| _01 |
1 |
\f$ M_{01} = \sum_{(x, y) \in ROI} x \cdot I(x, y) \f$ |
| _10 |
2 |
\f$ M_{10} = \sum_{(x, y) \in ROI} y \cdot I(x, y) \f$ |
| _02 |
3 |
\f$ M_{02} = \sum_{(x, y) \in ROI} x^2 \cdot I(x, y) \f$ |
| _11 |
4 |
\f$ M_{11} = \sum_{(x, y) \in ROI} x \cdot y \cdot I(x, y) \f$ |
| _20 |
5 |
\f$ M_{20} = \sum_{(x, y) \in ROI} y^2 \cdot I(x, y) \f$ |
ImageType
Specifies how each pixel is stored inside the image matrix data.
| Name |
Value |
Description |
| UInt8 |
0 |
8-bit unsigned integer. |
| UInt16 |
1 |
16-bit unsigned integer. |
| Float |
2 |
Single precision floating point. |
| Int8 |
3 |
8-bit signed integer. |
| Int16 |
4 |
16-bit signed integer. |
| Int32 |
5 |
32-bit signed integer. |
InferenceDevice
Inference devices used for running ONNX models.
| Name |
Value |
Description |
| CPU |
0 |
CPU. |
| CUDA |
1 |
NVIDIA CUDA GPU. |
| OpenVINO |
2 |
Intel OpenVINO (CPU, iGPU, VPU, FPGA) |
InterpolationMethod1D
Interpolation methods used for profiles and histograms.
| Name |
Value |
Description |
| Fast |
0 |
Linear interpolation (pixel-precise). |
| Precise |
1 |
Quadratic polynomial interpolation given 3 consecutive points (subpixel-precise, up to 1/6 px). |
InterpolationMethod2D
Pixel interpolation methods on an image.
| Name |
Value |
Description |
| NearestNeighbour |
0 |
The nearest pixel value is taken. Simple and efficient, but can produce artifacts. |
| Bilinear |
1 |
The weighted average of the four nearest pixels is taken. Slower but more accurate. |
JobStopResults
Defines the result of a job stop operation
| Name |
Value |
Description |
| Success |
0 |
Job stopped successfully |
| Pending |
1 |
Job stop is pending |
| Failure |
2 |
Job stop failed |
KernelShape
Possible kernel shapes.
| Name |
Value |
Description |
| Box |
0 |
|
| Cross |
1 |
|
| Ellipse |
2 |
|
KernelSVM
Type of kernels used in ocr::SVM::train.
| Name |
Value |
Description |
| Linear |
0 |
Linear kernel. Simple and fast. |
| Polynomial |
1 |
Polynomial kernel. More complex than the previous one. |
| RBF |
2 |
Radial Basis Function kernel. It can capture both linear and non-linear relationships. |
| Sigmoid |
3 |
Sigmoid kernel. For more complex non-linear relationships. |
| ExponentialChi2 |
4 |
Exponential Chi2 kernel. Similar to RBF kernel, but most robust to outliers. |
| HistogramIntersection |
5 |
Histogram intersection kernel. It compares the input distributions. |
KMeansInitialization
Defines the possible initialization methods for kMeans algorithm.
| Name |
Value |
Description |
| Random |
0 |
Random initial centroids are selected at each attempt. |
| KMeansPP |
1 |
Centroids are generated using KMeans++ initialization method (http://ilpubs.stanford.edu:8090/778/1/2006-13.pdf). |
Language
Supported languages for Deep Learning OCR.
| Name |
Value |
Description |
| English |
0 |
English. |
| Italian |
1 |
Italian. |
| Chinese_Simplified |
2 |
Simplified Chinese. |
| Chinese_Traditional |
3 |
Traditional Chinese. |
| Russian |
4 |
Russian. |
LineMEstimator
Defines the linear regression estimator to use.
| Name |
Value |
Description |
| Huber |
0 |
Efficient when data is normally distributed. |
| Tukey |
1 |
More robust to outliers but less efficient than the previous. |
LineToCircleDistance
Type of distance measurement between a line and a circle.
| Name |
Value |
Description |
| Center |
0 |
Distance between the line and the circle center. |
| Min |
1 |
Minimum distance between the line and the circle, measured along the axis perpendicular to the line, passing through the circle center. |
| Max |
2 |
Maximum distance between the line and the circle, measured along the axis perpendicular to the line, passing through the circle center. |
LogicOperationType
Defines logical operation types
| Name |
Value |
Description |
| And |
0 |
Logical AND operation |
| Or |
1 |
Logical OR operation |
| Xor |
2 |
Logical XOR operation |
| Nand |
3 |
Logical NAND operation |
| Nor |
4 |
Logical NOR operation |
LogLevel
| Name |
Value |
Description |
| Error |
0 |
|
| Warning |
1 |
|
| Info |
2 |
|
| Trace |
3 |
|
LogVerbosity
| Name |
Value |
Description |
| Quiet |
0 |
|
| Minimal |
1 |
|
| Normal |
2 |
|
| Info |
3 |
|
| Trace |
4 |
|
LTDV_ConverterModes
| Name |
Value |
Description |
| FIXED_VOLTAGE |
0 |
|
| AUTODETECT_VOLTAGE |
1 |
|
LTDV_CurrentRange
| Name |
Value |
Description |
| AUTOMATIC |
0 |
|
| LOW |
1 |
|
| HIGH |
2 |
|
LTDV_DigitalFilters
| Name |
Value |
Description |
| OFF |
0 |
|
| FILTER_10_MICRO |
1 |
|
| FILTER_20_MICRO |
2 |
|
| FILTER_50_MICRO |
3 |
|
| FILTER_100_MICRO |
4 |
|
| FILTER_200_MICRO |
5 |
|
| FILTER_500_MICRO |
6 |
|
LTDV_DriverModes
| Name |
Value |
Description |
| INDEPENDENT_OUTPUTS |
0 |
|
| SHARED_OUTPUTS |
1 |
|
LTDV_Edges
| Name |
Value |
Description |
| RISING |
0 |
|
| FALLING |
1 |
|
| BOTH |
2 |
|
LTDV_LightOutputs
| Name |
Value |
Description |
| LD1 |
0 |
|
| LD2 |
1 |
|
| LD3 |
2 |
|
| LD4 |
3 |
|
| LD5 |
4 |
|
| LD6 |
5 |
|
| LD7 |
6 |
|
| LD8 |
7 |
|
LTDV_OutputSources
| Name |
Value |
Description |
| OFF |
0 |
|
| PULSEGENERATOR1 |
1 |
|
| PULSEGENERATOR2 |
2 |
|
| PULSEGENERATOR3 |
4 |
|
| PULSEGENERATOR4 |
8 |
|
| PULSEGENERATOR5 |
16 |
|
| PULSEGENERATOR6 |
32 |
|
| PULSEGENERATOR7 |
64 |
|
| PULSEGENERATOR8 |
128 |
|
| PULSEGENERATOR9 |
256 |
|
| PULSEGENERATOR10 |
512 |
|
| PULSEGENERATOR11 |
1024 |
|
| PULSEGENERATOR12 |
2048 |
|
| PULSEGENERATOR13 |
4096 |
|
| PULSEGENERATOR14 |
8192 |
|
| PULSEGENERATOR15 |
16384 |
|
| PULSEGENERATOR16 |
32768 |
|
| TR1 |
65536 |
|
| TR2 |
131072 |
|
| TR3 |
262144 |
|
| TR4 |
524288 |
|
| TR5 |
1048576 |
|
| TR6 |
2097152 |
|
| TR7 |
4194304 |
|
| TR8 |
8388608 |
|
| CONTINUOUS |
16777216 |
|
LTDV_PulseGenerators
| Name |
Value |
Description |
| PG1 |
0 |
|
| PG2 |
1 |
|
| PG3 |
2 |
|
| PG4 |
3 |
|
| PG5 |
4 |
|
| PG6 |
5 |
|
| PG7 |
6 |
|
| PG8 |
7 |
|
| PG9 |
8 |
|
| PG10 |
9 |
|
| PG11 |
10 |
|
| PG12 |
11 |
|
| PG13 |
12 |
|
| PG14 |
13 |
|
| PG15 |
14 |
|
| PG16 |
15 |
|
LTDV_PulseGeneratorSources
| Name |
Value |
Description |
| OFF |
0 |
|
| TR1 |
1 |
|
| TR2 |
2 |
|
| TR3 |
4 |
|
| TR4 |
8 |
|
| TR5 |
16 |
|
| TR6 |
32 |
|
| TR7 |
64 |
|
| TR8 |
128 |
|
| OSCILLATOR |
256 |
|
| SW1 |
512 |
|
| SW2 |
1024 |
|
| SW3 |
2048 |
|
| SW4 |
4096 |
|
| Name |
Value |
Description |
| TR1 |
0 |
|
| TR2 |
1 |
|
| TR3 |
2 |
|
| TR4 |
3 |
|
| TR5 |
4 |
|
| TR6 |
5 |
|
| TR7 |
6 |
|
| TR8 |
7 |
|
LTDV_SynchOutputs
| Name |
Value |
Description |
| SH1 |
0 |
|
| SH2 |
1 |
|
| SH3 |
2 |
|
| SH4 |
3 |
|
| SH5 |
4 |
|
| SH6 |
5 |
|
| SH7 |
6 |
|
| SH8 |
7 |
|
LTDV_TCheck
| Name |
Value |
Description |
| DISABLED |
0 |
|
| ENABLED |
1 |
|
LTDV_Types
| Name |
Value |
Description |
| LTDVE4CH_20 |
7 |
|
| LTDVE8CH_20 |
8 |
|
| LTDVE2CH_20F |
10 |
|
| LTDVE1CH_40F |
13 |
|
MagnitudeMeasure
Describes how to measure magnitude from a vector.
| Name |
Value |
Description |
| Horizontal |
0 |
\f$ M_{Horizontal} = \frac{|x|}{4} \f$ |
| Vertical |
1 |
\f$ M_{Vertical} = \frac{|y|}{4} \f$ |
| Average |
2 |
\f$ M_{Average} = \frac{|x| + |y|}{8} \f$ |
| Sum |
3 |
\f$ M_{Sum} = \frac{|x| + |y|}{4} \f$ (saturated) |
| Maximum |
4 |
\f$ M_{Maximum} = \frac{max(|x|, |y|)}{4} \f$ |
| Hypot |
5 |
\f$ M_{Hypot} = \frac{\sqrt{x^2 + y^2}}{4} \f$ |
MatchingCriterion
Methods of classifying a path or a region as a member of a group (see ov::groupPathsByRegions and ov::groupRegionsByRegions).
| Name |
Value |
Description |
| Intersection |
0 |
The objects must have at least a point in common with the region. |
| Inclusion |
1 |
The objects have to be fully included in the region. |
MeanKernel
Describes the shape and size of a kernel used in image smoothing (Image::smooth).
| Name |
Value |
Description |
| Box3x3 |
0 |
|
| Box5x5 |
1 |
|
MEstimator
Defines how to suppress the outliers in the result.
| Name |
Value |
Description |
| Huber |
0 |
Considers the weighted average of the data points. More efficient. |
| Tukey |
1 |
Considers a trimmed mean of the data points (a percentage at the distribution boundaries is excluded). |
MinMax
Defines minimum or maximum selection
| Name |
Value |
Description |
| Min |
0 |
Minimum value selected |
| Max |
1 |
Maximum value selected |
MirrorDirection
Possible directions of image mirroring.
| Name |
Value |
Description |
| Horizontal |
0 |
|
| Vertical |
1 |
|
| Both |
2 |
|
MLType
Defines the type of Machine Learning model
| Name |
Value |
Description |
| MLP |
0 |
Multi-Layer Perceptron model |
| SVM |
1 |
Support Vector Machine model |
| KNN |
2 |
K-Nearest Neighbors model |
ModbusAddressVariableType
Defines the variable type for Modbus addresses
| Name |
Value |
Description |
| Bool |
0 |
Boolean variable type |
| Int |
1 |
Integer variable type |
| Float |
2 |
Floating-point variable type |
| Double |
3 |
Double-precision floating-point variable type |
| String |
4 |
String variable type |
| Short |
5 |
Short integer variable type |
| Long |
6 |
Long integer variable type |
| Byte |
7 |
Byte variable type |
ModbusBaseAddress
Defines the base address for Modbus connections
| Name |
Value |
Description |
| Base0 |
0 |
Base address starts at 0 |
| Base1 |
1 |
Base address starts at 1 |
ModbusRegisters
Defines the type of register in Modbus connections
| Name |
Value |
Description |
| Coils |
0 |
Coils register type |
| DiscreteInputs |
1 |
Discrete Inputs register type |
| HoldingRegisters |
2 |
Holding Registers register type |
| InputRegisters |
3 |
Input Registers register type |
ModelArch
Types of OCR models.
| Name |
Value |
Description |
| MLP |
0 |
Multi-Layer Perceptron. |
| SVM |
1 |
Support Vector Machine. |
Describes what model to select in Deep Learning algorithms.
| Name |
Value |
Description |
| Best |
0 |
Best model. |
| Fast |
1 |
Fast model. |
MorphologyKernel
Describes both the shape and size of kernels used in morphological operations.
| Name |
Value |
Description |
| Box3x3 |
0 |
|
| Box5x5 |
1 |
|
| Cross3x3 |
2 |
|
| Cross5x5 |
3 |
|
| Disc5x5 |
4 |
|
| Disc7x7 |
5 |
|
| Disc9x9 |
6 |
|
MotionTypes
Defines the motion type for MTDV
| Name |
Value |
Description |
| Relative |
0 |
Move relative position |
| Absolute |
1 |
Move absolute position |
MQTTQoS
Defines the MQTT Quality of Service level
| Name |
Value |
Description |
| AtMostOnce |
0 |
At most once delivery |
| AtLeastOnce |
1 |
At least once delivery |
| ExactlyOnce |
2 |
Exactly once delivery |
MQTTVersion
Defines the MQTT protocol version
| Name |
Value |
Description |
| MQTTv3_1 |
0 |
MQTT version 3.1 |
| MQTTv3_1_1 |
1 |
MQTT version 3.1.1 |
| MQTTv5 |
2 |
MQTT version 5 |
MTDV_Actions
| Name |
Value |
Description |
| Current_Position |
0 |
|
| Set_Absolute_Position |
1 |
|
| Set_Relative_Position |
2 |
|
| Motor_Homing |
3 |
|
| Motor_Stop |
4 |
|
MTDV_Parameters_Boolean
| Name |
Value |
Description |
| Invert_Homing_Direction |
11 |
|
| Homing_At_Startup |
12 |
|
| Swap_Encoder_Phases |
18 |
|
| Limit_Switch_Enable |
22 |
|
| Limit_Switch_Invert_Polarity |
23 |
|
| Restrict_Motion_To_Encoder_Range |
24 |
|
| Invert_Motor_Direction |
25 |
|
MTDV_Parameters_Float
| Name |
Value |
Description |
| Resolution |
15 |
|
| Motor_Encoder_Ratio |
17 |
|
| PID_P_Coefficent |
19 |
|
| PID_I_Coefficent |
20 |
|
| PID_D_Coefficent |
29 |
|
MTDV_Parameters_Int
| Name |
Value |
Description |
| Backlash_Comp_Amount |
27 |
|
| Backlash_Comp_On_Homing |
28 |
|
MTDV_Parameters_UnsignedInt
| Name |
Value |
Description |
| Run_Current |
5 |
|
| Hold_Current |
6 |
|
| Acceleration |
7 |
|
| Deceleration |
8 |
|
| Speed |
9 |
|
| Homing_Speed |
10 |
|
| Encoder_Type |
13 |
|
| Poles_Number |
14 |
|
| Interpolation |
16 |
|
| Homing_Timeout |
21 |
|
| Backlash_Comp_Type |
26 |
|
MultiThreadBehavior
Defines the multithreading behavior
| Name |
Value |
Description |
| AsyncIterations |
0 |
Each thread loops at its own speed |
| SyncIterations |
1 |
All threads synchronize at each iteration |
NodeTypes
Defines the access mode of GenICam nodes
| Name |
Value |
Description |
| Bool |
0 |
The node is read-only |
| Int |
1 |
The node is an integer value |
| Float |
2 |
The node is a floating point value |
| String |
3 |
The node is a string value |
| Command |
4 |
The node is a command |
ONNXLoggingLevel
Logging severity levels for ONNX Runtime diagnostic output.
| Name |
Value |
Description |
| Verbose |
0 |
|
| Info |
1 |
|
| Warning |
2 |
|
| Error |
3 |
|
| Fatal |
4 |
|
ONNXType
Classification of ONNX node types for model introspection.
| Name |
Value |
Description |
| Tensor |
0 |
|
| Unknown |
1 |
|
OperationType
Defines mathematical operation types
| Name |
Value |
Description |
| Sum |
0 |
Sum operation |
| Subtract |
1 |
Subtract operation |
| Multiply |
2 |
Multiply operation |
| Divide |
3 |
Divide operation |
Parity
Specifies the parity bit for a SerialPort object.
| Name |
Value |
Description |
| None |
0 |
No parity check occurs. |
| Odd |
1 |
Sets the parity bit so that the count of bits set is an odd number. |
| Even |
2 |
Sets the parity bit so that the count of bits set is an even number. |
| Mark |
3 |
Leaves the parity bit set to 1. |
| Space |
4 |
Leaves the parity bit set to 0. |
PathDistanceMode
Method of computing distances between two paths.
| Name |
Value |
Description |
| PointToPoint |
0 |
Distance is measured between the two nearest points of the two paths. |
| PointToSegment |
1 |
Distance is measured between a point in the first path and its nearest segment in the second. |
PathFeature
Path features.
| Name |
Value |
Description |
| BoundingBoxBottom |
0 |
Bottom position of path's bounding box (call to Path::getBoundingBox()). |
| BoundingBoxLeft |
1 |
Left position of path's bounding box (call to Path::getBoundingBox()). |
| BoundingBoxRight |
2 |
Right position of path's bounding box (call to Path::getBoundingBox()). |
| BoundingBoxTop |
3 |
Top position of path's bounding box (call to Path::getBoundingBox()). |
| DiameterLength |
4 |
Length of the path's diameter (call to Path::getDiameter()). |
| Length |
5 |
Total length of the path (call to Path::getLength()). |
| MassCenterX |
6 |
X coordinate of the path's mass center (call to Path::getMassCenter()). |
| MassCenterY |
7 |
Y coordinate of the path's mass center (call to Path::getMassCenter()). |
| PolygonArea |
8 |
Area of a polygon (call to Path::getArea()). |
| PolygonCircularity_BoundingCirclePreserving |
9 |
Circularity computed by Path::getCircularity() with BoundingCirclePreserving method. |
| PolygonCircularity_PerimeterPreserving |
10 |
Circularity computed by Path::getCircularity() with PerimeterPreserving method. |
| PolygonCircularity_RadiusPreserving |
11 |
Circularity computed by Path::getCircularity() with RadiusPreserving method. |
| PolygonConvexity |
12 |
Polygon convexity (call to Path::getConvexity()). |
| PolygonElongation |
13 |
Polygon elongation (call to Path::getElongation()). |
| PolygonMajorAxisLength |
14 |
Length of the path major elliptic axis (call to Path::getMajorEllipticAxis()). |
| PolygonMinorAxisLength |
15 |
Length of the path minor elliptic axis (call to Path::getMinorEllipticAxis()). |
| PolygonRectangularity |
16 |
Polygon rectangularity (call to Path::getRectangularity()). |
| Size |
17 |
Number of points on the path (call to Path::getSize()). |
PathFilter
Determines which paths to consider.
| Name |
Value |
Description |
| All |
0 |
|
| ClosedOnly |
1 |
|
| OpenOnly |
2 |
|
PathJoiningAngleMeasure
Determines how to measure the angle between two jointed paths.
| Name |
Value |
Description |
| InputPathOrientation |
0 |
The angle between the input paths' endings is taken. |
| OutputPathOrientation |
1 |
The angle between the new output paths' joints is taken. |
PathJoiningMethod
Determines how to combine two paths (in the middle).
| Name |
Value |
Description |
| AddBridge |
0 |
Adds a bridge (segment) connecting the two (closer) ends of the paths. |
| UniteEnds |
1 |
Unites directly the ends of the paths. |
PathKind
Defines whether a path is absolute or relative
| Name |
Value |
Description |
| Absolute |
0 |
Absolute path |
| Relative |
1 |
Relative path |
PathSegmentationMode
Describes how to segment a path.
| Name |
Value |
Description |
| SegmentsAndArcs |
0 |
Segmented parts can be fitted to a segment or an arc. |
| Segments |
1 |
Segmented parts will be straight segments only. |
PathType
Defines the type of path in file system
| Name |
Value |
Description |
| File |
0 |
A file path |
| Folder |
1 |
A folder path |
PatternFinder
Type of pattern to be found to calibrate images.
| Name |
Value |
Description |
| Checkerboard |
0 |
Corners finder from checkerboard. |
| CircleGrid |
1 |
Circles finder from a grid of circles. |
| ChArUco |
2 |
ChArUco finder from a ChArUco chessboard. |
PixelType
Pixel type (how many bytes are used for each pixel).
| Name |
Value |
Description |
| UInt8 |
0 |
Values from 0 to 255. |
| Int8 |
1 |
Values from -127 to 128. |
| UInt16 |
2 |
Values from -32768 to 32767. |
| Int16 |
3 |
Values from 0 to 65535. |
| Int32 |
4 |
Values from -2147483648 to 2147483647. |
| Float |
5 |
Floating point values. |
PolarInterpolationMethod
Possible pixel interpolation methods for polar transform.
| Name |
Value |
Description |
| Nearest |
0 |
Nearest neighbor interpolation. Fastest method. |
| Linear |
1 |
Bilinear interpolation. |
| Cubic |
2 |
Bicubic interpolation. |
| Area |
3 |
Resampling using pixel area relation. |
| Lanczos4 |
4 |
Lanczos interpolation over 8x8 neighborhood. |
Polarity
Determines which pixel values to take. Used in edge detection operations.
| Name |
Value |
Description |
| Bright |
0 |
Take only bright pixels (higher value). |
| Dark |
1 |
Take only dark pixels (lower value). |
| Any |
2 |
Both bright pixels and dark pixels are considered. |
PolarizationAngle
Selects the light polarization angle.
| Name |
Value |
Description |
| _0Degrees |
0 |
|
| _45Degrees |
1 |
|
| _90Degrees |
2 |
|
| _135Degrees |
3 |
|
PolarizationPattern
Grid layout of the polarization filter array.
| Name |
Value |
Description |
| _00 |
0 |
Pattern 90 – 45 / 135 – 0. |
| _01 |
1 |
Pattern 45 – 90 / 0 – 135. |
| _10 |
2 |
Pattern 135 – 0 / 90 – 45. |
| _11 |
3 |
Pattern 0 – 135 / 45 – 90. |
PolarSpace
Image polar space. Decides which formula to use, where parameters \f$ m \f$ and \f$ k \f$ are set to values that allow to fit the source image in the output image.
| Name |
Value |
Description |
| Polar |
0 |
\f$ \rho = m \sqrt{x^2 + y^2}, \phi = \arctan(\frac{y}{x}) \f$ |
| LogPolar |
1 |
\f$ \rho = k \log \sqrt{x^2 + y^2}, \phi = \arctan(\frac{y}{x}) \f$ |
PolygonMoment
Types of polygon moments, where \f$ p_x \f$ and \f$ p_y \f$ denotes x and y coordinate of a point \f$ p \f$.
| Name |
Value |
Description |
| _02 |
0 |
\f$ M_{2,0}(S) = \int_S p_x^2 \f$ |
| _11 |
1 |
\f$ M_{1,1}(S) = \int_S p_x p_y \f$ |
| _20 |
2 |
\f$ M_{0,2}(S) = \int_S p_y^2 \f$ |
ProfileResizeMethod
Interpolation methods when resizing a profile.
| Name |
Value |
Description |
| NearestNeighbour |
0 |
Takes the corresponding nearest neighbor. |
| Linear |
1 |
Linearly interpolates between profile's values distanced by step ( \f$ \frac{newSize}{oldSize} \f$). Values on range borders are preserved. |
ProjectionCombination
Types of values' combinations when a projection is required (see Image::getProjection).
| Name |
Value |
Description |
| Average |
0 |
|
| Maximum |
1 |
|
| Minimum |
2 |
|
| Sum |
3 |
|
| Median |
4 |
|
ProjectionDirection
Projection's directions.
| Name |
Value |
Description |
| Horizontal |
0 |
|
| Vertical |
1 |
|
RecipeOperation
| Name |
Value |
Description |
| Load |
0 |
|
| Save |
1 |
|
| Add |
2 |
|
| Remove |
3 |
|
RectangleCorner
Corners of a rectangle (used in Rectangle2D::getCorner).
| Name |
Value |
Description |
| TopLeft |
0 |
|
| TopRight |
1 |
|
| BottomRight |
2 |
|
| BottomLeft |
3 |
|
RectangleOrientation
Rectangle's possible orientations.
| Name |
Value |
Description |
| Horizontal |
0 |
Rectangle's width is greater or equal to its height. |
| Vertical |
1 |
Rectangle's height is greater or equal to its width. |
| Any |
2 |
Any orientation is accepted. |
RegionConnectivity
Defines how pixels are connected when merging regions.
| Name |
Value |
Description |
| EightDirections |
0 |
All 8 pixels around the current one are considered. |
| FourDirections |
1 |
Only top, down, left and right neighboring pixels are considered. |
RegionFeature
Region features (used to compare regions).
| Name |
Value |
Description |
| Area |
0 |
Total area of the region (call to Region::getArea()). |
| BoundingBoxBottom |
1 |
Bottom position of region's bounding box (call to Region::getBoundingBox()). |
| BoundingBoxHeight |
2 |
Height of region's bounding box (call to Region::getBoundingBox()). |
| BoundingBoxLeft |
3 |
Left position of region's bounding box (call to Region::getBoundingBox()). |
| BoundingBoxRight |
4 |
Right position of region's bounding box (call to Region::getBoundingBox()). |
| BoundingBoxTop |
5 |
Top position of region's bounding box (call to Region::getBoundingBox()). |
| BoundingBoxWidth |
6 |
Width of region's bounding box (call to Region::getBoundingBox()). |
| Circularity_BoundingCirclePreserving |
7 |
Region's circularity computed with BoundingCirclePreserving method (call to Region::getCircularity()). |
| Circularity_PerimeterPreserving |
8 |
Region's circularity computed with PerimeterPreserving method (call to Region::getCircularity()). |
| Circularity_RadiusPreserving |
9 |
Region's circularity computed with RadiusPreserving method (call to Region::getCircularity()). |
| Convexity |
10 |
Region's convexity (call to Region::getConvexity()). |
| DiameterLength |
11 |
Length of region diameter (call to Region::getDiameter()). |
| Elongation |
12 |
Region's elongation (call to Region::getElongation()). |
| MassCenterX |
13 |
X coordinate of region's mass center (call to Region::getMassCenter()). |
| MassCenterY |
14 |
Y coordinate of region's mass center (call to Region::getMassCenter()). |
| MajorAxisLength |
15 |
Length of the region's major elliptic axis (call to Region::getMajorEllipticAxis()). |
| MinorAxisLength |
16 |
Length of the region's minor elliptic axis (call to Region::getMinorEllipticAxis()). |
| NumberOfHoles_EightDirections |
17 |
Number of region holes computed using EightDirections connectivity (call to Region::getHoles()). |
| NumberOfHoles_FourDirections |
18 |
Number of region holes computed using FourDirections connectivity (call to Region::getHoles()). |
| PerimeterLength |
19 |
Length or region perimeter (call to Region::getPerimeter()). |
| Rectangularity |
20 |
Region's rectangularity (call to Region::getRectangularity()). |
RegionMoment
Types of region moments, where \f$ p_x \f$ and \f$ p_y \f$ denote the x and y coordinate of a pixel \f$ p \f$.
| Name |
Value |
Description |
| _02 |
0 |
\f$ M_{2,0}(R) = \sum_{p \in R} p_x^2 \f$ |
| _11 |
1 |
\f$ M_{1,1}(R) = \sum_{p \in R} p_x \cdot p_y \f$ |
| _20 |
2 |
\f$ M_{0,2}(R) = \sum_{p \in R} p_y^2 \f$ |
RegionOuterBoundary
A region boundary is a collection of points that are not connected to other points in at least one direction.
| Name |
Value |
Description |
| Top |
0 |
Points not connected to other points with lower y coordinate. |
| Right |
1 |
Points not connected to other points with higher x coordinate. |
| Bottom |
2 |
Points not connected to other points with higher y coordinate. |
| Left |
3 |
Points not connected to other points with lower x coordinate. |
ResizeMethod
Interpolation methods used in Image::resize.
| Name |
Value |
Description |
| NearestNeighbour |
0 |
The pixel is replaced by the nearest pixel in the source image. |
| Bilinear |
1 |
The pixel is replaced by a weighted average of the closest pixels in the source image. |
| Area |
2 |
The pixel is replaced by the average of the neighboring pixels in the source image. |
RotationDirection
Rotation directions when operations including angle measuring or vector interpolation are considered.
| Name |
Value |
Description |
| Clockwise |
0 |
|
| CounterClockwise |
1 |
|
RotationSize
How an image is resized after a rotation (in Image::rotate).
| Name |
Value |
Description |
| Fit |
0 |
Image is extended to fit the transformed image. |
| Preserve |
1 |
Image's size is preserved (some parts on the resulting image will be empty). |
RunThreadBehavior
Defines the behavior when running multithreading
| Name |
Value |
Description |
| MainThread |
0 |
Only the main thread is executed |
| AllThreads |
1 |
All threads are executed |
Scope
Defines the scope of a variable
| Name |
Value |
Description |
| Global |
0 |
Global scope |
| Local |
1 |
Local scope |
SegmentationAlgorithm
Methods for splitting text into single characters.
| Name |
Value |
Description |
| SimpleBlobs |
0 |
Connects pixels with similar intensity values. Fast but sensitive to noise. |
| ProjectionAnalysis |
1 |
Divides image into clusters based on the pixels in every projected column. |
| BlobsDistance |
2 |
Segments the image based on the distance between the pixels. More robust to noise. |
SegmentToLineDistance
Type of distance measurement between a segment and a line.
| Name |
Value |
Description |
| Center |
0 |
Distance between segment center and the line. |
| ClosestEndpoint |
1 |
Distance between the closest segment endpoint and the line. |
| FarthestEndpoint |
2 |
Distance between the farthest segment endpoint and the line. |
SegmentToSegmentAngleMeasure
| Name |
Value |
Description |
| Point1ToPoint1_Clockwise |
0 |
Angle spanning from P1 of the first segment to P1 of the second segment, clockwise. |
| Point1ToPoint1_CounterClockwise |
1 |
Angle spanning from P1 of the first segment to P1 of the second segment, counterclockwise |
| Point2ToPoint1_Clockwise |
2 |
Angle spanning from P2 of the first segment to P1 of the second segment, clockwise |
| Point2ToPoint1_CounterClockwise |
3 |
Angle spanning from P2 of the first segment to P1 of the second segment, counterclockwise |
Selection
Defines selection criteria
| Name |
Value |
Description |
| MAX |
0 |
Maximum value |
| MIN |
1 |
Minimum value |
Selection
Filter for selecting edges, ridges and stripes.
| Name |
Value |
Description |
| Best |
0 |
|
| First |
1 |
|
| Last |
2 |
|
ShapeRegionType
Type of objects encapsulated inside a ShapeRegion.
| Name |
Value |
Description |
| Region |
0 |
Region class. |
| Rectangle |
1 |
Rectangle2D class. |
| Circle |
2 |
Circle2D class. |
| Polygon |
3 |
Path class. |
| Ring |
4 |
Ring2D class. |
| Ellipse |
5 |
Ellipse2D class. |
ShapeType
| Name |
Value |
Description |
| None |
0 |
|
| Point |
1 |
|
| PointOffset |
2 |
|
| PointMiddle |
3 |
|
| PointIntersectionLL |
4 |
|
| PointIntersectionLC |
5 |
|
| PointIntersectionCC |
6 |
|
| Ucs1P |
7 |
|
| Ucs2P |
8 |
|
| UcsLP |
9 |
|
| Line2P |
10 |
|
| LinePLA |
11 |
|
| LineOrthogonal |
12 |
|
| LineParallel |
13 |
|
| LineParallelOffset |
14 |
|
| LineAxis |
15 |
|
| LineAxisArc |
16 |
|
| LineAxisPoint |
17 |
|
| Circle2P |
18 |
|
| Circle3P |
19 |
|
| CircleCP |
20 |
|
| CircleCR |
21 |
|
| CircleLLP |
22 |
|
| Arc3P |
23 |
|
| ArcC2P |
24 |
|
| PolyLine |
25 |
|
| Rect |
26 |
|
| Rect2P |
27 |
|
| Rect3P |
28 |
|
| Rect2PL |
29 |
|
| RectPWHA |
30 |
|
| LineStripe |
31 |
|
| CircularRing |
32 |
|
| SectorRing |
33 |
|
| DimLabel |
34 |
|
| PositionP |
35 |
|
| Diameter |
36 |
|
| Radius |
37 |
|
| Distance2P |
38 |
|
| Distance2A |
39 |
|
| DistancePL |
40 |
|
| DistanceAL |
41 |
|
| Distance2L |
42 |
|
| DistancePPL |
43 |
|
| Angle2L |
44 |
|
| ToleranceRectilinearity |
45 |
|
| ToleranceCircularity |
46 |
|
| ToleranceConcentricity |
47 |
|
| ToleranceParallelism |
48 |
|
| ToleranceOrthogonality |
49 |
|
ShearSize
How an image is resized after a rotation (in Image::rotate).
| Name |
Value |
Description |
| Fit |
0 |
Region frame is extended to fit the transformed image (but only if the extension is in the positive direction). |
| Preserve |
1 |
Region's frame size is preserved (some parts on the resulting image will be empty). |
ShiftDirection
Directions in which path's points will be moved.
| Name |
Value |
Description |
| Left |
0 |
|
| Right |
1 |
|
SolutionLanguage
Defines the programming language used for solution development
| Name |
Value |
Description |
| CSharp |
0 |
.NET 6.0 (C#) |
| CPP |
1 |
.NET 6.0 and Native (C#/C++ Interop) |
SortingOrder
Decides whether objects should be sorted in ascendant or descendant order.
| Name |
Value |
Description |
| Ascending |
0 |
|
| Descending |
1 |
|
SplitDirection
Directions in which a box or a rectangle will be split.
| Name |
Value |
Description |
| Horizontal |
0 |
|
| Vertical |
1 |
|
StartupModes
Defines the method used for starting the application
| Name |
Value |
Description |
| NewProject |
0 |
Starts a new project |
| LastProject |
1 |
Opens the last project |
| RecentProjects |
2 |
Opens the recent projects window |
StopBehavior
Defines how the Project stops before calling the Finalize blocks.
| Name |
Value |
Description |
| Graceful |
0 |
Wait for loop iterations to complete. |
| Break |
1 |
Break execution and exit immediately from each loop. |
StopBits
Specifies the number of stop bits used on the SerialPort object.
| Name |
Value |
Description |
| None |
0 |
No stop bits are used. This value is not supported by the StopBits property. |
| One |
1 |
One stop bit is used. |
| Two |
2 |
Two stop bits are used. |
| OnePointFive |
3 |
1.5 stop bits are used. |
TensorDataType
Supported ONNX tensor element data types.
| Name |
Value |
Description |
| Undefined |
0 |
|
| Float |
1 |
|
| UInt8 |
2 |
|
| Int8 |
3 |
|
| UInt16 |
4 |
|
| Int16 |
5 |
|
| Int32 |
6 |
|
| Int64 |
7 |
|
| String |
8 |
|
| Bool |
9 |
|
| Float16 |
10 |
|
| Double |
11 |
|
| UInt32 |
12 |
|
| UInt64 |
13 |
|
TextOrientation
Possible text orientations for OCR processing.
| Name |
Value |
Description |
| Vertical |
0 |
Vertical. |
| Horizontal |
1 |
Horizontal. |
TextSplitLevel
Describes how the text inside an image will be split by ov::dl::readText.
| Name |
Value |
Description |
| Block |
0 |
Split by block of text. |
| Paragraph |
1 |
Split by paragraph within a block. |
| Line |
2 |
Split by line within a paragraph. |
| Word |
3 |
Split by word within a line. |
| Symbol |
4 |
Split by symbol/character within a word. |
ThresholdingAlgorithm
Thresholding algorithms used for text extraction (see ov::ocr::extractText).
| Name |
Value |
Description |
| Simple |
0 |
Simple thresholding (using a min and max value). |
| Dynamic |
1 |
Dynamic thresholding (based on the neighboring pixels). |
| Automatic |
2 |
Automatic thresholding (based on a threshold value obtained with Image::findBestThresholdValue). |
ThresholdSelectionMethod
Methods for automatic threshold value selection (see Image::findBestThresholdValue).
| Name |
Value |
Description |
| ClusteringKittler |
0 |
The chosen value is the midpoint between the two clusters identified from the image histogram (distribution). Fast but can be sensitive to noise. |
| ClusteringKMeans |
1 |
The chosen value is the midpoint between the two clusters identified using the K-means clustering on the image. More robust to noise than the previous one. |
| ClusteringOtsu |
2 |
Chooses the threshold that maximizes the inter-class variance of the two clusters. Usually the most effective. |
| Entropy |
3 |
Chooses the threshold that minimizes the entropy of the two clusters. |
| HistogramIntermodes |
4 |
Assuming the image distribution is bimodal, smooths its histogram until there are only two local minima and returns the midpoint between the intermodes. Ideal for complex backgrounds or when there are multiple objects, but slower than the others. |
TranslateAlignment
Defines how to use the coordinate system alignment in translation operations.
| Name |
Value |
Description |
| Absolute |
0 |
Use the global coordinate system to make an absolute translation. |
| Relative |
1 |
Use the local coordinate system to make a relative translation. |
TrigonometricAngleType
Defines angle measurement units for trigonometric operations
| Name |
Value |
Description |
| Deg |
0 |
Degrees |
| Rad |
1 |
Radians |
TrigonometricOperationType
Defines trigonometric operation types
| Name |
Value |
Description |
| Sin |
0 |
Sine operation |
| Cos |
1 |
Cosine operation |
| Tan |
2 |
Tangent operation |
| ASin |
3 |
ArcSine operation |
| ACos |
4 |
ArcCosine operation |
| ATan |
5 |
ArcTangent operation |
TrimPathMethod
Methods to trim a path.
| Name |
Value |
Description |
| PointToPoint |
0 |
The outside part of the path is completely deleted. |
| AlongBoundary |
1 |
The outside part of the path is projected along the boundary. |
TurnAngleDirection
Decides which turns to consider when computing path angles.
| Name |
Value |
Description |
| Left |
0 |
|
| Right |
1 |
|
| All |
2 |
|
TypeTolerance
| Name |
Value |
Description |
| NOMINAL_BASED |
0 |
|
| RANGE_BASED |
1 |
|
TypeTolerance
| Name |
Value |
Description |
| NOMINAL_BASED |
0 |
|
| RANGE_BASED |
1 |
|
UserLevel
Defines the user access level
| Name |
Value |
Description |
| BASE |
0 |
Basic user with limited access |
| EDITOR |
1 |
User with editing capabilities |
| ADMIN |
2 |
Administrator with full access |