CWIMAQVision

NI Vision for Visual Basic

CWIMAQVision

CWIMAQVision is the top-level object for the CWIMAQVision control.

Properties

CoreUtilizationThis property allows you to specify how many processors all of your vision functions (VDM) should take advantage of. The default is to use as many cores as possible. You may use this to get/set the number of cores to use. If a custom value is set to 0, this indicates use as many as possible, and the user is only allowed to specify as many cores as available by the operating system at maximum.
ExceptionOnErrorSet this property to True to make the methods raise an exception on an error condition. Set this property to False to make the methods return a negative number to indicate the error.

Methods

AboutBoxDisplays the About box for the control.
AbsoluteDifferenceSubtracts one image from another or a constant from an image and returns the absolute value of the difference.
AddAdds an image to an image or a constant to an image.
AndComputes a bitwise AND or a bitwise NAND between two images or an image and a constant.
ArrayToComplexPlaneReplaces a plane of a complex image with the given array of pixel values.
AutoBThresholdObsolete—Use AutoThreshold2 instead. The Automatic Binary Threshold applies a threshold to an image that initially possesses 256 gray levels that divide the image into two classes. A statistical calculation is done to determine the optimal threshold.
AutoMThresholdObsolete—Use AutoThreshold2 instead. Automatic Multi-Threshold is a variant of the classification by clustering method.
The method is based on a reiterated measurement of a histogram. Starting from a random sort, the method determines the gray scale values. After finding the best result, it segments the histogram into N groups. These groups are based on the fact that each point in a group is closer to the barycenter of its own group than the barycenter of another group.
The function outputs the threshold data in two forms: A lookup table (LUT) directly usable by CWIMAQVision.UserLookup or a report directly usable by CWIMAQVision.MultiThreshold.
AutoThresholdObsolete—Use AutoThreshold2 instead. Automatically thresholds an image into multiple classes.
AutoThreshold2Automatically thresholds an image into multiple classes.
AverageComputes the average of two source images or an image and a constant.
BasicParticleObsolete—Use ParticleReport instead. Detects and returns the area and position of particles in a binary image.
BayerColorDecodeDecodes a Bayer encoded image into a color image.
BCGTransformApplies brightness, contrast, and gamma correction to an image by computing and applying a lookup table. The method computes the lookup table based on the Brightness, Contrast, and Gamma values.
BorderOperationModifies the border of an image.
BuildCoordinateSystemBuilds a reference for any arbitrary coordinate system with respect to the image plane. The reference of the coordinate system is specified as the position of the origin of the coordinate system, the orientation of its x-axis with respect to that of the image plane, and the direction of the axis.
CalculateBayerColorLUTCalculates the LUTs to be used by BayerColorDecode
CalculateCoefficientsObsolete—Use ParticleMeasurement instead. Calculates a specified coefficient for each detected particle.
CaliperObsolete—Use Caliper2 instead. Finds edges along a path in an image, chooses pairs of the edges, and measures the distance between them.
Caliper2Finds edges along a path in an image, chooses pairs of the edges, and measures the distance between them.
CannyEdgeFilterOutlines edges in an image using the Canny algorithm, which is well-suited to images with poor signal-to-noise ratios.
CastChanges the type of an image.
CentroidObsolete—Use Centroid2 instead. Computes the centroid of an image.
Centroid2Computes the centroid of an image.
CirclesObsolete—Use FindCircles instead. Separates overlapping circular objects and classifies them depending on their radii. This method also draws the detected circles into the destination image.
ClipboardToImageObsolete—Use ReadImageFromClipboard instead. Copies an image from the clipboard.
ColorBCGTransformApplies brightness, contrast, and gamma correction to each plane of a color image.
ColorEqualizeCalculates the histogram of the luminance plane or all the planes of a color image and redistributes pixel values across the desired range while maintaining pixel value groupings.
ColorHistogramObsolete—Use ColorHistogram3 instead. Calculates the histogram, or pixel distribution, of a color image.
ColorHistogram2Obsolete—Use ColorHistogram3 instead. Calculates the histogram, or pixel distribution, of a color image.
ColorHistogram3Calculates the histogram, or pixel distribution, of a color image.
ColorThresholdThresholds a color image. The method selects a pixel if all three color components fall within the specified range. The method replaces the value of selected pixels with the given replacement value and sets the value of unselected pixels to 0.
ColorUserLookupPerforms a transformation on an image by replacing each pixel value in a given color plane with the lookup table entry corresponding to that value.
ColorValueConversionObsolete—Use ColorValueConversion2 instead. Maps the value of a color in one color mode into the value of the same color in another color mode.
ColorValueConversion2Maps the value of a color in one color mode into the value of the same color in another color mode.
ColorValueToIntegerConverts color values to integers.
ComparePerforms comparison operations between two images or an image and a constant.
CompareGoldenTemplateCompares a template image to an inspection image at a specified alignment.
ComplexPlaneToArrayExtracts a plane from a complex image into a 2D array.
ConcentricRakeFinds edges along concentric circular or angular paths in the image. Edges are determined based on their contrast and slope.
ConvertByLookupObsolete—Use Cast instead. Converts an image by using a lookup table that is encoded in floating point values.
ConvertPixelToRealWorldCoordinatesTransforms pixel coordinates to real world coordinates, according to the calibration information contained in the image.
ConvertRealWorldToPixelCoordinatesTransforms real world coordinates to pixel coordinates, according to the calibration information.
ConvexObsolete—Use ConvexHull instead. Computes the convex envelope for each labeled particle in the source image. If the source image contains more than one particle, you must label each particle with Label before calling this method.
ConvexHullComputes the convex envelope for each particle in the source image.
ConvoluteApplies a linear filter to an image by convolving the image with a filtering kernel.
CoordinateReferenceObsolete—Use BuildCoordinateSystem instead. Builds a reference for any arbitrary coordinate system with respect to the image plane. The reference of the coordinate system is specified as the position of the origin of the coordinate system and the orientation of its x-axis with respect to that of the image plane.
CopyCopies the source image to the destination image, including the border size and calibration information. To copy an area of one image to an area of another image, use the Extract2 method with xSubsample and ySubsample set to 1.
CorrectCalibratedImageCorrects a calibrated image by applying a calibration to create a spatially correct image.
CorrelateObsolete—Use Correlate2 instead. Computes the normalized cross correlation between the source image and the template image.
Correlate2Computes the normalized cross correlation between the source image and the template image.
CreateCWIMAQAIMGradeReportCreates and returns a CWIMAQAIMGradeReport object.
CreateCWIMAQAnnulusCreates and returns a CWIMAQAnnulus object.
CreateCWIMAQArcCreates and returns a CWIMAQArc object.
CreateCWIMAQArcsCreates and returns a CWIMAQArcs object.
CreateCWIMAQAVISessionCreates and returns a CWIMAQAVISession object.
CreateCWIMAQBarcode2DReportCreates and returns a CWIMAQBarcode2DReport object.
CreateCWIMAQBarcodeReportCreates and returns a CWIMAQBarcodeReport object.
CreateCWIMAQBasicParticleReportObsolete Creates and returns a CWIMAQBasicParticleReport object.
CreateCWIMAQBCGOptionsCreates and returns a CWIMAQBCGOptions object.
CreateCWIMAQBMPFileOptionsCreates and returns a CWIMAQBMPFileOptions object.
CreateCWIMAQBrokenlineCreates and returns a CWIMAQBrokenline object.
CreateCWIMAQCalibrationGridOptionsCreates and returns a CWIMAQCalibrationGridOptions object.
CreateCWIMAQCalibrationPointsCreates and returns a CWIMAQCalibrationPoints object.
CreateCWIMAQCalibrationReportCreates and returns a CWIMAQCalibrationReport object.
CreateCWIMAQCaliperOptionsCreates and returns a CWIMAQCaliperOptions object.
CreateCWIMAQCaliperReportCreates and returns a CWIMAQCaliperReport object.
CreateCWIMAQCIEXYZColorCreates and returns a CWIMAQCIEXYZColor object.
CreateCWIMAQCircleDescriptorCreates and returns a CWIMAQCircleDescriptor object.
CreateCWIMAQCircleMatchReportCreates and returns a CWIMAQCircleMatchReport object.
CreateCWIMAQCirclesReportCreates and returns a CWIMAQCirclesReport object.
CreateCWIMAQClassifierReportCreates and returns a CWIMAQClassifierReport object.
CreateCWIMAQColorInformationCreates and returns a CWIMAQColorInformation object.
CreateCWIMAQColorValueConversionOptionsCreates and returns a CWIMAQColorValueConversionOptions object.
CreateCWIMAQContourSegmentsReportCreates and returns a CWIMAQContourSegmentsReport object.
CreateCWIMAQCoordinatesReportCreates and returns a CWIMAQCoordinatesReport object.
CreateCWIMAQCoordinateSystemCreates and returns a CWIMAQCoordinateSystem object.
CreateCWIMAQCurveOptionsCreates and returns a CWIMAQCurveOptions object.
CreateCWIMAQCurveReportCreates and returns a CWIMAQCurveReport object.
CreateCWIMAQCustomClassifierCreates and returns a CWIMAQCustomClassifier object.
CreateCWIMAQDataCreates and returns a CWIMAQData object.
CreateCWIMAQDataMatrixDescriptionOptionsCreates and returns a CWIMAQDataMatrixDescriptionOptions object.
CreateCWIMAQDataMatrixOptionsCreates and returns a CWIMAQDataMatrixOptions object.
CreateCWIMAQDataMatrixReportCreates and returns a CWIMAQDataMatrixReport object.
CreateCWIMAQDataMatrixSearchOptionsCreates and returns a CreateCWIMAQDataMatrixSearchOptions object.
CreateCWIMAQDataMatrixSizeOptionsCreates and returns a CWIMAQDataMatrixSizeOptions object.
CreateCWIMAQDiscriminationDataObsolete

