Back to Adaptive Vision Library website

You are here: Start » Function Reference » Image

Image

Image Basics

Icon Name Description / Applications Modules
ClearImage

Sets image pixels in ROI to the specified value.

FoundationLite
CopyImageData

Creates an image copy with the same size and pixel format.

FoundationLite
CreateImageFromPoint3DGrid

Creates a depth image from the Z-values of the input point grid.


Allows for performing 2D operations on 3D data.

Vision3DLite
CreateImageFromSurface

Creates a depth image from the Z-values of the input surface.


Allows for performing 2D operations on 3D data.

Vision3DStandard
EmptyImage

Creates an image filled with one color.


Most typically used to prepare a background for image drawing tools.

FoundationLite
FillImage

Fills the input image with one color.

FoundationLite
GetImageColumn

Extracts an array of pixel values from a single column of an image.

FoundationLite
GetImagePixel

Returns a single pixel of an image.

FoundationLite
GetImagePixel_Interpolated

Returns an interpolated single pixel of an image.


Sub-pixel sampling of an image.

FoundationLite
GetImageRow

Extracts an array of pixel values from a single row of an image.

FoundationLite
GetMultipleImagePixelValues_Safe

Returns an array of pixel values at specified locations; the image range is checked.

FoundationLite
ImageBox

Returns a box corresponding to the dimensions of an image.

FoundationLite
ImageCharacteristicPoint

Returns one of the 9 characteristic points of an image (corners or mid-points).

FoundationLite
ImageToMatrix

Converts a single-channel image to a matrix.

FoundationLite
JoinProfilesIntoImage

Creates an image by joining an array of 1D profiles into consecutive image rows.


Usually used for merging 3D profiles into a depth image.

FoundationLite
JoinProfilesIntoImage_OfSeries

Creates an image by joining 1D profiles, which appear in consecutive iterations.


Usually used for merging 3D profiles into a depth image.

FoundationLite
LoadImageObject

Loads serialized Image object from AVDATA file.

FoundationLite
MakeImage

Converts a pixel array to a single-channel image.

FoundationLite
MatrixToImage

Converts a matrix to a single-channel real image.

FoundationLite
RealignImagePitch

Creates a new image with a standard pitch alignment.


Can be used to normalize an image created with a non-standard third-party camera or framegrabber.

FoundationLite
SaveImageObject

Saves serialized Image object as AVDATA file.

FoundationLite
SetImageColumn

Sets pixel values in a single entire column of an image.


Allows for creating images from calculated real values. It is significantly slower than SetImageRow.

FoundationLite
SetImagePixel

Sets a pixel of an image to the selected value.

FoundationLite
SetImagePixels

Sets multiple pixels of an image to the selected value (all the pixels get the same value).

FoundationLite
SetImageRow

Sets pixel values in a single entire row of an image.


Allows for creating images from calculated real values.

FoundationLite
SetMultipleImagePixels

Sets pixels of an image to the selected values (each pixel gets another value).

FoundationLite
SkipEmptyImage

If the input image contains at least one pixel, then it is copied to the output; otherwise Nil is returned.


Secures against domain errors caused by empty images.

FoundationLite
TestImage

Returns a sample image.


Makes it possible to quickly present results of various image processing filters.

FoundationLite

Image Color Spaces

Icon Name Description / Applications Modules
BayerToRgb

Converts a Bayer-encoded color image into RGB color space.


Use this filter only if the conversion functionality is not provided by the camera (check appropriate pixel types).

FoundationBasic
CmykToRgb

Converts color space from Cyan-Magenta-Yellow-Key into Red-Green-Blue.


CMYK color space is designed for printing - not recommended for machine vision.

FoundationBasic
HsiToRgb

Converts color space from Hue-Saturation-Intensity into Red-Green-Blue.

FoundationBasic
HslToRgb

Converts color space from Hue-Saturation-Luminance to Red-Green-Blue.

FoundationBasic
HsvToRgb

Converts color space from Hue-Saturation-Value to Red-Green-Blue.

FoundationLite
LabToRgb

Converts color space from L*a*b* to Red-Green-Blue.

FoundationBasic
Rgb555ToRgb888

Converts a RGB555 image into a RGB888 one.


Decompression of pixel depth from 2 to 3 bytes.

FoundationBasic
Rgb565ToRgb888

Converts a RGB565 image into a RGB888 one.


Decompression of pixel depth from 2 to 3 bytes.

FoundationBasic
Rgb888ToRgb555

Converts a RGB888 image into a RGB555 one.


Compression of pixel depth from 3 to 2 bytes.

FoundationBasic
Rgb888ToRgb565

Converts a RGB888 image into a RGB565 one.


Compression of pixel depth from 3 to 2 bytes.

FoundationBasic
RgbToCmyk

Converts color space from Red-Green-Blue into Cyan-Magenta-Yellow-Key.


CMYK color space is designed for printing - not recommended for machine vision.

FoundationBasic
RgbToHsi

Converts color space from Red-Green-Blue into Hue-Saturation-Intensity.


Color analysis is easier in the HSI color space than in RGB.

FoundationBasic
RgbToHsl

Converts color space from Red-Green-Blue to Hue-Saturation-Luminance.


Color analysis is easier in the HSL color space than in RGB.

FoundationBasic
RgbToHsv

Converts color space from Red-Green-Blue to Hue-Saturation-Value.


Color analysis is easier in the HSV color space than in RGB.

FoundationLite
RgbToLab

Converts color space from Red-Green-Blue to L*a*b*.

FoundationBasic
RgbToXyz

Converts color space from Red-Green-Blue to XYZ.


