| Image Acquisition Toolbox™ |   |
Back to Top
General-Purpose Objects
Video input objects have one or more video source objects associated
with them. In this table, functions that work on both types of objects
use the phrase "image acquisition object" to refer to
both types of objects.
| clear | Clear image acquisition object from MATLAB workspace |
| delete | Remove image acquisition object from memory |
| disp | Display method for image acquisition objects |
| get | Image acquisition object properties |
| getselectedsource | Currently selected video source object |
| imaqfind | Find image acquisition objects |
| 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 |
| load | Load image acquisition object into MATLAB workspace |
| obj2mfile | Convert video input objects to MATLAB code |
| save | Save image acquisition objects to MAT-file |
| set | Configure or display image acquisition object properties |
| start | Obtain exclusive use of image acquisition device |
| stop | Stop video input object |
| videoinput | Create video input object |
| wait | Wait until image acquisition object stops running or logging |
Back to Top
Triggering
| trigger | Initiate data logging |
| triggerconfig | Configure video input object trigger properties |
| triggerinfo | Provide information about available trigger configurations |
Back to Top
Data
| flushdata | Remove data from memory buffer used to store acquired
image frames |
| getdata | Acquired image frames to MATLAB workspace |
| getsnapshot | Immediately return single image frame |
| peekdata | Most recently acquired image data |
Back to Top
Tools
| closepreview | Close Video Preview window |
| imaqhelp | Image acquisition object function and property help |
| imaqhwinfo | Information about available image acquisition hardware |
| imaqmem | Limit memory or display memory usage for the Image Acquisition Toolbox software |
| imaqmontage | Sequence of image frames as montage |
| imaqreset | Disconnect and delete all image acquisition objects |
| imaqtool | Launch Image Acquisition Tool |
| preview | Preview of live video data |
| propinfo | Property characteristics for image acquisition objects |
| stoppreview | Stop previewing video data |
Back to Top
Getting Command-Line Function Help
To get command-line function help, you can use the MATLAB help function.
For example, to get help for the getsnapshot function,
type the following:
help getsnapshot
However, the Image Acquisition
Toolbox software provides "overloaded" versions of several MATLAB functions. That is, it provides
toolbox-specific implementations of these functions using the same
function name.
For example, the Image Acquisition
Toolbox software provides an overloaded version of the delete function.
You get help for the MATLAB version
of this function if you type the following:
help delete
You can determine if a function is overloaded by examining the
last section of the help. For delete, the help
contains the following overloaded versions (not all are shown):
Overloaded methods
help char/delete.m
help scribehandle/delete.m
help scribehgobj/delete.m
.
.
.
help imaqdevice/delete.m
To obtain help on the Image Acquisition
Toolbox version of this function, type the following:
help imaqdevice/delete
To avoid having to specify which overloaded version you want
to view, use the imaqhelp function:
imaqhelp delete
You can also use this function to get help on image acquisition
object properties. For more information on overloaded functions and
class directories, refer to MATLAB Classes
and Objects in the Help browser.
| Contacting The MathWorks and Using the imaqsupport Function | | Functions — Alphabetical List | |
Alphabetical List