HALCON 26.05.0.0 / HALCON Operator-Referenz / Bildquelle
KlassenKlassen | | Operatoren

control_image_sourceT_control_image_sourceControlImageSourceControlImageSourcecontrol_image_source (Operator)

Name

control_image_sourceT_control_image_sourceControlImageSourceControlImageSourcecontrol_image_source — Steuern von Aktionen, die für Bildquellen verfügbar sind.

Signatur

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   ( Nur Windows)

static void HOperatorSet.ControlImageSource(HTuple imageSourceHandle, HTuple action, HTuple genParamName, HTuple genParamValue, out HTuple result)

HTuple HImageSource.ControlImageSource(string action, HTuple genParamName, HTuple genParamValue)

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]

Beschreibung

control_image_sourcecontrol_image_sourceControlImageSourceControlImageSourcecontrol_image_source initiiert Aktionen für die in ImageSourceHandleImageSourceHandleImageSourceHandleimageSourceHandleimage_source_handle festgelegte Bildquelle. Falls eine Aktion einen Wert liefert wird er in ResultResultResultresultresult zurückgegeben.

Die gewünschte Aktion wird in ActionActionActionactionaction festgelegt. Aktionen können global sein, oder nur die individuellen Module der Bildquelle betreffen. Manche Aktionen sind vom Verbindungszustand der Bildquelle abhängig. Die Optionen für ActionActionActionactionaction, die für jede Bildquelle verfügbar sind, sind:

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

Gibt die Namen aller Parametergruppen zurück. Wenn 'enumerate_groups'"enumerate_groups""enumerate_groups""enumerate_groups""enumerate_groups" abgefragt wird, müssen die generischen Parameter GenParamNameGenParamNameGenParamNamegenParamNamegen_param_name und GenParamValueGenParamValueGenParamValuegenParamValuegen_param_value leer bleiben.

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

Gibt alle Parameter zurück, die in der in GenParamValueGenParamValueGenParamValuegenParamValuegen_param_value gesetzten Gruppe verfügbar sind. 'group'"group""group""group""group" ist die einzige Option für GenParamNameGenParamNameGenParamNamegenParamNamegen_param_name. Die Parametergruppe, der der Parameter zugeordnet ist, wird in GenParamValueGenParamValueGenParamValuegenParamValuegen_param_value festgelegt, indem eine dieser Optionen gesetzt wird:

  • '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".

Werden keine generischen Parameter gesetzt, werden GenParamNameGenParamNameGenParamNamegenParamNamegen_param_name = 'group'"group""group""group""group" und GenParamValueGenParamValueGenParamValuegenParamValuegen_param_value = 'device'"device""device""device""device" standardmäßig angenommen.

'query_param_tree'"query_param_tree""query_param_tree""query_param_tree""query_param_tree"

Gibt ein verschachteltes HALCON Dictionary zurück, welches alle Parameterkategorien, Unterkategorien und ihre Parameter enthält. Für jeden enthaltenen Parameter ist auch der Parametertyp angegeben.

Diese Aktion ist spezifisch für ein Bildquellenmodul und daher muss eine Parametergruppe über generische Parameter festgelegt werden.

'group'"group""group""group""group" ist die einzige Option für GenParamNameGenParamNameGenParamNamegenParamNamegen_param_name. Die Parametergruppe, der der Parameter zugeordnet ist, wird in GenParamValueGenParamValueGenParamValuegenParamValuegen_param_value festgelegt, indem eine dieser Optionen gesetzt wird:

  • '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".

Werden keine generischen Parameter gesetzt, werden GenParamNameGenParamNameGenParamNamegenParamNamegen_param_name = 'group'"group""group""group""group" und GenParamValueGenParamValueGenParamValuegenParamValuegen_param_value = 'device'"device""device""device""device" standardmäßig angenommen.

'write_state_string'"write_state_string""write_state_string""write_state_string""write_state_string"

Gibt einen String zurück, der Informationen enthält, die benötigt werden, um die Werte aller persistierbaren Parameter der angegebenen Gruppe wiederherzustellen. Es werden nur Parameter berücksichtigt, deren Parametereigenschaft 'persistable'"persistable""persistable""persistable""persistable" den Wert 'true'"true""true""true""true" hat.

Diese Aktion ist spezifisch für ein Bildquellenmodul und daher muss eine Parametergruppe über generische Parameter festgelegt werden.

'group'"group""group""group""group" ist die einzige gültige Option für GenParamNameGenParamNameGenParamNamegenParamNamegen_param_name. Die Parametergruppe wird in GenParamValueGenParamValueGenParamValuegenParamValuegen_param_value festgelegt, indem eine dieser Optionen gesetzt wird:

  • '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".

Werden keine generischen Parameter gesetzt, werden GenParamNameGenParamNameGenParamNamegenParamNamegen_param_name = 'group'"group""group""group""group" und GenParamValueGenParamValueGenParamValuegenParamValuegen_param_value = 'device'"device""device""device""device" standardmäßig angenommen.

Diese Aktion kann nicht für die Gruppe 'image_source'"image_source""image_source""image_source""image_source" verwendet werden.

