Operator Reference

HALCON Operator Reference / Image Source
ClassesClasses | | Operators

snap_from_image_sourceT_snap_from_image_sourceSnapFromImageSourceSnapFromImageSourcesnap_from_image_source (Operator)

snap_from_image_sourceT_snap_from_image_sourceSnapFromImageSourceSnapFromImageSourcesnap_from_image_source — Acquire an image with corresponding meta data from an image source.

Signature

snap_from_image_source( : Images : ImageSourceHandle : Data)

Herror T_snap_from_image_source(Hobject* Images, const Htuple ImageSourceHandle, Htuple* Data)

void SnapFromImageSource(HObject* Images, const HTuple& ImageSourceHandle, HTuple* Data)

HImage HImageSource::SnapFromImageSource(HDict* Data) const

static void HOperatorSet.SnapFromImageSource(out HObject images, HTuple imageSourceHandle, out HTuple data)

HImage HImageSource.SnapFromImageSource(out HDict data)

def snap_from_image_source(image_source_handle: HHandle) -> Tuple[HObject, HHandle]

Description

snap_from_image_sourcesnap_from_image_sourceSnapFromImageSourceSnapFromImageSourcesnap_from_image_source actively causes the acquisition of ImagesImagesImagesimagesimages with the image source defined in the handle ImageSourceHandleImageSourceHandleImageSourceHandleimageSourceHandleimage_source_handle. For conventional devices, ImagesImagesImagesimagesimages 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 DataDataDatadatadata.

Internally, calling snap_from_image_sourcesnap_from_image_sourceSnapFromImageSourceSnapFromImageSourcesnap_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_sourcefetch_from_image_sourceFetchFromImageSourceFetchFromImageSourcefetch_from_image_source for continuous image acquisition.

As far as supported by the respective plugin, meta information is returned in DataDataDatadatadata. The provided parameters are described in fetch_from_image_sourcefetch_from_image_sourceFetchFromImageSourceFetchFromImageSourcefetch_from_image_source.

The device defined in ImageSourceHandleImageSourceHandleImageSourceHandleimageSourceHandleimage_source_handle needs to be connected when calling snap_from_image_sourcesnap_from_image_sourceSnapFromImageSourceSnapFromImageSourcesnap_from_image_source. See connect_image_sourceconnect_image_sourceConnectImageSourceConnectImageSourceconnect_image_source on how to connect your image source.

For further information about the states of an image source see Image Source.

Execution Information

  • Multithreading type: reentrant (runs in parallel with non-exclusive operators).
  • Multithreading scope: global (may be called from any thread).
  • Processed without parallelization.

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.

Parameters

ImagesImagesImagesimagesimages (output_object)  image(-array) → objectHImageHObjectHObjectHobject * (byte / int1 / int2 / uint2 / int4 / int8 / real)

Acquired images.

ImageSourceHandleImageSourceHandleImageSourceHandleimageSourceHandleimage_source_handle (input_control)  image_source → HImageSource, HTupleHHandleHTupleHtuple (handle) (IntPtr) (HHandle) (handle)

Handle of the image source that acquires the images.

DataDataDatadatadata (output_control)  dict → HDict, HTupleHHandleHTupleHtuple (handle) (IntPtr) (HHandle) (handle)

Meta information about the images.

Result

If the parameter values are correct, snap_from_image_sourcesnap_from_image_sourceSnapFromImageSourceSnapFromImageSourcesnap_from_image_source returns the value 2 ( H_MSG_TRUE) . Otherwise an exception is raised.

Possible Predecessors

connect_image_sourceconnect_image_sourceConnectImageSourceConnectImageSourceconnect_image_source, set_image_source_paramset_image_source_paramSetImageSourceParamSetImageSourceParamset_image_source_param

Possible Successors

disconnect_image_sourcedisconnect_image_sourceDisconnectImageSourceDisconnectImageSourcedisconnect_image_source

Module

Foundation

ClassesClasses | | Operators