start_image_sourceStartImageSourceStartImageSourcestart_image_sourceT_start_image_source

HALCON ScriptCpp++.NETPythonC

Short description

start_image_sourceStartImageSourceStartImageSourcestart_image_sourceT_start_image_source — Prepare the image source for continuously acquiring, transmitting and receiving images.

Signature

start_image_source( image_source ImageSourceHandle, attribute.name GenParamName, attribute.value GenParamValue )void StartImageSource( const HTuple& ImageSourceHandle, const HTuple& GenParamName, const HTuple& GenParamValue )static void HOperatorSet.StartImageSource( HTuple imageSourceHandle, HTuple genParamName, HTuple genParamValue )def start_image_source( image_source_handle: HHandle, gen_param_name: Sequence[str], gen_param_value: Sequence[Union[int, float, str]] ) -> None

Herror T_start_image_source( const Htuple ImageSourceHandle, const Htuple GenParamName, const Htuple GenParamValue )

void HImageSource::StartImageSource( const HTuple& GenParamName, const HTuple& GenParamValue ) const

void HImageSource.StartImageSource( HTuple genParamName, HTuple genParamValue )

Description

start_image_sourceStartImageSource prepares the image source device defined in the handle ImageSourceHandleimageSourceHandleimage_source_handle for continuously acquiring, transmitting and receiving images. These preparations include, e.g., allocating memory, starting the receiver and finally starting the sending device. If the image source has been started successfully, the status parameter 'stream_state'"stream_state" changes from 'initialized'"initialized" to 'running'"running".

As soon as the stream has been started images are continuously acquired and stored in the receivers image buffer queue, assuming the device is in a free running configuration. Images can be retrieved from the buffer queue with fetch_from_image_sourceFetchFromImageSource. See 'num_buffers'"num_buffers" in get_image_source_paramGetImageSourceParam on how to adapt the buffer queue capacity.

The device and a corresponding stream defined in ImageSourceHandleimageSourceHandleimage_source_handle need to be connected when calling start_image_sourceStartImageSource. See connect_image_sourceConnectImageSource on how to connect your image source.

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

Currently, no generic parameters GenParamNamegenParamNamegen_param_name and GenParamValuegenParamValuegen_param_value are supported.

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

ImageSourceHandleimageSourceHandleimage_source_handle (input_control) image_source → (handle)HTuple (HHandle)HImageSource, HTuple (IntPtr)HHandleHtuple (handle)

Handle of the image source to start the stream.

GenParamNamegenParamNamegen_param_name (input_control) attribute.name-array → (string)HTuple (HString)HTuple (string)Sequence[str]Htuple (char*)

Generic parameter name.

Default: [][]

GenParamValuegenParamValuegen_param_value (input_control) attribute.value-array → (integer / real / string)HTuple (Hlong / double / HString)HTuple (int / long / double / string)Sequence[Union[int, float, str]]Htuple (Hlong / double / char*)

Generic parameter value.

Default: [][]

Result

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

Combinations with other operators

Combinations

Possible predecessors

connect_image_sourceConnectImageSource, set_image_source_paramSetImageSourceParam

Possible successors

fetch_from_image_sourceFetchFromImageSource, stop_image_sourceStopImageSource

See also

stop_image_sourceStopImageSource

Module

Foundation