Operator Reference

HALCON Operator Reference / Image Source
ClassesClasses | | Operators

control_image_sourceT_control_image_sourceControlImageSourceControlImageSourcecontrol_image_source (Operator)

control_image_sourceT_control_image_sourceControlImageSourceControlImageSourcecontrol_image_source — Control actions available for an image source.

Signature

control_image_source( : : ImageSourceHandle, Action, GenParamName, GenParamValue : Result)

Herror T_control_image_source(const Htuple ImageSourceHandle, const Htuple Action, const Htuple GenParamName, const Htuple GenParamValue, Htuple* Result)

void ControlImageSource(const HTuple& ImageSourceHandle, const HTuple& Action, const HTuple& GenParamName, const HTuple& GenParamValue, HTuple* Result)

HTuple HImageSource::ControlImageSource(const HString& Action, const HTuple& GenParamName, const HTuple& GenParamValue) const

HTuple HImageSource::ControlImageSource(const char* Action, const HTuple& GenParamName, const HTuple& GenParamValue) const

HTuple HImageSource::ControlImageSource(const wchar_t* Action, const HTuple& GenParamName, const HTuple& GenParamValue) const   ( Windows only)

def control_image_source(image_source_handle: HHandle, action: str, gen_param_name: Sequence[str], gen_param_value: Sequence[Union[int, float, str]]) -> Sequence[HTupleElementType]

Description

control_image_sourcecontrol_image_sourceControlImageSourceControlImageSourcecontrol_image_source initiates actions for the image source specified in ImageSourceHandleImageSourceHandleImageSourceHandleimageSourceHandleimage_source_handle. If the action returns a value, it is passed back in ResultResultResultresultresult.

For further information about the image source concept see Image Source.

The requested action is determined in ActionActionActionactionaction. Actions can be global or targeting the individual module in the image source. Some actions depend on whether the image source is in a connected state or not. The options for ActionActionActionactionaction that are available for every image source are:

'enumerate_groups'"enumerate_groups""enumerate_groups""enumerate_groups""enumerate_groups"

Returns all parameter group names. When querying for 'enumerate_groups'"enumerate_groups""enumerate_groups""enumerate_groups""enumerate_groups", the generic parameters GenParamNameGenParamNameGenParamNamegenParamNamegen_param_name and GenParamValueGenParamValueGenParamValuegenParamValuegen_param_value need to remain empty.

'enumerate_params'"enumerate_params""enumerate_params""enumerate_params""enumerate_params"

Returns all parameters available in the group that is set in GenParamValueGenParamValueGenParamValuegenParamValuegen_param_value. When setting no generic parameters, GenParamNameGenParamNameGenParamNamegenParamNamegen_param_name = 'group'"group""group""group""group" and GenParamValueGenParamValueGenParamValuegenParamValuegen_param_value = 'device'"device""device""device""device" are assumed by default.

This action is specific to an image source module and therefore a parameter group has to be specified using generic parameters.

'group'"group""group""group""group" is the only option for GenParamNameGenParamNameGenParamNamegenParamNamegen_param_name. Specify the parameter group in GenParamValueGenParamValueGenParamValuegenParamValuegen_param_value by setting one of these options:

  • 'image_source'"image_source""image_source""image_source""image_source",

  • 'plugin'"plugin""plugin""plugin""plugin",

  • 'interface'"interface""interface""interface""interface",

  • 'local_device'"local_device""local_device""local_device""local_device",

  • 'device'"device""device""device""device",

  • 'stream'"stream""stream""stream""stream".

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)

Image source handle.

ActionActionActionactionaction (input_control)  string → HTuplestrHTupleHtuple (string) (string) (HString) (char*)

Action to be carried out.

Default: 'enumerate_params' "enumerate_params" "enumerate_params" "enumerate_params" "enumerate_params"

Suggested values: 'enumerate_params'"enumerate_params""enumerate_params""enumerate_params""enumerate_params", 'enumerate_groups'"enumerate_groups""enumerate_groups""enumerate_groups""enumerate_groups"

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

Generic parameter name.

Default: []

Suggested values: 'group'"group""group""group""group"

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: []

Suggested values: 'image_source'"image_source""image_source""image_source""image_source", 'plugin'"plugin""plugin""plugin""plugin", 'interface'"interface""interface""interface""interface", 'local_device'"local_device""local_device""local_device""local_device", 'device'"device""device""device""device", 'stream'"stream""stream""stream""stream"

ResultResultResultresultresult (output_control)  string-array → HTupleSequence[HTupleElementType]HTupleHtuple (string / real / integer / handle) (string / double / int / long / HHandle) (HString / double / Hlong / HHandle) (char* / double / Hlong / handle)

Action result, if available.

Result

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

Possible Predecessors

query_image_sourcesquery_image_sourcesQueryImageSourcesQueryImageSourcesquery_image_sources, create_image_sourcecreate_image_sourceCreateImageSourceCreateImageSourcecreate_image_source, connect_image_sourceconnect_image_sourceConnectImageSourceConnectImageSourceconnect_image_source

Possible Successors

disconnect_image_sourcedisconnect_image_sourceDisconnectImageSourceDisconnectImageSourcedisconnect_image_source

See also

set_image_source_paramset_image_source_paramSetImageSourceParamSetImageSourceParamset_image_source_param, get_image_source_paramget_image_source_paramGetImageSourceParamGetImageSourceParamget_image_source_param

Module

Foundation

ClassesClasses | | Operators