Creates and returns a CWIMAQDiscriminationData object.
CreateCWIMAQEdgeCoordinatesReportCreates and returns a CWIMAQEdgeCoordinatesReport object.
CreateCWIMAQEdgeOptionsCreates and returns a CWIMAQEdgeOptions object.
CreateCWIMAQEdgeOptions2Creates and returns a CWIMAQEdgeOptions2 object.
CreateCWIMAQEdgeReportCreates and returns a CWIMAQEdgeReport object.
CreateCWIMAQEdgeReport2Creates and returns a CWIMAQEdgeReport2 object.
CreateCWIMAQEllipseDescriptorCreates and returns a CWIMAQEllipseDescriptor object.
CreateCWIMAQEllipseMatchReportCreates and returns a CWIMAQEllipseMatchReport object.
CreateCWIMAQFileInformationCreates and returns a CWIMAQFileInformation object.
CreateCWIMAQFitCircleOptionsCreates and returns a CWIMAQFitCircleOptions object.
CreateCWIMAQFitCircleReportCreates and returns a CWIMAQFitCircleReport object.
CreateCWIMAQFitEllipseOptionsCreates and returns a CWIMAQFitEllipseOptions object.
CreateCWIMAQFitEllipseReportCreates and returns a CWIMAQFitEllipseReport object.
CreateCWIMAQFitLineReportCreates and returns a CWIMAQFitLineReport object.
CreateCWIMAQFlattenOptionsCreates and returns a CWIMAQFlattenOptions object.
CreateCWIMAQFreelineCreates and returns a CWIMAQFreeline object.
CreateCWIMAQFreeregionCreates and returns a CWIMAQFreeregion object.
CreateCWIMAQFullParticleReportObsolete Creates and returns a CWIMAQFullParticleReport object.
CreateCWIMAQGeometricFeatureReportCreates and returns a CWIMAQGeometricFeatureReport object.
CreateCWIMAQGeometricFeatureTypeOptionsCreates and returns a CWIMAQGeometricFeatureTypeOptions object.
CreateCWIMAQGeometricPatternMatchReportCreates and returns a CWIMAQGeometricPatternMatchReport object.
CreateCWIMAQHistogramOptionsCreates and returns a CWIMAQHistogramOptions object.
CreateCWIMAQHistogramReportCreates and returns a CWIMAQHistogramReport object.
CreateCWIMAQImageCreates and returns a CWIMAQImage object.
CreateCWIMAQImageDialogCreates and returns a CWIMAQImageDialog object.
CreateCWIMAQInspectionAlignmentCreates and returns a CWIMAQInspectionAlignment object.
CreateCWIMAQInspectionOptionsCreates and returns a CWIMAQInspectionOptions object.
CreateCWIMAQJPEG2000FileAdvancedOptionsCreates and returns a CWIMAQJPEG2000FileAdvancedOptions object.
CreateCWIMAQJPEGFileOptionsCreates and returns a CWIMAQJPEGFileOptions object.
CreateCWIMAQKernelCreates and returns a CWIMAQKernel object.
CreateCWIMAQLCDInformationCreates and returns a CWIMAQLCDInformation object.
CreateCWIMAQLCDSegmentsReportCreates and returns a CWIMAQLCDSegmentsReport object.
CreateCWIMAQLearnCalibrationOptionsCreates and returns a CWIMAQLearnCalibrationOptions object.
CreateCWIMAQLearnColorPatternOptionsCreates and returns a CWIMAQLearnColorPatternOptions object.
CreateCWIMAQLearnGeometricPatternAdvancedOptionsCreates and returns a CWIMAQLearnGeometricPatternAdvancedOptions object.
CreateCWIMAQLearnGeometricPatternOptionsCreates and returns a CWIMAQLearnGeometricPatternOptions object.
CreateCWIMAQLearnPatternAdvancedOptionsCreates and returns a CWIMAQLearnPatternAdvancedOptions object.
CreateCWIMAQLearnPatternAdvancedRotationOptionsCreates and returns a CWIMAQLearnPatternAdvancedRotationOptions object.
CreateCWIMAQLearnPatternAdvancedShiftOptionsCreates and returns a CWIMAQLearnPatternAdvancedShiftOptions object.
CreateCWIMAQLearnPatternOptionsCreates and returns a CWIMAQLearnPatternOptions object.
CreateCWIMAQLineCreates and returns a CWIMAQLine object.
CreateCWIMAQLinearAveragesReportCreates and returns a CWIMAQLinearAveragesReport object.
CreateCWIMAQLineDescriptorCreates and returns a CWIMAQLineDescriptor object.
CreateCWIMAQLineEquationCreates and returns a CWIMAQLineEquation object.
CreateCWIMAQLineMatchReportCreates and returns a CWIMAQLineMatchReport object.
CreateCWIMAQLinesCreates and returns a CWIMAQLines object.
CreateCWIMAQLocalThresholdOptionsCreates and returns a CWIMAQLocalThresholdOptions object.
CreateCWIMAQMatchColorPatternOptionsCreates and returns a CWIMAQMatchColorPatternOptions object.
CreateCWIMAQMatchGeometricPatternAdvancedOptionsCreates and returns a CWIMAQMatchGeometricPatternAdvancedOptions object.
CreateCWIMAQMatchGeometricPatternOptionsCreates and returns a CWIMAQMatchGeometricPatternOptions object.
CreateCWIMAQMatchPatternAdvancedOptionsCreates and returns a CWIMAQMatchPatternAdvancedOptions object.
CreateCWIMAQMatchPatternOptionsCreates and returns a CWIMAQMatchPatternOptions object.
CreateCWIMAQMeterArcCreates and returns a CWIMAQMeterArc object.
CreateCWIMAQMultipleGeometricTemplateCreates and returns a CWIMAQMultipleGeometricTemplate object.
CreateCWIMAQMultiThresholdDataCreates and returns a CWIMAQMultiThresholdData object.
CreateCWIMAQNearestNeighborEngineOptionsCreates and returns a CWIMAQNearestNeighborEngineOptions object.
CreateCWIMAQNearestNeighborTrainingReportCreates and returns a CWIMAQNearestNeighborTrainingReport object.
CreateCWIMAQOvalCreates and returns a CWIMAQOval object.
CreateCWIMAQPaletteCreates and returns a CWIMAQPalette object.
CreateCWIMAQParticleClassifierCreates and returns a CWIMAQParticleClassifier object.
CreateCWIMAQParticleFilter2DataCreates and returns a CWIMAQParticleFilter2Data object.
CreateCWIMAQParticleFilterDataCreates and returns a CWIMAQParticleFilterData object.
CreateCWIMAQParticleReportCreates and returns a CWIMAQParticleReport object.
CreateCWIMAQParticleSelectionDataCreates and returns a CWIMAQParticleSelectionData object.
CreateCWIMAQPatternMatchReportCreates and returns a CWIMAQPatternMatchReport object.
CreateCWIMAQPeakValleyReportCreates and returns a CWIMAQPeakValleyReport object.
CreateCWIMAQPNGFileOptionsCreates and returns a CWIMAQPNGFileOptions object.
CreateCWIMAQPointCreates and returns a CWIMAQPoint object.
CreateCWIMAQPointsCreates and returns a CWIMAQPoints object.
CreateCWIMAQPolygonCreates and returns a CWIMAQPolygon object.
CreateCWIMAQProfileReportCreates and returns a CWIMAQProfileReport object.
CreateCWIMAQQRCodeReportCreates and returns a CWIMAQQRCodeReport object.
CreateCWIMAQQRDataTokensCreates and returns a CWIMAQQRDataTokens object.
CreateCWIMAQQRDescriptionOptionsCreates and returns a CWIMAQQRDescriptionOptions object.
CreateCWIMAQQRSearchOptionsCreates and returns a CWIMAQQRSearchOptions object.
CreateCWIMAQQRSizeOptionsCreates and returns a CWIMAQQRSizeOptions object.
CreateCWIMAQQuantifyReportCreates and returns a CWIMAQQuantifyReport object.
CreateCWIMAQRectangleCreates and returns a CWIMAQRectangle object.
CreateCWIMAQRectangleDescriptorCreates and returns a CWIMAQRectangleDescriptor object.
CreateCWIMAQRectangleMatchReportCreates and returns a CWIMAQRectangleMatchReport object.
CreateCWIMAQRegionsCreates and returns a CWIMAQRegions object.
CreateCWIMAQRotatedRectangleCreates and returns a CWIMAQRotatedRectangle object.
CreateCWIMAQSearchLinesCreates and returns a CWIMAQSearchLines object.
CreateCWIMAQShapeDetectionOptionsCreates and returns a CWIMAQShapeDetectionOptions object.
CreateCWIMAQShapeReportCreates and returns a CWIMAQShapeReport object.
CreateCWIMAQSimpleCalibrationOptionsCreates and returns a CWIMAQSimpleCalibrationOptions object.
CreateCWIMAQStraightEdgeOptionsCreates and returns a CWIMAQStraightEdgeOptions object.
CreateCWIMAQStraightEdgesCreates and returns a CWIMAQStraightEdges object.
CreateCWIMAQStructuringElementCreates and returns a CWIMAQStructuringElement object.
CreateCWIMAQTextOptionsCreates and returns a CWIMAQTextOptions object.
CreateCWIMAQThresholdDataObsolete Creates and returns a CWIMAQThresholdData object.
CreateCWIMAQTIFFFileOptionsCreates and returns a CWIMAQTIFFFileOptions object.
CxAddAdds an image or a constant to a complex image.
CxAttenuateAttenuates the frequencies of a complex image.
CxConjugateComputes the conjugate of a complex image, converting the complex pixel data (z = a + ib) into (z = a - ib).
CxDivideDivides a complex image by an image or a constant.
CxFlipFrequencyTransposes the high and low frequencies of a complex image.
The method flips the high and low frequency components of an FFT image to produce a central, symmetric representation of the spatial frequencies.
CxMultiplyMultiplies a complex image by an image or a constant.
CxSubtractSubtracts an image or a constant from a complex image.
CxTruncateTruncates the frequencies of a complex image.
DanielssonCreates a very accurate distance map based on the Danielsson distance algorithm. The method encodes the pixel value of a particle as a function of the distance of the pixel from the particle perimeter. For a faster but less precise algorithm, use the Distance method.
DetectCirclesDetects circles in a search image.
DetectEllipsesDetects ellipses in a search image.
DetectLinesDetects lines in a search image.
DetectPeaksOrValleysFinds the location, amplitude, and second derivative of peaks or valleys in the input array.
DetectRectanglesDetects rectangles in a search image.
DetectRotationDetects the rotational shift between two images, usually a reference image containing a part at a known orientation and another image containing the part in an unknown orientation.
DistanceCreates a distance map. The method encodes the pixel value of a particle as a function of the distance of the pixel from the particle border. For a more precise but slower algorithm, use Danielsson.
DivideDivides an image by an image or a constant.
DrawLineObsolete—Use DrawLine2 instead. Draws a line on an image.
DrawLine2Draws a line on an image.
DrawOvalObsolete—Use DrawOval2 instead. Draws an oval on an image.
DrawOval2Draws an oval on an image.
DrawRectObsolete—Use DrawRect2 instead. Draws a rectangle on an image.
DrawRect2Draws a rectangle on an image.
DrawTextObsolete—Use DrawText2 instead. Draws text on an image.
DrawText2Draws text on an image.
EdgeFilterExtracts the contours (detects edges) in gray-level values.
EnumerateCustomKeysRetrieves all keynames from an image.
EqualizeObsolete—Use Equalize2 instead.

