Most recently acquired image data
data = peekdata(obj,frames)
data = peekdata(obj,frames) returns
the latest number of frames specified by
frames is greater than the number of frames
currently acquired, all available frames are returned with a warning
message stating that the requested number of frames was not available.
be a 1-by-1 video input object.
data is returned as an H-by-W-by-B-by-F matrix
Image height, as specified in the object's
Image width, as specified in the object's
Number of color bands, as specified in the
Number of frames returned
data is returned to the MATLAB® workspace in its native data
type using the color space specified by the
You can use the MATLAB
to view the returned data. Use
imaqmontage to view
multiple frames at once.
peekdata is a nonblocking function that immediately
returns image frames and execution control to the MATLAB workspace. Not all requested
data might be returned.
peekdata provides a look at the data; it
does not remove data from the memory buffer. The object's
value is not affected by the number of frames returned by
The behavior of
peekdata depends on the settings
Running and the
The object has been started but is waiting for a trigger.
The object has been started, a trigger has executed, and the object is actively acquiring data.
The object has stopped running because it acquired the
requested number of frames or you called the
The number of frames available to
determined by recalling the last frame returned by a previous
and the number of frames that were acquired since then.
peekdata can be used only after the
is issued and while the object is running.
also be called once after
obj has stopped running.
peekdata function does not return any
data while running if in disk logging mode.
To get a list of options you can use on a function, press the Tab key after entering a function on the MATLAB command line. The list expands, and you can scroll to choose a property or value. For information about using this advanced tab completion feature, see Using Tab Completion for Functions.