You are here: Start » Classes

Classes

NameDescription
AnyCameraModel
ArcFittingMap
AssertionException
AverageImages_OfLoopState
AvlIgnoreAttribute Disables serialization of the field or property.
AvlObjectAttribute Marks the type as serializable by the Serializer.
Barcode Holds information about 1D barcode: its position, format and text which is encoded.
BarcodeGrades Holds information about Barcode quality.
BarcodeGradingDiagnostic Holds information about Barcode quality.
BarcodeParams Specifies range of possible barcodes.
BinaryReader
BinaryWriter
Blob
BlobSplittingParams This structure contains parameters for splitting region into blobs.
ByteArray Like std::vector: random-access and growable. Created mainly for passing data between filters, but dynamic growth is also supported for convenience. Fixed binary representation in 12 bytes (for interoperability): 0x00: pointer to data (warning: on x64 pointer has 8 bytes) 0x04: int size; 0x08: int capacity;
ByteBuffer
CancellationException
CharacterSample
CircleFittingMap
ClassConfidence
ClassifiedRectangle Rectangle belonging to a specific class.
ClassifyObjectModelId Identifier of Classify Object model.
CodabarParameters Datamatrix codes detection settings.
Code128Parameters Code128 detection settings.
ColorizeImageState
COMModel
COMModelFull
CompareGoldenTemplate_EdgesState
CompareGoldenTemplate_IntensityState
ConcatenatePaths_OfLoopState
Conditional<T>
ConfusionTable Represents elements of confusionTable.
CudaDevice Properties of a CUDA device.
DataCode Holds information about data code: its position and text which is encoded.
DatacodeBarcodeParams Specifies how barcodes are read.
DatacodeDetectionParams Specifies how data codes are being detected.
DataCodeDetectorParams Parameters for detecting barcodes and datacodes.
DatacodeParams Specifies range of possible data matrix codes.
DatacodeTunerContext
DataMatrix Holds information about DataMatrix: its position and text which is encoded.
DetectAnomalies1ModelId Identifier of Detect Anomalies 1 model.
DetectAnomalies2ModelId Identifier of Detect Anomalies 2 model.
DetectFeaturesModelId Identifier of Detect Features model.
Diagnostic<T>
DisposableList<T>
Disposables
DomainException
DrawingStyle
DynamicThresholdParams This structure contains parameters for dynamic thresholding of an image.
EdgeGoldenTemplate
EdgeModel
EdgeModel_Elastic
EdgeModel2
EnumerateFilesRandomState
EnumerateFilesState
EnumerateFilesStateBase
EnumerateImageTilesState
Exception
FeatureClass
FileEnumItem
FinderPatternOutline_ContoursState namespace pImpl_helpers
FittingMap
GoldenTemplate2Model
GrabImageFromFilesState
GrayGoldenTemplate
GrayModel
GrayModel2
Heatmap
Histogram
HistogramCombinators_OfLoopState
Image Universal (portable) image type with explicit run-time information about its format. Designed for optimum balance between simplicity and genericity. Supports monochromatic and multichannel images based on one of the 6 plain data types (UINT8, SINT8, UINT16, SINT16, SINT32, REAL). Image performs automatic memory management.
ImageCombinators_OfLoopState
ImagePointTransformsState
ImageValueCoordinateTransform Transform based on image values.
InputVideoStream
IOException
JoinImages_OfSeriesState
JoinProfilesIntoImage_OfSeriesState
JsonData JSON data.
JsonFormatParameters JSON format parameters.
KNNModel
License
LicenseException
LinearCodeParams Parameters for reading linear barcodes.
LineScanCameraBasicParams Basic parameters for line scan camera model.
LineScanCameraModel Line scan camera model parameters with distortion.
LocalBlindness This structure contains parameters of 1D scanning process that can prevent weaker edges in the vicinity of some strong edges from being detected.
LocateObjectsModelId Identifier of Locate Objects model.
LocatePointsModelId Identifier of Locate Points model.
LocateText_PostProcessHeatmapState
LocateTextModelId Identifier of Read Characters model.
LUTTransformImageState
ManyCodeSettings Many codes detection settings.
Matrix
MatrixCodeParams Parameters for reading Data Matrix and QR Codes.
MlpModel
NullableBase<T>
OAuthUser OAuth 2.0 user details
OcrCandidate Score and character pair.
OcrMlpModel
OcrModel Type contains trained OCR model for all OCR functions.
OcrResult Text obtained from an optical character recognition operation.
OcrSvmModel
OpcUaNodeId Represents a NodeId in the OPC UA information model.
Optional<T>
OutOfMemoryException
OutputVideoStream
Path
PathFittingField The structure defines a field in which a path will be fitted.
PathFittingMap
PCAModel
PDF417Code Holds information about PDF417 code: its position and text which is encoded.
PDF417CodeParams Specifies range of possible PDF417 codes.
PinholeCameraBasicParams Basic parameters for pinhole camera model.
PinholeCameraModel Pinhole camera model parameters with distortion.
PixelLut
Point3DGrid
PointCloudCoordinateTransform Image transformation data to point cloud coordinate.
PreSplitProcessingParams This structure contains parameters for preprocessing the region.
Profile
ProfileCombinators_OfLoopState
PythonObject
QRCode Holds information about QR code: its position, version, polarity and text which is encoded.
RandomState
ReadCharactersModelId Identifier of Read Characters model.
ReadDataCodes_State namespace pImpl_helpers
RectificationMap Rectification transform described as a spatial map with some metadata
RectificationTransform Analytical description of a rectification transform
Region Compressed binary mask.
RegionCombinators_OfLoopState
RotationLimits3D Rotation limits for registration of Point Clouds
RuntimeException
SamplingParams This structure contains parameters for controlling the sampling along a path process.
SaveImageState
ScanMap
ScanMapArrayState
ScanMapState
SegmentFittingMap
SegmentInstancesModelId Identifier of Segment Instances model.
ShapeRegion
SparseImage
SpatialMap
SplittingParams This structure contains parameters for splitting region into blobs.
Statistics_OfLoopState
StringLabel
StripeScanParams This structure contains parameters of stripe scanning process. Instance of this structure should be customized and passed as a parameter to stripe scanning related functions.
StripeScanParams3D This structure contains parameters of surface stripe scanning process. Instance of this structure should be customized and passed as a parameter to surface stripe scanning related functions.
Surface
SvmModel
SystemException
Tensor
TensorFormat A descriptor of data in a tensor.
TestPoint3DGridState
TestSurfaceState
TexemModel
TextSegmentation How text should be split
TextSegmentationMethod Parameters for region segmentation algorithms.
TextThresholdingMethod Parameters of text extraction algorithm.
ThresholdParams Parameters for thresholding of an image.
TransformLimits3D Rotation and translation limits for registration of Point Clouds
TranslationLimits3D Translation limits for registration of Point Clouds
ValueLimits
ValueLimits_f64
WeaverModelId Identifier of WEAVER model.
WebSocketConnectionState
XmlNode
ZCode_State
Zebra_GrabImageState namespace pImpl_helpers
ZResult Holds information about detected codes using ZBarcode library.

