You are here: Start » AVL.NET » Classes

Classes

NameDescription
AccumulateProfileState
ActivityIndicator Display control that provides an animation indicating waiting or working state of UI.
AddHistograms_OfLoopState
AddImages_OfLoopState
AddProfiles_OfLoopState
AnalogIndicator Display control of analog value indicator with needle and round board.
AnalogIndicatorWithScales Display control of analog value indicator with needle and green/yellow/red colors marked on a round board.
AnyCameraModel
Arc2DArrayDesigner Prompts the user to edit an array of Arc2D objects.
Arc2DDesigner Prompts the user to edit the Arc2D.
ArcFittingFieldThe structure defines a ring-like field in which an arc will be fitted.
ArcFittingFieldArrayDesigner Prompts the user to edit an array of ArcFittingField objects.
ArcFittingFieldDesigner Prompts the user to edit the ArcFittingField.
ArcFittingMap
ArcFittingState
AVL
AvlNetException
AVS
BarcodeGradesHolds information about Barcode quality.
Box3D
BoxArrayDesigner Prompts the user to edit an array of Box objects.
BoxDesigner Prompts the user to edit the Box.
ByteBufferThis type stores a raw binary data of variable length (a continuous stream of bytes). It is usually used when implementing a non-textual custom communication with external systems and devices, or when working with non-textual files of arbitrary formats.
CharacterFeatures
CharacterSample
Circle2DArrayDesigner Prompts the user to edit an array of Circle2D objects.
Circle2DDesigner Prompts the user to edit the Circle2D.
Circle3D
CircleFitting3DState
CircleFittingFieldArrayDesigner Prompts the user to edit an array of CircleFittingField objects.
CircleFittingFieldDesigner Prompts the user to edit the CircleFittingField.
CircleFittingMap
CircleFittingState
ColorizeImageState
ColorThresholdParamsThis structure contains parameters for color-based thresholding of an image.
COMModel
COMModelFull
CompareGoldenTemplate_EdgesState
CompareGoldenTemplate_IntensityState
ConcatenatePaths_OfLoopState
DataCodeHolds information about data code: its position and text which is encoded.
DataMatrixHolds information about DataMatrix: its position and text which is encoded.
DataMatrixCodeParamsSpecifies range of possible data matrix codes.
DataMatrixDetectionParamsSpecifies how data matrix codes are being detected.
DebugPreviewWindowState
DomainException
DrawingStyle
DynamicThresholdParamsThis structure contains parameters for dynamic thresholding of an image.
EdgeGoldenTemplate
EdgeModel
EdgeModelDesigner Prompts the user to edit an Edge Model.
EnumerateFilesRandomState
EnumerateFilesState
EnumerateFilesStateBase
EnumerateImageTilesState
FatalException
FeatureClass
FileEnumItem
FittingMap
GDIImage
GenApi_CategoryDescriptor
GenApi_EnumDescriptor
GenApi_EnumEntryDescriptor
GenApi_FloatDescriptor
GenApi_IntegerDescriptor
GenApi_ParameterDescriptor
GenICam
GenTL_DeviceDescriptor
GenTL_LibraryDescriptor
GigEVision_DeviceDescriptor
GoldenTemplate2Model
GoPointPlot
GoProfile
GrayGoldenTemplate
GrayModel
GrayModelDesigner Prompts the user to edit a Gray Model.
Histogram
HoughCircleAggregates detected circle with its score.
Image
ImagePointTransformsState
InitGPUProcessingState
InputVideoStream
IOException
JoinImages_OfSeriesState
JoinProfilesIntoImage_OfSeriesState
KNNModel
Knob Value selection control class representing a round knob.
LensDistortion
LicenseException
Line2DArrayDesigner Prompts the user to edit an array of Line2D objects.
Line2DDesigner Prompts the user to edit the Line2D.
Line3D
LocationArrayDesigner Prompts the user to edit an array of Location objects.
LocationDesigner Prompts the user to edit the Location.
LUTTransformImageState
Matrix
MaximumHistogram_OfLoopState
MaximumImage_OfLoopState
MaximumProfile_OfLoopState
MinimumHistogram_OfLoopState
MinimumImage_OfLoopState
MinimumProfile_OfLoopState
MlpModel
MultiplyHistograms_OfLoopState
MultiplyImages_OfLoopState
MultiplyProfiles_OfLoopState
NullableHelper static class that is intended to create nullable types easily with type parameter skipped.
NullableRef<T>Represents a reference type that can be assigned null.
NullableValue<T>Represents a value that can be passed or returned optionally.
Object2DThis is output structure for template matching related functions. It groups matched object with its properties.
OcrMlpModel
OcrModelType contains trained OCR model for all OCR functions.
OcrModelDesigner Prompts the user to edit an OCR Model.
OcrSvmModel
OnOffButton ON/OFF switchable button control.
OrganicModel
OutputVideoStream
PassFailIndicator Display control class representing one of the Pass/Neutral/Fail states.
Path
PathArrayDesigner Prompts the user to edit an array of Path objects.
PathDesigner Prompts the user to edit the Path.
PathFitting3DState
PathFittingFieldThe structure defines a field in which a path will be fitted.
PathFittingFieldArrayDesigner Prompts the user to edit an array of PathFittingField objects.
PathFittingFieldDesigner Prompts the user to edit the PathFittingField.
PathFittingMap
PathFittingState
PCAModel
PDF417CodeHolds information about PDF417 code: its position and text which is encoded.
PDF417CodeParamsSpecifies range of possible PDF417 codes.
PDF417DetectionParamsSpecifies how PDF417 codes are being detected.
PhotometricStereo_InitializeHeightMapStruct_State
PinholeCameraBasicParamsBasic parameters for pinhole camera model.
PinholeCameraModelPinhole camera model parameters with distortion.
PixelLut
Point2DArrayDesigner Prompts the user to edit an array of Point2D objects.
Point2DDesigner Prompts the user to edit the Point2D.
Point3DGrid
Position3D
ProcessHelperHelper class that allows to break currently executing functions.
Profile
ProfileBox
QRCodeHolds information about QR code: its position, version and text which is encoded.
RandomState
Rectangle2DArrayDesigner Prompts the user to edit an array of Rectangle2D objects.
Rectangle2DDesigner Prompts the user to edit the Rectangle2D.
RectificationMapRectification transform described as a spatial map with some metadata
RectificationTransformAnalytical description of a rectification transform
RegionCompressed binary mask.
RegionDesigner Prompts the user to edit a Region.
RegionIntersection_OfLoopState
RegionOfInterest
RegionSymmetricDifference_OfLoopState
RegionUnion_OfLoopState
RidgeScanParamsThis structure contains parameters of ridge scanning process. Instance of this structure should be customized and passed as a parameter to ridge scanning related functions.
RidgeScanParams3DThis 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.
RuntimeException
SafeList<T> Represents a strongly typed list of objects that can be accessed by index. The list is responsible for disposing it's elements.
SafeNullableRef<T> Extension of the NullableRef<T> class, that takes responsibility for disposing object in the Value property.
SaveImageState
ScanMap
ScanMapArrayState
ScanMapState
Segment2DArrayDesigner Prompts the user to edit an array of Segment2D objects.
Segment2DDesigner Prompts the user to edit the Segment2D.
Segment3D
SegmentFitting3DState
SegmentFittingFieldArrayDesigner Prompts the user to edit an array of SegmentFittingField objects.
SegmentFittingFieldDesigner Prompts the user to edit the SegmentFittingField.
SegmentFittingMap
SegmentFittingState
SegmentScanFieldArrayDesigner Prompts the user to edit an array of SegmentScanField objects.
SegmentScanFieldDesigner Prompts the user to edit the SegmentScanField.
SelectingVideoBox Extension of VideoBox class adding ability to select a cropping rectangle on top of the image.
SerializerSerializes and deserializes objects into and from binary data.
Settings
ShapeRegionRegion defined by its shape.
ShapeRegionArrayDesigner Prompts the user to edit an array of ShapeRegion objects.
ShapeRegionDesigner Prompts the user to edit the ShapeRegion.
SpatialMap
Statistics_OfLoopState
Stripe1DRepresents stripes found by 1DEdgeDetection functions.
StripeScanParamsThis structure contains parameters of stripe scanning process. Instance of this structure should be customized and passed as a parameter to stripe scanning related functions.
StripeScanParams3DThis 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
SurfaceFormatStores information about dimensions, depth image pixel format, coordinate offsets and scales of a surface.
SurfaceStripe1DRepresents surface stripes found by 1DEdgeDetection3D functions.
SvmModel
SystemException
TelecentricCameraBasicParamsBasic parameters for telecentric camera model.
TelecentricCameraModelTelecentric camera model parameters with distortion.
TestPoint3DGridState
TestSurfaceState
TexemModel
TextSegmentationHow text should be split
TextSegmentationDesigner Prompts the user to edit a segmentation model.
TextSegmentationMethodParameters for region segmentation algorithms.
TextThresholdingMethodParameters of text extraction algorithm.
VideoBox Optimized for efficiency (with hardware acceleration) control displaying images or video frames.
VideoBoxImage Helper class for Image property (data port) in the VideoBox control.
VideoBoxPrimitive Represents a single 2D geometry primitive displayed by the View2DBox control.
View2DBox Extension of the VideoBox control allowing to show a set of 2D geometry primitives on top of the image.
View2DBoxPrimitive Represents a single 2D geometry primitive displayed by the View2DBox control.
View3DBox Hardware accelerated display control for presenting 3D point cloud data and primitives.
ZoomingVideoBox VideoBox class extension that allows end user to manipulate preview zoom and translation.

