User`s guide
getdata
is measured continuously with respect to 0 until the acquisition stops.
When the acquisition stops, the o bject’s
Running property is set to 'Off'.
[data, time, metadat a] = getdata(...) returns m etadata,an
F-by-1 array of structures, where F is the number of frames returned
in
data. Each structure contains information about the corresponding
frame in
data.Them etadata structure contains these fields:
Metadata Field Description
'AbsTime'
Absolute time the frame was acquired, expressed
as a time vector
'FrameNumbe
r'
Number identifying the nth frame since the
start command was issued
'RelativeFr
ame'
Number identifying the nth frame relative to the
start of a trigger
'TriggerIn
dex'
Number of the trigger in wh ich this frame was
acquired
getdata is
a blocking function that returns execution control to the
MATLAB wor
kspace after the requested number of frames becomes
available
within the time period specified by the object’s
Timeout
property.
The object’s
FramesAvailable property is automatically
reduced b
y the number of frames returned by
getdata.Iftherequested
number of
frames is greater than the frames to be acquired,
getdata
returns a
n error.
It is poss
ible to issue a Ctrl+C while
getdata is blocking. This does not
stop the a
cquisition but does return control to MATLAB.
Examples Construct a video input object associated with a M atrox device at ID 1.
obj = vid
eoinput('matrox', 1);
Initiate an acquisition and access the logged data.
start(obj);
12-11