'read_state_string'"read_state_string""read_state_string""read_state_string""read_state_string"

Stellt alle persistierbaren Parameter der angegebenen Gruppe anhand des Zustandsstrings wieder her, der im generischen Parameter 'state_string'"state_string""state_string""state_string""state_string" übergeben wird.

'group'"group""group""group""group" und 'state_string'"state_string""state_string""state_string""state_string" sind die gültigen Optionen für GenParamNameGenParamNameGenParamNamegenParamNamegen_param_name.

Der generische Parameter 'state_string'"state_string""state_string""state_string""state_string" ist obligatorisch und muss den Zustandsstring enthalten, der zuvor über die Aktion 'write_state_string'"write_state_string""write_state_string""write_state_string""write_state_string" erzeugt wurde.

Diese Aktion ist spezifisch für ein Bildquellenmodul und daher muss eine Parametergruppe über generische Parameter festgelegt werden. Die Parametergruppe wird in GenParamValueGenParamValueGenParamValuegenParamValuegen_param_value festgelegt, indem eine dieser Optionen gesetzt wird:

  • '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".

Wenn der generische Parameter 'group'"group""group""group""group" nicht gesetzt wird, wird standardmäßig der Wert 'device'"device""device""device""device" angenommen.

Diese Aktion kann nicht für die Gruppe 'image_source'"image_source""image_source""image_source""image_source" verwendet werden.

'write_config_file'"write_config_file""write_config_file""write_config_file""write_config_file"

Schreibt eine Bildquellenkonfigurationsdatei, welche Informationen enthält, die für einen erfolgreichen Verbindungsaufbau benötigt werden, aber auch um alle persistierbaren Parameter aller Parametergruppen wiederherzustellen.

Das Schreiben dieser Datei ist sowohl im verbundenen, als auch im nicht verbunden Zustand erlaubt. Wenn sie im nicht verbundenen Zustand geschrieben wird, enthält sie keine Informationen zur Wiederherstellung der persistierbaren Parameter der Bildquellenmodule (Plugin, Gerät, ...).

Diese Aktion erfordert einen Pfad zu der Datei, die geschrieben werden soll. Dieser muss übergeben werden zusammen mit GenParamNameGenParamNameGenParamNamegenParamNamegen_param_name = 'file_name'"file_name""file_name""file_name""file_name" im korrespondierenden GenParamValueGenParamValueGenParamValuegenParamValuegen_param_value.

Die HALCON Dateiendung für Bildquellenkonfigurationsdateien ist '.hisc'. Wenn keine Dateiendung angegeben wird, wird diese automatisch verwendet.

Um diese Konfigurationsdateien zu lesen (und Bildquellen-Handles daraus zu erzeugen) siehe create_image_sourcecreate_image_sourceCreateImageSourceCreateImageSourcecreate_image_source.

Ausführungsinformationen

Parameter

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

Bildquellen-Handle.

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

Auszuführende Aktion.

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

Wertevorschläge: 'enumerate_params'"enumerate_params""enumerate_params""enumerate_params""enumerate_params", 'enumerate_groups'"enumerate_groups""enumerate_groups""enumerate_groups""enumerate_groups", 'query_param_tree'"query_param_tree""query_param_tree""query_param_tree""query_param_tree", 'write_state_string'"write_state_string""write_state_string""write_state_string""write_state_string", 'read_state_string'"read_state_string""read_state_string""read_state_string""read_state_string", 'write_config_file'"write_config_file""write_config_file""write_config_file""write_config_file"

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

Generischer Parametername.

Default: []

Wertevorschläge: 'group'"group""group""group""group", 'state_string'"state_string""state_string""state_string""state_string", 'file_name'"file_name""file_name""file_name""file_name"

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*)

Generischer Parameterwert.

Default: []

Wertevorschläge: '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)

Ergebniswert der Aktion, falls vorhanden.

Ergebnis

Sind die Parameterwerte korrekt, gibt control_image_sourcecontrol_image_sourceControlImageSourceControlImageSourcecontrol_image_source den Wert 2 ( H_MSG_TRUE) zurück. Andernfalls wird eine Fehlerbehandlung durchgeführt.

Vorgänger

query_image_sourcesquery_image_sourcesQueryImageSourcesQueryImageSourcesquery_image_sources, create_image_sourcecreate_image_sourceCreateImageSourceCreateImageSourcecreate_image_source, connect_image_sourceconnect_image_sourceConnectImageSourceConnectImageSourceconnect_image_source

Nachfolger

disconnect_image_sourcedisconnect_image_sourceDisconnectImageSourceDisconnectImageSourcedisconnect_image_source

Siehe auch

set_image_source_paramset_image_source_paramSetImageSourceParamSetImageSourceParamset_image_source_param, get_image_source_paramget_image_source_paramGetImageSourceParamGetImageSourceParamget_image_source_param

Modul

Foundation

KlassenKlassen | | Operatoren
HALCON Operator-Referenz 26.05.0.0 Copyright © 1996-2026 MVTec Software GmbH