Structures

NameDescription
Anchor3DDecides about relative position of object in 3D. Exact behaviour depends on filter being used.
AnnotatedPoint2DPoint with grid indices
Arc2D
BarcodeGradingDiagnosticHolds information about Barcode quality.
BlobSplittingParamsThis structure contains parameters for splitting region into blobs.
Box
Circle2D
CircleFittingFieldThe structure defines a ring-like field in which a circle will be fitted.
ClassConfidence
CoordinateSystem Equivalent of the CoordinateSystem2D AVS type. Describes general transform of the object on the 2D surface.
CoordinateSystem2D
Edge1DRepresents edges found by 1DEdgeDetection functions.
EdgeScanParamsThis structure contains parameters of edge scanning process. Instance of this structure should be customized and passed as a parameter to edge scanning related functions.
EdgeScanParams3DThis 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.
Extremum1DRepresents extremum found in profile.
Extremum2DRepresents extremum found in image.
Gap1DRepresents gaps found by 1DEdgeDetection functions.
GenTL_InterfaceDescriptor
ImageFormatStores information about dimensions and pixel format of an image.
ImageLocalExtremaVerificationThis structure contains parameters for verification of local extrema visible on an image.
IntensityThresholdParamsThis structure contains parameters for thresholding an image.
Interval
Line2D
LinearFunction
LocalBlindnessThis structure contains parameters of 1D scanning process that can prevent weaker edges in the vicinity of some strong edges from being detected.
Location
OcrCandidateScore and character pair.
Pixel
PixelFormat
Plane3D
Point2D
Point3D
PointRunCompressed sequence of horizontally consecutive locations.
ProfileEdgeRepresents edges found in profile.
ProfileRidgeRepresents ridges found in profile.
ProfileSectionRepresents sections found in profile.
ProfileStripeRepresents stripes found in profile.
QuadraticFunction
Range
Rectangle2D
RegionProcessingParamsThis structure contains parameters for opening and closing of a region.
Ridge1DRepresents ridges found by 1DEdgeDetection functions.
Segment2D
SegmentFittingFieldThe structure defines a rectangular field in which a segment will be fitted.
SegmentScanFieldThe structure defines a rectangular field in which a series of scan will be performed.
Size
Sphere3D
StringLabel
SurfaceEdge1DRepresents surface edges found by 1DEdgeDetection3D functions.
SurfaceRidge1DRepresents surface ridges found by 1DEdgeDetection3D functions.
Vector2D
Vector3D