Creates a histogram equalization of an image. The method redistributes the pixel values of an image to create a linear accumulated histogram. You must execute CWIMAQVision.Histogram prior to this method to supply HistogramReport as input for Equalize. The precision of the method depends on the histogram precision, which in turn depends on the number of classes used in the histogram.
Equalize2Calculates the histogram of an image and redistributes pixel values across the appropriate range to maintain the same pixel value distribution. Pixels whose values are the same before the redistribution also have common pixel values after the redistribution.
ExpandObsolete—Use Expand2 instead. Expands an image or part of an image by adjusting the horizontal and vertical resolution.
Expand2Expands (duplicates) an image or part of an image by adjusting the horizontal and vertical resolution.
ExtractObsolete—Use Extract2 instead. Reduces the size of an image or part of an image by adjusting the horizontal and vertical resolution.
Extract2Extracts (reduces) an image or part of an image with adjustment of the horizontal and vertical resolution.
ExtractColorPlanesExtracts the three planes (RGB, HSL, HSV, or HSI) from an image. The type of planes that you extract does not need to be the same as the image type. For example, you can extract the Hue, Saturation, and Luminance plane from an RGB32 image. Use ExtractSingleColorPlane to extract a single plane from a color image.
ExtractComplexPlaneExtracts a plane from a complex image and places the plane into another image.
ExtractCurvesFinds curves in an image.
ExtractSingleColorPlaneExtracts a single plane from a color image. The plane that you extract is independent from the type of the image. For example, you can extract the hue plane from an RGB32 image or the green plane from an HSL32 image.
FFTComputes the Fourier transform of an image.
FillHoleFills holes in particles. The function fills the holes with a pixel value of 1.
FillImageObsolete—Use FillImage2 instead. Sets each pixel in an image to a specified value.
FillImage2Sets each pixel in an image to a specified value.
FindAngleBetweenLinesComputes the angle between two lines.
FindBisectingLineComputes a line that bisects the two lines specified by Line1 and Line2.
FindCirclesSeparates overlapping circular objects and classifies them based on their radius, surface area, and perimeter. Starting from a binary image, it finds the radius and center of the circular objects even when multiple circular objects overlap. In addition, this method can trace the circles in the destination image. It constructs and uses a Danielsson distance map to determine the radius of each object.
FindDistanceFromPointToLineComputes the distance of a point from a line.
FindEdgesObsolete—Use FindEdges2 instead. Finds edges along a path in an image.
FindEdges2Obsolete—Use CWIMAQVision.FindEdges3 instead. Finds edges along a path in an image.
FindEdges3Finds edges along a path in an image.
FindIntersectionPointComputes the intersection of two lines.
FindLCDSegmentsCalculates the region of interest of each digit from a rectangular area of interest around whole LCD and electroluminescent indicators, which can contain multiple digits. Use this method first in a calibration phase. This method requires that all segments of the indicator are activated.
FindMidLineComputes the mid line between a point and a reference line. The mid line is the line that is parallel to the reference line and lies midway between the point and the reference line.