XYZ color space is designed for human perception - not recommended for machine vision.

FoundationBasic
RgbToYCoCg

Converts color space from Red-Green-Blue into pseudointensitY-Orange-Green.

FoundationBasic
RgbToYuv

Converts color space from Red-Green-Blue into YUV.

FoundationBasic
SplitBayerImage

Creates several monochromatic images from individual pixels of the input Bayer pattern image.

FoundationBasic
XyzToRgb

Converts color space from XYZ to Red-Green-Blue.


XYZ color space is designed for human perception - not recommended for machine vision.

FoundationBasic
YCoCgToRgb

Converts color space from pseudointensitY-Orange-Green into Red-Green-Blue.

FoundationBasic
Yuv442ToRgb

Converts a YUV-encoded image into RGB color space.

FoundationBasic
YuvToRgb

Converts color space from YUV into Red-Green-Blue.

FoundationBasic

Image Combinators

Icon Name Description / Applications Modules
AddImages

Adds two images pixel by pixel.

FoundationLite
AddImages_OfArray

Adds images of an array pixel by pixel.

FoundationLite
AddImages_OfLoop

Adds images appearing in consecutive iterations pixel by pixel.

FoundationLite
AverageImages

Averages two images pixel by pixel.

FoundationLite
AverageImages_OfArray

Averages images from an array pixel by pixel.

FoundationLite
AverageImages_OfLoop

Averages images appearing in consecutive iterations pixel by pixel.

FoundationLite
BlendImages

Computes weighted sum pixel by pixel.

FoundationLite
ComposeImages

Takes pixels from the first image within the specified region and from the other one elsewhere.

FoundationLite
DifferenceImage

Computes the non-negative distances between corresponding pixel values.


Useful for things like comparing an image against a template or for detecting differences between consecutive video frames.

FoundationLite
DifferenceImage_Flex

Computes the non-negative distances between corresponding pixel values using tiles.


Useful for things like comparing an image against a template or for detecting differences between consecutive video frames.

FoundationPro
DifferenceImage_Shifted

Computes the non-negative distances between corresponding pixel values.


Useful for things like comparing an image against a template or for detecting differences between consecutive video frames.

FoundationLite
DivideImages

Divides two images pixel by pixel.


Can be used for flat field correction.

FoundationLite
LerpImages

Interpolates two images linearly pixel by pixel.

FoundationLite
LerpImages_ByImage

Interpolates two images linearly pixel by pixel according to another image values.

FoundationLite
MaximumImage

Creates an image from the higher pixel values of each corresponding pair.

FoundationLite
MaximumImage_OfArray

Computes the maximum of images of an array pixel by pixel.

FoundationLite
MaximumImage_OfLoop

Computes the maximum of images appearing in consecutive iterations pixel by pixel.

FoundationLite
MedianImages_OfArray

Compute median value for each pixel of images from an array.

FoundationLite
MinimumImage

Creates an image from the lower pixel values of each corresponding pair.

FoundationLite
MinimumImage_OfArray

Computes the minimum of images of an array pixel by pixel.

FoundationLite
MinimumImage_OfLoop

Computes the minimum of images appearing in consecutive iterations pixel by pixel.

FoundationLite
MultiplyImages

Multiplies two images pixel by pixel.

FoundationLite
MultiplyImages_OfArray

Multiplies images of an array pixel by pixel.

FoundationLite
MultiplyImages_OfLoop

Multiplies images appearing in consecutive iterations pixel by pixel.

FoundationLite
NthImage_OfArray

For each pixel location, get value of n-th (increasing) pixel among input images.

FoundationLite
RollingAverageImages_OfArray

Averages images appearing in an array pixel by pixel using exponential rolling average.

FoundationLite
RollingAverageImages_OfLoop

Averages images appearing in consecutive iterations pixel by pixel using exponential rolling average.

FoundationLite
SubtractImages

Subtracts two images pixel by pixel. The result is signed.

FoundationLite

Image Conversions

Icon Name Description / Applications Modules
AddChannels

Creates a monochromatic image by summing the values of the input image channels.

FoundationLite
AddChannels_Saturation

Creates a monochromatic image by summing the values of the input image channels with saturation.

FoundationLite
AverageChannels

Creates a monochromatic image by averaging the input image channels.

FoundationLite
AverageChannels_121

Creates a monochromatic image by averaging the input image channels.


Conversion to mono which is more consistent with human perception (our eyes are more sensitive to green).

FoundationLite
AverageChannels_Weighted

Creates a monochromatic image from weighted averages of the input image channels.

FoundationLite
ConvertPixelType

Changes the type of pixel components.

FoundationLite
ConvertToMultichannel

Creates a multichannel image from a monochromatic one by replicating its channel.

FoundationLite
MergeChannels

Creates a multichannel image from several monochromatic ones.

FoundationLite
MixChannels

Calculates a linear combination of image channels.

FoundationLite
ReverseChannels

Reverses the order of channels in an image.


E.g. when one has an RGB image, but needs to convert to BGR.

FoundationLite
SelectChannel

Creates an image from a single channel of the input image.

FoundationLite
SplitChannels

Creates several monochromatic images from individual channels of the input image.

FoundationLite

Image Drawing

Icon Name Description / Applications Modules
DrawArc

Draws an arc on an image.

FoundationLite
DrawArcs_MultiColor

Draws arcs on an image with multiple colors.

FoundationLite
DrawArcs_SingleColor

Draws arcs on an image with a single color.

FoundationLite
DrawArcs_TwoColors

Draws arcs on an image with two colors, depending on the status of each arc.


Usually: green or red for pass/fail status.

