Main SDK namespace. More...

Classes
class	ConstFrameIterator
	Iterates over the frame in a row major fashion and grants read access. More...

class	ConstImageIterator
	Iterates in a row major fashion over the image and grants read access to the pixels. More...

class	ConstMeasurementFieldIterator
	Iterates over a measurement field in a row major fashion and grants read access. More...

class	DeviceInfo
	Holds important information about a device. More...

class	DeviceNetworkConfig
	Encapsulates the on device network configuration. More...

class	EnumerationClient
	Defines the interface for classes that want to be updated about the detection of available devices. More...

class	EnumerationDetector
	Common interface for classes detecting available devices. More...

class	EnumerationManager
	Detects and monitors available devices. More...

class	Frame
	Represents a data frame received from a device. More...

class	FrameMetadata
	Encapsulates the metadata of frames provided by the devices. More...

class	FramerateCounter
	Measures frame rates. More...

class	Image
	Encapsulates false color images with 8-bit color depth. More...

class	ImageBuilder
	Creates false color images from thermal frames. More...

class	ImageInfo
	Encapsulates all relevant information about a false color image. More...

class	ImageIterator
	Iterates in a row major fashion over the image and grants read and write access to the pixels. More...

class	IpAddress
	Encapsulates an IP v4 address. More...

class	IRImager
	Common interface for all classes representing Optris thermal cameras. More...

class	IRImagerClient
	Base class for clients observing an IRImager. More...

class	IRImagerConfig
	Holds the SDK settings found in the configuration file. More...

class	IRImagerConfigReader
	Reads SDK configuration XML files. More...

class	IRImagerCreator
	Defines the interface for classes that instantiate IRImager implementations. More...

class	IRImagerFactory
	Factory instantiating IRImager implementations. More...

class	MeasurementField
	Rectangular measurement field with individual radiation parameters. More...

class	OperationMode
	Defines the interface for classes realizing operation modes. More...

class	Pixel
	Represents a pixel with three color channels and 8 bits of color depth. More...

class	Port
	Encapsulates a network port number. More...

class	Sdk
	Static class granting access to SDK wide configuration and utility functions. More...

class	SDKException
	Exception raised by the SDK. More...

struct	SnapshotEvent
	Encapsulates data about a snapshot event. More...

class	TemperatureConverter
	Converts temperatures in °C to and from their internal SDK representation. More...

struct	TemperatureRegion
	Characterizes a rectangular region by the indexes of the upper left and the lower right corners along with an associated temperature. More...

class	ThermalFrame
	Encapsulates thermal frame data received from a device. More...

class	VersionInfo
	Encapsulates version and build information about the SDK. More...

Enumerations
enum class	DeviceType { Unknown , PI1 , PI160 , PI2x0 , PI160orPI2x0 , PI4x0 , PI4x0I , PI640 , PI640I , PI1M , Xi80 , Xi160 , Xi400 , Xi410 , Xi410MT , Xi440 , Xi640 , Xi1M }
	Represents the different types of Optris thermal cameras.

enum class	FlagState { Open , Closed , Opening , Closing , Error , Initializing }
	Represents the different states of the shutter flag. More...

enum class	ColorFormat { RGB , BGR }
	Represents the different available color formats. More...

enum class	WidthAlignment { OneByte = 1 , TwoBytes = 2 , FourBytes = 4 , EightBytes = 8 }
	Represents the different available width alignments. More...

enum class	SnapshotTrigger { DigitalInput , AnalogInput , Software }
	Represents the different triggers of an event. More...

enum class	SnapshotType { Snapshot , SnapshotOnEdge }
	Represents the different event types. More...

enum class	TemperaturePrecision { Unknown = 0 , Standard = 1 , High = 2 }
	Represents the available temperature precisions. More...

enum class	ColoringPalette { AlarmBlue , AlarmBlueHi , GrayBW , GrayWB , AlarmGreen , Iron , IronHi , Medical , Rainbow , RainbowHi , AlarmRed }
	Represents the available coloring palettes. More...

enum class	PaletteScalingMethod { Manual , MinMax , Sigma1 , Sigma3 }
	Represents the false color conversion strategies. More...

enum class	Verbosity { Off = 1 , Error = 2 , Warning = 3 , Info = 4 , Debug = 5 }
	Represents the different logging verbosity levels. More...

