Back to Aurora Vision Library Lite website
You are here: Start » Image » Image IO » EnumerateImages_Random
EnumerateImages_Random
Header: | AVL.h |
---|---|
Namespace: | avl |
Scans a disk directory for image files and then returns the images one by one in consecutive iterations sorted randomly.
Applications: Emulates image acquisition with images stored on disk.
Syntax
bool avl::EnumerateImages_Random ( EnumerateFilesRandomState& ioState, const atl::Directory& inDirectory, atl::Optional<avl::ImageFileFormat::Type> inFileType, atl::Optional<int> inSeed, bool inRepeat, bool inProcessSubdirectories, bool inInvert, bool inLoadAlphaChannel, const int inDelay, avl::Image& outImage, atl::File& outFilePath, atl::String& outFileName, atl::Optional<bool&> outIsFirst = atl::NIL, atl::Optional<bool&> outIsLast = atl::NIL )
Parameters
Name | Type | Default | Description | |
---|---|---|---|---|
ioState | EnumerateFilesRandomState& | Object used to maintain state of the function. | ||
inDirectory | const Directory& | \".\" | Input directory | |
inFileType | Optional<ImageFileFormat::Type> | NIL | File format of the images | |
inSeed | Optional<int> | NIL | Random seed used to determine random 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 | ||
inDelay | const int | Minimum time between iterations in milliseconds | ||
outImage | Image& | Output image | ||
outFilePath | File& | Output file path | ||
outFileName | String& | Output file name | ||
outIsFirst | Optional<bool&> | NIL | Flag indicating the first iteration | |
outIsLast | Optional<bool&> | NIL | Flag indicating the last iteration |
Optional Outputs
The computation of following outputs can be switched off by passing value atl::NIL
to these parameters: outIsFirst, outIsLast.
Read more about Optional Outputs.