grab_image (Operator)

Name

grab_image — Grab an image from the specified image acquisition device.

Synopsis

grab_image( : Image : AcqHandle : )

Description

The operator grab_image grabs an image via the image acquisition device specified by AcqHandle. The desired operational mode of the image acquisition device as well as a suitable image part can be adjusted via the operator open_framegrabber. Additional interface-specific settings can be specified via set_framegrabber_param.

Parameters

Image (output_object)	image → object (byte / uint2)
Grabbed image.

AcqHandle (input_control)	framegrabber → (integer)
Handle of the acquisition device to be used.

Example

* Select a suitable image acquisition interface name AcqName
info_framegrabber(AcqName,'port',Information,Values)
* Choose the port P and the input line L your camera is connected to
open_framegrabber(AcqName,1,1,0,0,0,0,'default',-1,'default',-1.0, \
                  'default','default','default',P,L,AcqHandle)
grab_image(Image,AcqHandle)
close_framegrabber(AcqHandle)

Result

If the image could be acquired successfully, the operator grab_image returns the value 2 (H_MSG_TRUE). Otherwise an exception handling is raised.

Parallelization Information

grab_image is reentrant and processed without parallelization.

Possible Predecessors

open_framegrabber, set_framegrabber_param

Possible Successors

grab_image, grab_image_start, grab_image_async, close_framegrabber

See also

open_framegrabber, info_framegrabber, set_framegrabber_param

Module

Foundation