Enumerations

NameDescription
ActivationFunction
ActivityIndicator.Mode Determines the display mode of ActivityIndicator control.
AdjustmentMetricOptimization metric for path adjustment
Anchor1DDecides about relative position of object. Exact behaviour depends on filter being used.
Anchor2DDecides about relative position of object. Exact behaviour depends on filter being used.
AngleMetric
AngleRange
AnyCameraModelType
AxisSelects axis on which operation will be performed.
BarcodeFormat
BarcodeGradingErrorCode grading error details.
BayerTypeDescribes kind of Bayer-encoding.
BlobMergingMethod
BlobsDifferenceMeasure
BorderPosition
BoundingRectangleFeatureCriterion of finding bounding rectangle.
CameraModelTypeTypes of available camera model
CharacterFeaturesType
CharacterSortingOrderDecides whether and how to sort character regions in optical character recognition related filters.
CircleFittingMethodPossible methods of fitting a circle to a set of points.
CircularityMeasureWhen calculating circularity one may choose to use different reference circular region.
ColorPaletteDescribes which color palette will be used by the ColorizeImage filter.
CompareMeasureWays of computing image compare.
CornerResponseMethod
CorrelationMeasureWays of computing image correlation.
CreateSpatialMapUnitTypes of units/coordinates for parameters of SpatialMap creation filter
CropPathMethodChooses a method to crop a path.
CropScaleModeChooses scale for the output image.
CurvatureMeasureMethod of computation of the surface curvature.
DataMatrixCodeTypeDetermines which datamatrix code type is decoded.
DataMatrixDetectionMethodSpecifies how code candidates are located.
DataMatrixDistortionLevelDistortion of the code grid
DataMatrixGapSizeSpecifies the distance between neighboring modules.
DataMatrixOutlineStrategySpecifies precision of outline detection.
DataMatrixPyramidStrategySpecifies the step of image downsampling used for finding codes at different scales.
DataMatrixTypeDetermines datamatrix code type.
DataPreprocessing
DifferentiationMethod
DirectionInterpretation
DistanceMeasureMethod to use when measuring distance between two objects like Profiles, Histograms or Images.
DownsampleRegionMode
DrawingModeMethods of drawing on the image.
EdgeFilterDetermines which method is used to compute image gradients.
EdgeMaskFilterNon-recursive filters for gradient computing.
EdgeNoiseLevelInformation about how much noise the object edges have.
EdgePolarityModeDefines how edges with reversed polarity should be treated.
EdgeTransitionDecides what is considered as an edge in the image.
EquidistanceType
ExtremumTypeDecides what kind of extremum is returned.
FileSortingOrderCriterion to take into account when sorting files.
FitType
FrequencyDomainOrigin
GaussKernelPossible dimensions of gaussian kernel used to smooth image.
GenApi_InterfaceType
GradientAngleRangeRange of image gradient angles to choose from
GradientMaskOperatorDescribes methods of image gradient computing.
GradientOperatorDescribes which operator use to compute image gradient.
HSxColorModelColor models used in given operation.
ImageFileFormatAvailable formats.
ImageMomentType
ImagePixelType Specifies the image pixel data type for image data.
InterpolationMethodPossible pixel interpolation methods:
JoinDirection
KernelShapeDescribes structuring element shape.
KMeansClusteringMethod
LawsFilterSize
LawsFilterType
LensDistortionModelTypePossible predefined sets of lens distortion parameters.
LinearBinaryPatternType
LinePeakDetectionMethod
LogsLevelDefines level of logs messages.
MagnitudeMeasureMethod of estimation of the vectors' magnitude.
MarkerType
MatchingCriterion
MatrixOperation
MeanKernelDescribes shape and size of structuring element used during smoothing.
MeasureObjectMethodPossible methods of measuring width of an object.
MEstimatorDefines how to suppress the influence of values far from most others on the result.
MetricSpecifies method of calculating distance between two points.
Metric3DSpecifies method of calculating distance between two points in 3D.
MetricUnit
MirrorDirectionDescribes possible directions of image mirroring.
MlpPreprocessingSets additional normalization process.
MorphologyKernelDescribes shape and size of kernel used during morphological operation.
NonMaximaMethod
OcrModelType
OverflowControlControl handling overflowed tiles.
PassFailIndicator.IndicatorImageSizeMode Specifies the size stretching mode of the PassFailIndicator control in the Image display mode.
PassFailIndicator.Mode Specifies the display mode of the PassFailIndicator control.
PathDistanceMode
PathFeature
PathFilter
PathOrientationAlignment
PathSegmentationMode
PeriodPrecisionMethod
PlainType
PlanarTransformationType
Point3DFileFormat
PointShapePossible points' shapes to draw.
PolarInterpolationMethod
PolarityDetermines which pixel values will be taken under consideration in processing in edge detection related operations.
PolarSpaceTypeDecides which formula use to transform image. Parameters \(m\) and \(k\) are set to values which allow to fit source image in output image.
Primitive3DType Specifies the type of the primitive handled by the View3DBox control.
ProcessingDirections
ProfileBox.SizeMode Specifies profile scaling mode in ProfileBox control.
ProfileInterpolationMethodPossible values of ProfileInterpolationMethod:
ProfileProcessingMode
ProjectionDirectionPossible directions of projection operations.
ProjectionModePossible combinations of values in projection operations.
RectangleOrientationDescribes how to adjust rectangle's orientation.
RectangularRoiMaskDescribes what shape the ROI inside rectangle will have.
RegionConnectivityDecides how to understand, which pixels are connected.
RegionContourMode
RegionFeatureDetermines which region feature value to compute.
RegionMomentType
RegionOfInterestType
RegionSkeletonMethodAvailable methods for region skeletonization operation.
ResizeMethod
ResizeProfileInterpolation
ResultInterpretation
RidgeOperatorMethod of the ridge magnitude measuring.
RotationDirectionDecides about direction of rotation when operation of angle measuring or vector interpolation are considered.
RotationSizeModeDescribes image size change when rotating is performed.
SegmentationAlgorithmThe way in which text should be split int characters.
SelectionDescribes which result will be reported as filter output.
ShapeMomentType
ShapeRegionType Specifies the type of the Shape Region primitive.
ShiftDirection
ShiftType
SimdLevelDifferent simd levels.
SmoothImageMedianKernelDescribes kernel shape to be used during median image smoothing.
SortingOrderDecides whether objects should be sorted in ascendant or descendant order.
SplitDirectionDescribes a direction in which a box or a rectangle can be split.
StepChange
SurfaceEdgeTransitionDecides what is considered a surface edge.
SurfaceRidgePolarityDetermines which height values will be taken under consideration in processing in surface ridge detection related operations.
SurfaceStripePolarityDetermines which pixel values will be taken under consideration in processing in surface edge detection related operations.
TestImageIdType of test image.
TheilSenVariantDefines a specific method of the Theil-Sen family.
ThresholdDynamicReferenceMethodPossible methods of calculating dynamic threshold values. See SmoothImage filter family.
ThresholdingAlgorithmWhich algorithm should be used to extract image from the background.
ThresholdSelectionMethodPossible methods of selecting of the threshold automatically.
TiffImageCompressionSchemeAvailable TIFF compression schemes.
TileSize
TileTranslationMode
TranslateAlignmentTranslate operation coordinate system alignment.
TurnAngleDirection
TurnAnglePrecision
VideoBoxDisplayMode Specifies the underlying display technology mode for the VideoBox control.
VideoBoxPrimitiveType Specifies the type of a primitive displayed by the View2DBox control.
VideoBoxSizeMode Determines the image size handling mode of the VideoBox control.
VideoEncoder
VideoPreviewConversion.PreviewPixelFormat
View3DBox.WorldOrientationMode Determines the world coordinate system type for the View3DBox control.
View3DColoringMode Specifies the point cloud points automatic coloring mode.
View3DGridDisplayMode Specifies the coordinate system measuring grid display mode used in the View3DBox scene visualization.
View3DProjectionMode Specifies the view/projection mode used by the View3DBox control to present its scene.
View3DWorldOrientation Specifies the world space coordinate system type used by the View3DBox control to display its scene.
ZoomingVideoBoxMode Specifies the size handling mode of the ZoomingVideoBox control.
ZoomingVideoBoxSizeMode Specifies the initial size handling mode for ZoomingVideoBox class.

Interfaces

NameDescription
INullable<T>
Previous: Function Reference