documentation.HELP! NI Vision for Visual Basic Documentation

CWIMAQVision

NI Vision for Visual Basic

previous page next page

CWIMAQVision

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

Properties

CoreUtilization	This 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.
ExceptionOnError	Set 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

AboutBox	Displays the About box for the control.
AbsoluteDifference	Subtracts one image from another or a constant from an image and returns the absolute value of the difference.
Add	Adds an image to an image or a constant to an image.
And	Computes a bitwise AND or a bitwise NAND between two images or an image and a constant.
ArrayToComplexPlane	Replaces a plane of a complex image with the given array of pixel values.
AutoBThreshold	Obsolete—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.
AutoMThreshold	Obsolete—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.
AutoThreshold	Obsolete—Use AutoThreshold2 instead. Automatically thresholds an image into multiple classes.
AutoThreshold2	Automatically thresholds an image into multiple classes.
Average	Computes the average of two source images or an image and a constant.
BasicParticle	Obsolete—Use ParticleReport instead. Detects and returns the area and position of particles in a binary image.
BayerColorDecode	Decodes a Bayer encoded image into a color image.
BCGTransform	Applies 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.
BorderOperation	Modifies the border of an image.
BuildCoordinateSystem	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, the orientation of its x-axis with respect to that of the image plane, and the direction of the axis.
CalculateBayerColorLUT	Calculates the LUTs to be used by BayerColorDecode
CalculateCoefficients	Obsolete—Use ParticleMeasurement instead. Calculates a specified coefficient for each detected particle.
Caliper	Obsolete—Use Caliper2 instead. Finds edges along a path in an image, chooses pairs of the edges, and measures the distance between them.
Caliper2	Finds edges along a path in an image, chooses pairs of the edges, and measures the distance between them.
CannyEdgeFilter	Outlines edges in an image using the Canny algorithm, which is well-suited to images with poor signal-to-noise ratios.
Cast	Changes the type of an image.
Centroid	Obsolete—Use Centroid2 instead. Computes the centroid of an image.
Centroid2	Computes the centroid of an image.
Circles	Obsolete—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.
ClipboardToImage	Obsolete—Use ReadImageFromClipboard instead. Copies an image from the clipboard.
ColorBCGTransform	Applies brightness, contrast, and gamma correction to each plane of a color image.
ColorEqualize	Calculates 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.
ColorHistogram	Obsolete—Use ColorHistogram3 instead. Calculates the histogram, or pixel distribution, of a color image.
ColorHistogram2	Obsolete—Use ColorHistogram3 instead. Calculates the histogram, or pixel distribution, of a color image.
ColorHistogram3	Calculates the histogram, or pixel distribution, of a color image.
ColorThreshold	Thresholds 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.
ColorUserLookup	Performs a transformation on an image by replacing each pixel value in a given color plane with the lookup table entry corresponding to that value.
ColorValueConversion	Obsolete—Use ColorValueConversion2 instead. Maps the value of a color in one color mode into the value of the same color in another color mode.
ColorValueConversion2	Maps the value of a color in one color mode into the value of the same color in another color mode.
ColorValueToInteger	Converts color values to integers.
Compare	Performs comparison operations between two images or an image and a constant.
CompareGoldenTemplate	Compares a template image to an inspection image at a specified alignment.
ComplexPlaneToArray	Extracts a plane from a complex image into a 2D array.
ConcentricRake	Finds edges along concentric circular or angular paths in the image. Edges are determined based on their contrast and slope.
ConvertByLookup	Obsolete—Use Cast instead. Converts an image by using a lookup table that is encoded in floating point values.
ConvertPixelToRealWorldCoordinates	Transforms pixel coordinates to real world coordinates, according to the calibration information contained in the image.
ConvertRealWorldToPixelCoordinates	Transforms real world coordinates to pixel coordinates, according to the calibration information.
Convex	Obsolete—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.
ConvexHull	Computes the convex envelope for each particle in the source image.
Convolute	Applies a linear filter to an image by convolving the image with a filtering kernel.
CoordinateReference	Obsolete—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.
Copy	Copies 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.
CorrectCalibratedImage	Corrects a calibrated image by applying a calibration to create a spatially correct image.
Correlate	Obsolete—Use Correlate2 instead. Computes the normalized cross correlation between the source image and the template image.
Correlate2	Computes the normalized cross correlation between the source image and the template image.
CreateCWIMAQAIMGradeReport	Creates and returns a CWIMAQAIMGradeReport object.
CreateCWIMAQAnnulus	Creates and returns a CWIMAQAnnulus object.
CreateCWIMAQArc	Creates and returns a CWIMAQArc object.
CreateCWIMAQArcs	Creates and returns a CWIMAQArcs object.
CreateCWIMAQAVISession	Creates and returns a CWIMAQAVISession object.
CreateCWIMAQBarcode2DReport	Creates and returns a CWIMAQBarcode2DReport object.
CreateCWIMAQBarcodeReport	Creates and returns a CWIMAQBarcodeReport object.
CreateCWIMAQBasicParticleReport	Obsolete Creates and returns a CWIMAQBasicParticleReport object.
CreateCWIMAQBCGOptions	Creates and returns a CWIMAQBCGOptions object.
CreateCWIMAQBMPFileOptions	Creates and returns a CWIMAQBMPFileOptions object.
CreateCWIMAQBrokenline	Creates and returns a CWIMAQBrokenline object.
CreateCWIMAQCalibrationGridOptions	Creates and returns a CWIMAQCalibrationGridOptions object.
CreateCWIMAQCalibrationPoints	Creates and returns a CWIMAQCalibrationPoints object.
CreateCWIMAQCalibrationReport	Creates and returns a CWIMAQCalibrationReport object.
CreateCWIMAQCaliperOptions	Creates and returns a CWIMAQCaliperOptions object.
CreateCWIMAQCaliperReport	Creates and returns a CWIMAQCaliperReport object.
CreateCWIMAQCIEXYZColor	Creates and returns a CWIMAQCIEXYZColor object.
CreateCWIMAQCircleDescriptor	Creates and returns a CWIMAQCircleDescriptor object.
CreateCWIMAQCircleMatchReport	Creates and returns a CWIMAQCircleMatchReport object.
CreateCWIMAQCirclesReport	Creates and returns a CWIMAQCirclesReport object.
CreateCWIMAQClassifierReport	Creates and returns a CWIMAQClassifierReport object.
CreateCWIMAQColorInformation	Creates and returns a CWIMAQColorInformation object.
CreateCWIMAQColorValueConversionOptions	Creates and returns a CWIMAQColorValueConversionOptions object.
CreateCWIMAQContourSegmentsReport	Creates and returns a CWIMAQContourSegmentsReport object.
CreateCWIMAQCoordinatesReport	Creates and returns a CWIMAQCoordinatesReport object.
CreateCWIMAQCoordinateSystem	Creates and returns a CWIMAQCoordinateSystem object.
CreateCWIMAQCurveOptions	Creates and returns a CWIMAQCurveOptions object.
CreateCWIMAQCurveReport	Creates and returns a CWIMAQCurveReport object.
CreateCWIMAQCustomClassifier	Creates and returns a CWIMAQCustomClassifier object.
CreateCWIMAQData	Creates and returns a CWIMAQData object.
CreateCWIMAQDataMatrixDescriptionOptions	Creates and returns a CWIMAQDataMatrixDescriptionOptions object.
CreateCWIMAQDataMatrixOptions	Creates and returns a CWIMAQDataMatrixOptions object.
CreateCWIMAQDataMatrixReport	Creates and returns a CWIMAQDataMatrixReport object.
CreateCWIMAQDataMatrixSearchOptions	Creates and returns a CreateCWIMAQDataMatrixSearchOptions object.
CreateCWIMAQDataMatrixSizeOptions	Creates and returns a CWIMAQDataMatrixSizeOptions object.
CreateCWIMAQDiscriminationData	Obsolete Creates and returns a CWIMAQDiscriminationData object.
CreateCWIMAQEdgeCoordinatesReport	Creates and returns a CWIMAQEdgeCoordinatesReport object.
CreateCWIMAQEdgeOptions	Creates and returns a CWIMAQEdgeOptions object.
CreateCWIMAQEdgeOptions2	Creates and returns a CWIMAQEdgeOptions2 object.
CreateCWIMAQEdgeReport	Creates and returns a CWIMAQEdgeReport object.
CreateCWIMAQEdgeReport2	Creates and returns a CWIMAQEdgeReport2 object.
CreateCWIMAQEllipseDescriptor	Creates and returns a CWIMAQEllipseDescriptor object.
CreateCWIMAQEllipseMatchReport	Creates and returns a CWIMAQEllipseMatchReport object.
CreateCWIMAQFileInformation	Creates and returns a CWIMAQFileInformation object.
CreateCWIMAQFitCircleOptions	Creates and returns a CWIMAQFitCircleOptions object.
CreateCWIMAQFitCircleReport	Creates and returns a CWIMAQFitCircleReport object.
CreateCWIMAQFitEllipseOptions	Creates and returns a CWIMAQFitEllipseOptions object.
CreateCWIMAQFitEllipseReport	Creates and returns a CWIMAQFitEllipseReport object.
CreateCWIMAQFitLineReport	Creates and returns a CWIMAQFitLineReport object.
CreateCWIMAQFlattenOptions	Creates and returns a CWIMAQFlattenOptions object.
CreateCWIMAQFreeline	Creates and returns a CWIMAQFreeline object.
CreateCWIMAQFreeregion	Creates and returns a CWIMAQFreeregion object.
CreateCWIMAQFullParticleReport	Obsolete Creates and returns a CWIMAQFullParticleReport object.
CreateCWIMAQGeometricFeatureReport	Creates and returns a CWIMAQGeometricFeatureReport object.
CreateCWIMAQGeometricFeatureTypeOptions	Creates and returns a CWIMAQGeometricFeatureTypeOptions object.
CreateCWIMAQGeometricPatternMatchReport	Creates and returns a CWIMAQGeometricPatternMatchReport object.
CreateCWIMAQHistogramOptions	Creates and returns a CWIMAQHistogramOptions object.
CreateCWIMAQHistogramReport	Creates and returns a CWIMAQHistogramReport object.
CreateCWIMAQImage	Creates and returns a CWIMAQImage object.
CreateCWIMAQImageDialog	Creates and returns a CWIMAQImageDialog object.
CreateCWIMAQInspectionAlignment	Creates and returns a CWIMAQInspectionAlignment object.
CreateCWIMAQInspectionOptions	Creates and returns a CWIMAQInspectionOptions object.
CreateCWIMAQJPEG2000FileAdvancedOptions	Creates and returns a CWIMAQJPEG2000FileAdvancedOptions object.
CreateCWIMAQJPEGFileOptions	Creates and returns a CWIMAQJPEGFileOptions object.
CreateCWIMAQKernel	Creates and returns a CWIMAQKernel object.
CreateCWIMAQLCDInformation	Creates and returns a CWIMAQLCDInformation object.
CreateCWIMAQLCDSegmentsReport	Creates and returns a CWIMAQLCDSegmentsReport object.
CreateCWIMAQLearnCalibrationOptions	Creates and returns a CWIMAQLearnCalibrationOptions object.
CreateCWIMAQLearnColorPatternOptions	Creates and returns a CWIMAQLearnColorPatternOptions object.
CreateCWIMAQLearnGeometricPatternAdvancedOptions	Creates and returns a CWIMAQLearnGeometricPatternAdvancedOptions object.
CreateCWIMAQLearnGeometricPatternOptions	Creates and returns a CWIMAQLearnGeometricPatternOptions object.
CreateCWIMAQLearnPatternAdvancedOptions	Creates and returns a CWIMAQLearnPatternAdvancedOptions object.
CreateCWIMAQLearnPatternAdvancedRotationOptions	Creates and returns a CWIMAQLearnPatternAdvancedRotationOptions object.
CreateCWIMAQLearnPatternAdvancedShiftOptions	Creates and returns a CWIMAQLearnPatternAdvancedShiftOptions object.
CreateCWIMAQLearnPatternOptions	Creates and returns a CWIMAQLearnPatternOptions object.
CreateCWIMAQLine	Creates and returns a CWIMAQLine object.
CreateCWIMAQLinearAveragesReport	Creates and returns a CWIMAQLinearAveragesReport object.
CreateCWIMAQLineDescriptor	Creates and returns a CWIMAQLineDescriptor object.
CreateCWIMAQLineEquation	Creates and returns a CWIMAQLineEquation object.
CreateCWIMAQLineMatchReport	Creates and returns a CWIMAQLineMatchReport object.
CreateCWIMAQLines	Creates and returns a CWIMAQLines object.
CreateCWIMAQLocalThresholdOptions	Creates and returns a CWIMAQLocalThresholdOptions object.
CreateCWIMAQMatchColorPatternOptions	Creates and returns a CWIMAQMatchColorPatternOptions object.
CreateCWIMAQMatchGeometricPatternAdvancedOptions	Creates and returns a CWIMAQMatchGeometricPatternAdvancedOptions object.
CreateCWIMAQMatchGeometricPatternOptions	Creates and returns a CWIMAQMatchGeometricPatternOptions object.
CreateCWIMAQMatchPatternAdvancedOptions	Creates and returns a CWIMAQMatchPatternAdvancedOptions object.
CreateCWIMAQMatchPatternOptions	Creates and returns a CWIMAQMatchPatternOptions object.
CreateCWIMAQMeterArc	Creates and returns a CWIMAQMeterArc object.
CreateCWIMAQMultipleGeometricTemplate	Creates and returns a CWIMAQMultipleGeometricTemplate object.
CreateCWIMAQMultiThresholdData	Creates and returns a CWIMAQMultiThresholdData object.
CreateCWIMAQNearestNeighborEngineOptions	Creates and returns a CWIMAQNearestNeighborEngineOptions object.
CreateCWIMAQNearestNeighborTrainingReport	Creates and returns a CWIMAQNearestNeighborTrainingReport object.
CreateCWIMAQOval	Creates and returns a CWIMAQOval object.
CreateCWIMAQPalette	Creates and returns a CWIMAQPalette object.
CreateCWIMAQParticleClassifier	Creates and returns a CWIMAQParticleClassifier object.
CreateCWIMAQParticleFilter2Data	Creates and returns a CWIMAQParticleFilter2Data object.
CreateCWIMAQParticleFilterData	Creates and returns a CWIMAQParticleFilterData object.
CreateCWIMAQParticleReport	Creates and returns a CWIMAQParticleReport object.
CreateCWIMAQParticleSelectionData	Creates and returns a CWIMAQParticleSelectionData object.
CreateCWIMAQPatternMatchReport	Creates and returns a CWIMAQPatternMatchReport object.
CreateCWIMAQPeakValleyReport	Creates and returns a CWIMAQPeakValleyReport object.
CreateCWIMAQPNGFileOptions	Creates and returns a CWIMAQPNGFileOptions object.
CreateCWIMAQPoint	Creates and returns a CWIMAQPoint object.
CreateCWIMAQPoints	Creates and returns a CWIMAQPoints object.
CreateCWIMAQPolygon	Creates and returns a CWIMAQPolygon object.
CreateCWIMAQProfileReport	Creates and returns a CWIMAQProfileReport object.
CreateCWIMAQQRCodeReport	Creates and returns a CWIMAQQRCodeReport object.
CreateCWIMAQQRDataTokens	Creates and returns a CWIMAQQRDataTokens object.
CreateCWIMAQQRDescriptionOptions	Creates and returns a CWIMAQQRDescriptionOptions object.
CreateCWIMAQQRSearchOptions	Creates and returns a CWIMAQQRSearchOptions object.
CreateCWIMAQQRSizeOptions	Creates and returns a CWIMAQQRSizeOptions object.
CreateCWIMAQQuantifyReport	Creates and returns a CWIMAQQuantifyReport object.
CreateCWIMAQRectangle	Creates and returns a CWIMAQRectangle object.
CreateCWIMAQRectangleDescriptor	Creates and returns a CWIMAQRectangleDescriptor object.
CreateCWIMAQRectangleMatchReport	Creates and returns a CWIMAQRectangleMatchReport object.
CreateCWIMAQRegions	Creates and returns a CWIMAQRegions object.
CreateCWIMAQRotatedRectangle	Creates and returns a CWIMAQRotatedRectangle object.
CreateCWIMAQSearchLines	Creates and returns a CWIMAQSearchLines object.
CreateCWIMAQShapeDetectionOptions	Creates and returns a CWIMAQShapeDetectionOptions object.
CreateCWIMAQShapeReport	Creates and returns a CWIMAQShapeReport object.
CreateCWIMAQSimpleCalibrationOptions	Creates and returns a CWIMAQSimpleCalibrationOptions object.
CreateCWIMAQStraightEdgeOptions	Creates and returns a CWIMAQStraightEdgeOptions object.
CreateCWIMAQStraightEdges	Creates and returns a CWIMAQStraightEdges object.
CreateCWIMAQStructuringElement	Creates and returns a CWIMAQStructuringElement object.
CreateCWIMAQTextOptions	Creates and returns a CWIMAQTextOptions object.
CreateCWIMAQThresholdData	Obsolete Creates and returns a CWIMAQThresholdData object.
CreateCWIMAQTIFFFileOptions	Creates and returns a CWIMAQTIFFFileOptions object.
CxAdd	Adds an image or a constant to a complex image.
CxAttenuate	Attenuates the frequencies of a complex image.
CxConjugate	Computes the conjugate of a complex image, converting the complex pixel data (z = a + ib) into (z = a - ib).
CxDivide	Divides a complex image by an image or a constant.
CxFlipFrequency	Transposes 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.
CxMultiply	Multiplies a complex image by an image or a constant.
CxSubtract	Subtracts an image or a constant from a complex image.
CxTruncate	Truncates the frequencies of a complex image.
Danielsson	Creates 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.
DetectCircles	Detects circles in a search image.
DetectEllipses	Detects ellipses in a search image.
DetectLines	Detects lines in a search image.
DetectPeaksOrValleys	Finds the location, amplitude, and second derivative of peaks or valleys in the input array.
DetectRectangles	Detects rectangles in a search image.
DetectRotation	Detects 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.
Distance	Creates 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.
Divide	Divides an image by an image or a constant.
DrawLine	Obsolete—Use DrawLine2 instead. Draws a line on an image.
DrawLine2	Draws a line on an image.
DrawOval	Obsolete—Use DrawOval2 instead. Draws an oval on an image.
DrawOval2	Draws an oval on an image.
DrawRect	Obsolete—Use DrawRect2 instead. Draws a rectangle on an image.
DrawRect2	Draws a rectangle on an image.
DrawText	Obsolete—Use DrawText2 instead. Draws text on an image.
DrawText2	Draws text on an image.
EdgeFilter	Extracts the contours (detects edges) in gray-level values.
EnumerateCustomKeys	Retrieves all keynames from an image.
Equalize	Obsolete—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.
Equalize2	Calculates 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.
Expand	Obsolete—Use Expand2 instead. Expands an image or part of an image by adjusting the horizontal and vertical resolution.
Expand2	Expands (duplicates) an image or part of an image by adjusting the horizontal and vertical resolution.
Extract	Obsolete—Use Extract2 instead. Reduces the size of an image or part of an image by adjusting the horizontal and vertical resolution.
Extract2	Extracts (reduces) an image or part of an image with adjustment of the horizontal and vertical resolution.
ExtractColorPlanes	Extracts 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.
ExtractComplexPlane	Extracts a plane from a complex image and places the plane into another image.
ExtractCurves	Finds curves in an image.
ExtractSingleColorPlane	Extracts 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.
FFT	Computes the Fourier transform of an image.
FillHole	Fills holes in particles. The function fills the holes with a pixel value of 1.
FillImage	Obsolete—Use FillImage2 instead. Sets each pixel in an image to a specified value.
FillImage2	Sets each pixel in an image to a specified value.
FindAngleBetweenLines	Computes the angle between two lines.
FindBisectingLine	Computes a line that bisects the two lines specified by Line1 and Line2.
FindCircles	Separates 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.
FindDistanceFromPointToLine	Computes the distance of a point from a line.
FindEdges	Obsolete—Use FindEdges2 instead. Finds edges along a path in an image.
FindEdges2	Obsolete—Use CWIMAQVision.FindEdges3 instead. Finds edges along a path in an image.
FindEdges3	Finds edges along a path in an image.
FindIntersectionPoint	Computes the intersection of two lines.
FindLCDSegments	Calculates 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.
FindMidLine	Computes 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.
FindPerpendicularLine	Computes a perpendicular line that passes through a point and is perpendicular to a reference line.
FindPointDistances	Computes the distance, in pixels, between consecutive pairs of points.
FindPolygonArea	Computes the area of a polygon described by the coordinates of its vertices.
FindStraightEdges	Searches an ROI for straight edges.
FitCircle	Obsolete—Use FitCircle2 instead. Finds the circle that best represents a set of points.
FitCircle2	Finds the circle that best represents a set of points.
FitEllipse	Obsolete—Use FitEllipse2 instead. Finds the ellipse that best represents a set of points.
FitEllipse2	Finds the ellipse that best represents a set of points.
FitLine	Finds the line that best represents a set of points.
FlattenImage	Flattens 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.
GetAngles2	Computes the angles formed by sets of four points in an image or between sets of two points and a common vertex.
GetCalibrationInformation	Returns calibration information associated with an image.
GetColorLine	Obsolete—Use GetLine2 instead. Reads a line of pixels from a color image into an array.
GetColorPixelValue	Obsolete—Use GetPixel instead. Reads the pixel value from a color image.
GetErrorText	A hidden method that returns the error text corresponding to an error code. The error text is a description of what the error code signifies.
GetFileInfo	Obsolete—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.
GetFileInformation	Returns 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.
GetGeometricFeaturesFromCurves	Returns a set of geometric features extracted from the passed curves.
GetGeometricTemplateFeatureInfo	Returns the features learned and stored in the passed geometric template.
GetImageCalibration	Obsolete—Use GetCalibrationInformation instead. Returns the calibration information of an image.
GetLine	Obsolete—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.
GetLine2	Returns the pixel values along a given line in an image.
GetPixel	Reads a pixel value from an image.
GetPixelValue	Obsolete—Use GetPixel instead. Reads a pixel value from an image.
GetPointsOnContour	Finds 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.
GetPointsOnLine	Given the endpoints of a line, returns an collection of all the points comprising the line.
GetRowColumn	Reads a row or a column of pixel values from an image into an array.
GradeDataMatrixBarcodeAIM	Grades a Data Matrix barcode using the AIM Print Quality metrics (included in the ISO 16022 specification).
GrayEdge	Obsolete—Use EdgeFilter instead. Applies a nonlinear filter to highlight edges.
GrayMorphology	Applies morphological transformations to gray level images.
Histogram	Obsolete—Use Histogram2 instead. Calculates the histogram, or pixel value distribution, of an image.
Histogram2	Calculates the histogram, or pixel value distribution, of an image.
ImageToClipboard	Obsolete—Use WriteImageToClipboard instead. Copies an image onto the clipboard.
ImageToImage	Copies a small image into a larger image, which is useful for making thumbnail sketches from multiple miniature images.
IntegerToColorValue	Converts integers to color values.
InterlaceCombine	Combines two field images to create a single frame image.
InterlaceSeparate	Separates a frame image into two field images.
Interpolate1D	Obsolete—Use InterpolatePoints instead. Interpolates the pixel values of an image over specified points.
InterpolatePoints	Resamples an array of pixels from an image using multiple interpolation functions. Use this method to perform subpixel analysis of pixel profiles in the image.
Inverse	Inverts 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
InverseFFT	Takes the inverse Fourier transform of an image.
Label	Obsolete—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.
Label2	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.
LearnCalibrationGrid	Learns a calibration from an image of a grid of circles.
LearnCalibrationPoints	Learns a calibration from a set of pixel coordinates and corresponding real-world coordinates.
LearnColor	Extracts 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.
LearnColorPattern	Creates 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.
LearnGeometricPattern	Creates 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.
LearnGoldenTemplate	Creates 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.
LearnMultipleGeometricPatterns	Learns the multiple geometric template.
LearnPattern	Obsolete—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.
LearnPattern2	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.
LinearAverages	Obsolete—Use LinearAverages2 instead. Computes the mean line profile of an image.
LinearAverages2	Computes the mean line profile of an image.
LineGauge	Obsolete—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.
LineGauge2	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. 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.
LineProfile	Obsolete—Use LineProfile2 instead. Computes the profile of a line of pixels.
LineProfile2	Computes 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.
LocalThreshold	Automatically thresholds an image into a binary image based on the requested local adaptive thresholding method.
LogDiff	Completes the following operation for each pixel (x,y): DestImage(x,y) = SourceImage(x,y) AND NOT Operand
LowPass	Calculates 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.
MagicWand	Obsolete—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.
MagicWand2	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.
MakeAnnulus	Creates a CWIMAQAnnulus object given the properties of the annulus.
MakeArc	Creates a CWIMAQArc object given the properties of the arc.
MakeLine	Creates a CWIMAQLine object given the properties of the line.
MakeOval	Creates a CWIMAQOval object given the properties of the oval.
MakePoint	Creates a CWIMAQPoint object given the properties of the point.
MakePoints	Creates a CWIMAQPoints collection from an array of the x-coordinates and y-coordinates of the points to be added to the collection.
MakeRectangle	Creates a CWIMAQRectangle object given the properties of the rectangle.
MakeRotatedRectangle	Creates a CWIMAQRotatedRectangle object given the properties of the rotated rectangle.
Mask	Copies SourceImage into DestImage. If a pixel value is 0 (OFF) in MaskImage, the corresponding pixel in DestImage is set to 0.
MaskToRegions	Transforms a mask image into a regions collection.
MatchColor	Finds the match between the color content of multiple regions in an image and those defined by the input ColorInformation.
MatchColorPattern	Searches 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.
MatchGeometricPattern	Searches for a template image in the input Image.
MatchMultipleGeometricPatterns	Searches for the templates that are part of the multiple geometric template in the target image.
MatchPattern	Obsolete—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.
MatchPattern2	Searches 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.
MathLookup	Converts 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.
Max	Computes the maximum of the pixel values of two images or the maximum of a the pixel values and a constant.
MedianFilter	Filters 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.
Min	Computes the minimum value between two pixels or a pixel and a constant and copies the value to the destination pixel.
Modulo	Takes the modulo of an image by an image or an image by a constant.
Morphology	Performs primary morphological transformations.
MulDiv	Computes a ratio between two source images.
Multiply	Multiplies an image by an image, or multiplies an image by a constant.
MultiThreshold	Obsolete—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.
MultiThreshold2	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.
NthOrder	Filters 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.
Or	Performs an OR or NOR operation on two images or an image and a constant.
Particle	Obsolete—Use ParticleReport instead. Detects and measures particles. The method returns a set of measurements made from particles in a binary image.
ParticleCoefficients	Obsolete—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.
ParticleDiscrimination	Obsolete—Use SelectParticles instead. Filters an array of particle reports based on criteria ranges. Call the Particle method before calling this method.
ParticleFilter	Obsolete—Use ParticleFilter2 instead. Filters (keeps or removes) particles in an image according to their morphological measurements.
ParticleFilter2	Filters (keeps or removes) particles in an image according to their morphological measurements.
ParticleFilter3	Filters (keeps or removes) particles in an image according to their morphological measurements.
ParticleMeasurement	Takes a measurement on all particles in a binary image.
ParticleReport	Detects and returns commonly-used properties of particles in a binary image.
PointDistances	Obsolete—Use FindPointDistances instead. Computes the distance, in pixels, between consecutive pairs of points.
Quantify	Quantifies 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.
RaiseError	Raises 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.
Rake	Finds edges along a set of parallel lines defined inside a rectangular region. Edges are determined based on their contrast and slope.
ReadBarcode	Reads a barcode from an image.
ReadClassifierFile	Reads a classifier from file.
ReadCustomData	Reads user data from a keyname in an image.
ReadCustomStringData	Reads a string from a keyname in an image.
ReadDataMatrixBarcode	Obsolete—Use CWIMAQVision.ReadDataMatrixBarcode2 instead. Reads Data Matrix barcodes from an image.
ReadDataMatrixBarcode2	Reads 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.
ReadFile	Obsolete—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.
ReadImage	Reads image information from a file. The file can be in one of the following formats: PNG, JPEG, JPEG2000, TIFF, AIPD, or BMP.
ReadImageAndVisionInfo	Reads 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.
ReadImageFromClipboard	Reads an image from the clipboard.
ReadLCD	Reads 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.
ReadMeter	Reads 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.
ReadMultipleGeometricTemplateFile	Reads a multiple geometric template from file.
ReadPDF417Barcode	Reads PDF417 barcodes from an image.
ReadQRCode	Reads 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.
RefineMatches	Refines matches returned from MatchPattern2 using subpixel information learned using LearnPattern2.
RegionsProfile	Calculates 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.
RegionsToMask	Transforms a collection of region objects into a mask image.
RejectBorder	Eliminates particles that touch the border of an image.
RemoveCustomData	Removes all data associated with a keyname from an image.
RemoveParticle	Eliminates 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.
ReplaceColorPlanes	Replaces 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.
ReplaceComplexPlane	Replaces a plane of a complex image with the pixel values from a given image.
Resample	Obsolete—Use Resample2 instead. Resizes an image to a given resolution.
Resample2	Resamples an image to a user-defined size. You can use this method to display a reduced or enlarged image.
Rotate	Obsolete—Use Rotate2 instead. Rotates an image counterclockwise.
Rotate2	Rotates an image counterclockwise.
Segmentation	Starting 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.
SelectParticles	Obsolete 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.
Separation	Separates 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.
SetCalibrationInformation	Obsolete—Use CWIMAQVision.SetCalibrationInformation2 instead. Sets calibration information from a calibrated image to an image to be calibrated. Both images must be the same size.
SetCalibrationInformation2	Sets calibration information from a calibrated image to an image to be calibrated. Both images must be the same size.
SetColorLine	Obsolete—Use SetLine2 instead. Writes a line of pixels in a color image.
SetColorPixelValue	Obsolete—Use SetPixel2 instead. Changes the pixel value in a color image.
SetImageCalibration	Obsolete—Use SetSimpleCalibration instead. Sets the physical calibration attributes of an image.
SetLine	Obsolete—Use SetLine2 instead. Sets the pixel values along a line in an image.
SetLine2	Changes the intensity values in a line of pixels of an image.
SetPixel	Obsolete—Use SetPixel2 instead. Changes a pixel value in an image.
SetPixel2	Changes a pixel value in an image.
SetPixelValue	Obsolete—Use SetPixel2 instead. Writes a pixel value to an image.
SetRowColumn	Changes the intensity values in either a row or a column of pixels in an image.
SetSimpleCalibration	Sets 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.
ShapeMatch	Finds objects in an image whose shape matches the shape of the object specified by a template.
Shift	Translates an image based on a horizontal and vertical offset.
Shift16To8	Obsolete—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.
SimpleEdge	Finds 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.
Skeleton	Starting 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).
Spoke	Finds edges along radial lines specified inside an annular region. The edges are determined based on their contrast and slope.
Subtract	Subtracts an image from an image or subtracts a constant from an image.
Symmetry	Transforms an image through its symmetry.
Threshold	Thresholds 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.
TransformRegions	Rotates and translates a region in an image to transform the region from the ReferenceCoordinateSystem to the MeasurementCoordinateSystem.
Transpose	Transposes an image.
UnflattenImage	Takes the data returned from FlattenImage and stores it in an image.
Unwrap	Unwraps a circular strip from an image into a rectangular strip.
UserLookup	Performs a user-defined lookup table transformation by remapping the pixel values in an image.
View3D	Obsolete 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.
WatershedTransform	Computes 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.
WriteBMPFile	Writes an image to a file in BMP format.
WriteClassifierFile	Writes a classifier to a file.
WriteCustomData	Associates user data with a keyname in an image.
WriteCustomStringData	Associates a string with a keyname in an image.
WriteFile	Obsolete—Use WriteImage instead. Writes an image to a file.
WriteImage	Writes an image to a file.
WriteImageAndVisionInfo	Writes 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.
WriteImageToClipboard	Writes an image to the clipboard.
WriteJPEG2000File	Writes an image to a file in JPEG2000 format.
WriteJPEGFile	Writes an image to a file in JPEG format.
WriteMultipleGeometricTemplateFile	Writes a multiple geometric template to file.
WritePNGFile	Writes an image to a file in PNG format.
WriteTIFFFile	Writes an image to a file in TIFF format.
Xor	Performs an XOR or XNOR operation on two images or an image and a constant.

---

previous page start next page

Get in touch

Submit feedback about this site to:

• [email protected]