FoundationLite
DrawBox

Draws a box on an image.

FoundationLite
DrawBoxes_MultiColor

Draws boxes on an image with multiple colors.

FoundationLite
DrawBoxes_SingleColor

Draws boxes on an image with a single color.

FoundationLite
DrawBoxes_TwoColors

Draws boxes on an image with two colors, depending on the status of each box.


Usually: green or red for pass/fail status.

FoundationLite
DrawCircle

Draws a circle on an image.

FoundationLite
DrawCircles_MultiColor

Draws circles on an image with multiple colors.

FoundationLite
DrawCircles_SingleColor

Draws circles on an image with a single color.

FoundationLite
DrawCircles_TwoColors

Draws circles on an image with two colors, depending on the status of each circle.


Usually: green or red for pass/fail status.

FoundationLite
DrawCoordinateSystem

Draws a pair of arrows representing a coordinate system on an image.

FoundationLite
DrawCoordinateSystems_MultiColor

Draws coordinate systems on an image with multiple colors.

FoundationLite
DrawCoordinateSystems_SingleColor

Draws coordinate systems on an image with a single color.

FoundationLite
DrawCoordinateSystems_TwoColors

Draws coordinate systems on an image with two colors, depending on the status of each coordinate system.


Usually: green or red for pass/fail status.

FoundationLite
DrawCrosshair

Draws a crosshair on an image.

FoundationLite
DrawCrosshairs_MultiColor

Draws crosshairs on an image with multiple colors.

FoundationLite
DrawCrosshairs_SingleColor

Draws crosshairs on an image with a single colors.

FoundationLite
DrawCrosshairs_TwoColors

Draws crosshairs on an image with two colors, depending on the status of each crosshair.


Usually: green or red for pass/fail status.

FoundationLite
DrawDimensionLine

Draws a dimension line on an image.

FoundationLite
DrawDimensionLines_MultiColor

Draws dimension lines on an image with multiple colors.

FoundationLite
DrawDimensionLines_SingleColor

Draws dimension lines on an image with a single color.

FoundationLite
DrawDimensionLines_TwoColors

Draws dimension lines on an image with two colors, depending on the status of each dimension line.


Usually: green or red for pass/fail status.

FoundationLite
DrawEllipse

Draws an ellipse on an image.

FoundationLite
DrawEllipses_MultiColor

Draws ellipses on an image with multiple colors.

FoundationLite
DrawEllipses_SingleColor

Draws ellipses on an image with a single color.

FoundationLite
DrawEllipses_TwoColors

Draws ellipses on an image with two colors, depending on the status of each ellipse.


Usually: green or red for pass/fail status.

FoundationLite
DrawGridImage

Draws an image as a tile on an image considered to be a grid of tiles.

FoundationLite
DrawImage

Draws an image on another one.

FoundationLite
DrawImages

Draws an array of images on an image.

FoundationLite
DrawLine

Draws a line on an image.

FoundationLite
DrawLines_MultiColor

Draws lines on an image with multiple colors.

FoundationLite
DrawLines_SingleColor

Draws lines on an image with a single color.

FoundationLite
DrawLines_TwoColors

Draws lines on an image with two colors, depending on the status of each line.


Usually: green or red for pass/fail status.

FoundationLite
DrawPath

Draws a path on an image.

FoundationLite
DrawPaths_MultiColor

Draws paths on an image with multiple colors.

FoundationLite
DrawPaths_SingleColor

Draws paths on an image with a single color.

FoundationLite
DrawPaths_TwoColors

Draws paths on an image with two colors, depending on the status of each path.


Usually: green or red for pass/fail status.

FoundationLite
DrawPoint

Draws a point on an image.

FoundationLite
DrawPoints_MultiColor

Draws points on an image with multiple colors.

FoundationLite
DrawPoints_SingleColor

Draws points on an image with a single color.

FoundationLite
DrawPoints_TwoColors

Draws points on an image with two colors, depending on the status of each point.


Usually: green or red for pass/fail status.

FoundationLite
DrawRectangle

Draws a rectangle on an image.

FoundationLite
DrawRectangles_MultiColor

Draws rectangles on an image with multiple colors.

FoundationLite
DrawRectangles_SingleColor

Draws rectangles on an image with a single color.

FoundationLite
DrawRectangles_TwoColors

Draws rectangles on an image with two colors, depending on the status of each rectangle.


Usually: green or red for pass/fail status.

FoundationLite
DrawRegion

Draws a region on an image.

FoundationLite
DrawRegions_MultiColor

Draws regions on an image with multiple colors.

FoundationLite
DrawRegions_SingleColor

Draws regions on an image with a single color.

FoundationLite
DrawRegions_TwoColors

Draws regions on an image with two colors, depending on the status of each region.


Usually: green or red for pass/fail status.

FoundationLite
DrawSegment

Draws a segment on an image.

FoundationLite
DrawSegments_MultiColor

Draws segments on an image with multiple colors.

FoundationLite
DrawSegments_SingleColor

Draws segments on an image with a single color.

FoundationLite
DrawSegments_TwoColors

Draws segments on an image with two colors, depending on the status of each segment.


Usually: green or red for pass/fail status.

FoundationLite
DrawShapeRegion

Draws a shape region on an image.

FoundationLite
DrawShapeRegions_MultiColor

Draws shape regions on an image with multiple colors.

FoundationLite
DrawShapeRegions_SingleColor

Draws shape regions on an image with a single color.

FoundationLite
DrawShapeRegions_TwoColors

Draws shape regions on an image with two colors, depending on the status of each region.


Usually: green or red for pass/fail status.

FoundationLite
DrawString