enum class	CalibrationFileSource { Device , Filesystem , Internet , Empty }
	Represents the different sources from which the calibration files can be acquired. More...

Functions
OTC_SDK_API bool	is1MDevice (DeviceType type) noexcept
	Returns whether the given device is of the 1M variety.

OTC_SDK_API std::string	toString (DeviceType deviceType) noexcept
	Returns a string representation of the given device type.

OTC_SDK_API std::ostream &	operator<< (std::ostream &out, DeviceType deviceType) noexcept
	Output stream operator for device types.

OTC_SDK_API std::string	toString (FlagState flagState) noexcept
	Returns a string representation of the given flag state.

OTC_SDK_API std::ostream &	operator<< (std::ostream &out, FlagState state) noexcept
	Ouput stream operator for flag states.

std::ostream &	operator<< (std::ostream &out, const Pixel &pixel) noexcept
	Output stream operator for pixels.

OTC_SDK_API std::ostream &	operator<< (std::ostream &out, const IpAddress &address)
	Output stream operator for IP addresses.

OTC_SDK_API std::ostream &	operator<< (std::ostream &out, const Port &port) noexcept
	Output stream operator for port numbers.

OTC_SDK_API std::ostream &	operator<< (std::ostream &out, const IRImagerConfig &config)
	Output stream operator for the IRImagerConfig.

Variables
static constexpr float	INVALID_TEMPERATURE = -100.F
	All temperatures in °C equal or lower are invalid.

static constexpr unsigned short	INVALID_VALUE = 0
	All internal temperature values equal to this are invalid.

Detailed Description

Main SDK namespace.

Enumeration Type Documentation

◆ CalibrationFileSource

enum class optris::CalibrationFileSource

strong

Represents the different sources from which the calibration files can be acquired.

Enumerator
Device	The calibration files are fetched from the on-board memory of the device. Not supported by all devices.
Filesystem	The calibration files are copied from a local filesystem directory.
Internet	The calibration files are downloaded from Optris servers. Requires internet access.
Empty	No calibration source wanted.

◆ ColorFormat

enum class optris::ColorFormat

strong

Represents the different available color formats.

The format defines the storage sequence of the pixel color values. Therefore, the color value of the first letter will come first in the image pixel value array.

Some systems refer to the significance of the color values as color format. Here the color value of the first letter is the most significant byte. On big-endian machines this byte comes first. On little-endian machines it will come last.

False color image with Iron color palette: Left correct color format, right wrong color format.

Enumerator
RGB	Pixel colors values are stored in the sequence: (red, green, blue).
BGR	Pixel colors values are stored in the sequence: (blue, green, red).

◆ ColoringPalette

enum class optris::ColoringPalette

strong

Represents the available coloring palettes.

Enumerator
AlarmBlue
AlarmBlueHi
GrayBW
GrayWB
AlarmGreen
Iron
IronHi
Medical
Rainbow
RainbowHi
AlarmRed

◆ FlagState

enum class optris::FlagState

strong

Represents the different states of the shutter flag.

A flag cycle is defined by the transition through the following states:

Open - Closing - Closed - Opening - Open

During the automated startup calibration after a successful device connection the flag state will be Initializing indicating the thermal frame data is not yet reliable.

Enumerator
Open	Flag is open.
Closed	Flag is closed.
Opening	Flag is opening.
Closing	Flag is closing.
Error	Flag is in an error state.
Initializing	Flag state is beeing initialized/calibrated.

◆ PaletteScalingMethod

enum class optris::PaletteScalingMethod

strong

Represents the false color conversion strategies.

Enumerator
Manual	User-defined upper and lower limit (fixed values).
MinMax	Dynamic determination of minimum and maximum temperature as upper and lower limit.
Sigma1	Dynamic determination of upper and lower limit from standard deviation of temperature image.
Sigma3	Same as eSigma1, but with factor 3.

◆ SnapshotTrigger

enum class optris::SnapshotTrigger

strong

Represents the different triggers of an event.

Enumerator
DigitalInput	Triggered by digital input.
AnalogInput	Triggered by analog input.
Software	Triggered by software.

◆ SnapshotType

enum class optris::SnapshotType

strong

Represents the different event types.