FindPerpendicularLineComputes a perpendicular line that passes through a point and is perpendicular to a reference line.
FindPointDistancesComputes the distance, in pixels, between consecutive pairs of points.
FindPolygonAreaComputes the area of a polygon described by the coordinates of its vertices.
FindStraightEdgesSearches an ROI for straight edges.
FitCircleObsolete—Use FitCircle2 instead. Finds the circle that best represents a set of points.
FitCircle2Finds the circle that best represents a set of points.
FitEllipseObsolete—Use FitEllipse2 instead. Finds the ellipse that best represents a set of points.
FitEllipse2Finds the ellipse that best represents a set of points.
FitLineFinds the line that best represents a set of points.
FlattenImageFlattens an image and stores its data.
GetAngles>Obsolete—Use GetAngles2 instead. Computes the angles formed by sets of four points in an image or between sets of two points and a common vertex.
GetAngles2Computes the angles formed by sets of four points in an image or between sets of two points and a common vertex.
GetCalibrationInformationReturns calibration information associated with an image.
GetColorLineObsolete—Use GetLine2 instead. Reads a line of pixels from a color image into an array.
GetColorPixelValueObsolete—Use GetPixel instead. Reads the pixel value from a color image.
GetErrorTextA hidden method that returns the error text corresponding to an error code. The error text is a description of what the error code signifies.
GetFileInfoObsolete—Use GetFileInformation instead. Returns information regarding the contents of an image file. You can retrieve information from the following image file formats only: AIPD, BMP, JPEG, JPEG2000, PNG, and TIFF.
GetFileInformationReturns information regarding the contents of an image file. You can retrieve information from the following image file formats only: AIPD, BMP, JPEG, PNG, and TIFF.
GetGeometricFeaturesFromCurvesReturns a set of geometric features extracted from the passed curves.
GetGeometricTemplateFeatureInfoReturns the features learned and stored in the passed geometric template.
GetImageCalibrationObsolete—Use GetCalibrationInformation instead. Returns the calibration information of an image.
GetLineObsolete—Use GetLine2 instead. Returns the pixel values along a given line in an image. If the starting or ending point of the line is outside the image, the line clips at the last visible pixel.
GetLine2Returns the pixel values along a given line in an image.
GetPixelReads a pixel value from an image.
GetPixelValueObsolete—Use GetPixel instead. Reads a pixel value from an image.
GetPointsOnContourFinds the number of edge segments in an image and returns the coordinates of the pixels in each segment. Any pixel that is greater than zero is considered as an edge location.