Draws a string on an image.

FoundationLite
DrawStringLabels_MultiColor

Draws strings (text) on an image with multiple colors.

FoundationLite
DrawStringLabels_SingleColor

Draws strings (text) on an image with a single color.

FoundationLite
DrawStringLabels_TwoColors

Draws strings (text) on an image with two colors, depending on the status of each string.


Usually: green or red for pass/fail status.

FoundationLite
DrawStrings_MultiColor

Draws strings (text) on an image with multiple colors.

FoundationLite
DrawStrings_SingleColor

Draws strings (text) on an image with a single color.

FoundationLite
DrawStrings_TwoColors

Draws strings (text) on an image with two colors, depending on the status of each string.


Usually: green or red for pass/fail status.

FoundationLite
DrawVector

Draws a vector at an associated initial point on an image.

FoundationLite
DrawVectors_MultiColor

Draws vectors at associated initial points on an image with multiple colors.

FoundationLite
DrawVectors_SingleColor

Draws vectors on an image with a single color.

FoundationLite
DrawVectors_TwoColors

Draws vectors on an image with two colors, depending on the status of each vector.


Usually: green or red for pass/fail status.

FoundationLite
MakeHeatmap

Creates a new Heatmap object.

FoundationLite
VisualizeHeatmap

Colorizes heat-map and blends it with background image.

FoundationLite
VisualizeHeatmap_Old

Colorizes a heat-map and blends it with a background image.

FoundationLite

Image Enhancement

Icon Name Description / Applications Modules
AutoAdjustColors

Adjusts image colors by stretching each channel separately.

FoundationLite
EqualizeImageHistogram

Maps image pixels to new values to achieve uniform distribution of intensities in the range (0, 255).

FoundationLite
ExpaintImage_Bornemann

Speculatively sets pixel values outside of a region using the fast marching method and coherence analysis.

FoundationPro
ExpaintImage_Telea

Speculatively sets pixel values outside of a region using the fast marching method.

FoundationPro
InpaintImage

Fills in a region of an image with pixel values interpolated from the borders of the area.


Speculative setting of unknown (or unwanted) pixels. Usually used for preparing incomplete images for further processing.

FoundationPro
InpaintImage_Bornemann

Fills in a region of an image with pixel values interpolated from the borders of the area; uses fast marching method and coherence analysis.


Speculative setting of unknown (or unwanted) pixels. This version is giving the best results among reasonably fast traditional methods.

FoundationPro
InpaintImage_Telea

Fills in a region of an image with pixel values interpolated from the borders of the area; uses fast marching method.


Speculative setting of unknown (or unwanted) pixels. This version is trying to do this better than with simple interpolation.

FoundationPro
NormalizeImage

Rescales an image linearly, so that its minimum becomes inNewMinimum and the maximum of the remaining pixels becomes inNewMaximum.


Aims at better using the image's dynamic range to represent an interesting subset of pixel values.

FoundationLite
NormalizeLocalBrightness_Gauss

Normalizes local brightness of the image. Internally uses Gauss smoothing.


Compensates uneven illumination.

FoundationBasic
NormalizeLocalBrightness_Mean

Normalizes local brightness of the image. Internally uses Mean smoothing.


Compensates uneven illumination.

FoundationBasic
NormalizeLocalContrast

Normalizes local contrast of the image using Wallis filter.

FoundationBasic
SharpenImage

Enhances contrast of an image so that it appears sharper.


Use this filter only to improve human perception, not to preprocess an image for analysis.

FoundationLite

Image Features

Icon Name Description / Applications Modules
DistanceTransform

Computes an image in which the pixel values denote the estimated distances to the nearest bright pixel in the input image.


This is an initial step of some advanced traditional image analysis algorithms.

FoundationBasic
GradientImageRidges

Finds ridge pixels in a gradient image.

FoundationPro
ImageCenter

Returns the geometrical center of an image.

FoundationLite
ImageHistogram

Computes the histogram of the image pixel values.

FoundationBasic
ImageLocalMaxima

Finds image locations characterized by locally maximal pixel values.


Detection of characteristic points, usually after some image transformations.

FoundationBasic
ImageLocalMinima

Finds image locations characterized by locally minimal pixel values.


Detection of characteristic points, usually after some image transformations.

FoundationBasic
ImageMassCenter

Computes a point with coordinates equal to image mass center in brightness scale.

FoundationLite
ImageMoment

Computes the selected moment of an image in regular and normalized (divided by sum of pixel values) variant.

FoundationLite
ImageOrientation

Computes the orientation of an image using image moments. The result range is from 0.0 to 180.0.

FoundationLite
ImagePixels

Returns an array of pixels from the input image.

FoundationLite
ImagePixelValues

Returns an array of pixel values from the input image.

FoundationLite
ImageProfileAlongPath

Creates a series of segments across the input path, measures the average pixel intensity on each of the segments, and creates the final profile from those values.


This is the first step of all 1D Edge Detection operations. Here available for direct use by the user.

FoundationPro
ImageProjection

Computes the average (or other statistic) for each image row or column and then merges the obtained results into a profile.

FoundationLite
ImageRidges

Finds ridge pixels in an image.

FoundationBasic
ImageSharpness

Returns a value dependent on sharpness of the image. The value is bigger for sharper images.


Designed for manual or automatic camera focus adjustment.

FoundationBasic
ImageStandardDeviation

Calculates standard deviation of image pixel values.

FoundationBasic

Image IO

Icon Name Description / Applications Modules
FillImageBuffer

Fills image buffer with provided data.

FoundationLite
FillImagePreviewBuffer

Fills image buffer with provided data.

