Back to Aurora Vision Library website
You are here: Start » Function Reference » Image » Image IO » LoadImage
Loads a single image from a file.
void avl::LoadImage ( const atl::File& inFile, bool inLoadAlphaChannel, avl::Image& outImage )
|inFile||const File&||Path to a file|
|inLoadAlphaChannel||bool||Whether to load the alpha channel (if exists) as an additional image channel|
The operation loads an image from a file in one of the standard image file formats. Currently the filter supports the following formats:
- BMP (*.bmp),
- JPEG (*.jpg, *jpeg),
- PNG (*.png),
- PNM (*.pbm, *.pgm, *.ppm, *.pnm),
- TIFF (*.tif, *.tiff).
The format of the image file is recognized automatically based on the file header.
The resulting outImage will be three-channel image of UInt8 pixel type, or sometimes of UInt16 pixel type for 16-bit depth images of supported formats (PNG, TIFF).
- Set inFile to specify a path to the image file you want to load.
- This filter can also be added easily by dragging and dropping an image file from Windows Explorer to the Program Editor in Aurora Vision Studio.
List of possible exceptions:
|DomainError||Image is damaged or it is not a BMP, PNG, PNM, TIF or JPG file in LoadImage. File: File name
Unable to open an image. Image header format is unrecognized. Image format is unknown or image is damaged. Load image supports only BMP, PNG, PNM, JPG and TIFF formats.
- SaveImage – Saves an image to a file.