Back to Adaptive Vision Studio website

You are here: Start » Filter Reference » Image » Image IO » GrabImage_FromFiles

GrabImage_FromFiles


Module: FoundationLite

Simulates capturing a frame from a camera.

Applications

Can be used as EnumerateImages, but its state is global in a program - does not reset when some task is finished.
Name Type Description
inDirectory Directory Input directory
inFileType ImageFileFormat* File format of the images
inSortingOrder FileSortingOrder Sorting order
inRepeat Bool Determines whether to repeat reading directory after reading all files
inProcessSubdirectories Bool Flag indicating whether to load images from the subdirectories or not
inInvert Bool Flag indicating whether to enumerate images backwards or not
inLoadAlphaChannel Bool Flag indicating whether to load alpha channel of the image or not
outImage Image Output image
outFilePath File Output file path
outFileName String Output file name

Description

This filter works similarly to EnumerateImages, but it behaves more like a camera: it preserves its state across the whole program.

For example, you can have two GrabImage_FromFiles filters in two different Task macrofilters. When execution of second Task starts, images loaded previously in the first Task are not loaded again.

Examples

Description of usage of this filter can be found in examples and tutorial: HMI Start Stop.

Complexity Level

This filter is available on Basic Complexity Level.

See Also

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