FoundationLite
EnumerateImages

Scans a disk directory for image files and then returns the images one by one in consecutive iterations sorted according to the specified order.


Emulates image acquisition with images stored on disk.

FoundationLite
EnumerateImages_Random

Scans a disk directory for image files and then returns the images one by one in consecutive iterations sorted randomly.


Emulates image acquisition with images stored on disk.

FoundationLite
GetAvailableVideoCompressors

Lists FourCC names of available video compressors.

FoundationLite
GrabImage_FromFiles

Simulates capturing a frame from a camera.


Can be used as EnumerateImages, but its state is global in a program - does not reset when some task is finished.

FoundationLite
GrabImage_FromFiles_ResetState

Resets the global state of GrabImage_FromFiles filter.

FoundationLite
LoadImage

Loads a single image from a file.

FoundationLite
LoadImageFormat

Loads a single image format from a file without loading all image data.

FoundationLite
LoadImageFromBuffer

Loads a single image from a file stored in memory.


Use this filter when you received an image file through I/O communication, e.g. through a TcpIp connection.

FoundationLite
OpenInputVideoStream

Opens and creates a video stream from a file.

FoundationLite
OpenOutputVideoStream

Creates a video stream which will be saved to a selected file.

FoundationLite
ReadVideoStream

Acquires a frame from a previously opened video stream.

FoundationLite
SaveImage

Saves an image to a file.

FoundationLite
SaveImageToBuffer

Saves an image to a file stored in ByteBuffer.


Use this filter if you want to send image file through I/O communication, e.g. through a TcpIp connection.

FoundationLite
SaveImageToJpeg

Saves an image to a JPEG file.

FoundationLite
SaveImageToJpeg_Asynchronous

Saves an image to a JPEG file in the background thread.

FoundationLite
SaveImageToPng

Saves an image to a PNG file.

FoundationLite
SaveImageToPng_Asynchronous

Saves an image to a PNG file in the background thread.

FoundationLite
SaveImageToTiff

Saves an image to a TIFF file.

FoundationLite
SaveImageToTiff_Asynchronous

Saves an image to a TIFF file in the background thread.

FoundationLite
SaveImage_Asynchronous

Saves an image to a file in the background thread.

FoundationLite
WriteVideoStream

Writes an image to a previously opened video stream.

FoundationLite
DecodeVideo

Captures an image from video file with using FFmpeg library.

ThirdParty

Image Local Transforms

Icon Name Description / Applications Modules
CloseImage

Removes small dark structures from an image (or fills in bright ones) by applying consecutive dilation and erosion.


E.g. removal of the "pepper" component of salt-and-pepper noise.

FoundationLite
ConvolveImage

Computes a convolution of the input image with a user-specified mask.


Non-standard local transforms defined by the user.

FoundationLite
DifferenceOfGaussians

Applies difference of Gaussians on an image, i.e. computes difference of two Gaussian smoothed images.


Emphasizes high-frequency image features such as lines or patches / dots.

FoundationBasic
DilateAndErodeImage

Calculates dilation and erosion simultaneously for faster execution.

FoundationPro
DilateImage

Replaces each pixel with the maximum of pixels within a kernel.


Thickens bright features in an images and thins dark ones.

FoundationLite
DilateImage_AnyKernel

Replaces each pixel with the maximum of pixels within an arbitrary kernel.

FoundationPro
DilateImage_Mask

Replaces each pixel with the maximum of pixels within a small rectangular kernel.

FoundationLite
ErodeImage

Replaces each pixel with the minimum of pixels within a kernel.


Thins bright features in an image and thickens dark ones.

FoundationLite
ErodeImage_AnyKernel

Replaces each pixel with the minimum of pixels within an arbitrary kernel.

FoundationPro
ErodeImage_Mask

Replaces each pixel with the minimum of pixels within a small rectangular kernel.

FoundationLite
GradientDirAndPresenceImage

Computes an image of gradient directions mapped to the range from 1 to 255. Zero means "no edge".


For highly optimized analysis of gradient directions.

FoundationBasic
GradientImage

Computes a gradient image with smoothing operator of any size. The output pixels are signed.

FoundationLite
GradientImage_Mask

Computes a gradient image with a Sobel or Prewitt operator.

FoundationLite
GradientMagnitudeImage

Measures the strength of gradient at each pixel location with Sobel or Prewitt operator.

FoundationLite
GradientMagnitudeImage_Signed

Computes an image of gradient for only selected direction.


For highly optimized analysis of gradient directions.

FoundationBasic
OpenImage

Removes small bright structures from an image (or fills in dark ones) by applying consecutive erosion and dilation.


E.g. removal of the "salt" component of salt-and-pepper noise.

FoundationLite
SmoothImage_Bilateral

Smooths an image while preserving sharp edges.

FoundationPro
SmoothImage_Deriche

Smooths an image using Deriche filter.


Approximation of the gaussian filter, which can be faster for large kernels.

FoundationLite
SmoothImage_Gauss

Smooths an image using a gaussian kernel.


Removal of gaussian noise from images.

FoundationLite
SmoothImage_Gauss_Mask

Smooths an image using a predefined gaussian kernel.


Removal of gaussian noise from images (fast).

FoundationLite
SmoothImage_Mean

Smooths an image by averaging pixels within a rectangular kernel.


Usually used for computing features related to local image "windows". Can be also used for noise removal, but Gauss is superior here.

FoundationLite
SmoothImage_Mean_AnyKernel

Smooths an image by averaging pixels within an arbitrary kernel.


Usually used for computing features related to local image "windows" having non-standard shape.