GetPointsOnLineGiven the endpoints of a line, returns an collection of all the points comprising the line.
GetRowColumnReads a row or a column of pixel values from an image into an array.
GradeDataMatrixBarcodeAIMGrades a Data Matrix barcode using the AIM Print Quality metrics (included in the ISO 16022 specification).
GrayEdgeObsolete—Use EdgeFilter instead. Applies a nonlinear filter to highlight edges.
GrayMorphologyApplies morphological transformations to gray level images.
HistogramObsolete—Use Histogram2 instead. Calculates the histogram, or pixel value distribution, of an image.
Histogram2Calculates the histogram, or pixel value distribution, of an image.
ImageToClipboardObsolete—Use WriteImageToClipboard instead. Copies an image onto the clipboard.
ImageToImageCopies a small image into a larger image, which is useful for making thumbnail sketches from multiple miniature images.
IntegerToColorValueConverts integers to color values.
InterlaceCombineCombines two field images to create a single frame image.
InterlaceSeparateSeparates a frame image into two field images.
Interpolate1DObsolete—Use InterpolatePoints instead. Interpolates the pixel values of an image over specified points.
InterpolatePointsResamples an array of pixels from an image using multiple interpolation functions. Use this method to perform subpixel analysis of pixel profiles in the image.
InverseInverts the pixel intensities of an image in the following manner:
Let
dynamicMin = 0 (U8 images) or the smallest initial pixel value (I16 and SGL images)
dynamicMax = 255 (U8 images) or the largest initial pixel value (I16 and SGL images)
Each pixel value p is replaced by f(p), where f(p) = dynamicMax - p + dynamicMin
InverseFFTTakes the inverse Fourier transform of an image.
LabelObsolete—Use Label2 instead. Labels the particles in a binary image by applying a unique value to all pixels within a particle. This value is encoded in 8 or 16 bits, depending on the image type. The method can label 255 particles in an 8-bit image and 65,535 particles in a 16-bit image.
Label2Labels the particles in a binary image by applying a unique value to all pixels within a particle. This value is encoded in 8 or 16 bits, depending on the image type. The method can label 255 particles in an 8-bit image and 65,535 particles in a 16-bit image.
LearnCalibrationGridLearns a calibration from an image of a grid of circles.
LearnCalibrationPointsLearns a calibration from a set of pixel coordinates and corresponding real-world coordinates.
LearnColorExtracts the color features of an image, which can be used for color matching or other applications related with color information, such as color identification and color image segmentation.
LearnColorPatternCreates a description of the color template image for which you are going to look during the color pattern matching stage. This description data is appended to the input color template image. During the color pattern matching step, the color template descriptor is extracted from the color template image and used to search for the template in the color match image.
LearnGeometricPatternCreates a description of the template image you are going to look for during the matching stage. This description data is appended to the input template image. During the matching step, the description data is extracted from the template image and used to search for the template image in the match image.
LearnGoldenTemplateCreates a description of the golden template image you are going to compare against during the inspection stage. This description data is appended to the input template image.
LearnMultipleGeometricPatternsLearns the multiple geometric template.
LearnPatternObsolete—Use LearnPattern2 instead. Creates a description of the template image for which you are going to look during the matching stage. This description data is appended to the input template image. During the matching step, the template descriptor is extracted from the template image and used to search for the template in the match image.
LearnPattern2Creates a description of the template image for which you are going to look during the matching stage. This description data is appended to the input template image. During the matching step, the template descriptor is extracted from the template image and used to search for the template in the match image.
LinearAveragesObsolete—Use LinearAverages2 instead. Computes the mean line profile of an image.
LinearAverages2Computes the mean line profile of an image.
LineGaugeObsolete—Use LineGauge2 instead. Measures the distance between selected edges with high-precision subpixel accuracy. You can use different measurement modes with this method, such as measuring distances between points and edges and vice versa. This method also can step and repeat its measurements across the image. Depending on the type of the measurement, this method first determines the relevant edges in the image before computing the distances.
LineGauge2Measures the distance between selected edges with high-precision subpixel accuracy. You can use different measurement modes with this method, such as measuring distances between points and edges and vice versa. Use the ReferenceCoordinateSystem and the MeasurementCoordinateSystem to transform the line used to perform the measurements. Use Offsets to step and repeat measurements across the image. Depending on the type of the measurement, this method first determines the relevant edges in the image before computing the distances.
LineProfileObsolete—Use LineProfile2 instead. Computes the profile of a line of pixels.
LineProfile2Computes the profile of a line of pixels. This method returns other information such as pixel statistics and the coordinates of the pixels along the line.
LocalThresholdAutomatically thresholds an image into a binary image based on the requested local adaptive thresholding method.
LogDiffCompletes the following operation for each pixel (x,y): DestImage(x,y) = SourceImage(x,y) AND NOT Operand
LowPassCalculates the interpixel variation between the pixel being processed and those pixels surrounding it. If the pixel being processed has a variation greater than a specified percentage, it is set to the average pixel value as calculated from the neighboring pixels.
MagicWandObsolete—Use MagicWand2 instead. Creates an image mask by extracting a region surrounding a reference pixel, called the origin, and using a tolerance (+ or -) of intensity variations based on this reference pixel. Using this origin, the method searches for its neighbors with an intensity that equals or falls within the tolerance value of the point of reference. The resulting image is binary.
MagicWand2Creates an image mask by extracting a region surrounding a reference pixel, called the origin, and using a tolerance (+ or -) of intensity variations based on this reference pixel. Using this origin, the method searches for its neighbors with an intensity that equals or falls within the tolerance value of the point of reference. The resulting image is binary.
MakeAnnulusCreates a CWIMAQAnnulus object given the properties of the annulus.
MakeArcCreates a CWIMAQArc object given the properties of the arc.
MakeLineCreates a CWIMAQLine object given the properties of the line.
MakeOvalCreates a CWIMAQOval object given the properties of the oval.
MakePointCreates a CWIMAQPoint object given the properties of the point.
MakePointsCreates a CWIMAQPoints collection from an array of the x-coordinates and y-coordinates of the points to be added to the collection.
MakeRectangleCreates a CWIMAQRectangle object given the properties of the rectangle.
MakeRotatedRectangleCreates a CWIMAQRotatedRectangle object given the properties of the rotated rectangle.
MaskCopies SourceImage into DestImage. If a pixel value is 0 (OFF) in MaskImage, the corresponding pixel in DestImage is set to 0.

