get_image_source_param — Gibt den Wert eines Bildquellenparameters zurück.
get_image_source_param( : : ImageSourceHandle, Param, GenParamName, GenParamValue : Value)
Der Operator get_image_source_param gibt die Parameterwerte oder
-eigenschaften eines Bildquellen-Handles ImageSourceHandle in
Value zurück.
Der Parameter wird in Param festgelegt. Die
Parametergruppe kann mit generischen Parametern bestimmt werden.
Es gibt zwei Arten von Informationen die vom Parameter Param
abgefragt werden können. Mit GenParamName kann unterschieden werden,
ob der Wert oder Metainformationen bezüglich des Parameters
zurückgegeben werden soll.
Folgende Optionen bestehen für GenParamName:
Die Parametergruppe, der der Parameter zugeordnet ist,
wird in GenParamValue festgelegt, indem eine dieser Optionen
gesetzt wird:
'image_source',
'plugin',
'interface',
'local_device',
'device',
'stream'.
Werden keine generischen Parameter gesetzt, werden
GenParamName = 'group' und
GenParamValue = 'device' standardmäßig angenommen.
Die Gruppe 'image_source' ist immer verfügbar, während für die restlichen Parametergruppen eine Verbindung bestehen muss.
Gibt Metainformationen über Param zurück.
Die entsprechende Eigenschaft des Parameters wird in GenParamValue
festgelegt, indem eine dieser Optionen gesetzt wird:
'access': Gibt Zugriffsberechtigungen als String zurück.
Werteliste: 'na' ((momentan) nicht verfügbar), 'ro' (nur Lesezugriff), 'rw' (lesen/schreiben), 'wo' (nur Schreibzugriff).
'description': Gibt eine Parameterbeschreibung als String zurück.
'display_name': Gibt den Anzeigenamen des Parameters als String zurück.
'increment': Gibt die Schrittweite des Parameters als reelle Zahl oder Integer (abhängig vom Parametertyp) zurück.
'max': Gibt den maximalen Wert des Parameters als reelle Zahl oder Integer (abhängig vom Parametertyp) zurück.
'min': Gibt den minimalen Wert des Parameters als reelle Zahl oder Integer (abhängig vom Parametertyp) zurück.
'persistable': Gibt Information über die Persistenz des Parameters als Integer zurück.
Werteliste: 0 (false), 1 (true).
'tooltip': Gibt eine Kurzbeschreibung des Parameters zurück.
'type': Gibt den Parametertyp als String zurück.
Werteliste: 'boolean', 'command', 'enumeration' (String aus einer festen Liste möglicher Werte), 'integer', 'real', 'register', 'string'.
'values': Gibt eine Liste aller möglichen Werte für Parameter des Typs 'type' = 'enumeration', sowie für einige der Typen 'integer' und 'real'.
'visibility': Gibt Informationen über die Sichtbarkeit des Parameters zurück.
Werteliste: 'basic', 'advanced', 'all'.
Es ist von der Bildquelle und ihrem Zustand abhängig, welche Parameter
Param abgefragt werden können. Während manche Parameter spezifisch
für den Software- oder Hardwarehersteller sind und manche davon abhängig
sind ob das Gerät verbunden ist, sind die Parameter der Gruppe
'image_source' immer verfügbar. Die folgende Tabelle gibt einen
Überblick , welche Parameter mit set_image_source_param gesetzt
werden können und welche mit get_image_source_param ausgelesen
werden können. Eine Beschreibung der Parameter findet sich unterhalb der
Tabelle.
GenParamName |
set |
get |
|---|---|---|
| 'device_access_flags' | x |
x |
| 'device_access_status' | x |
|
| 'device_connect_mode' | x |
|
| 'device_id' | x |
x |
| 'device_is_connected' | x |
|
| 'device_query_timeout' | x |
x |
| 'device_user_name' | x |
x |
| 'device_serial_number' | x |
x |
| 'fetch_timeout' | x |
x |
| 'interface_connect_mode' | x |
|
| 'interface_display_name' | x |
|
| 'interface_id' | x |
x |
| 'interface_is_connected' | x |
|
| 'interface_query_timeout' | x |
x |
| 'num_buffers' | x |
x |
| 'plugin_connect_mode' | x |
|
| 'plugin_is_connected' | x |
|
| 'plugin_name' | x |
x |
| 'plugin_path' | x |
x |
| 'stream_connect_mode' | x |
|
| 'stream_id' | x |
x |
| 'stream_is_connected' | x |
|
| 'stream_state' | x |
|
| 'version' | x
|
GenTL-Zugriffs-Flags, die beim Verbindungsversuch mit dem Gerät verwendet werden.
'control': Öffnen des Geräts so, dass andere Hosts/Prozesse nur Lesezugriff auf das Gerät haben. Der Gerätezugriffsmodus ist für diesen Prozess Lese-/Schreibzugriff.
'exclusive': Öffnen des Geräts so, dass nur dieser Host/Prozess Zugriff auf das Gerät hat. Der Gerätezugriffsmodus ist für diesen Prozess Lese-/Schreibzugriff.
'none': Entweder ist das Gerät nicht geöffnet weil es zuvor noch nicht geöffnet wurde, oder der Zugriff verweigert wurde.
'read_only': Öffnen des Geräts nur mit Lesezugriff. Alle Port-Funktionen haben nur Lesezugriff auf das Gerät.
'unknown': Nicht in einem Befehl verwendet. Kann verwendet werden, um eine Variable zu initialisieren, um diese Information abzufragen.
Momentaner GenTL Zugriffsstatus des Geräts.
'busy': Das Gerät wurde bereits von einem anderen Host/Prozess im Modus 'exclusive' geöffnet.
'open_read_only': Das Gerät wurde bereits von diesem Prozess geöffnet. Die Verbindung wir so eingerichtet, dass nur Lesezugriff zulässig ist, eine andere Anwendung ist bereits im Modus 'control' (siehe 'device_access_flags').
'open_read_write': Das Gerät wurde bereits von diesem Prozess im Modus 'exclusive' oder 'control' geöffnet (siehe 'device_access_flags').
'no_access': Auf das Gerät ist kein Zugriff möglich.
'read_only': Nur mit Lesezugriff auf das Gerät möglich.
'read_write': Lese-/Schreibzugriff auf das Gerät möglich. (siehe 'device_access_flags').
'unknown': Gerätezugriff nicht bekannt.
Verbindungsmodus für das Gerätemodul.
'automatic': Kein Identifikator wird angegeben, das benötigte Modul wird automatisch gefunden und verbunden.
'exact': Ein Modulidentifikator wurde für die Verbindung zum Modul angegeben.
'none': Keine Modulverbindung notwendig.
Identifikator für das Gerät als String. Kann
angegeben werden um das Gerätemodul zu spezifizieren, das mit
connect_image_source geöffnet wird.
Verbindungsstatus eines Geräts als Integer.
Werteliste: 0 (nicht verbunden), 1 (verbunden).
Gewünschter Timeout [ms] um ausstehende Geräteabfragen abzubrechen. Wird als Timeout für die Geräteerkennung in GigE Vision Transport-Layern verwendet. Wird -1 festgelegt, wird der Timeout auf unendlich gesetzt.
Default: 1100
Seriennummer des Geräts. Kann verwendet werden um ein Gerät zu spezifizieren ohne direkt die 'device_id' angeben zu müssen.
Nutzername des Gerätes als String. Kann verwendet werden um ein Gerät zu spezifizieren ohne direkt die 'device_id' angeben zu müssen.
Gewünschter Timeout [ms] um einen ausstehenden Bildeinzug abzubrechen. Wird -1 festgelegt, wird der Timeout auf unendlich gesetzt.
Default: 5000
Verbindungsmodus für das Interface-Modul.
'automatic': Kein Identifikator wird angegeben, das benötigte Modul wird automatisch gefunden und verbunden.
'exact': Ein Modulidentifikator wurde für die Verbindung zum Modul angegeben.
'none': Keine Modulverbindung notwendig.
Gibt eine menschenlesbaren sekundären Identifikator für das Interface als String zurück.
Identifikator für das Interface als String.
Kann angegeben werden um das Interface-Modul zu spezifizieren, das mit
connect_image_source geöffnet wird.
Verbindungsstatus eines Interfaces als Integer.
Werteliste: 0 (nicht verbunden), 1 (verbunden).
Gewünschter Timeout [ms] um ausstehende Interface-Abfragen abzubrechen. Wird -1 festgelegt, wird der Timeout auf unendlich gesetzt.
Default: 1100
Anzahl Buffer, die von
start_image_source für den Bildeinzug angelegt wird.
Eine höhere Anzahl Buffer kann bei kurzzeitigen Belastungsspitzen
des Host-Systems den Verlust von Bildern verhindern.
Default: 4
Verbindungsmodus für das Plugin-Modul.
'automatic': Kein Identifikator wird angegeben, das benötigte Modul wird automatisch gefunden und verbunden.
'exact': Ein Modulidentifikator wurde für die Verbindung zum Modul angegeben.
'none': Keine Modulverbindung notwendig.
Verbindungsstatus eines Plugins als Integer.
Werteliste: 0 (nicht verbunden), 1 (verbunden).
Name des Plugins als String.
Pfad zur .cti Plugin-Datei.
Kann verwendet werden um die Plugin-Datei zu spezifizieren, auch wenn die
GenTL-Umgebungsvariablen zur Plugin-Detektion den Pfad der gewünschten
Plugin-Datei nicht enthalten.
Verbindungsmodus für das Stream-Modul.
'automatic': Kein Identifikator wird angegeben, das benötigte Modul wird automatisch gefunden und verbunden.
'exact': Ein Modulidentifikator wurde für die Verbindung zum Modul angegeben.
'none': Keine Modulverbindung notwendig.
Identifikator für den Stream als String.
Kann angegeben werden um das Stream-Modul zu spezifizieren, das mit
connect_image_source geöffnet wird.
Verbindungsstatus eines Streams als Integer.
Werteliste: 0 (nicht verbunden), 1 (verbunden).
Aktueller Zustand des Streams.
'initialized': Stream ist initialisiert, aber läuft nicht.
'running': Stream läuft. Das heißt, dass Ressourcen wie Threads und Buffer angelegt sind um Bilder empfangen zu können. In Abhängigkeit der Gerätekonfiguration werden Bilder in diesem Zustand dauerhaft im Hintergrund übertragen.
Versionsnummer der Bildquellen-Bibliothek.
Für Plugins, die von MVTec zur Verfügung gestellt werden, beschreibt die MVTec Interfaces Reference Documentation alle Plugin-spezifischen Parameter.
Für die Beschreibung weiterer Parameter wird auf die Dokumentation der entsprechenden Software- oder Hardwarehersteller verwiesen.
ImageSourceHandle (input_control) image_source → (handle)
Bildquellen-Handle.
Param (input_control) string → (string)
Abgefragter Parameter.
GenParamName (input_control) attribute.name-array → (string)
Generischer Parametername.
Default: []
Wertevorschläge: 'group', 'property'
GenParamValue (input_control) attribute.value-array → (integer / real / string)
Generischer Parameterwert.
Default: []
Wertevorschläge: 'image_source', 'plugin', 'interface', 'local_device', 'device', 'stream', 'tooltip', 'description', 'display_name', 'visibility', 'access', 'type', 'persistable', 'min', 'max', 'increment', 'values'
Value (output_control) string-array → (string / real / integer / handle)
Abgefragter Wert.
* Get current selected pixel format (notice per default 'group'='device'). get_image_source_param (ImageSourceHandle, 'PixelFormat', [], [], PixelFormat) * Get list of supported pixel formats by the device. get_image_source_param (ImageSourceHandle, 'PixelFormat', 'property', 'values', AvailablePixelFormats) * Get the version information of the plugin. get_image_source_param (ImageSourceHandle, 'TLVersion', 'group', 'plugin', Version)
Sind die Parameterwerte korrekt, gibt get_image_source_param
den Wert 2 (
H_MSG_TRUE)
zurück.
Andernfalls wird eine Fehlerbehandlung durchgeführt.
query_image_sources,
create_image_source,
connect_image_source
set_image_source_param,
disconnect_image_source
Foundation