FoundationPro
SmoothImage_Mean_Mask

Smooths an image by averaging pixels within a small rectangular kernel.


This is a faster alternative to SmoothImage_Mean when the kernel is very small.

FoundationLite
SmoothImage_Median

Replaces each pixel with the median of pixels within a kernel.


Edge-preserving noise removal (but slow).

FoundationLite
SmoothImage_Median_Mask

Replaces each pixel with the median of pixels within a 3x3 rectangular kernel (faster).

FoundationLite
SmoothImage_Middle

Replaces each pixel with the average of maximum and minimum calculated within a kernel.


Useful for calculating per-pixel threshold values for image binarization.

FoundationLite
SmoothImage_Quantile

Replaces each pixel with a quantile of pixels within a kernel.


Edge-preserving noise removal (but slow).

FoundationLite
SmoothRegion_Mean

Smooths an region by averaging pixels within a rectangular kernel.


Usually used for computing features related to local image "windows". Can be also used for noise removal, but Gauss is superior here.

FoundationLite
StandardDeviationImage

Creates image of pixels' local standard deviations.

FoundationBasic

Image Look Up Tables

Icon Name Description / Applications Modules
ApplyPixelLut

Applies previously created Look Up transformation to provided image.

FoundationBasic
CreateCustomLut

Creates Look Up Table for user provided operation on image pixels.

FoundationBasic
CreateGammaCorrectionLut

Creates Look Up Table for gamma correction operation on image pixels.

FoundationBasic
CreateLogarithmLut

Creates Look Up Table for logarithm operation on image pixels.

FoundationBasic
CreatePowerLut

Creates Look Up Table for power operation on image pixels.

FoundationBasic

Image Metrics

Icon Name Description / Applications Modules
ColorDistance

Compares two pixels using chromatic and non-chromatic information. Assumes RGB color space.


Color comparison insensitive to changes of illumination.

FoundationPro
ColorDistanceImage

Compares each pixel with the specified color using chromatic and non-chromatic information.


Color analysis insensitive to changes of illumination.

FoundationPro
ColorDistance_CIE76

Compares two pixels using CIE76 delta E. Assumes RGB color space.

FoundationPro
ColorDistance_CIE94

Compares two pixels using CIE94 delta E. Assumes RGB color space.

FoundationPro
ColorDistance_CIEDE2000

Compares two pixels using CIEDE2000 delta E. Assumes RGB color space.

FoundationPro
CompareImages

Compares two images tile by tile using one of several available methods.

FoundationPro
CompareImages_CVG

Compares two images tile by tile using one of several available methods.

FoundationPro
ImageCorrelation

Computes the correlation of pattern and image.

FoundationPro
ImageCorrelationImage

Computes an image of correlation between a pattern and the input image at each possible location.


This filter is used internally by the Gray-based Template Matching.

FoundationPro
ImageDifference

Measures dissimilarity between two images.

FoundationBasic
ImageDifferenceImage

Computes an image of differences between a moving pattern and the input image.

FoundationBasic

Image Pixel Statistics

Icon Name Description / Applications Modules
DaPImageMedian

Computes the average direction within the region of interest.

FoundationPro
ImageAverage

Computes the average of the image pixel values.

FoundationLite
ImageAverageHSx

Computes the average of the HSV, HSL or HSI image pixel values.

FoundationLite
ImageMaximum

Finds the location and the value of the brightest pixel.

FoundationLite
ImageMinimum

Finds the location and the value of the darkest pixel.

FoundationLite
ImageStatistics

Computes various statistics of the image pixel values.

FoundationLite
ImageSum

Computes the sum of the image pixel values.

FoundationLite

Image Point Transforms

Icon Name Description / Applications Modules
AbsoluteValueImage

Transforms pixel values to their absolute values pixel by pixel.

FoundationLite
AddNoiseToImage

Adds random noise to the image.

FoundationLite
AddToImage

Adds a scalar value to each pixel.

FoundationLite
ClipPixels

Sets pixels below the low value to the low value and above the high value to the high value.

FoundationLite
ColorizeImage

Shows a monochromatic image in false colors.

FoundationLite
CorrectGamma

Performs gamma correction.


Image enhancement for human perception. For computer vision consider LogarithmImage.

FoundationLite
DivideImage

Divides each pixel by a scalar value.

FoundationLite
InvertImage

Applies numeric inversion (1/x) of the pixel values.

FoundationLite
LogarithmImage

Computes a natural logarithm of each pixel.


Transforms an image in such a way that a quotient on the input image becomes a difference on the output image. This can be useful for dealing with variable illumination.

FoundationLite
LUTTransformImage

Changes pixel values for data stored in array.

FoundationLite
MultiplyImage

Multiplies each pixel by a scalar value.

FoundationLite
NegateImage

Reverts the pixel value range (unsigned) or applies numeric negation (signed).

FoundationLite
PowerImage

Exponentiates each pixel to the given power.

FoundationLite
ReplacePixels

Substitutes pixels having the specified value with a new value.

FoundationLite
ResaturateImage

Sets pixels below the low value to minimum, above the high value to maximum, and interpolates the rest.

FoundationLite
RescalePixels

Applies linear transformation to pixel values.

FoundationLite
SquareImage

Raises pixel values to the second power pixel by pixel.

FoundationLite
SquareRootImage

Transforms pixel values to their square roots pixel by pixel.

FoundationLite
SubtractFromImage

Subtracts a scalar value from each pixel.

FoundationLite

Image Relations

Icon Name Description / Applications Modules
TestBoxInImage

Tests whether a box is contained in the dimensions of an image.

FoundationLite
TestImageEqualTo