MaskToRegionsTransforms a mask image into a regions collection.
MatchColorFinds the match between the color content of multiple regions in an image and those defined by the input ColorInformation.
MatchColorPatternSearches for a color pattern, or color template image, in the input Image. Use LearnColorPattern prior to using this method to ensure that the color template image has been configured for the color pattern match stage.
MatchGeometricPatternSearches for a template image in the input Image.
MatchMultipleGeometricPatternsSearches for the templates that are part of the multiple geometric template in the target image.
MatchPatternObsolete—Use MatchPattern2 instead. Searches for a pattern, or template image, in the input Image. Use LearnPattern prior to using this method to ensure that the template image has been configured for the pattern match stage.
MatchPattern2Searches for a pattern, or template image, in the input Image. Use LearnPattern2 prior to using this method to ensure that the template image has been configured for the pattern match stage.
MathLookupConverts the pixel values of an image by replacing them with values from a defined lookup table. This method modifies the dynamic range of either part of an image or the complete image, depending on the type of curve chosen.
MaxComputes the maximum of the pixel values of two images or the maximum of a the pixel values and a constant.
MedianFilterFilters an image using a nonlinear filter. For each pixel, the algorithm takes the neighborhood specified by the given filter sizes and replaces the pixel with the median value of the neighborhood.
MinComputes the minimum value between two pixels or a pixel and a constant and copies the value to the destination pixel.
ModuloTakes the modulo of an image by an image or an image by a constant.
MorphologyPerforms primary morphological transformations.
MulDivComputes a ratio between two source images.
MultiplyMultiplies an image by an image, or multiplies an image by a constant.
MultiThresholdObsolete—Use MultiThreshold2 instead. Thresholds an image into multiple classes. The method classifies each pixel into the last threshold range of which it is a member. If a pixel is not a member of any of the given ranges, the method sets it to 0. For example, given two threshold ranges




