get_param_infoget_param_infoGetParamInfoGetParamInfoget_param_info (Operator)

Name

get_param_infoget_param_infoGetParamInfoGetParamInfoget_param_info — Informationen zu Operatorparametern.

Signatur

Beschreibung

get_param_infoget_param_infoGetParamInfoGetParamInfoGetParamInfoget_param_info dient zur Abfrage der Online-Texte zu einem Parameter eines vorgegebenen Operators. Die Art der Information (SlotSlotSlotSlotslotslot), die für jeden Parameter zur Verfügung steht, lässt sich mittels query_param_infoquery_param_infoQueryParamInfoQueryParamInfoQueryParamInfoquery_param_info abfragen. Mögliche Slots sind unten gelistet. Für eine detailliertere Beschreibung der Einträge wird auf das Manual „Extension Package Programmer’s Manual“ verwiesen.

'description':

Beschreibung des Parameters.

'description.latex':

Beschreibung des Parameters in LaTeX Notation.

'parameter_class':

Parameterklasse.

'input_object'

'output_object'

'input_control'

'output_control'

'type_list':

Zulässige(r) Datentyp(en) für Parameterwerte.

'default_type':

Default-Typ für Parameterwerte (nur bei Steuerparametern). Dies ist der Parametertyp der bei HALCON/C im „simple Mode“ verwendet wird. Falls 'none' angegeben wird, dann muss der „Tupel Modus“ verwendet werden.

'sem_type':

Semantischer Typ des Parameters. Das ist wichtig für die Zuordnung der Parameter zu Objektklassen in objektorientierten Sprachen (C++, .NET, COM). Gehören mehrere Parameter semantisch zu einem Typ, so wird dies dabei ebenfalls bezeichnet.

'default_value':

Default-Wert für den Parameter (nur bei Eingabe-Steuerparametern). Hierbei handelt es sich um eine reine Information (der Parameterwert muss in jedem Fall explizit übergeben werden, auch wenn der default-Wert verwendet werden soll). Dieser Eintrag dient nur als Hinweis, als Ausgangspunkt für eigene Experimente. Die Werte sind so gewählt, dass sie normalerweise keine Fehler verursachen und etwas sinnvolles bewirken.

'modified':

'true', falls der Operator den Eingabeparameter modifiziert.

'multi_value':

'true', falls ein Tupel an Werten übergeben werden muss,

'false', falls genau ein Wert übergeben werden muss, und

'optional', wenn beides erlaubt ist.

'multichannel':

'true', falls ein Eingabebildobjekt mehrkanalig sein darf.

'multiinstance':

'true', falls ein Array semantischer Tupel (z.B. Posen, Kameraparameter, etc.) übergeben werden muss,

'false', falls genau ein semantisches Tupel übergeben werden muss, und

'optional', wenn beides erlaubt ist.

'mixed_type':

Nur bei Steuerparametern und auch nur dann, wenn Wertetupel ('multivalue'-'true'/'optional') und verschiedene Datentypen für Parameterwerte ('type_list' mehr als ein Wert) zulässig sind. In diesem Fall gibt SlotSlotSlotSlotslotslot an, ob in einem Tupel auch Werte verschiedener Typen gemischt auftreten dürfen ('true' oder 'false').

'values':

Werteauswahl (optional).

'value_list':

Falls ein Parameter nur eine begrenzte Anzahl von Werten annehmen kann, werden diese explizit aufgeführt (optional).

'valuemin':

Minimalwert eines Werteintervalls.

'valuemax':

Maximalwert eines Werteintervalls.

'valuefunction':

Funktion des Werteverlaufs einer Testreihe (lin, log, quadr, ...).

'steprec':

Empfohlene Schrittweite der Parameterwerte in einer Testreihe.

'stepmin':

Minimale Schrittweite der Parameterwerte in einer Testreihe.

'valuenumber':

Aussage über die Anzahl der Parameter absolut oder relativ zu anderen Parametern

'assertion':

Aussage über die Parameterwerte absolut oder relativ zu anderen Parametern.

'cd_type_list.[compute_device]':

Liste der Eingabebild-Typen, die von der angegebenen Compute-Device-Implementierung des Operators unterstützt werden (z.B. 'cd_type_list.opencl' für OpenCL-Geräte).

'cd_value_list.[compute_device]':

Liste der Eingabe-Steuerparameter, die von der angegebenen Compute-Device-Implementierung des Operators unterstützt werden (z.B. 'cd_value_list.opencl' für OpenCL-Geräte).

Die Online-Texte werden den Dateien operators_[LANG].ref, operators_[LANG].sta, operators_[LANG].key, operators_[LANG].num und operators_[LANG].idx entnommen, die HALCON im aktuellen Verzeichnis und im Verzeichnis 'help_dir' (siehe get_systemget_systemGetSystemGetSystemGetSystemget_system und set_systemset_systemSetSystemSetSystemSetSystemset_system) sucht.

Achtung

Das Encoding der Ergebnisse ist UTF-8.

Ausführungsinformationen

• Multithreading-Typ: reentrant (läuft parallel zu nicht-exklusiven Operatoren).
• Multithreading-Bereich: global (kann von jedem Thread aufgerufen werden).
• Wird ohne Parallelisierung verarbeitet.

Parameter

Ergebnis

get_param_infoget_param_infoGetParamInfoGetParamInfoGetParamInfoget_param_info liefert den Wert TRUE, wenn die Parameter korrekt sind und die Hilfsdateien verfügbar sind. Sonst wird eine Fehlerbehandlung durchgeführt.

Vorgänger

get_keywordsget_keywordsGetKeywordsGetKeywordsGetKeywordsget_keywords, search_operatorsearch_operatorSearchOperatorSearchOperatorSearchOperatorsearch_operator

Alternativen

get_param_namesget_param_namesGetParamNamesGetParamNamesGetParamNamesget_param_names, get_param_numget_param_numGetParamNumGetParamNumGetParamNumget_param_num, get_param_typesget_param_typesGetParamTypesGetParamTypesGetParamTypesget_param_types

Siehe auch

query_param_infoquery_param_infoQueryParamInfoQueryParamInfoQueryParamInfoquery_param_info, get_operator_infoget_operator_infoGetOperatorInfoGetOperatorInfoGetOperatorInfoget_operator_info, get_operator_nameget_operator_nameGetOperatorNameGetOperatorNameGetOperatorNameget_operator_name

Modul

Foundation