Structures

NameDescription
Anchor3D Decides about relative position of object in 3D. Exact behaviour depends on filter being used.
AnnotatedPoint2D Point with grid indices
Arc2D
ArcFittingField The structure defines a ring-like field in which an arc will be fitted.
BarcodeDecodingParams Specifies how barcodes are being decoded.
BarcodeLength Barcode length settings.
BaseState
Box
Box3D
CharacterFeatures
Circle2D
Circle3D
CircleFittingField The structure defines a ring-like field in which a circle will be fitted.
Code1DSettings Settings for 1D barcodes detection
CodeDetectionParameters Defined code detection parameters.
ColorThresholdParams This structure contains parameters for color-based thresholding of an image.
CoordinateSystem2D
DataCodeScores Holds information about confidence scores for a data code.
DataCodeTypeSelection Specifies which code symbologies will be read.
DatamatrixParameters Datamatrix codes detection settings.
DateTime Represents information about date and time.
DebugPreviewWindowState
Edge1D
EdgeScanParams This structure contains parameters of edge scanning process. Instance of this structure should be customized and passed as a parameter to edge scanning related functions.
EdgeScanParams3D This structure contains parameters of surface edge scanning process. Instance of this structure should be customized and passed as a parameter to surface edge scanning related functions.
Ellipse2D
Extremum1D Represents extremum found in profile.
Extremum2D Represents extremum found in image.
Gap1D
GS1DatabarParameters GS1 databar detection settings.
Hash
HeatmapThresholds
HistogramExtremum Represents an extremum found in a histogram.
HoughCircle Aggregates detected circle with its score.
ImageFormat Stores information about dimensions and pixel format of an image.
ImageLocalExtremaVerification This structure contains parameters for verification of local extrema visible on an image.
ImageLocationCoordinateTransform Transform based on locations coordinates.
IntensityThresholdParams This structure contains parameters for thresholding an image.
Interval
JsonParseOptions JSON parse options.
LabeledPoint2D
LensDistortion
Line2D
Line3D
LinearFunction
LinearSymbologies Specifies which 1D code symbologies will be read.
LocateTextDeployHint Hints for a preparing a model for a subsequent execution with given settings in advance.
LocateTextResult Text obtained from an optical character recognition operation.
Location
MatrixSymbologies Specifies which 2D code symbologies will be read.
Object2D This is output structure for template matching related functions. It groups matched object with its properties.
OcrDeployHint Hints for a preparing a model for a subsequent execution with given settings in advance.
OutputSurfaceFormat Surface creating filter parameters.
PDF417DetectionParams Specifies how PDF417 codes are being detected.
Pixel
PixelFormat
Plane3D
Point2D
Point3D
PointRun Compressed sequence of horizontally consecutive locations.
Position3D
ProfileEdge Represents edges found in profile.
ProfileRidge Represents ridges found in profile.
ProfileSection Represents sections found in profile.
ProfileStripe Represents stripes found in profile.
QuadraticFunction
QueueOverflowControl Control handling overflow in queues.
Range
RangeThresholdParams This structure contains parameters for thresholding an image.
Rectangle2D
RegionFrame A separate class to force field order in class Region
RegionProcessingParams This structure contains parameters for opening and closing of a region.
Ridge1D
RidgeScanParams This structure contains parameters of ridge scanning process. Instance of this structure should be customized and passed as a parameter to ridge scanning related functions.
RidgeScanParams3D This structure contains parameters of surface ridge scanning process. Instance of this structure should be customized and passed as a parameter to surface ridge scanning related functions.
Ring2D
Segment2D
Segment3D
SegmentFittingField The structure defines a rectangular field in which a segment will be fitted.
SegmentScanField The structure defines a rectangular field in which a series of scan will be performed.
ShapeRegionDeprecated Region defined by its shape.
Size
SparsePixel
SparseRow
Sphere3D
Stripe1D
SurfaceCoordinatesFormat Stores information about X and Y coordinate offsets and scales of a surface.
SurfaceEdge1D Represents surface edges found by 1DEdgeDetection3D functions.
SurfaceExtremum Represents extremum found on a surface.
SurfaceFormat Stores information about dimensions, depth image pixel format, coordinate offsets and scales of a surface.
SurfaceLocalExtremaVerification This structure contains parameters for verification of local extrema visible on a surface.
SurfaceRidge1D Represents surface ridges found by 1DEdgeDetection3D functions.
SurfaceStripe1D Represents surface stripes found by 1DEdgeDetection3D functions.
TelecentricCameraBasicParams Basic parameters for telecentric camera model.
TelecentricCameraModel Telecentric camera model parameters with distortion.
Vector2D
Vector3D
XTransform