rangeMin rangeMax useNewValue newValue
80 150 TRUE 10
120 200 FALSE <ignored>

the method operates as follows:
Replaces pixel values below 80 with 0.
Replaces pixel values from 80 to 120 with 10.
Does not change pixel values from 121 to 200.
Replaces pixel values above 200 with 0.
MultiThreshold2Thresholds an image into multiple classes. The method classifies each pixel into the last threshold range of which it is a member. If a pixel is not a member of any of the given ranges, the method sets it to 0. For example, given two threshold ranges




rangeMin rangeMax useNewValue newValue
80 150 TRUE 10
120 200 FALSE <ignored>

the method operates as follows:
Replaces pixel values below 80 with 0.
Replaces pixel values from 80 to 120 with 10.
Does not change pixel values from 121 to 200.
Replaces pixel values above 200 with 0.
NthOrderFilters an image using a nonlinear filter. For each pixel, the algorithm takes the neighborhood specified by the given filter sizes and replaces the pixel with the nth smallest value in the neighborhood.
OrPerforms an OR or NOR operation on two images or an image and a constant.
ParticleObsolete—Use ParticleReport instead. Detects and measures particles. The method returns a set of measurements made from particles in a binary image.
ParticleCoefficientsObsolete—Use ParticleMeasurement instead. Calculates the coefficients of all detected particles. This method returns an array of coefficients whose measurements are based on the results from Particle.
ParticleDiscriminationObsolete—Use SelectParticles instead. Filters an array of particle reports based on criteria ranges. Call the Particle method before calling this method.
ParticleFilterObsolete—Use ParticleFilter2 instead. Filters (keeps or removes) particles in an image according to their morphological measurements.
ParticleFilter2Filters (keeps or removes) particles in an image according to their morphological measurements.
ParticleFilter3Filters (keeps or removes) particles in an image according to their morphological measurements.
ParticleMeasurementTakes a measurement on all particles in a binary image.
ParticleReportDetects and returns commonly-used properties of particles in a binary image.
PointDistancesObsolete—Use FindPointDistances instead. Computes the distance, in pixels, between consecutive pairs of points.
QuantifyQuantifies the contents of an image or the regions within an image. The region definition is performed with a labeled image mask. Each region of the mask has a single unique value.
RaiseErrorRaises the error with the specified error number. The error code must be an error that is returned by some CWIMAQVision or CWIMAQ function. An invalid error code causes Vision to return an unexpected error message.
RakeFinds edges along a set of parallel lines defined inside a rectangular region. Edges are determined based on their contrast and slope.
ReadBarcodeReads a barcode from an image.
ReadClassifierFileReads a classifier from file.
ReadCustomDataReads user data from a keyname in an image.
ReadCustomStringDataReads a string from a keyname in an image.
ReadDataMatrixBarcodeObsolete—Use CWIMAQVision.ReadDataMatrixBarcode2 instead. Reads Data Matrix barcodes from an image.
ReadDataMatrixBarcode2Reads a Data Matrix barcode from an image. Many of the options provided by this method allow for automatic detection of properties of the Data Matrix barcode or what methods the function should use to locate and decode the barcode. Specificying specific properties and methods for these options will greatly increase the performance of the method.
ReadFileObsolete—Use ReadImage instead. Reads image information from a file. The file can be in one of the following formats: PNG, JPEG, TIFF, AIPD, or BMP.
ReadImageReads image information from a file. The file can be in one of the following formats: PNG, JPEG, JPEG2000, TIFF, AIPD, or BMP.
ReadImageAndVisionInfoReads an image file, including any extra vision information saved with the image. This includes overlay information, pattern matching template information, custom data, and calibration information, as written by WriteImageAndVisionInfo.

