Learn more about Image Acquisition Toolbox

Property Reference

Alphabetical List

---

This chapter contains brief descriptions of all the properties of the video input object and the properties of the video source object that are common to all video source objects. Video source objects can also support device-specific properties that vary depending on the image acquisition hardware. To get help on these device-specific properties, use the imaqhelp function, specifying the video source object as an argument.

Video Input Objects Image acquisition object properties, arranged by category Video Source Objects Video source object properties, arranged alphabetically

Back to Top

Video Input Objects

General General image acquisition properties Callback Properties related to callback events Triggering Properties related to triggering Acquisition Source Properties related to video acquisition source

Back to Top of Section

General

BayerSensorAlignment	Specify sensor alignment for Bayer demosaicing
DeviceID	Identify image acquisition device represented by video input object
DiskLogger	Specify MATLAB AVI file object used to log data
DiskLoggerFrameCount	Specify number of frames written to disk
EventLog	Store information about events
FrameGrabInterval	Specify how often to acquire frame from video stream
FramesAcquired	Indicate total number of frames acquired
FramesAvailable	Indicate number of frames available in memory buffer
FramesPerTrigger	Specify number of frames to acquire per trigger using selected video source
Logging	Indicate whether object is currently logging data
LoggingMode	Specify destination for acquired data
Name	Specify name of image acquisition object
NumberOfBands	Indicate number of color bands in data to be acquired
Previewing	Indicate whether object is currently previewing data in separate window
ReturnedColorSpace	Specify color space used in MATLAB
ROIPosition	Specify region-of-interest (ROI) window
Running	Indicate whether video input object is ready to acquire data
Tag	Specify descriptive text to associate with image acquisition object
Timeout	Specify how long to wait for image data
Type	Identify type of image acquisition object
UserData	Store data to associate with image acquisition object
VideoFormat	Specify video format or name of device configuration file
VideoResolution	Indicate width and height of incoming video stream

Back to Top of Section

Callback

ErrorFcn	Specify M-file callback function to execute when run-time error occurs
FramesAcquiredFcn	Specify M-file executed when specified number of frames have been acquired
FramesAcquiredFcnCount	Specify number of frames that must be acquired before frames acquired event is generated
StartFcn	Specify M-file executed when start event occurs
StopFcn	Specify M-file executed when stop event occurs
TimerFcn	Specify M-file callback function to execute when timer event occurs
TimerPeriod	Specify number of seconds between timer events
TriggerFcn	Specify M-file callback function to execute when trigger event occurs

Back to Top of Section

Triggering

InitialTriggerTime	Record absolute time of first trigger
TriggerCondition	Indicate required condition before trigger event occurs
TriggerFrameDelay	Specify number of frames to skip before acquiring frames after trigger occurs
TriggerRepeat	Specify number of additional times to execute trigger
TriggersExecuted	Indicate total number of executed triggers
TriggerSource	Indicate hardware source to monitor for trigger conditions
TriggerType	Indicate type of trigger used by video input object

Back to Top of Section

Acquisition Source

SelectedSourceName	Specify name of currently selected video source
Source	Indicate video source objects associated with video input object

Back to Top

Video Source Objects

Video input objects create one or more video source objects that represent the image acquisition data sources. The following table lists the properties common to all video source objects.

Note   A video source object can support additional, device-specific properties. These properties vary, depending on the image acquisition hardware. To get information about these properties, use the imaqhelp function, specifying the video source object as an argument.

Parent	Identify video input object that is parent of video source object
Selected	Indicate whether video source object will be used for acquisition
Tag	Specify descriptive text to associate with image acquisition object
Type	Identify type of image acquisition object

wait

Properties — Alphabetical List

© 1984-2009- The MathWorks, Inc.    -   Site Help   -   Patents   -   Trademarks   -   Privacy Policy   -   Preventing Piracy   -   RSS