Dies ist die Beschreibung der MATLAB/Octave API Bindings für das Thermal Imaging Bricklet. Allgemeine Informationen über die Funktionen und technischen Spezifikationen des Thermal Imaging Bricklet sind in dessen Hardware Beschreibung zusammengefasst.
Eine Installationanleitung für die MATLAB/Octave API Bindings ist Teil deren allgemeine Beschreibung.
Der folgende Beispielcode ist Public Domain (CC0 1.0).
Download (matlab_example_callback.m)
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 | function matlab_example_callback()
import com.tinkerforge.IPConnection;
import com.tinkerforge.BrickletThermalImaging;
HOST = 'localhost';
PORT = 4223;
UID = 'XYZ'; % Change XYZ to the UID of your Thermal Imaging Bricklet
ipcon = IPConnection(); % Create IP connection
ti = handle(BrickletThermalImaging(UID, ipcon), 'CallbackProperties'); % Create device object
ipcon.connect(HOST, PORT); % Connect to brickd
% Don't use device before ipcon is connected
% Register high contrast image callback to function cb_high_contrast_image
set(ti, 'HighContrastImageCallback', @(h, e) cb_high_contrast_image(e));
% Enable high contrast image transfer for callback
ti.setImageTransferConfig(BrickletThermalImaging.IMAGE_TRANSFER_CALLBACK_HIGH_CONTRAST_IMAGE);
input('Press key to exit\n', 's');
ipcon.disconnect();
end
% Callback function for high contrast image callback
function cb_high_contrast_image(e)
% e.image is an array of size 80*60 with a 8 bit grey value for each element
end
|
Download (matlab_example_create_image.m)
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 | function matlab_example_create_image()
import java.io.File;
import javax.imageio.ImageIO;
import com.tinkerforge.IPConnection;
import java.awt.image.BufferedImage;
import com.tinkerforge.BrickletThermalImaging;
% Takes one thermal image and saves it as PNG
HOST = 'localhost';
PORT = 4223;
UID = 'XYZ'; % Change XYZ to the UID of your Thermal Imaging Bricklet
WIDTH = 80;
HEIGHT = 60;
SCALE = 10;
% Creates standard thermal image color palette (blue=cold, red=hot)
paletteR = zeros(1, 255, 'int32');
paletteG = zeros(1, 255, 'int32');
paletteB = zeros(1, 255, 'int32');
function createThermalImageColorPalette()
% The palette is gnuplot's PM3D palette.
% See here for details: https://stackoverflow.com/questions/28495390/thermal-imaging-palette
for x = 1:1:255
paletteR(x) = int32(fix(255 * sqrt(x / 255)));
paletteG(x) = int32(fix(255 * (x / 255)^3));
paletteB(x) = 0;
paletteBSine = sin(2 * pi * (x / 255));
if paletteBSine >= 0
paletteB(x) = int32(fix(255 * sin(2 * pi * (x / 255))));
end
end
end
% Helper function for simple buffer resize
function resizedBufferedImage = resize(sourceBufferedImage, newW, newH)
import java.awt.Image;
import java.awt.image.BufferedImage;
scaledSourceBufferedImage = sourceBufferedImage.getScaledInstance(newW, ...
newH, ...
Image.SCALE_SMOOTH);
resizedBufferedImage = BufferedImage(newW, newH, BufferedImage.TYPE_INT_ARGB);
g2d = resizedBufferedImage.createGraphics();
g2d.drawImage(scaledSourceBufferedImage, 0, 0, []);
g2d.dispose();
end
ipcon = IPConnection(); % Create IP connection
ti = handle(BrickletThermalImaging(UID, ipcon), 'CallbackProperties'); % Create device object
ipcon.connect(HOST, PORT); % Connect to brickd
% Do not use device before ipcon is connected
% Enable high contrast image transfer for getter
ti.setImageTransferConfig(BrickletThermalImaging.IMAGE_TRANSFER_MANUAL_HIGH_CONTRAST_IMAGE);
createThermalImageColorPalette();
% If we change between transfer modes we have to wait until one more
% image is taken after the mode is set and the first image is saved
% we can call get_high_contrast_image any time.
pause on;
pause(0.5);
image = typecast(ti.getHighContrastImage(), 'int32');
% Use palette mapping to create thermal image coloring
for i = 1:1:4800
% Because in MATLAB/Octave indexing starts from 1
if image(i) < 255
image(i) = image(i) + 1;
end
alphaLSH = uint32(bitshift(255, 24));
redLSH = uint32(bitshift(paletteR(image(i)), 16));
greenLSH = uint32(bitshift(paletteG(image(i)), 8));
blueLSH = uint32(bitshift(paletteB(image(i)), 0));
image(i) = typecast(bitor(bitor(alphaLSH, redLSH), bitor(greenLSH, blueLSH)), ...
'int32');
end
% Create BufferedImage with data
bufferedImage = BufferedImage(WIDTH, HEIGHT, BufferedImage.TYPE_INT_ARGB);
bufferedImage.setRGB(0, 0, WIDTH, HEIGHT, image, 0, WIDTH);
% Scale to 800x600 and save thermal image!
ImageIO.write(resize(bufferedImage, WIDTH*SCALE, HEIGHT*SCALE), 'png', File('thermal_image.png'));
input('Press key to exit\n', 's');
ipcon.disconnect();
end
|
Download (matlab_example_live_video.m)
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 | function matlab_example_live_video()
import java.awt.*;
import javax.swing.*;
import java.awt.Image;
import javax.swing.BoxLayout;
import javax.swing.ImageIcon;
import java.awt.event.WindowEvent;
import com.tinkerforge.IPConnection;
import java.awt.image.BufferedImage;
import com.tinkerforge.BrickletThermalImaging;
% Shows live thermal image video in in swing label
HOST = 'localhost';
PORT = 4223;
UID = 'XYZ'; % Change XYZ to the UID of your Thermal Imaging Bricklet
WIDTH = 80;
HEIGHT = 60;
SCALE = 5;
% Creates standard thermal image color palette (blue=cold, red=hot)
paletteR = zeros(1, 255, 'int32');
paletteG = zeros(1, 255, 'int32');
paletteB = zeros(1, 255, 'int32');
function createThermalImageColorPalette()
% The palette is gnuplot's PM3D palette.
% See here for details: https://stackoverflow.com/questions/28495390/thermal-imaging-palette
for x = 1:1:255
paletteR(x) = int32(fix(255 * sqrt(x / 255)));
paletteG(x) = int32(fix(255 * (x / 255)^3));
paletteB(x) = 0;
paletteBSine = sin(2 * pi * (x / 255));
if paletteBSine >= 0
paletteB(x) = int32(fix(255 * sin(2 * pi * (x / 255))));
end
end
end
% Function to handle example exit
function end_example()
ipcon.disconnect();
frameExample.hide();
end
ipcon = IPConnection(); % Create IP connection
ti = handle(BrickletThermalImaging(UID, ipcon), 'CallbackProperties'); % Create device object
ipcon.connect(HOST, PORT); % Connect to brickd
% Do not use device before ipcon is connected
% Enable high contrast image transfer for callback
ti.setImageTransferConfig(BrickletThermalImaging.IMAGE_TRANSFER_CALLBACK_HIGH_CONTRAST_IMAGE);
createThermalImageColorPalette();
% If we change between transfer modes we have to wait until one more
% image is taken after the mode is set and the first image is saved
% we can call get_high_contrast_image any time.
pause on;
pause(0.5);
% Prepare the JPanel and the JFrame
panelExample = JPanel();
frameExample = JFrame('Example Live Video');
set(frameExample, 'WindowClosingCallback', @(h, e) end_example());
frameExample.setSize(WIDTH*SCALE, HEIGHT*SCALE);
panelExample.setLayout(BoxLayout(panelExample, BoxLayout.Y_AXIS));
% Prepare JLabel
bufferedImage = BufferedImage(80, 60, BufferedImage.TYPE_INT_ARGB);
newW = WIDTH*SCALE;
newH = HEIGHT*SCALE;
scaledSourceBufferedImage = bufferedImage.getScaledInstance(newW, ...
newH, ...
Image.SCALE_SMOOTH);
resizedBufferedImage = BufferedImage(newW, newH, BufferedImage.TYPE_INT_ARGB);
g2d = resizedBufferedImage.createGraphics();
g2d.drawImage(scaledSourceBufferedImage, 0, 0, []);
g2d.dispose();
labelExample = JLabel(ImageIcon(resizedBufferedImage));
labelExample.setAlignmentX(Component.CENTER_ALIGNMENT);
% Populate the layout
panelExample.add(labelExample);
frameExample.getContentPane().add(panelExample);
frameExample.pack();
frameExample.show();
% Register high contrast image callback to function cb_high_contrast_image
set(ti, 'HighContrastImageCallback', @(h, e) cb_high_contrast_image(e, ...
paletteR, ...
paletteG, ...
paletteB, ...
WIDTH, ...
HEIGHT, ...
SCALE, ...
labelExample));
end
% Callback function for high contrast image callback
function cb_high_contrast_image(e, ...
paletteR, ...
paletteG, ...
paletteB, ...
WIDTH, ...
HEIGHT, ...
SCALE, ...
labelExample)
import java.awt.Image;
import javax.swing.JLabel;
import javax.swing.ImageIcon;
import java.awt.image.BufferedImage;
image = typecast(e.image, 'int32');
% Use palette mapping to create thermal image coloring
for i = 1:1:4800
% Because in MATLAB/Octave indexing starts from 1
if image(i) < 255
image(i) = image(i) + 1;
end
alphaLSH = uint32(bitshift(255, 24));
redLSH = uint32(bitshift(paletteR(image(i)), 16));
greenLSH = uint32(bitshift(paletteG(image(i)), 8));
blueLSH = uint32(bitshift(paletteB(image(i)), 0));
image(i) = typecast(bitor(bitor(alphaLSH, redLSH), bitor(greenLSH, blueLSH)), ...
'int32');
end
% Create BufferedImage with data
bufferedImage = BufferedImage(WIDTH, HEIGHT, BufferedImage.TYPE_INT_ARGB);
bufferedImage.setRGB(0, 0, WIDTH, HEIGHT, image, 0, WIDTH);
% Simple buffer resize
newW = WIDTH*SCALE;
newH = HEIGHT*SCALE;
scaledSourceBufferedImage = bufferedImage.getScaledInstance(newW, ...
newH, ...
Image.SCALE_SMOOTH);
resizedBufferedImage = BufferedImage(newW, newH, BufferedImage.TYPE_INT_ARGB);
g2d = resizedBufferedImage.createGraphics();
g2d.drawImage(scaledSourceBufferedImage, 0, 0, []);
g2d.dispose();
% Set resized buffered image as icon of label. Change SCALE to change the
% size of the video
labelExample.setIcon(ImageIcon(resizedBufferedImage));
end
|
Download (octave_example_callback.m)
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 | function octave_example_callback()
more off;
HOST = "localhost";
PORT = 4223;
UID = "XYZ"; % Change XYZ to the UID of your Thermal Imaging Bricklet
ipcon = javaObject("com.tinkerforge.IPConnection"); % Create IP connection
ti = javaObject("com.tinkerforge.BrickletThermalImaging", UID, ipcon); % Create device object
ipcon.connect(HOST, PORT); % Connect to brickd
% Don't use device before ipcon is connected
% Register high contrast image callback to function cb_high_contrast_image
ti.addHighContrastImageCallback(@cb_high_contrast_image);
% Enable high contrast image transfer for callback
ti.setImageTransferConfig(ti.IMAGE_TRANSFER_CALLBACK_HIGH_CONTRAST_IMAGE);
input("Press key to exit\n", "s");
ipcon.disconnect();
end
% Callback function for high contrast image callback
function cb_high_contrast_image(e)
% e.image is an array of size 80*60 with a 8 bit grey value for each element
end
|
Download (octave_example_create_image.m)
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 | function octave_example_create_image()
more off;
% Takes one thermal image and saves it as PNG
HOST = "localhost";
PORT = 4223;
UID = "XYZ"; % Change XYZ to the UID of your Thermal Imaging Bricklet
WIDTH = 80;
HEIGHT = 60;
SCALE = 10;
ipcon = javaObject("com.tinkerforge.IPConnection"); % Create IP connection
ti = javaObject("com.tinkerforge.BrickletThermalImaging", UID, ipcon); % Create device object
% Creates standard thermal image color palette (blue=cold, red=hot)
paletteR = zeros(1, 255, "int32");
paletteG = zeros(1, 255, "int32");
paletteB = zeros(1, 255, "int32");
function createThermalImageColorPalette()
% The palette is gnuplot's PM3D palette.
% See here for details: https://stackoverflow.com/questions/28495390/thermal-imaging-palette
for x = 1:1:255
paletteR(x) = int32(fix(255 * sqrt(x / 255)));
paletteG(x) = int32(fix(255 * (x / 255)^3));
paletteB(x) = 0;
paletteBSine = sin(2 * pi * (x / 255));
if paletteBSine >= 0
paletteB(x) = int32(fix(255 * sin(2 * pi * (x / 255))));
end
end
end
% Helper function for simple buffer resize
function resizedBufferedImage = resize(sourceBufferedImage, newW, newH)
scaledSourceBufferedImage = sourceBufferedImage.getScaledInstance(newW, ...
newH, ...
java_get("java.awt.Image", "SCALE_SMOOTH"));
resizedBufferedImage = javaObject("java.awt.image.BufferedImage", ...
newW, ...
newH, ...
java_get("java.awt.image.BufferedImage", "TYPE_INT_ARGB"));
g2d = resizedBufferedImage.createGraphics();
g2d.drawImage(scaledSourceBufferedImage, 0, 0, []);
g2d.dispose();
end
ipcon.connect(HOST, PORT); % Connect to brickd
% Do not use device before ipcon is connected
% Enable high contrast image transfer for getter
ti.setImageTransferConfig(java_get("com.tinkerforge.BrickletThermalImaging", ...
"IMAGE_TRANSFER_MANUAL_HIGH_CONTRAST_IMAGE"));
createThermalImageColorPalette();
% If we change between transfer modes we have to wait until one more
% image is taken after the mode is set and the first image is saved
% we can call get_high_contrast_image any time.
pause(0.5);
image = typecast(ti.getHighContrastImage(), "int32");
% Use palette mapping to create thermal image coloring
for i = 1:1:4800
% Because in MATLAB/Octave indexing starts from 1
if image(i) < 255
image(i) = image(i) + 1;
end
alphaLSH = uint32(bitshift(255, 24));
redLSH = uint32(bitshift(paletteR(image(i)), 16));
greenLSH = uint32(bitshift(paletteG(image(i)), 8));
blueLSH = uint32(bitshift(paletteB(image(i)), 0));
image(i) = typecast(bitor(bitor(alphaLSH, redLSH), bitor(greenLSH, blueLSH)), ...
"int32");
end
% Create BufferedImage with data
bufferedImage = javaObject("java.awt.image.BufferedImage", ...
WIDTH, ...
HEIGHT, ...
java_get("java.awt.image.BufferedImage", "TYPE_INT_ARGB"));
bufferedImage.setRGB(0, 0, WIDTH, HEIGHT, image, 0, WIDTH);
% Scale to 800x600 and save thermal image!
javaMethod("write", ...
"javax.imageio.ImageIO", ...
resize(bufferedImage, WIDTH*SCALE, HEIGHT*SCALE), ...
"png", ...
javaObject("java.io.File", "thermal_image.png"));
input("Press key to exit\n", "s");
ipcon.disconnect();
end
|
Prinzipiell kann jede Methode der MATLAB Bindings eine TimeoutException
werfen. Diese Exception wird
geworfen wenn das Gerät nicht antwortet. Wenn eine Kabelverbindung genutzt
wird, ist es unwahrscheinlich, dass die Exception geworfen wird (unter der
Annahme, dass das Gerät nicht abgesteckt wird). Bei einer drahtlosen Verbindung
können Zeitüberschreitungen auftreten, sobald die Entfernung zum Gerät zu
groß wird.
Neben der TimeoutException
kann auch noch eine NotConnectedException
geworfen werden, wenn versucht wird mit einem Brick oder Bricklet zu
kommunizieren, aber die IP Connection nicht verbunden ist.
Da die MATLAB Bindings auf Java basieren und Java nicht mehrere Rückgabewerte unterstützt und eine Referenzrückgabe für elementare Type nicht möglich ist, werden kleine Klassen verwendet, die nur aus Member-Variablen bestehen. Die Member-Variablen des zurückgegebenen Objektes werden in der jeweiligen Methodenbeschreibung erläutert.
Das Package für alle Brick/Bricklet Bindings und die IP Connection ist
com.tinkerforge.*
Alle folgend aufgelisteten Methoden sind Thread-sicher.
BrickletThermalImaging
(String uid, IPConnection ipcon)¶Parameter: |
|
---|---|
Rückgabe: |
|
Erzeugt ein Objekt mit der eindeutigen Geräte ID uid
.
In MATLAB:
import com.tinkerforge.BrickletThermalImaging;
thermalImaging = BrickletThermalImaging("YOUR_DEVICE_UID", ipcon);
In Octave:
thermalImaging = java_new("com.tinkerforge.BrickletThermalImaging", "YOUR_DEVICE_UID", ipcon);
Dieses Objekt kann benutzt werden, nachdem die IP Connection verbunden ist.
BrickletThermalImaging.
getHighContrastImage
()¶Rückgabe: |
|
---|
Gibt das aktuelle High Contrast Image zurück. Siehe hier für eine Beschreibung des Unterschieds zwischen High Contrast Image und einem Temperature Image. Wenn unbekannt ist welche Darstellungsform genutzt werden soll, ist vermutlich das High Contrast Image die richtige form.
Die Daten der 80x60 Pixel-Matrix werden als ein eindimensionales Array bestehend aus 8-Bit Werten dargestellt. Die Daten sind Zeile für Zeile von oben links bis unten rechts angeordnet.
Jeder 8-Bit Wert stellt ein Pixel aus dem Grauwertbild dar und kann als solcher direkt dargestellt werden.
Bevor die Funktion genutzt werden kann muss diese mittels
setImageTransferConfig()
aktiviert werden.
BrickletThermalImaging.
getTemperatureImage
()¶Rückgabe: |
|
---|
Gibt das aktuelle Temperature Image zurück. See hier für eine Beschreibung des Unterschieds zwischen High Contrast und Temperature Image. Wenn unbekannt ist welche Darstellungsform genutzt werden soll, ist vermutlich das High Contrast Image die richtige Form.
Die Daten der 80x60 Pixel-Matrix werden als ein eindimensionales Array bestehend aus 16-Bit Werten dargestellt. Die Daten sind Zeile für Zeile von oben links bis unten rechts angeordnet.
Jeder 16-Bit Wert stellt eine Temperaturmessung in entweder Kelvin/10 oder
Kelvin/100 dar (abhängig von der Auflösung die mittels setResolution()
eingestellt wurde).
Bevor die Funktion genutzt werden kann muss diese mittels
setImageTransferConfig()
aktiviert werden.
BrickletThermalImaging.
getStatistics
()¶Rückgabeobjekt: |
|
---|
Gibt die Spotmeter Statistiken, verschiedene Temperaturen, die aktuelle Auflösung und Status-Bits zurück.
Die Spotmeter Statistiken bestehen aus:
Die Temperaturen sind:
Die Auflösung ist entweder 0 bis 6553 Kelvin oder 0 bis 655 Kelvin. Ist die Auflösung ersteres, so ist die Auflösung Kelvin/10. Ansonsten ist sie Kelvin/100.
FFC (Flat Field Correction) Status:
Temperaturwarnungs-Status:
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für resolution:
Für ffcStatus:
BrickletThermalImaging.
setResolution
(int resolution)¶Parameter: |
|
---|
Setzt die Auflösung. Das Thermal Imaging Bricklet kann entweder
Die Genauigkeit ist spezifiziert von -10°C bis 450°C im ersten Auflösungsbereich und von -10°C bis 140°C im zweiten Bereich.
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für resolution:
BrickletThermalImaging.
getResolution
()¶Rückgabe: |
|
---|
Gibt die Auflösung zurück, wie von setResolution()
gesetzt.
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für resolution:
BrickletThermalImaging.
setSpotmeterConfig
(int[] regionOfInterest)¶Parameter: |
|
---|
Setzt die Spotmeter Region (Spotmeter Region of Interest). Die 4 Werte sind
Die Spotmeter Statistiken können mittels getStatistics()
ausgelesen werden.
BrickletThermalImaging.
getSpotmeterConfig
()¶Rückgabeobjekt: |
|
---|
Gibt die Spotmeter Konfiguration zurück, wie von setSpotmeterConfig()
gesetzt.
BrickletThermalImaging.
setHighContrastConfig
(int[] regionOfInterest, int dampeningFactor, int[] clipLimit, int emptyCounts)¶Parameter: |
|
---|
Setzt die Region of Interest für das High Contrast Image, den Dampening Faktor, das
Clip Limit und die Empty Counts. Diese Konfiguration wird nur im High Contrast Modus
genutzt (siehe setImageTransferConfig()
).
Die High Contrast Region of Interest besteht aus vier Werten:
Der Algorithmus zum Erzeugen eines High Contrast Images wird auf diese Region angewandt.
Dampening Factor: Dieser Parameter stellt die Stärke der zeitlichen Dämpfung dar, die auf der HEQ (History Equalization) Transformationsfunktion angewendet wird. Ein IIR-Filter der Form:
(N / 256) * transformation_zuvor + ((256 - N) / 256) * transformation_aktuell
wird dort angewendet. Der HEQ Dämpfungsfaktor stellt dabei den Wert N in der Gleichung dar. Der Faktor stellt also ein, wie stark der Einfluss der vorherigen HEQ Transformation auf die aktuelle ist. Umso niedriger der Wert von N um so größer ist der Einfluss des aktuellen Bildes. Umso größer der Wert von N umso kleiner ist der Einfluss der vorherigen Dämpfungs-Transferfunktion.
Clip Limit Index 0 (AGC HEQ Clip Limit High): Dieser Parameter definiert die maximale Anzahl an Pixeln, die sich in jeder Histogrammklasse sammeln dürfen. Jedes weitere Pixel wird verworfen. Der Effekt dieses Parameters ist den Einfluss von stark gefüllten Klassen in der HEQ Transformation zu beschränken.
Clip Limit Index 1 (AGC HEQ Clip Limit Low): Dieser Parameter definiert einen künstliche Menge, die jeder nicht leeren Histogrammklasse hinzugefügt wird. Wenn Clip Limit Low mit L dargestellt wird, so erhält jede Klasse mit der aktuellen Menge X die effektive Menge L + X. Jede Klasse, die nahe einer gefüllten Klasse ist erhält die Menge L. Der Effekt von höheren Werten ist eine stärkere lineare Transferfunktion bereitzustellen. Niedrigere Werte führen zu einer nichtlinearen Transferfunktion.
Empty Counts: Dieser Parameter spezifiziert die maximale Anzahl von Pixeln in einer Klasse, damit die Klasse als leere Klasse interpretiert wird. Jede Histogrammklasse mit dieser Anzahl an Pixeln oder weniger wird als leere Klasse behandelt.
BrickletThermalImaging.
getHighContrastConfig
()¶Rückgabeobjekt: |
|
---|
Gibt die High Contrast Konfiguration zurück, wie von
setHighContrastConfig()
gesetzt.
BrickletThermalImaging.
setFluxLinearParameters
(int sceneEmissivity, int temperatureBackground, int tauWindow, int temperaturWindow, int tauAtmosphere, int temperatureAtmosphere, int reflectionWindow, int temperatureReflection)¶Parameter: |
|
---|
Setzt die Flux-Linear-Parmaeter die für eine Radiometrie-Kalibrierung benötigt werden.
Siehe FLIR-Dokument 102-PS245-100-01 für mehr Informationen.
Neu in Version 2.0.5 (Plugin).
BrickletThermalImaging.
getFluxLinearParameters
()¶Rückgabeobjekt: |
|
---|
Gibt die Flux-Linear-Parameter zurück, wie von setFluxLinearParameters()
gesetzt.
Neu in Version 2.0.5 (Plugin).
BrickletThermalImaging.
setFFCShutterMode
(int shutterMode, int tempLockoutState, boolean videoFreezeDuringFFC, boolean ffcDesired, long elapsedTimeSinceLastFFC, long desiredFFCPeriod, boolean explicitCmdToOpen, int desiredFFCTempDelta, int imminentDelay)¶Parameter: |
|
---|
Setzt die FFC-Shutter-Mode Parameter.
Siehe FLIR-Dokument 110-0144-03 4.5.15 für mehr Informationen.
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für shutterMode:
Für tempLockoutState:
Neu in Version 2.0.6 (Plugin).
BrickletThermalImaging.
getFFCShutterMode
()¶Rückgabeobjekt: |
|
---|
Setzt die FFC-Shutter-Mode Parameter.
Siehe FLIR-Dokument 110-0144-03 4.5.15 für mehr Informationen.
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für shutterMode:
Für tempLockoutState:
Neu in Version 2.0.6 (Plugin).
BrickletThermalImaging.
runFFCNormalization
()¶Startet die Flat-Field Correction (FFC) Normalisierung.
Siehe FLIR-Dokument 110-0144-03 4.5.16 für mehr Informationen.
Neu in Version 2.0.6 (Plugin).
BrickletThermalImaging.
getSPITFPErrorCount
()¶Rückgabeobjekt: |
|
---|
Gibt die Anzahl der Fehler die während der Kommunikation zwischen Brick und Bricklet aufgetreten sind zurück.
Die Fehler sind aufgeteilt in
Die Fehlerzähler sind für Fehler die auf der Seite des Bricklets auftreten. Jedes Brick hat eine ähnliche Funktion welche die Fehler auf Brickseite ausgibt.
BrickletThermalImaging.
setStatusLEDConfig
(int config)¶Parameter: |
|
---|
Setzt die Konfiguration der Status-LED. Standardmäßig zeigt die LED die Kommunikationsdatenmenge an. Sie blinkt einmal auf pro 10 empfangenen Datenpaketen zwischen Brick und Bricklet.
Die LED kann auch permanent an/aus gestellt werden oder einen Herzschlag anzeigen.
Wenn das Bricklet sich im Bootlodermodus befindet ist die LED aus.
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für config:
BrickletThermalImaging.
getStatusLEDConfig
()¶Rückgabe: |
|
---|
Gibt die Konfiguration zurück, wie von setStatusLEDConfig()
gesetzt.
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für config:
BrickletThermalImaging.
getChipTemperature
()¶Rückgabe: |
|
---|
Gibt die Temperatur, gemessen im Mikrocontroller, aus. Der Rückgabewert ist nicht die Umgebungstemperatur.
Die Temperatur ist lediglich proportional zur echten Temperatur und hat eine hohe Ungenauigkeit. Daher beschränkt sich der praktische Nutzen auf die Indikation von Temperaturveränderungen.
BrickletThermalImaging.
reset
()¶Ein Aufruf dieser Funktion setzt das Bricklet zurück. Nach einem Neustart sind alle Konfiguration verloren.
Nach dem Zurücksetzen ist es notwendig neue Objekte zu erzeugen, Funktionsaufrufe auf bestehenden führen zu undefiniertem Verhalten.
BrickletThermalImaging.
getIdentity
()¶Rückgabeobjekt: |
|
---|
Gibt die UID, die UID zu der das Bricklet verbunden ist, die Position, die Hard- und Firmware Version sowie den Device Identifier zurück.
Die Position ist 'a', 'b', 'c', 'd', 'e', 'f', 'g' oder 'h' (Bricklet Anschluss). Ein Bricklet hinter einem Isolator Bricklet ist immer an Position 'z'.
Eine Liste der Device Identifier Werte ist hier zu finden. Es gibt auch eine Konstante für den Device Identifier dieses Bricklets.
BrickletThermalImaging.
setImageTransferConfig
(int config)¶Parameter: |
|
---|
Die notwendige Bandbreite für dieses Bricklet ist zu groß um Getter/Callbacks oder High Contrast/Temperature Images gleichzeitig zu nutzen. Daher muss konfiguriert werden was genutzt werden soll. Das Bricklet optimiert seine interne Konfiguration anschließend dahingehend.
Zugehörige Funktionen:
getHighContrastImage()
.getTemperatureImage()
.HighContrastImageCallback
callback.TemperatureImageCallback
callback.Die folgenden Konstanten sind für diese Funktion verfügbar:
Für config:
BrickletThermalImaging.
getImageTransferConfig
()¶Rückgabe: |
|
---|
Gibt die Image Transfer Konfiguration zurück, wie von setImageTransferConfig()
gesetzt.
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für config:
Callbacks können registriert werden um zeitkritische oder wiederkehrende Daten vom Gerät zu erhalten. Die Registrierung wird mit MATLABs "set" Funktion durchgeführt. Die Parameter sind ein Gerätobjekt, der Callback-Name und die Callback-Funktion. Hier ein Beispiel in MATLAB:
function my_callback(e)
fprintf('Parameter: %s\n', e.param);
end
set(device, 'ExampleCallback', @(h, e) my_callback(e));
Die Octave Java Unterstützung unterscheidet sich hier von MATLAB, die "set" Funktion kann hier nicht verwendet werden. Die Registrierung wird in Octave mit "add*Callback" Funktionen des Gerätobjekts durchgeführt. Hier ein Beispiel in Octave:
function my_callback(e)
fprintf("Parameter: %s\n", e.param);
end
device.addExampleCallback(@my_callback);
Es ist möglich mehrere Callback-Funktion hinzuzufügen und auch mit einem korrespondierenden "remove*Callback" wieder zu entfernen.
Die Parameter des Callbacks werden der Callback-Funktion als Felder der
Struktur e
übergeben. Diese ist von der java.util.EventObject
Klasse
abgeleitete. Die verfügbaren Callback-Namen mit den entsprechenden
Strukturfeldern werden unterhalb beschrieben.
Bemerkung
Callbacks für wiederkehrende Ereignisse zu verwenden ist immer zu bevorzugen gegenüber der Verwendung von Abfragen. Es wird weniger USB-Bandbreite benutzt und die Latenz ist erheblich geringer, da es keine Paketumlaufzeit gibt.
BrickletThermalImaging.
HighContrastImageCallback
¶Event-Objekt: |
|
---|
Dieser Callback wird für jedes neue High Contrast Image ausgelöst, wenn die
Transfer Image Config für diesen Callback konfiguriert wurde (siehe
setImageTransferConfig()
).
Die Daten der 80x60 Pixel-Matrix werden als ein eindimensionales Array bestehend aus 8-Bit Werten dargestellt. Die Daten sind Zeile für Zeile von oben links bis unten rechts angeordnet.
Jeder 8-Bit Wert stellt ein Pixel aus dem Grauwertbild dar und kann als solcher direkt dargestellt werden.
Bemerkung
Falls das Rekonstruieren des Wertes fehlschlägt, wird der Callback mit null für image ausgelöst.
In MATLAB kann die set()
Function verwendet werden um diesem Callback eine
Callback-Function zuzuweisen.
In Octave kann diesem Callback mit addHighContrastImageCallback()
eine Callback-Function
hinzugefügt werden. Eine hinzugefügter Callback-Function kann mit
removeHighContrastImageCallback()
wieder entfernt werden.
BrickletThermalImaging.
TemperatureImageCallback
¶Event-Objekt: |
|
---|
Dieser Callback wird für jedes neue Temperature Image ausgelöst, wenn die Transfer
Image Config für diesen Callback konfiguriert wurde (siehe
setImageTransferConfig()
).
Die Daten der 80x60 Pixel-Matrix werden als ein eindimensionales Array bestehend aus 16-Bit Werten dargestellt. Die Daten sind Zeile für Zeile von oben links bis unten rechts angeordnet.
Jeder 16-Bit Wert stellt ein Pixel aus dem Temperatur Bild dar und kann als solcher direkt dargestellt werden.
Bemerkung
Falls das Rekonstruieren des Wertes fehlschlägt, wird der Callback mit null für image ausgelöst.
In MATLAB kann die set()
Function verwendet werden um diesem Callback eine
Callback-Function zuzuweisen.
In Octave kann diesem Callback mit addTemperatureImageCallback()
eine Callback-Function
hinzugefügt werden. Eine hinzugefügter Callback-Function kann mit
removeTemperatureImageCallback()
wieder entfernt werden.
Virtuelle Funktionen kommunizieren nicht mit dem Gerät selbst, sie arbeiten nur auf dem API Bindings Objekt. Dadurch können sie auch aufgerufen werden, ohne das das dazugehörige IP Connection Objekt verbunden ist.
BrickletThermalImaging.
getAPIVersion
()¶Rückgabeobjekt: |
|
---|
Gibt die Version der API Definition zurück, die diese API Bindings implementieren. Dies ist weder die Release-Version dieser API Bindings noch gibt es in irgendeiner Weise Auskunft über den oder das repräsentierte(n) Brick oder Bricklet.
BrickletThermalImaging.
getResponseExpected
(byte functionId)¶Parameter: |
|
---|---|
Rückgabe: |
|
Gibt das Response-Expected-Flag für die Funktion mit der angegebenen Funktions IDs zurück. Es ist true falls für die Funktion beim Aufruf eine Antwort erwartet wird, false andernfalls.
Für Getter-Funktionen ist diese Flag immer gesetzt und kann nicht entfernt
werden, da diese Funktionen immer eine Antwort senden. Für
Konfigurationsfunktionen für Callbacks ist es standardmäßig gesetzt, kann aber
entfernt werden mittels setResponseExpected()
. Für Setter-Funktionen ist
es standardmäßig nicht gesetzt, kann aber gesetzt werden.
Wenn das Response-Expected-Flag für eine Setter-Funktion gesetzt ist, können Timeouts und andere Fehlerfälle auch für Aufrufe dieser Setter-Funktion detektiert werden. Das Gerät sendet dann eine Antwort extra für diesen Zweck. Wenn das Flag für eine Setter-Funktion nicht gesetzt ist, dann wird keine Antwort vom Gerät gesendet und Fehler werden stillschweigend ignoriert, da sie nicht detektiert werden können.
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für functionId:
BrickletThermalImaging.
setResponseExpected
(byte functionId, boolean responseExpected)¶Parameter: |
|
---|
Ändert das Response-Expected-Flag für die Funktion mit der angegebenen Funktion IDs. Diese Flag kann nur für Setter-Funktionen (Standardwert: false) und Konfigurationsfunktionen für Callbacks (Standardwert: true) geändert werden. Für Getter-Funktionen ist das Flag immer gesetzt.
Wenn das Response-Expected-Flag für eine Setter-Funktion gesetzt ist, können Timeouts und andere Fehlerfälle auch für Aufrufe dieser Setter-Funktion detektiert werden. Das Gerät sendet dann eine Antwort extra für diesen Zweck. Wenn das Flag für eine Setter-Funktion nicht gesetzt ist, dann wird keine Antwort vom Gerät gesendet und Fehler werden stillschweigend ignoriert, da sie nicht detektiert werden können.
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für functionId:
BrickletThermalImaging.
setResponseExpectedAll
(boolean responseExpected)¶Parameter: |
|
---|
Ändert das Response-Expected-Flag für alle Setter-Funktionen und Konfigurationsfunktionen für Callbacks diese Gerätes.
Interne Funktionen werden für Wartungsaufgaben, wie zum Beispiel das Flashen einer neuen Firmware oder das Ändern der UID eines Bricklets, verwendet. Diese Aufgaben sollten mit Brick Viewer durchgeführt werden, anstelle die internen Funktionen direkt zu verwenden.
BrickletThermalImaging.
setBootloaderMode
(int mode)¶Parameter: |
|
---|---|
Rückgabe: |
|
Setzt den Bootloader-Modus und gibt den Status zurück nachdem die Modusänderungsanfrage bearbeitet wurde.
Mit dieser Funktion ist es möglich vom Bootloader- in den Firmware-Modus zu wechseln und umgekehrt. Ein Welchsel vom Bootloader- in der den Firmware-Modus ist nur möglich wenn Entry-Funktion, Device Identifier und CRC vorhanden und korrekt sind.
Diese Funktion wird vom Brick Viewer während des Flashens benutzt. In einem normalem Nutzerprogramm sollte diese Funktion nicht benötigt werden.
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für mode:
Für status:
BrickletThermalImaging.
getBootloaderMode
()¶Rückgabe: |
|
---|
Gibt den aktuellen Bootloader-Modus zurück, siehe setBootloaderMode()
.
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für mode:
BrickletThermalImaging.
setWriteFirmwarePointer
(long pointer)¶Parameter: |
|
---|
Setzt den Firmware-Pointer für writeFirmware()
. Der Pointer
muss um je 64 Byte erhöht werden. Die Daten werden alle 4 Datenblöcke
in den Flash geschrieben (4 Datenblöcke entsprechen einer Page mit 256 Byte).
Diese Funktion wird vom Brick Viewer während des Flashens benutzt. In einem normalem Nutzerprogramm sollte diese Funktion nicht benötigt werden.
BrickletThermalImaging.
writeFirmware
(int[] data)¶Parameter: |
|
---|---|
Rückgabe: |
|
Schreibt 64 Bytes Firmware an die Position die vorher von
setWriteFirmwarePointer()
gesetzt wurde. Die Firmware wird
alle 4 Datenblöcke in den Flash geschrieben.
Eine Firmware kann nur im Bootloader-Mode geschrieben werden.
Diese Funktion wird vom Brick Viewer während des Flashens benutzt. In einem normalem Nutzerprogramm sollte diese Funktion nicht benötigt werden.
BrickletThermalImaging.
writeUID
(long uid)¶Parameter: |
|
---|
Schreibt eine neue UID in den Flash. Die UID muss zuerst vom Base58 encodierten String in einen Integer decodiert werden.
Wir empfehlen die Nutzung des Brick Viewers zum ändern der UID.
BrickletThermalImaging.
readUID
()¶Rückgabe: |
|
---|
Gibt die aktuelle UID als Integer zurück. Dieser Integer kann als Base58 encodiert werden um an den üblichen UID-String zu gelangen.
BrickletThermalImaging.
DEVICE_IDENTIFIER
¶Diese Konstante wird verwendet um ein Thermal Imaging Bricklet zu identifizieren.
Die getIdentity()
Funktion und der
IPConnection.EnumerateCallback
Callback der IP Connection haben ein deviceIdentifier
Parameter um den Typ
des Bricks oder Bricklets anzugeben.
BrickletThermalImaging.
DEVICE_DISPLAY_NAME
¶Diese Konstante stellt den Anzeigenamen eines Thermal Imaging Bricklet dar.