Operator Reference

HALCON Operator Reference / Image Source

• HDevelop
• .NET
• Python
• C++
• C

ClassesClasses | | Operators

start_image_sourceT_start_image_sourceStartImageSourceStartImageSourcestart_image_source (Operator)

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

Signature

start_image_source( : : ImageSourceHandle, GenParamName, GenParamValue : )

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

void StartImageSource(const HTuple& ImageSourceHandle, const HTuple& GenParamName, const HTuple& GenParamValue)

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

static void HOperatorSet.StartImageSource(HTuple imageSourceHandle, HTuple genParamName, HTuple genParamValue)

void HImageSource.StartImageSource(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

Description

start_image_sourcestart_image_sourceStartImageSourceStartImageSourcestart_image_source prepares the image source device defined in the handle ImageSourceHandleImageSourceHandleImageSourceHandleimageSourceHandleimage_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""stream_state""stream_state""stream_state" changes from 'initialized'"initialized""initialized""initialized""initialized" to 'running'"running""running""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_sourcefetch_from_image_sourceFetchFromImageSourceFetchFromImageSourcefetch_from_image_source. See 'num_buffers'"num_buffers""num_buffers""num_buffers""num_buffers" in get_image_source_paramget_image_source_paramGetImageSourceParamGetImageSourceParamget_image_source_param on how to adapt the buffer queue capacity.

The device and a corresponding stream defined in ImageSourceHandleImageSourceHandleImageSourceHandleimageSourceHandleimage_source_handle need to be connected when calling start_image_sourcestart_image_sourceStartImageSourceStartImageSourcestart_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.

Currently, no generic parameters GenParamNameGenParamNameGenParamNamegenParamNamegen_param_name and GenParamValueGenParamValueGenParamValuegenParamValuegen_param_value are supported.

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

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

Handle of the image source to start the stream.

GenParamNameGenParamNameGenParamNamegenParamNamegen_param_name (input_control)  attribute.name-array → HTupleSequence[str]HTupleHtuple (string) (string) (HString) (char*)

Generic parameter name.

Default: []

GenParamValueGenParamValueGenParamValuegenParamValuegen_param_value (input_control)  attribute.value-array → HTupleSequence[Union[int, float, str]]HTupleHtuple (integer / real / string) (int / long / double / string) (Hlong / double / HString) (Hlong / double / char*)

Generic parameter value.

Default: []

Result

If the parameter values are correct, start_image_sourcestart_image_sourceStartImageSourceStartImageSourcestart_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

fetch_from_image_sourcefetch_from_image_sourceFetchFromImageSourceFetchFromImageSourcefetch_from_image_source, stop_image_sourcestop_image_sourceStopImageSourceStopImageSourcestop_image_source

See also

stop_image_sourcestop_image_sourceStopImageSourceStopImageSourcestop_image_source

Module

Foundation

---

ClassesClasses | | Operators