ReadImageFromClipboardReads an image from the clipboard.
ReadLCDReads an LCD display in an input image using the regions calculated by the FindLCDSegments. ReadLCD returns the number as a double and as a string. The Segments status output indicates if the number is recognized properly or any of the digits are not recognized fully. This output returns the status of each of the digits in the display. The algorithm tolerates light drift.
ReadMeterReads the position of a needle using the information in a CWIMAQMeterArc object. The method reads VU-meters with a dark needle on a light background or with a light needle on a dark background. It returns the location of the tip of the needle as a percentage of the full range of the meter.
ReadMultipleGeometricTemplateFileReads a multiple geometric template from file.
ReadPDF417BarcodeReads PDF417 barcodes from an image.
ReadQRCodeReads a QR code from an image. Many of the options provided by this method allow for automatic detection of properties of the QR code or what methods the function should use to locate and decode the code. Specifying specific properties and methods for these options will greatly increase the performance of the method.
RefineMatchesRefines matches returned from MatchPattern2 using subpixel information learned using LearnPattern2.
RegionsProfileCalculates the profile of the pixels along the boundary of the specified regions. This method returns other information such as pixel statistics and the coordinates of the pixels along the boundary.
RegionsToMaskTransforms a collection of region objects into a mask image.
RejectBorderEliminates particles that touch the border of an image.
RemoveCustomDataRemoves all data associated with a keyname from an image.
RemoveParticleEliminates or keeps particles resistant to a specified number of erosions. The particles that are kept are exactly the same as those found in the original source image.
ReplaceColorPlanesReplaces one or more image planes from a color image (RGB, HSL, HSV, or HSI). The method replaces only the planes supplied as input. If all three planes are supplied, the source image is ignored, and only the destination image is used. The image is resized to the dimensions of the planes passed on input. Therefore, their sizes must be identical. If one or two planes are supplied, the planes must have the same dimension as the source image.
ReplaceComplexPlaneReplaces a plane of a complex image with the pixel values from a given image.
ResampleObsolete—Use Resample2 instead. Resizes an image to a given resolution.
Resample2Resamples an image to a user-defined size. You can use this method to display a reduced or enlarged image.
RotateObsolete—Use Rotate2 instead. Rotates an image counterclockwise.
Rotate2Rotates an image counterclockwise.
SegmentationStarting from a labeled image, calculates the zones of influence between particles. Each labeled particle dilates/grows until the particles reach their neighbors, at which time this growth is stopped.
SelectParticlesObsolete Returns a selection of particle measurements in reports from BasicParticle or Particle based on a minimum and maximum criteria. SelectParticles allows you to choose which measurements you want to obtain from a particle-detection process.
SeparationSeparates touching particles, particularly small isthmuses found between particles. This method performs n erosions (n = NumberOfErosions), and then reconstructs the final image based on the results of the erosion. If an existing isthmus is broken or removed during the erosion process, the particles are reconstructed without the isthmus. The reconstructed particles, however, have the same size as the initial particles except that they are separated. If no isthmus is broken during the erosion process, the particles are reconstructed as they were initially found, and no change is made.
SetCalibrationInformationObsolete—Use CWIMAQVision.SetCalibrationInformation2 instead. Sets calibration information from a calibrated image to an image to be calibrated. Both images must be the same size.
SetCalibrationInformation2Sets calibration information from a calibrated image to an image to be calibrated. Both images must be the same size.
SetColorLineObsolete—Use SetLine2 instead. Writes a line of pixels in a color image.
SetColorPixelValueObsolete—Use SetPixel2 instead. Changes the pixel value in a color image.
SetImageCalibrationObsolete—Use SetSimpleCalibration instead. Sets the physical calibration attributes of an image.
SetLineObsolete—Use SetLine2 instead. Sets the pixel values along a line in an image.
SetLine2Changes the intensity values in a line of pixels of an image.
SetPixelObsolete—Use SetPixel2 instead. Changes a pixel value in an image.
SetPixel2Changes a pixel value in an image.
SetPixelValueObsolete—Use SetPixel2 instead. Writes a pixel value to an image.
SetRowColumnChanges the intensity values in either a row or a column of pixels in an image.
SetSimpleCalibrationSets a simple calibration for an image or resets the real-world coordinate system in a calibrated image. When used to reset a coordinate system, if the correction table is still required, the table must be relearned. When the coordinate system angle is set to zero, you do not need to make a correction.
ShapeMatchFinds objects in an image whose shape matches the shape of the object specified by a template.
ShiftTranslates an image based on a horizontal and vertical offset.
Shift16To8Obsolete—Use Cast instead. Converts a 16-bit image to an 8-bit image. This conversion is done by shifting the 16-bit pixel values right by the specified number of shift operations, which must be between 1 and 8, and then truncating the result to get an 8-bit value.
SimpleEdgeFinds step edges along a collection of pixel coordinates. This method can return the first, both the first and the last, or all the edges found.
SkeletonStarting from a binary image, calculates the skeletons of the particles within an image or the lines delineating the zones of influence of the objects (skeleton of an inverse image).
SpokeFinds edges along radial lines specified inside an annular region. The edges are determined based on their contrast and slope.
SubtractSubtracts an image from an image or subtracts a constant from an image.
SymmetryTransforms an image through its symmetry.
ThresholdThresholds an image. The method sets pixels values outside of the given range to 0. The method sets pixel values within the range to a given value or leaves the values unchanged.
TransformRegionsRotates and translates a region in an image to transform the region from the ReferenceCoordinateSystem to the MeasurementCoordinateSystem.
TransposeTransposes an image.
UnflattenImageTakes the data returned from FlattenImage and stores it in an image.
UnwrapUnwraps a circular strip from an image into a rectangular strip.
UserLookupPerforms a user-defined lookup table transformation by remapping the pixel values in an image.
View3DObsolete Displays an image using an isometric view. Each pixel from the image source appears as a column of pixels in the 3D view. The pixel value corresponds to the altitude.
WatershedTransformComputes the watershed transform of an image. The watershed transfrom outputs an image in which the same number (label) is assigned to all the pixels that belong to the same catchment basin of the topographic surface of the input image, and 0 is assigned to all the pixels in the watershed line.
WriteBMPFileWrites an image to a file in BMP format.
WriteClassifierFileWrites a classifier to a file.
WriteCustomDataAssociates user data with a keyname in an image.
WriteCustomStringDataAssociates a string with a keyname in an image.
WriteFileObsolete—Use WriteImage instead. Writes an image to a file.
WriteImageWrites an image to a file.
WriteImageAndVisionInfoWrites an image, along with extra vision information associated with the image, to a PNG file. This extra vision information includes overlay, pattern matching template, and calibration information, and custom data.
WriteImageToClipboardWrites an image to the clipboard.
WriteJPEG2000FileWrites an image to a file in JPEG2000 format.
WriteJPEGFileWrites an image to a file in JPEG format.
WriteMultipleGeometricTemplateFileWrites a multiple geometric template to file.
WritePNGFileWrites an image to a file in PNG format.
WriteTIFFFileWrites an image to a file in TIFF format.
XorPerforms an XOR or XNOR operation on two images or an image and a constant.