grab_data_asyncGrabDataAsyncGrabDataAsyncgrab_data_asyncT_grab_data_async

HALCON ScriptCpp++.NETPythonC

Short description

grab_data_asyncGrabDataAsyncGrabDataAsyncgrab_data_asyncT_grab_data_async — Asynchronous grab of images and preprocessed image data from the specified image acquisition device.

Signature

grab_data_async( out image Image, out region Region, out xld_cont Contours, framegrabber AcqHandle, number MaxDelay, out string Data )void GrabDataAsync( HObject* Image, HObject* Region, HObject* Contours, const HTuple& AcqHandle, const HTuple& MaxDelay, HTuple* Data )static void HOperatorSet.GrabDataAsync( out HObject image, out HObject region, out HObject contours, HTuple acqHandle, HTuple maxDelay, out HTuple data )def grab_data_async( acq_handle: HHandle, max_delay: float ) -> Tuple[HObject, HObject, HObject, Sequence[HTupleElementType]]

def grab_data_async_s( acq_handle: HHandle, max_delay: float ) -> Tuple[HObject, HObject, HObject, HTupleElementType]Herror T_grab_data_async( Hobject* Image, Hobject* Region, Hobject* Contours, const Htuple AcqHandle, const Htuple MaxDelay, Htuple* Data )

HRegion HImage::GrabDataAsync( HXLDCont* Contours, const HFramegrabber& AcqHandle, double MaxDelay, HTuple* Data )

HRegion HImage::GrabDataAsync( HXLDCont* Contours, const HFramegrabber& AcqHandle, double MaxDelay, HString* Data )

HImage HRegion::GrabDataAsync( HXLDCont* Contours, const HFramegrabber& AcqHandle, double MaxDelay, HTuple* Data )

HImage HRegion::GrabDataAsync( HXLDCont* Contours, const HFramegrabber& AcqHandle, double MaxDelay, HString* Data )

HImage HFramegrabber::GrabDataAsync( HRegion* Region, HXLDCont* Contours, double MaxDelay, HTuple* Data ) const

HImage HFramegrabber::GrabDataAsync( HRegion* Region, HXLDCont* Contours, double MaxDelay, HString* Data ) const

HRegion HImage.GrabDataAsync( out HXLDCont contours, HFramegrabber acqHandle, double maxDelay, out HTuple data )

HRegion HImage.GrabDataAsync( out HXLDCont contours, HFramegrabber acqHandle, double maxDelay, out string data )

HImage HRegion.GrabDataAsync( out HXLDCont contours, HFramegrabber acqHandle, double maxDelay, out HTuple data )

HImage HRegion.GrabDataAsync( out HXLDCont contours, HFramegrabber acqHandle, double maxDelay, out string data )

HImage HFramegrabber.GrabDataAsync( out HRegion region, out HXLDCont contours, double maxDelay, out HTuple data )

HImage HFramegrabber.GrabDataAsync( out HRegion region, out HXLDCont contours, double maxDelay, out string data )

Description

The operator grab_data_asyncGrabDataAsync requests asynchronously grabbed images and preprocessed image data from the image acquisition device specified by AcqHandleacqHandleacq_handle. By default, grab_data_asyncGrabDataAsync also starts the next asynchronous grab before the operator returns. More information about the behavior of a specific image acquisition device can be found in the corresponding interface documentation in the directory doc/html/reference/acquisition. The desired operational mode of the image acquisition device as well as a suitable image part and additional interface-specific settings can be specified using the operators open_framegrabberOpenFramegrabber and set_framegrabber_paramSetFramegrabberParam. Depending on the current configuration of the image acquisition device, the preprocessed image data can be returned in terms of images (Imageimageimage), regions (Regionregionregion), XLD contours (Contourscontourscontours), and control data (Datadatadata).