Tests whether two images equal.

FoundationLite
TestLocationInBox

Tests whether a location is contained in the dimensions of a box.

FoundationLite
TestLocationInImage

Tests whether a location is contained in the dimensions of an image.

FoundationLite
TestPointInImage

Tests whether a point is contained in the dimensions of an image.

FoundationLite
TestRectangleInImage

Tests whether a rectangle is contained in the dimensions of an image.

FoundationLite

Image Spatial Transforms

Icon Name Description / Applications Modules
CreateAffineTransformMatrix

Creates affine transform matrix matrix. Return product of matrices: Translation * Rotation * Scale * Shearing.

FoundationBasic
CreateImagePyramid

Creates an array of images, each downsampled from the previous one.


Frequently used to create scale-invariant image analysis algorithms.

FoundationBasic
CreateImagePyramid_Gauss

Creates an array of images, each downsampled from the previous, gauss-smoothed one.


Frequently used to create scale-invariant image analysis algorithms. Reduces impact of pixel aliasing.

FoundationBasic
CropImage

Creates an image from a box-shaped fragment of the input image (with margins if requested).


Reduction of the amount of image data to be stored in memory.

FoundationLite
CropImageToQuadrangle

Creates an image from a quadrangle on another image.


Can be used for cropping an image from a slightly distorted rectangle. Do not use it for perspective distortion though.

FoundationPro
CropImageToRectangle

Creates an image from a rectangular fragment of another image (with black margins if requested).


Usually used for creating images of individual objects, e.g. after Template Matching.

FoundationLite
DownsampleImage

Shrinks an image by the factor of two along each axis.


Usually used to speed-up image analysis at the cost of reduced precision. It is internally used to implement the pyramid strategy in template matching filters.

FoundationBasic
DownsampleImage_Midlevels

Shrinks an image by the factor of 1.5 or SQRT(2) along each axis.


Usually used to speed-up image analysis at the cost of reduced precision. It is internally used to implement the pyramid strategy.

FoundationBasic
ImageAlongArc

Creates an image from pixels traversed along an arc.


E.g. "Unwrapping" of object contours, so that they appear as 1D structures on the output image.

FoundationBasic
ImageAlongPath

Creates an image from pixels traversed along a path.


E.g. "Unwrapping" of object contours, so that they appear as 1D structures on the output image.

FoundationPro
ImageInversePolarTransform

Transforms an image from polar or log-polar space to euclidean space.

FoundationBasic
ImagePolarTransform

Transforms an image to polar or log-polar space.

FoundationBasic
JoinImages

Creates a single image by glueing together the two input images in horizontal or vertical direction.

FoundationLite
JoinImages_OfArray

Creates a single image by glueing together many input images in horizontal or vertical direction.

FoundationLite
JoinImages_OfSeries

Creates a single image by glueing together a series of input images in horizontal or vertical direction.


Joining images from a line-scan camera, which produces too few lines at a time.

FoundationLite
MirrorImage

Reverses the order of the input image columns or rows depending on inMirrorDirection value.

FoundationLite
ResizeImage

Enlarges or shrinks an image to new dimensions.

FoundationLite
ResizeImage_FixedAspectRatio

Changes one dimension of the image to a desired length while the other dimension is set to a length such that the aspect ration of the image is maintained.

FoundationLite
ResizeImage_Relative

Resizes an image by a factor along each axis.

FoundationLite
RotateImage

Rotates an image clockwise.

FoundationLite
ShearImage

Computes a leant image (shifts the rows).


Image preprocessing when there are slanted objects.

FoundationLite
ShrinkImageNTimes

Shrinks an image by a natural factor along each axis.

FoundationLite
TransformImage

Transforms an image by the provided transformation matrix.

FoundationLite
TranslateImage

Translates an image by a vector, without changing its dimensions.


E.g. camera shaking reduction.

FoundationLite
TranslatePixels

Moves the pixels of the input image by the vectors specified with inVectorImage.

FoundationLite
TransposeImage

Flips and rotates an image so that columns are exchanged with rows.


Useful when operations on image columns should be replaced with operations on image rows, which are much faster due to the cache memory.

FoundationLite
TrimImageToRegion

Trims an image to the area of the specified region.

FoundationLite
UncropImage

Inverse of CropImage.

FoundationLite

Image Spatial Transforms Maps

Icon Name Description / Applications Modules
AccessSpatialMap

Returns individual fields of a spatial map.

Calibration
AddSpatialMaps

Combines two spatial maps.


Makes it possible to use single RemapImage filter even if there are two or more image remapping operations (e.g. lens distortion + perspective distortion).

Calibration
CombineSpatialMaps

Combines two spatial maps.


Makes it possible to use single RemapImage filter even if there are two or more image remapping operations (e.g. lens distortion + perspective distortion).

Calibration
ConvertMatrixMapsToSpatialMap

Joins two matrices of coordinates to produce a SpatialMap for use in RemapImage.

Calibration
ConvertSpatialMap

Converts a spatial map to a different format.

Calibration
ConvertSpatialMapToMatrixMaps

Splits a spatial map into two matrices of source coordinates.

Calibration
ConvertSpatialMap_ToNearest

Converts any spatial map to NearestNeighbour interpolation.


Reducing quality for the purpose of speed.

Calibration
CreateCylinderMap

Creates a spatial map for transformations from a cylinder surface to a flat rectangle.


Inspection of the surface of bottles and other cylindrical objects. The result is used by RemapImage.

Calibration
CreateImageInversePolarTransformMap

Creates a spatial map representing an image inverse polar transform.


Data preprocessing for fast inverse polar transform. The result is used by RemapImage.