Enumerator
Snapshot	Event source is snapshot.
SnapshotOnEdge	Event source is snapshot on edge.

◆ TemperaturePrecision

enum class optris::TemperaturePrecision

strong

Represents the available temperature precisions.

Enumerator
Unknown	Unknown precision.
Standard	Standard precision.
High	Hight precision.

◆ Verbosity

enum class optris::Verbosity

strong

Represents the different logging verbosity levels.

Enumerator
Off	Off.
Error	Error.
Warning	Warning.
Info	Info.
Debug	Debug.

◆ WidthAlignment

enum class optris::WidthAlignment

strong

Represents the different available width alignments.

Depending on the chosen alignment additional bytes will be added to the end of each row in an image so that its size in bytes adheres to that alignment. This enables some frame works like OpenGL to read the image data in bigger chunks than one byte at a time which can result in significant performance benefits.

Example false color image with faulty width alignment.

Enumerator
OneByte	The row size is aligned to one byte.
TwoBytes	The row size is aligned to two bytes.
FourBytes	The row size is aligned to four bytes.
EightBytes	The row size is aligned to eight bytes.

Function Documentation

◆ is1MDevice()

OTC_SDK_API bool optris::is1MDevice ( DeviceType type )

noexcept

Returns whether the given device is of the 1M variety.

Parameters

[in] type imager device type to check.

Returns: true if the given device is of the 1M variety. False otherwise.

◆ operator<<() [1/6]

OTC_SDK_API std::ostream & optris::operator<<	(	std::ostream &	out,
		const IpAddress &	address )

Output stream operator for IP addresses.

Parameters

[in]	out	stream to write the address to.
[in]	address	to output.

Returns: used output stream.

◆ operator<<() [2/6]

OTC_SDK_API std::ostream & optris::operator<<	(	std::ostream &	out,
		const IRImagerConfig &	config )

Output stream operator for the IRImagerConfig.

Parameters

[out]	out	stream to output to.
[in]	config	to output.

Returns: used output stream.

◆ operator<<() [3/6]

std::ostream & optris::operator<<	(	std::ostream &	out,
		const Pixel &	pixel )

inlinenoexcept

Output stream operator for pixels.

Parameters

[in]	out	stream to output to.
[in]	pixel	to output.

Returns: used output operator.

◆ operator<<() [4/6]

OTC_SDK_API std::ostream & optris::operator<<	(	std::ostream &	out,
		const Port &	port )

noexcept

Output stream operator for port numbers.

Parameters

[in]	out	stream to write the port number to.
[in]	port	to output.

Returns: used output stream.

◆ operator<<() [5/6]

OTC_SDK_API std::ostream & optris::operator<<	(	std::ostream &	out,
		DeviceType	deviceType )

noexcept

Output stream operator for device types.

Parameters

[in]	out	stream to use.
[in]	deviceType	to output.

Returns: used output stream.

◆ operator<<() [6/6]

OTC_SDK_API std::ostream & optris::operator<<	(	std::ostream &	out,
		FlagState	state )

noexcept

Ouput stream operator for flag states.

Parameters

[in]	out	stream to ouput to.
[in]	state	to output.

Returns: used output stream.

◆ toString() [1/2]

OTC_SDK_API std::string optris::toString ( DeviceType deviceType )

noexcept

Returns a string representation of the given device type.

Parameters

[in] deviceType for which a string representation is desired.

Returns: string respresentation of the given device type.

◆ toString() [2/2]

OTC_SDK_API std::string optris::toString ( FlagState flagState )

noexcept

Returns a string representation of the given flag state.

Returns: string representation of the given flag state.

Classes

Enumerations

Functions

Variables

Detailed Description

Enumeration Type Documentation

◆ CalibrationFileSource

◆ ColorFormat

◆ ColoringPalette

◆ FlagState

◆ PaletteScalingMethod

◆ SnapshotTrigger

◆ SnapshotType

◆ TemperaturePrecision

◆ Verbosity

◆ WidthAlignment

Function Documentation

◆ is1MDevice()

◆ operator<<() [1/6]

◆ operator<<() [2/6]

◆ operator<<() [3/6]

◆ operator<<() [4/6]

◆ operator<<() [5/6]

◆ operator<<() [6/6]

◆ toString() [1/2]

◆ toString() [2/2]