The grab of the next image is finished by calling grab_data_asyncGrabDataAsync or grab_image_asyncGrabImageAsync. If more than MaxDelaymaxDelaymax_delay ms have passed since the asynchronous grab was started, the asynchronously grabbed image is considered as too old and a new image is grabbed, if necessary. If a negative value is assigned to MaxDelaymaxDelaymax_delay, this control mechanism is deactivated.

To abort the grab, the operator set_framegrabber_paramSetFramegrabberParam with the parameter 'do_abort_grab' can be used if the specific image acquisition interface supports it. Note that as an exception from the description of the concurrent usage in multiple threads (see below) 'do_abort_grab' can also be used from another thread.

Please note that if you call the operators grab_imageGrabImage or grab_dataGrabData after grab_data_asyncGrabDataAsync, the asynchronous grab started by grab_data_asyncGrabDataAsync is aborted and a new synchronous grab is started.

Attention

For a multithreaded application, info_framegrabberInfoFramegrabber, open_framegrabberOpenFramegrabber, and close_framegrabberCloseFramegrabber are executed exclusively.

grab_data_asyncGrabDataAsync runs in parallel with all non-exclusive operators inside and outside of this group.

Execution information

Execution information

• Multithreading type: reentrant (runs in parallel with non-exclusive operators).

• Multithreading scope: global (may be called from any thread).

• Processed without parallelization.

Parameters

Imageimageimage (output_object) image(-array) → object (byte / real / uint2)HObject (byte / real / uint2)HImage (byte / real / uint2)HObject (byte / real / uint2)Hobject * (byte / real / uint2)

Grabbed image data.

Regionregionregion (output_object) region(-array) → objectHObjectHRegionHObjectHobject *

Pre-processed image regions.

Contourscontourscontours (output_object) xld_cont(-array) → objectHObjectHXLDContHObjectHobject *

Pre-processed XLD contours.

AcqHandleacqHandleacq_handle (input_control) framegrabber → (handle)HTuple (HHandle)HFramegrabber, HTuple (IntPtr)HHandleHtuple (handle)

Handle of the acquisition device to be used.

MaxDelaymaxDelaymax_delay (input_control) number → (real)HTuple (double)HTuple (double)floatHtuple (double)

Maximum tolerated delay between the start of the asynchronous grab and the delivery of the image [ms].

Default: -1.0-1.0
Suggested values: -1.0, 20.0, 33.3, 40.0, 66.6, 80.0, 99.9-1.0, 20.0, 33.3, 40.0, 66.6, 80.0, 99.9

Datadatadata (output_control) string(-array) → (string / real / integer / handle)HTuple (HString / double / Hlong / HHandle)HTuple (string / double / int / long / HHandle)Sequence[HTupleElementType]Htuple (char* / double / Hlong / handle)

Pre-processed control data.

Example

(HDevelop)

* Select a suitable image acquisition interface name AcqName
open_framegrabber(AcqName,1,1,0,0,0,0,'default',-1,'default',-1.0, \
                  'default','default','default',-1,-1,AcqHandle)
* Grab image, segment it, and start next grab
grab_data_async (Image1, Region1, Contours1, AcqHandle, -1.0, Data1)
* Process data 1...
* Finish asynchronous grab, segment this image, and start next grab
grab_data_async (Image2, Region2, Contours2, AcqHandle, -1.0, Data2)
* Process data 2...
close_framegrabber(AcqHandle)

Result

If the image acquisition device is open and supports the image acquisition via grab_data_asyncGrabDataAsync, the operator grab_data_asyncGrabDataAsync returns the value 2 (H_MSG_TRUE). Otherwise an exception is raised.

Combinations with other operators

Combinations

Possible predecessors

open_framegrabberOpenFramegrabber, grab_image_startGrabImageStart, set_framegrabber_paramSetFramegrabberParam

Possible successors

grab_image_asyncGrabImageAsync, set_framegrabber_paramSetFramegrabberParam, close_framegrabberCloseFramegrabber

See also

open_framegrabberOpenFramegrabber, info_framegrabberInfoFramegrabber, set_framegrabber_paramSetFramegrabberParam

Module

Foundation