Image Acquisition Toolbox™

getsnapshot - Immediately return single image frame

Syntax

frame = getsnapshot(obj)

Description

frame = getsnapshot(obj) immediately returns one single image frame, frame, from the video input object obj. The frame of data returned is independent of the video input object FramesPerTrigger property and has no effect on the value of the FramesAvailable or FramesAcquired property.

The object obj must be a 1-by-1 video input object.

frame is returned as an H-by-W-by-B matrix where

frame is returned to the MATLAB workspace in its native data type using the color space specified by the ReturnedColorSpace property.

You can use the MATLAB image or imagesc function to view the returned data.

Note   If obj is running but not logging, and has been configured with a hardware trigger, a timeout error will occur.

To interrupt the getsnapshot function and return control to the MATLAB command line, issue the ^C (Ctrl+C) command.

Examples

Create a video input object.

obj = videoinput('matrox', 1);

Acquire and display a single frame of data.

frame = getsnapshot(obj);
image(frame);

Remove the video input object from memory.

delete(obj);

See Also

getdata, imaqhelp, peekdata

getselectedsource

imaqfind