Enumerations

NameDescription
AccumulationMode Possible combinations of values in profile extraction operations.
ActivationFunction Function used to activate neuron.
AdjustmentMetric Optimization metric for path adjustment
Anchor1D Decides about relative position of object. Exact behaviour depends on filter being used.
Anchor2D Decides about relative position of object. Exact behaviour depends on filter being used.
AndroidCameraOption Barcode data types.
AndroidSystemDirectory Barcode data types.
AngleDifferenceTolerance Specifies what angles can be considered similar.
AngleMetric Methods of angle measurement.
AngleRange
AnyCameraModelType
AnyCodeInverse Inverse code settings. If DPM enabled then always Both version is used.
AnyCodeMirrorImages Decode mirror images.
Axis Selects axis on which operation will be performed.
BarcodeFormat Recognizable formats of barcodes.
BarcodeGradingError Code grading error details.
BarcodeLimitedMarginCheck Limited margin check.
BarcodeReadingStrategy Determines if additional attempts to read a barcode should be performed.
BarcodeSecurityLevel Increasing the level of security can reduce scanning aggressiveness, so select only the level of security necessary.
BarcodeStartStopCharacters Detect upper case or lower case barcode start/stop characters.
BayerType Describes kind of Bayer-encoding.
BilateralSamplingMethod Determines which sampling method will be used in the calculations.
BinaryMode
BlobMergingMethod Changes classification method in gray based image segmentation.
BlobsDifferenceMeasure Changes classification method in gray based image segmentation.
BlobThresholdReferenceMethod Possible methods of calculating the center of a data mode.
BorderPosition Determines where exactly the border is built.
BoundingRectangleFeature Criterion of finding bounding rectangle.
CameraModelType Types of available camera model
CharacterFeaturesType
CharacterSortingOrder Decides whether and how to sort character regions in optical character recognition related filters.
CircleFittingMethod Possible methods of fitting a circle to a set of points.
CircularityMeasure When calculating circularity one may choose to use different reference circular region.
CodabarStripMode Codabar read result strip mode
CodeDecodeStrategy Decode strategy.
CodeDetectionMethod Detection method.
CodeFormat Recognizable code formats.
CodeInverse1D Code inverse.
CodePolarity Determines which pixel values will be interpreted as foreground modules.
ColorPalette Describes which color palette will be used by the ColorizeImage filter.
CompareMeasure Ways of computing image compare.
CornerResponseMethod Corner response is calculated with regard to convolution matrix, given as \[M = \left(\begin{array}{ccc} \sum g_r^2 & \sum g_c g_r \\ \sum g_c g_r & \sum g_c^2 \end{array} \right)\]
CorrelationMeasure Ways of computing image correlation.
CreateSpatialMapUnit Types of units/coordinates for parameters of SpatialMap creation filter
CropScaleMode Chooses scale for the output image.
CrosshairShape Shape of drawn crosshairs representing points.
CurvatureMeasure Method of computation of the surface curvature.
CylinderMappingMode Determines which pixels of the mapped cylinder have to be within the given rectangle.
DatacodeDecodeStrategy Specifies precision of outline detection.
DatacodeDetectionMethod Specifies how code candidates are located.
DatacodeDistortionLevel Distortion of the code grid
DataCodeDotSize Specifies the size of a dot for dot-printed codes.
DatacodeEdgeTracker Decides how strongly edge tracker preserves continuity of an edge.
DatacodeFinderTradeoff Decides whether to optimize parameters for weak edges or for jagged ones.
DatacodeGapSize Specifies the distance between neighboring modules.
DatacodePerspectiveLevel Perspective distortion of the code grid
DatacodePyramidStrategy Specifies the step of image downsampling used for finding codes at different scales.
DataCodeType Symbology of a 2D code.
DataMatrixType Determines data code type.
DataModeFunction Possible methods of calculating the center of a data mode.
DebayeringMethod Determines what method of decoding a Bayer-encoded image will be used.
DeepLearningLogLevel Defines level of messages logged by Deep Learning filters.
DelimiterHandling
DetectedLocationShape Shape of drawn crosshairs representing detected locations.
DeviceKind Device types capable of executing deep learning models.
DifferentiationMethod Methods of profile differentiation.
Dimension Selects a dimension to which an operation will be performed.
DirectionInterpretation
DistanceMeasure Method to use when measuring distance between two objects like Profiles, Histograms or Images.
DownsampleFunction Downsampling method used when generating an image pyramid.
DownsampleRegionMode Decides what method will be used by DownsampleRegion filter.
DPMMode DPM settings.
DrawingMode Methods of drawing on the image.
EdgeFilter Determines which method is used to compute image gradients.
EdgeMaskFilter Non-recursive filters for gradient computing.
EdgeNoiseLevel Information about how much noise the object edges have.
EdgePolarityMode Defines how edges with reversed polarity should be treated.
EdgeTransition Decides what is considered as an edge in the image.
ElasticMatchingDetectionStrategy Specifies precision of candidates detection.
EquidistanceType Methods of maintaining equal distance in corner cases.
ErrorType
ExtremumType Decides what kind of extremum is returned.
FileAccessMode
FileNameFilter Represents the type of the file name filter.
FileSortingOrder Criterion to take into account when sorting files.
FileTimeVariant Represents a variant of the file's time attribute.
FitType Possibilities of solution fitting.
FrequencyDomainOrigin
GaussKernel Possible dimensions of gaussian kernel used to smooth image.
GradientAngleRange Range of image gradient angles to choose from
GradientMaskOperator Describes methods of image gradient computing.
GradientOperator Describes which operator use to compute image gradient.
GradientOrientation Describes witch of gradient's orientation to compute.
Grid3DFileFormat Which file format to use.
HandEyeCalibrationMethod Hand Eye Calibration Method Type used for Optimization
HistogramInterpolationMethod Possible values of HistogramInterpolationMethod:
HSxColorModel Color models used in given operation.
HTTPRequestMethod HTTP request method types.
ImageFileFormat Available formats.
ImageMomentType Possible image moment descriptors.
IntegerBinaryFormat Defines a format of integer binary serialization
InterpolationMethod Possible pixel interpolation methods:
ISBTConcatenation ISBT Concatenation
JoinDirection Describes in which direction join should be performed.
JsonDataType JSON data type.
JsonFormatLineBreakType JSON format line break type.
KernelShape Describes structuring element shape.
KMeansClusteringMethod Possible methods of KMeans clustering.
LawsFilterSize Possible size of Laws texture filter.
LawsFilterType Possible types of Laws filter.
LensDistortionModelType Possible predefined sets of lens distortion parameters.
LicenseStorage
LinearBinaryPatternType Linear Binary Pattern kind.
LineMEstimator Defines linear regression estimator to use.
LinePeakDetectionMethod Determines exact line peak position extraction method.
LocateTextPretrainedModel Type of pretrained LocateText model.
LocateTextPretrainedModelQuantized Type of pretrained LocateText model.
LogsLevel Defines level of logs messages.
LoopControl
LuminanceMode Determines how the luminance of an image gets computed.
MagnitudeMeasure Method of estimation of the vectors' magnitude.
MarkerType Possible segments' marker shapes to draw. All images created with inMarkerType equal to 7.0.
MatchingCriterion Methods of classifying an object as a member of group.
MatrixOperation
MeanKernel Describes shape and size of structuring element used during smoothing.
MeasureObjectMethod Possible methods of measuring width of an object.
MEstimator Defines how to suppress the influence of values far from most others on the result.
Metric Specifies method of calculating distance between two points.
Metric3D Specifies method of calculating distance between two points in 3D.
MetricUnit Represents available metric units for drawing dimensions on image.
MidlevelScale Which midlevel scale to use.
MIL1DcodeFormat Gradable 1D barcodes formats/types/symbologies by Matrox Image Library.
MIL2DcodeFormat Gradable 2D barcodes formats/types/symbologies by Matrox Image Library.
MirrorDirection Describes possible directions of image mirroring.
MlpPreprocessing Sets additional normalization process.
ModbusDataFormat Describes possible data formats.
MorphologyKernel Describes shape and size of kernel used during morphological operation.
NonMaximaMethod Defines the way non-maxima are detected.
NumberSystemBase Specifies the base of the number system.
OAuthProvider OAuth Provider.
OcrModelType
OcrPretrainedModel Type of pretrained OCR model.
OcrPretrainedModelQuantized Type of pretrained OCR model.
OpcUaCertificateHandling Defines the action taken on the local application certificate for OPC UA client when the security settings are initialized.
OpcUaNodeIdType Represents a type of the identifier in a NodeId of the OPC UA information model.
OpcUaSecurityMode Determines the message security mode of OPC UA connection
OverflowControl Control handling overflowed tiles.
PathDistanceMode Method of distance between path computation.
PathFeature Determines which path feature value to compute.
PathFilter Determines which paths will be taken into account.
PathJoiningAngleMeasure Determines a way to measure the angle between two paths being joined.
PathJoiningMethod Determines a way to combine two paths in one.
PathOrientationAlignment Determines how to align paths orientation.
PathSegmentationMode Describes possible output of segmentation operation.
PeriodPrecisionMethod Determines if and how sub-point accuracy is achieved
PlainType
PlanarTransformationType
PlaneType One of three types of plane in 3D determined by the coordinate axes.
Point3DFileFormat Available formats.
Point3DGridType Describes how a point grid is ordered.
PointShape Possible points' shapes to draw.
PolarInterpolationMethod Possible pixel interpolation methods for polar transform:
Polarity Determines which pixel values will be taken under consideration in processing in edge detection related operations.
PolarSpaceType Decides which formula use to transform image. Parameters \(m\) and \(k\) are set to values which allow to fit source image in output image.
ProcessingDirections
ProductType
ProfileInterpolationMethod Possible values of ProfileInterpolationMethod:
ProjectionDirection Possible directions of projection operations.
ProjectionMode Possible combinations of values in projection operations.
PythonObjectKind
QueueOverflowAction Control handling overflow in queues.
RealBinaryFormat Defines format of real value (floating point) binary serialization
RectangleOrientation Describes how to adjust rectangle's orientation.
RectangularRoiMask Describes what shape the ROI inside rectangle will have.
RegionConnectivity Decides how to understand, which pixels are connected.
RegionContourMode Decides what kind of paths will be result of RegionContour filter.
RegionFeature Determines which region feature value to compute.
RegionMomentType Region moments are regions' mathematical features computed as sums over region pixels, where \(p_x\) and \(p_y\) denotes x and y coordinate of a pixel.
RegionSegmentFittingMethod Determines how segments are fitted to a region.
RegionSkeletonMethod Available methods for region skeletonization operation.
ResampleSurfaceMode Determines which surface scale should be chosen for resampling.
ResizeMethod Interpolation method used when image resizing is considered.
ResizeProfileInterpolation Methods of interpolation during profile resizing.
ResultInterpretation
RidgeOperator Method of the ridge magnitude measuring.
RotationDirection Decides about direction of rotation when operation of angle measuring or vector interpolation are considered.
RotationSizeMode Describes image size change when rotating is performed.
SegmentationAlgorithm The way in which text should be split int characters.
Selection Describes which result will be reported as filter output.
SequenceEnding Determines which array ends to consider.
SerialPortFlowControl
SerialPortParity
SerialPortStopBits
ShapeRegionType
ShiftDirection Direction that vertices of the path will be moved in.
ShiftType Describes ways of object shifting
SimdLevel Different simd levels.
SmoothImageMedianKernel Describes kernel shape to be used during median image smoothing.
SortingOrder Decides whether objects should be sorted in ascendant or descendant order.
SplitDirection Describes a direction in which a box or a rectangle can be split.
StepChange
StreamMode Describes, how to interpret file stream.
StringBinaryFormat Defines format of string binary serialization
StringEncodingFormat Defines character encoding used during string binary serialization
SurfaceEdgeTransition Decides what is considered a surface edge.
SurfaceMultipointHeight Determines what height a surface point created from more than one point will have.
SurfaceRidgePolarity Determines which height values will be taken under consideration in processing in surface ridge detection related operations.
SurfaceStripePolarity Determines which pixel values will be taken under consideration in processing in surface edge detection related operations.
TensorDataOrdering Arrangement of a data elements in a tensor.
TensorDataType A type of data stored in a tensor.
TestImageId Type of test image.
TheilSenVariant Defines a specific method of the Theil-Sen family.
ThresholdDynamicReferenceMethod Possible methods of calculating dynamic threshold values. See SmoothImage filter family.
ThresholdingAlgorithm Which algorithm should be used to extract image from the background.
ThresholdSelectionMethod Possible methods of selecting of the threshold automatically.
TiffImageCompressionScheme Available TIFF compression schemes.
TileSize Defines tile size used in segmentation.
TileTranslationMode How many translation of a tile should be considered.
TranslateAlignment Translate operation coordinate system alignment.
TrimPathMethod Chooses a method to trim a path.
TurnAngleDirection Decides which turns are important in operation being performed.
TurnAnglePrecision Switches between pixel-precise or subpixel-precise operation.
VideoEncoder Supported video encoders. Note that those encoders are not shipped with the software.
View3DColoring
View3DWorldOrientation
VolumeCalculationMethod Determines how negative values are handled.
ZBarcodeType Detected symbology.

Interfaces

NameDescription
ICopyable<T>
IMoveable<T>
Previous: Function Reference