Back to Aurora Vision Library Lite website

You are here: Start » Image

Image

Image Basics

Icon Name Description / Applications
ClearImage

Sets image pixels in ROI to the specified value.

CopyImageData

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

CopyPixels

Copies pixels from one image to another.

EmptyImage

Creates an image filled with one color.


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

FillImage

Fills the input image with one color.

GetImageColumn

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

GetImageData

Extracts the image content (raw pixel data) as a binary buffer.

GetImagePixel

Returns a single pixel of an image.

GetImagePixel_Interpolated

Returns an interpolated single pixel of an image.


Sub-pixel sampling of an image.

GetImageRow

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

GetMultipleImagePixelValues_Safe

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

ImageBox

Returns a box corresponding to the dimensions of an image.

ImageCharacteristicPoint

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

ImageToMatrix

Converts a single-channel image to a matrix.

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.

JoinProfilesIntoImage_OfSeries

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


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

LoadImageObject

Loads serialized Image object from AVDATA file.

MakeImage

Converts a pixel array to a single-channel image.

MatrixToImage

Converts a matrix to a single-channel real image.

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.

SaveImageObject

Saves serialized Image object as AVDATA file.

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.

SetImagePixel

Sets a pixel of an image to the selected value.

SetImagePixels

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

SetImageRow

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


Allows for creating images from calculated real values.

SetMultipleImagePixels

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

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.

TestImage

Returns a sample image.


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

Image Color Spaces

Icon Name Description / Applications
HsvToRgb

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

RgbToHsv

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


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

Image Combinators

Icon Name Description / Applications
AddImages

Adds two images pixel by pixel.

AddImages_OfArray

Adds images of an array pixel by pixel.

AddImages_OfLoop

Adds images appearing in consecutive iterations pixel by pixel.

AverageImages

Averages two images pixel by pixel.

AverageImages_OfArray

Averages images from an array pixel by pixel.

AverageImages_OfLoop

Averages images appearing in consecutive iterations pixel by pixel.

BlendImages

Computes weighted sum pixel by pixel.

ComposeImages

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

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.

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.

DivideImages

Divides two images pixel by pixel.


Can be used for flat field correction.

LerpImages

Interpolates two images linearly pixel by pixel.

LerpImages_ByImage

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

MaximumImage

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

MaximumImage_OfArray

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

MaximumImage_OfLoop

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

MedianImages_OfArray

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

MinimumImage

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

MinimumImage_OfArray

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

MinimumImage_OfLoop

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

MultiplyImages

Multiplies two images pixel by pixel.

MultiplyImages_OfArray

Multiplies images of an array pixel by pixel.

MultiplyImages_OfLoop

Multiplies images appearing in consecutive iterations pixel by pixel.

NthImage_OfArray

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

RollingAverageImages_OfArray

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

RollingAverageImages_OfLoop

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

SubtractImages

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

Image Conversions

Icon Name Description / Applications
AddChannels

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

AddChannels_Saturation

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

AppendImageChannel

Appends a single valued channel to the input image.

AverageChannels

Creates a monochromatic image by averaging the input image channels.

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).

AverageChannels_Weighted

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

ConvertPixelType

Changes the type of pixel components.

ConvertToMultichannel

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

MergeChannels

Creates a multichannel image from several monochromatic ones.

MixChannels

Calculates a linear combination of image channels.

ReverseChannels

Reverses the order of channels in an image.


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

SelectChannel

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

SplitChannels

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

SplitChannels_OrNil

Creates several monochromatic images from individual channels of the input image and sets Nil for channels that are not present.

Image Drawing

Icon Name Description / Applications
DrawArc

Draws an arc on an image.

DrawBox

Draws a box on an image.

DrawCircle

Draws a circle on an image.

DrawCoordinateSystem

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

DrawCrosshair

Draws a crosshair on an image.

DrawDimensionLine

Draws a dimension line on an image.

DrawEllipse

Draws an ellipse on an image.

DrawGridImage

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

DrawImage

Draws an image on another one.

DrawLine

Draws a line on an image.

DrawPath

Draws a path on an image.

DrawPoint

Draws a point on an image.

DrawRectangle

Draws a rectangle on an image.

DrawRegion

Draws a region on an image.

DrawSegment

Draws a segment on an image.

DrawShapeRegion

Draws a shape region on an image.

DrawString

Draws a string on an image.

DrawVector

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

MakeHeatmap

Creates a new Heatmap object.

VisualizeHeatmap

Colorizes heat-map and blends it with background image.

VisualizeHeatmap_Old

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

Image Enhancement

Icon Name Description / Applications
AutoAdjustColors

Adjusts image colors by stretching each channel separately.

EqualizeImageHistogram

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

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.

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.

Image Features

Icon Name Description / Applications
ImageCenter

Returns the geometrical center of an image.

ImageMassCenter

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

ImageMoment

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

ImageOrientation

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

ImagePixels

Returns an array of pixels from the input image.

ImagePixelValues

Returns an array of pixel values from the input image.

ImageProjection

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

Image IO

Icon Name Description / Applications
FillImageBuffer

Fills image buffer with provided data.

FillImagePreviewBuffer

Fills image buffer with provided data.

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.

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.

GetAvailableVideoCompressors

Lists FourCC names of available video compressors.

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.

GrabImage_FromFiles_ResetState

Resets the global state of GrabImage_FromFiles filter.

