snap_from_image_source — Acquire an image with corresponding meta data from an image source.
snap_from_image_source( : Images : ImageSourceHandle : Data)
snap_from_image_source actively causes the acquisition of
Images with the image source defined in the handle
ImageSourceHandle. For conventional devices, Images
is most likely to be a single image, but complex sensors, e.g. 3D sensors,
might provide multiple images at once. Additionally, meta information is
returned in Data.
Internally, calling snap_from_image_source starts the image
acquisition, retrieves an image, and stops the acquisition again, freeing
all resources. It is therefore tailored towards the basic synchronous
acquisition of one image.
See fetch_from_image_source for continuous image acquisition.
As far as supported by the respective plugin, meta information
is returned in Data. The provided parameters are described in
fetch_from_image_source.
The device defined in ImageSourceHandle needs to be
connected when calling snap_from_image_source.
See connect_image_source on how to connect your image source.
For further information about the states of an image source see Image Source.
This operator returns a handle. Note that the state of an instance of this handle type may be changed by specific operators even though the handle is used as an input parameter by those operators.
Images (output_object) image(-array) → object (byte / int1 / int2 / uint2 / int4 / int8 / real)
Acquired images.
ImageSourceHandle (input_control) image_source → (handle)
Handle of the image source that acquires the images.
Data (output_control) dict → (handle)
Meta information about the images.
If the parameter values are correct, snap_from_image_source
returns the value 2 (
H_MSG_TRUE)
. Otherwise an exception is raised.
connect_image_source,
set_image_source_param
Foundation