Documentation

Image Acquisition Toolbox Functions

Device Connection

clear Clear image acquisition object from MATLAB workspace
delete Remove image acquisition object from memory
disp Display method for image acquisition objects
imaqfind Find image acquisition objects
imaqhwinfo Information about available image acquisition hardware
imaqmem Limit memory or display memory usage for Image Acquisition Toolbox software
imaqreset Disconnect and delete all image acquisition objects
imaqtool Launch Image Acquisition Tool
start Obtain exclusive use of image acquisition device
stop Stop video input object
videoinput Create video input object
imaq.VideoDevice Acquire one frame at a time from video device

Image Preview and Device Configuration

closepreview Close Video Preview window
get Return image acquisition object properties
getselectedsource Return currently selected video source object
imaqhelp Image acquisition object function and property help
imaqtool Launch Image Acquisition Tool
preview Preview of live video data
propinfo Property characteristics for image acquisition objects
set Configure or display image acquisition object properties
stoppreview Stop previewing video data

Image Data Acquisition

Acquisition Using GigE Vision Hardware

gigecamlist List of GigE Vision cameras connected to your system
gigecam Create gigecam object to acquire images from GigE Vision cameras
commands List of commands available for GigE Vision camera
executeCommand Execute command on GigE Vision camera
snapshot Acquire single image frame from GigE Vision camera
preview Preview of live video data
closepreview Close Video Preview window

Acquisition Using Matrox Hardware

matroxlist List of Matrox frame grabbers connected to your system
matroxcam Create matroxcam object to acquire images from Matrox frame grabbers
snapshot Acquire single image frame from Matrox frame grabber
preview Preview of live video data
closepreview Close Video Preview window

Acquisition Using Kinect for Windows Hardware

imaqtool Launch Image Acquisition Tool
videoinput Create video input object
imaq.VideoDevice Acquire one frame at a time from video device
getdata Acquired image frames to MATLAB workspace
peekdata Most recently acquired image data
getsnapshot Immediately return single image frame
set Configure or display image acquisition object properties
start Obtain exclusive use of image acquisition device
islogging Determine whether video input object is logging
isrunning Determine whether video input object is running
isvalid Determine whether image acquisition object is associated with image acquisition device
wait Wait until image acquisition object stops running or logging
stop Stop video input object
clear Clear image acquisition object from MATLAB workspace
delete Remove image acquisition object from memory
flushdata Remove data from memory buffer used to store acquired image frames
obj2mfile Convert video input objects to MATLAB code
imaqmem Limit memory or display memory usage for Image Acquisition Toolbox software
imaqmontage Sequence of image frames as montage
load Load image acquisition object into MATLAB workspace
save Save image acquisition objects to MAT-file
trigger Initiate data logging
triggerconfig Configure video input object trigger properties
triggerinfo Provide information about available trigger configurations

Acquisition Using Any Hardware

imaqtool Launch Image Acquisition Tool
videoinput Create video input object
imaq.VideoDevice Acquire one frame at a time from video device
getdata Acquired image frames to MATLAB workspace
peekdata Most recently acquired image data
getsnapshot Immediately return single image frame
set Configure or display image acquisition object properties
start Obtain exclusive use of image acquisition device
islogging Determine whether video input object is logging
isrunning Determine whether video input object is running
isvalid Determine whether image acquisition object is associated with image acquisition device
wait Wait until image acquisition object stops running or logging
stop Stop video input object
clear Clear image acquisition object from MATLAB workspace
delete Remove image acquisition object from memory
flushdata Remove data from memory buffer used to store acquired image frames
obj2mfile Convert video input objects to MATLAB code
imaqmem Limit memory or display memory usage for Image Acquisition Toolbox software
imaqmontage Sequence of image frames as montage
load Load image acquisition object into MATLAB workspace
save Save image acquisition objects to MAT-file
trigger Initiate data logging
triggerconfig Configure video input object trigger properties
triggerinfo Provide information about available trigger configurations
Was this topic helpful?