LoadImage

Loads a single image from a file.

LoadImageFormat

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

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.

LoadMultiplePagesTiffImage

Loads a image array from a tiff file.

OpenInputVideoStream

Opens and creates a video stream from a file.

OpenOutputVideoStream

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

ReadVideoStream

Acquires a frame from a previously opened video stream.

SaveImage

Saves an image to a file.

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.

SaveImageToJpeg

Saves an image to a JPEG file.

SaveImageToJpeg_Asynchronous

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

SaveImageToPng

Saves an image to a PNG file.

SaveImageToPng_Asynchronous

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

SaveImageToTiff

Saves an image to a TIFF file.

SaveImageToTiff_Asynchronous

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

SaveImage_Asynchronous

Saves an image to a file in the background thread.

WriteVideoStream

Writes an image to a previously opened video stream.

DecodeVideo

Captures an image from video file with using FFmpeg library.

Image Local Transforms

Icon Name Description / Applications
BottomHatImage

Performs a morphological black top hat (bottom hat) operation on a image using a predefined kernel.

BottomHatImage_AnyKernel

Performs a morphological black top hat (bottom hat) operation on a image using an arbitrary kernel.

BottomHatImage_Mask

Performs a morphological black top hat (bottom hat) operation on a image using a predefined mask.

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.

CloseImage_AnyKernel

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.

CloseImage_Mask

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.

ConvolveImage

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


Non-standard local transforms defined by the user.

DilateImage

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


Thickens bright features in an images and thins dark ones.

DilateImage_Mask

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

ErodeImage

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


Thins bright features in an image and thickens dark ones.

ErodeImage_Mask

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

GradientImage

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

GradientImage_Mask

Computes a gradient image with a Sobel or Prewitt operator.

GradientMagnitudeImage

Measures the strength of gradient at each pixel location.

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.

OpenImage_AnyKernel

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.

OpenImage_Mask

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.

SmoothImage_Deriche

Smooths an image using Deriche filter.


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

SmoothImage_Gauss

Smooths an image using a gaussian kernel.


Removal of gaussian noise from images.

SmoothImage_Gauss_Mask

Smooths an image using a predefined gaussian kernel.


Removal of gaussian noise from images (fast).

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.

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.

SmoothImage_Median

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


Edge-preserving noise removal (but slow).

SmoothImage_Median_Mask

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

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.

SmoothImage_Quantile

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


Edge-preserving noise removal (but slow).

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.

TopHatImage

Performs a morphological white top hat operation on a image using a predefined kernel.

TopHatImage_AnyKernel

Performs a morphological white top hat operation on a image using an arbitrary kernel.

TopHatImage_Mask

Performs a morphological white top hat operation on a image using a predefined mask.

Image Pixel Statistics

Icon Name Description / Applications
ImageAverage

Computes the average of the image pixel values.

ImageAverageHSx

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

ImageMaximum

Finds the location and the value of the brightest pixel.

ImageMinimum

Finds the location and the value of the darkest pixel.

ImageStatistics

Computes various statistics of the image pixel values.

ImageSum

Computes the sum of the image pixel values.

Image Point Transforms

Icon Name Description / Applications
AbsoluteValueImage

Transforms pixel values to their absolute values pixel by pixel.

AddNoiseToImage

Adds random noise to the image.

AddToImage

Adds a scalar value to each pixel.

ClipPixels

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

ColorizeImage

Shows a monochromatic image in false colors.

CorrectGamma

Performs gamma correction.


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

DivideImage

Divides each pixel by a scalar value.

InvertImage

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

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.

LUTTransformImage

Changes pixel values for data stored in array.

MultiplyImage

Multiplies each pixel by a scalar value.

NegateImage

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

PowerImage

Exponentiates each pixel to the given power.

ReplacePixels

Substitutes pixels having the specified value with a new value.

ResaturateImage

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

RescalePixels

Applies linear transformation to pixel values.

RescalePixels_FixedRange

Transforms pixels value from given range into new one.

SquareImage

Raises pixel values to the second power pixel by pixel.

SquareRootImage

Transforms pixel values to their square roots pixel by pixel.

SubtractFromImage

Subtracts a scalar value from each pixel.

Image Relations

Icon Name Description / Applications
TestBoxInImage

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

TestImageEqualTo

Tests whether two images equal.

TestLocationInBox

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

TestLocationInImage

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

TestPointInImage

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

TestRectangleInImage

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

Image Spatial Transforms

Icon Name Description / Applications
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.

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.

JoinImages

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

JoinImages_OfArray

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

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.

MirrorImage

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

ResizeImage

Enlarges or shrinks an image to new dimensions.

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.

ResizeImage_Relative

Resizes an image by a factor along each axis.

RotateImage

Rotates an image clockwise.

ShearImage

Computes a leant image (shifts the rows).


Image preprocessing when there are slanted objects.

ShrinkImageNTimes

Shrinks an image by a natural factor along each axis.

TransformImage

Transforms an image by the provided transformation matrix.

TranslateImage

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


E.g. camera shaking reduction.

TranslatePixels

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

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.

TrimImageToRegion

Trims an image to the area of the specified region.

UncropImage

Inverse of CropImage.

Image Thresholding

Icon Name Description / Applications
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.

ThresholdImage_Dynamic

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


Image binarization when the illumination is uneven.

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.

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.