get_param_infoget_param_infoGetParamInfoGetParamInfo (Operator)

Name

get_param_infoget_param_infoGetParamInfoGetParamInfo — Informationen zu Operatorparametern.

Signatur

Beschreibung

get_param_infoget_param_infoGetParamInfoGetParamInfoGetParamInfo dient zur Abfrage der Online-Texte zu einem Parameter eines vorgegebenen Operators. Die Art der Information (SlotSlotSlotSlotslot), die für jeden Parameter zur Verfügung steht, lässt sich mittels query_param_infoquery_param_infoQueryParamInfoQueryParamInfoQueryParamInfo abfragen. Derzeit werden folgende Slots angeboten:

'description':

Beschreibung des Parameters.

'description.latex':

Beschreibung des Parameters in LaTeX Notation.

'parameter_class':

Parameterklasse: 'input_object', 'output_object', 'input_control' oder 'output_control'.

'type_list':

Zulässige(r) Datentyp(en) für Parameterwerte Werte: 'real', 'integer' oder 'string' (für Steuerparameter), 'byte', 'direction', 'cyclic', 'int1', 'int2', 'uint2', 'int4', 'int8', 'real', 'complex', 'vector_field' (für Bilder).

'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. Werte: 'real', 'integer', 'string' oder 'none'.

'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. Bisher werden die folgenden Objekte Unterstützt:

object, image, region, xld,

xld_cont, xld_para, xld_poly, xld_ext_para, xld_mod_para,

integer, real, number, string,

channel, grayval, window,

histogram, distribution,

point(.x, .y), extent(.x, .y),

angle(.rad oder .deg),

circle(.center.x, .center.y, .radius),

arc(.center.x, .center.y, .angle.rad, .begin.x, .begin.y),

ellipse(.center.x, .center.y, .angle.rad, .radius1, .radius2),

line(.begin.x, .begin.y, .end.x, .end.y)

rectangle(.origin.x, .origin.y, .corner.x, .corner.y

bzw. .extent.x, .extent.y),

polygon(.x, .y), contour(.x, .y),

coordinates(.x, .y), chord(.x1, .x2, .y),

chain(.begin.x, .begin.y, .code).

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

'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 SlotSlotSlotSlotslot 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.

'steprec':

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_systemGetSystemGetSystemGetSystem und set_systemset_systemSetSystemSetSystemSetSystem) sucht.

Achtung

Das Encoding der Ergebnisse ist ISO 8859-1 für Englisch und Deutsch sowie UTF-8 für Japanisch.

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_infoGetParamInfoGetParamInfoGetParamInfo liefert den Wert 2 (H_MSG_TRUE), wenn die Parameter korrekt sind und die Hilfsdateien verfügbar sind. Sonst wird eine Fehlerbehandlung durchgeführt.

Vorgänger

get_keywordsget_keywordsGetKeywordsGetKeywordsGetKeywords, search_operatorsearch_operatorSearchOperatorSearchOperatorSearchOperator

Alternativen

get_param_namesget_param_namesGetParamNamesGetParamNamesGetParamNames, get_param_numget_param_numGetParamNumGetParamNumGetParamNum, get_param_typesget_param_typesGetParamTypesGetParamTypesGetParamTypes

Siehe auch

query_param_infoquery_param_infoQueryParamInfoQueryParamInfoQueryParamInfo, get_operator_infoget_operator_infoGetOperatorInfoGetOperatorInfoGetOperatorInfo, get_operator_nameget_operator_nameGetOperatorNameGetOperatorNameGetOperatorName

Modul

Foundation