Operator Reference

HALCON Operator Reference / Image Source

• HALCON Script
• .NET
• Python
• C++
• C

ClassesClasses | | Operators

stop_image_sourceT_stop_image_sourceStopImageSourceStopImageSourcestop_image_source (Operator)

stop_image_sourceT_stop_image_sourceStopImageSourceStopImageSourcestop_image_source — Stop the continuous acquisition, transmission and reception of images of the image source.

Signature

stop_image_source( : : ImageSourceHandle, GenParamName, GenParamValue : )

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

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

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

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

void HImageSource.StopImageSource(HTuple genParamName, HTuple genParamValue)

def stop_image_source(image_source_handle: HHandle, gen_param_name: Sequence[str], gen_param_value: Sequence[Union[int, float, str]]) -> None

Description

stop_image_sourcestop_image_sourceStopImageSourceStopImageSourcestop_image_source stops the continuous acquisition, transmission and reception of images of the image source device defined in the handle ImageSourceHandleImageSourceHandleImageSourceHandleimageSourceHandleimage_source_handle. It withdraws the preparations performed by start_image_sourcestart_image_sourceStartImageSourceStartImageSourcestart_image_source. The status parameter 'stream_state'"stream_state""stream_state""stream_state""stream_state" changes from 'running'"running""running""running""running" to 'initialized'"initialized""initialized""initialized""initialized".

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

stop_image_sourcestop_image_sourceStopImageSourceStopImageSourcestop_image_source can be used from another thread to abort a blocking call of fetch_from_image_sourcefetch_from_image_sourceFetchFromImageSourceFetchFromImageSourcefetch_from_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 stop 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, stop_image_sourcestop_image_sourceStopImageSourceStopImageSourcestop_image_source returns the value 2 ( H_MSG_TRUE) . Otherwise an exception is raised.

Possible Predecessors

start_image_sourcestart_image_sourceStartImageSourceStartImageSourcestart_image_source, fetch_from_image_sourcefetch_from_image_sourceFetchFromImageSourceFetchFromImageSourcefetch_from_image_source

Possible Successors

disconnect_image_sourcedisconnect_image_sourceDisconnectImageSourceDisconnectImageSourcedisconnect_image_source

See also

start_image_sourcestart_image_sourceStartImageSourceStartImageSourcestart_image_source

Module

Foundation

---

ClassesClasses | | Operators