Calibration
CreateImagePolarTransformMap

Creates a spatial map representing an image polar transform.


Data preprocessing for fast image polar transform. The result is used by RemapImage.

Calibration
CreateImageResizeMap

Creates a spatial map representing an image resizing.


Data preprocessing for fast image resize between two constant sizes. The result is used by RemapImage.

Calibration
CreateImageRotationMap

Creates a spatial map representing an image rotation.


Preprocessing data for fast image rotation by a constant angle. The result is used by RemapImage.

Calibration
CreateMatrixTransformMap

Creates a spatial map which performs transform defined as a 3x3 homography matrix.

Calibration
CreatePerspectiveMap_Path

Creates a perspective transform map from planes defined by paths.


Data preprocessing for fast perspective correction. The result is used by RemapImage.

Calibration
CreatePerspectiveMap_Points

Creates a perspective transform map from four points denoting a rectangle in the world coordinates.


Data preprocessing for fast perspective correction. The result is used by RemapImage.

Calibration
CreatePincushionMap

Creates a spatial map for removing/adding pincushion distortion, using divisional lens distortion model.


The easiest way to remove typical lens distortion. Use together with RemapImage.

Calibration
CreateSphereMap

Creates a spatial map for transformations from a sphere surface to a flat rectangle.


Inspection of the surface of balls and other spherical objects. The result is used by RemapImage.

Calibration
CropSpatialMap

Crops a spatial map to the specified input and output boxes.

Calibration
LoadSpatialMap

Deserializes a SpatialMap object from a AVDATA file.

Calibration
RemapImage

Applies a precomputed image transform, defined by a spatial map object.


Fast (precomputed) image transformations, especially for view undistortion or object geometry correction (e.g. pos recognition of labels on cylindrical bottles).

Calibration
SaveSpatialMap

Serializes a SpatialMap object to an AVDATA file.

Calibration
TestSpatialMapApplicability

Checks if a spatial map may be applied to transform the given image.

Calibration
UnmapPoint

Computes locations of image point on the source image from image point location on remapped image.

Calibration

Image Thresholding

Icon Name Description / Applications Modules
SelectThresholdValue

Selects best threshold value using the image histogram.


Usually used before a thresholding filter when the image brightness is variable. Use with care.

FoundationBasic
ThresholdImage

Transforms each pixel value to maximum or minimum depending on whether they belong to the specified range.


Image binarization when the illumination is constant and uniform.

FoundationLite
ThresholdImage_Color

Transforms each pixel value to maximum or minimum depending on the distance from a given color.


Color analysis with a given reference color.

FoundationPro
ThresholdImage_Dynamic

Thresholds an image relatively to some value calculated in a local rectangular neighbourhood.


Image binarization when the illumination is uneven.

FoundationLite
ThresholdImage_HSx

Transforms each pixel value to minimum or maximum depending on whether it belongs to specified region in the HSV, HSL or HSI color space.


Color analysis.

FoundationLite
ThresholdImage_Hysteresis

Thresholds an image with a hysteresis, i.e. with a lower threshold for neighboring pixels.

FoundationBasic
ThresholdImage_Relative

Thresholds an image with a different threshold value for each pixel (inBaseImage(x, y) + inValue).

FoundationBasic
ThresholdImage_RGB

Transforms each pixel value to minimum or maximum depending on whether it belongs to the specified range for each individual pixel component.


Multi-channel thresholding.

FoundationLite
ThresholdToRegion

Creates a region containing image pixels with values within the specified range.


Extraction of a region of objects that can be defined by a salient brightness.

FoundationBasic
ThresholdToRegion_Color

Creates a region containing image pixels with values close to the given color.


Color analysis with a given reference color.

FoundationPro
ThresholdToRegion_Dynamic

Thresholds an image relatively to the average pixel value in a local rectangular neighborhood.


Useful in case of uneven illumination.

FoundationBasic
ThresholdToRegion_HSx

Creates a region containing image pixels which belongs to specified region in HSV, HSL or HSI space.


Extraction of a region characterized with a specific color.

FoundationBasic
ThresholdToRegion_Relative

Thresholds an image with a different threshold value for each pixel (inBaseImage(x, y) + inValue).

FoundationBasic
ThresholdToRegion_Relative_DarkBright

Thresholds an image using two relative thresholds and produces two regions (Dark and Bright) in a single image pass.


This filter can replace two instances of ThresholdToRegion_Relative which may slightly improve performance.

FoundationBasic
ThresholdToRegion_RGB

Creates a region containing image pixels which belongs to the specified range for each individual pixel component.


Multi-channel thresholding.

FoundationBasic

Image Tiling

Icon Name Description / Applications Modules
CreateImageTiles

Generates an array of regions and an array of boxes covering the area of an image.

FoundationBasic
CreateImageTiles_AsBoxes

Generates an array of boxes covering the area of an image.

FoundationBasic
CutImageIntoTiles

Generates an array of small images by cutting the input image.

FoundationBasic
EnumerateImageTiles

Enumerates tiles from image.

FoundationBasic
JoinImageTiles

Joins previously cut tiles into single image.

FoundationBasic

Image Vector Transforms

Icon Name Description / Applications Modules
MeasurePixelVectors

Computes gradient magnitudes of an image.

FoundationBasic
NormalizePixelVectors

Adjusts gradient angles to a given range.

FoundationBasic
PixelVectorDirAndPresence

Computes gradient orientations of an image.

FoundationBasic
ResizePixelVectors

Rescales an image treating pixels as vectors.

FoundationBasic
RotatePixelVectors

Rotates image gradients.

FoundationBasic