Main SDK namespace. More...

Classes
class	AlarmChannel
	Interface representing an alarm channel. More...

struct	AlarmChannelConfig
	Holds the configuration of an alarm channel. More...

class	AlarmChannelStatus
	Encapsulates the status of an alarm channel. More...

struct	AlarmEvent
	Event containing the status of an alarm channel. More...

struct	AlarmsConfig
	Holds the alarm configuration. More...

struct	CompositeAlarmEvent
	Event containing the status of the composite alarm. More...

class	CompositeAlarmStatus
	Encapsulates the status of the composite alarm. More...

struct	ConnectionEvent
	Represents a connection event. More...

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

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

class	EnumerationClient
	Base class for all clients observing the EnumerationManager. More...

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

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

struct	FieldShapeConfig
	Encapsulates the configuration of a field shape. More...

struct	FieldStats
	Encapsulates the results of the statistical analysis of a measurement field. More...

class	FieldStatus
	Encapsulates the status of a processed measurement field. More...

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

struct	FrameEvent
	Event containing the results of the successful processing of a frame. 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...

struct	IntegralPixel
	Helper struct for calculating an integral image. More...

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

class	IRImager
	Interface defining the API for interacting with Optris thermal cameras. More...

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

struct	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	MacAddress
	Encapsulates a media access control address (MAC address). More...

class	MeasurementField
	Measurement field or region of interest (ROI) within the thermal frame. More...

struct	MeasurementFieldConfig
	Encapsulates the configuration of a measurement field. More...

class	OperationInfo
	Encapsulates information about an operation module within the processing pipeline. More...

struct	OperationInfoEvent
	Event containing trace information about the operation modules of the processing pipeline. More...

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

struct	PifAiConfig
	Encapsulates the configuration for a PIF analog input channel. More...

struct	PifAoConfig
	Encapsulates the configuration for a PIF analog output channel. More...

struct	PifConfig
	Holds the configuration of the processing interface. More...

struct	PifDiConfig
	Encapsulates the configuration for a PIF digital input channel. More...

struct	PifDoConfig
	Encapsulates the configuration for a PIF digital output channel. More...

struct	PifFsConfig
	Encapsulates the configuration for a PIF fail safe channel. More...

struct	PifIndex
	Holds the indices that identify the physical pin on a PIF device for a PIF channel. 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...

struct	ProcessingOutputConfig
	Specifies which outputs should be computed and provided by the SDK. More...

class	ProcessInterface
	Interface defining the API for interacting with process interfaces (PIFs). More...

struct	RadiationParameters
	Holds the radiation parameters for a frame or a measurement field. More...

struct	Range
	Generic range structure. More...

struct	RawFrameEvent
	Event containing the raw unprocessed frame data and metadata. More...

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

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

struct	Slope
	Encapsulates the parameters of a linear transformation. 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 processed thermal frame data. More...

struct	UncommittedValueEvent
	Event containing the uncommitted value generated from a PIF analog input. More...

class	UncommittedValueStatus
	Holds the status of an uncommitted value derived from a PIF analog input. More...

struct	Vector2
	Generic 2D vector structure. More...

class	Version
	Represent a version with major, minor and patch version numbers. More...

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

struct	VideoFormatEvent
	Event containing information about the current video format. More...

Typedefs
using	RangeF = Range<float>
	Alias for a range with float components.

using	RangeI = Range<int>
	Alias for a range with integer components.

using	Vector2f = Vector2<float>
	Alias for a 2D vector with float components.

using	Vector2i = Vector2<int>
	Alias for a 2D vector with integer components.

Enumerations
enum class	AlarmInput { MeasurementField , InternalTemperature , ChipTemperature , UncommittedValue }
	Represents the different inputs that an alarm channel monitors. More...

enum class	AlarmState { Unknown , Disabled , Orphaned , Clear , PreActive , Active }
	Represents the different states an alarm channel can be in. More...

enum class	AlarmRangeRelation { Unknown , BelowRange , InRange , AboveRange }
	Represents the relation of an alarm input value to an alarm range. More...

enum class	ChipHeatingMode { Floating , Auto , Fixed }
	Represents the available chip heating modes. More...

enum class	ConnectionState { Disconnecting , Disconnected , Connecting , CaliAccessInternet , CaliInternetDownload , CaliDeviceDownload , CaliCopy , CaliCopySourceDirectory , CaliAcquired , CaliMissing , Failed , Connected , Lost , Timeout }
	Represents the current connection state. More...

enum class	DeviceType { Unknown , PI1 , PI160 , PI2x0 , PI160orPI2x0 , PI4x0 , PI4x0I , PI640 , PI640I , PI1M , Xi80 , Xi160 , Xi320 , Xi320MT , 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	RadiationParameterSource { Sdk , Pif }
	Represents the different sources of radiation parameters. More...

enum class	RdcMode { Off , Normal , Wide , Unknown }
	Represents the different modes for radial distortion correction. More...

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

enum class	FieldShape { Rectangle , Ellipse , Polygon , Splines }
	Represents the different available field shapes. More...

enum class	FieldStat { Minimum , Maximum , Mean , Median }
	Represents the different field statistics that can be used by other components (PIF, alarms). More...

enum class	TemperatureScalingMode { Manual , MinMax , Sigma1 , Sigma3 }
	Represents the different mode to scale temperatures when generating a false color image. More...

enum class	PifDeviceType { Automatic , None , Standard , IndustrialMV , IndustrialMA , Internal , Stackable , TemperatureProbe , Proprietary }
	Represents the supported PIF device types. More...

enum class	PifAiMode { Off , FlagControl , Emissivity , AmbientTemperature , UncommittedValue }
	Represents the available modes for PIF analog input channels. More...

enum class	PifDiMode { Off , FlagControl }
	Represents the available modes for PIF digital input channels. More...

enum class	PifAoMode { Off , FlagStatus , FrameSync , FailSafe , ExternalCommunication , MeasurementField , InternalTemperature , Alarm }
	Represents the available modes for PIF analog output channels. More...

enum class	PifDoMode { Off , FlagStatus , FrameSync , FailSafe , ExternalCommunication , Alarm }
	Represents the available modes for PIF digital output channels. More...

enum class	PifFsMode { Off , On }
	Represents the available modes for PIF fail safe channels. More...

enum class	PifAoOutputMode { _0_20mA , _4_20mA , _0_10V }
	Represents the available output modes for PIF analog output channels. 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 std::ostream &	operator<< (std::ostream &out, const AlarmChannelConfig &config) noexcept
	Output stream operator for alarm channel configurations.

OTC_SDK_API std::ostream &	operator<< (std::ostream &out, const AlarmChannelStatus &status)
	Output stream operator for alarm channel status.

OTC_SDK_API std::string	toString (AlarmInput alarmInput) noexcept
	Returns a string representation of the given alarm input.

OTC_SDK_API std::string	toString (AlarmState alarmState) noexcept
	Returns a string representation of the given alarm state.

OTC_SDK_API std::string	toString (AlarmRangeRelation alarmRangeRelation) noexcept
	Returns a string representation of the given alarm range relation.

OTC_SDK_API std::ostream &	operator<< (std::ostream &out, AlarmInput alarmInput) noexcept
	Output stream operator for alarm inputs.

OTC_SDK_API std::ostream &	operator<< (std::ostream &out, AlarmState alarmState) noexcept
	Output stream operator for alarm states.

OTC_SDK_API std::ostream &	operator<< (std::ostream &out, AlarmRangeRelation alarmRangeRelation) noexcept
	Output stream operator for alarm range relations.

OTC_SDK_API std::ostream &	operator<< (std::ostream &out, const AlarmsConfig &config) noexcept
	Output stream operator for the alarm configuration.

OTC_SDK_API std::ostream &	operator<< (std::ostream &out, const CompositeAlarmStatus &status)
	Output stream operator for composite alarm status.

OTC_SDK_API std::string	toString (ChipHeatingMode mode) noexcept
	Returns a string representation of the given chip heating mode.

OTC_SDK_API std::ostream &	operator<< (std::ostream &out, ChipHeatingMode mode) noexcept
	Ouput stream operator for chip heating mode.

OTC_SDK_API std::string	toString (ConnectionState state) noexcept
	Returns a string representation of the given connection state.

OTC_SDK_API std::ostream &	operator<< (std::ostream &out, ConnectionState state) noexcept
	Ouput stream operator for connection state.

OTC_SDK_API bool	isPI (DeviceType type) noexcept
	Returns whether the given device is PI.

OTC_SDK_API bool	isXI (DeviceType type) noexcept
	Returns whether the given device is a Xi.

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

OTC_SDK_API bool	isMTDevice (DeviceType type) noexcept
	Returns whether the given device is an MT device.

OTC_SDK_API bool	isDeviceAnsweringAllCommands (DeviceType type) noexcept
	Returns whether the given device will answer on all commands, also on commands with no answer needed (such as set commands).

OTC_SDK_API bool	isAutonomousDevice (DeviceType type) noexcept
	Returns whether the given device supports the autonomous mode.

OTC_SDK_API bool	isEthernetDevice (DeviceType type) noexcept
	Returns whether the given device supports Ethernet.

OTC_SDK_API bool	hasFocusMotor (DeviceType type) noexcept
	Returns whether the given device has a focus motor.

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.

bool	operator== (const RadiationParameters &lhs, const RadiationParameters &rhs) noexcept
	Checks if two radiation parameter sets are equal.

bool	operator!= (const RadiationParameters &lhs, const RadiationParameters &rhs) noexcept
	Checks if two radiation parameter sets are unequal.

OTC_SDK_API std::string	toString (RadiationParameterSource source) noexcept
	Returns a string representation of the given radiation parameter source.

OTC_SDK_API std::ostream &	operator<< (std::ostream &out, const RadiationParameters &radiation) noexcept
	Ouput stream operator for radiation parameters.

OTC_SDK_API std::ostream &	operator<< (std::ostream &out, RadiationParameterSource source) noexcept
	Ouput stream operator for radiation parameter sources.

template<typename T>
bool	operator== (const Range< T > &lhs, const Range< T > &rhs) noexcept
	Checks if two ranges are equal.

template<typename T>
bool	operator!= (const Range< T > &lhs, const Range< T > &rhs) noexcept
	Checks if two ranges are unequal.

template<typename T>
bool	isIn (const T &value, const Range< T > &range) noexcept
	Checks if a value is within a given range.

template<typename T>
std::ostream &	operator<< (std::ostream &out, const Range< T > &range) noexcept
	Ouput stream operator for ranges.

OTC_SDK_API std::string	toString (RdcMode mode) noexcept
	Returns a string representation of the given radial distortion correction mode.

OTC_SDK_API std::ostream &	operator<< (std::ostream &out, RdcMode mode) noexcept
	Ouput stream operator for radial distortion correction modes.

std::ostream &	operator<< (std::ostream &out, const Slope &slope) noexcept
	Output stream operator for Slope.

OTC_SDK_API std::string	toString (TemperaturePrecision precision) noexcept
	Returns a string representation of the given temperature precision.

OTC_SDK_API std::ostream &	operator<< (std::ostream &out, TemperaturePrecision precision) noexcept
	Ouput stream operator for temperature precisions.

template<typename T>
bool	operator== (const Vector2< T > &lhs, const Vector2< T > &rhs) noexcept
	Checks if two vectors are equal.

template<typename T>
bool	operator!= (const Vector2< T > &lhs, const Vector2< T > &rhs) noexcept
	Checks if two vectors are unequal.

template<typename T>
Vector2< T >	operator+ (const Vector2< T > &lhs, const Vector2< T > &rhs) noexcept
	Adds two vectors together.

template<typename T>
Vector2< T >	operator- (const Vector2< T > &lhs, const Vector2< T > &rhs) noexcept
	Subtracts two vectors.

template<typename T>
std::ostream &	operator<< (std::ostream &out, const Vector2< T > &vector) noexcept
	Ouput stream operator for vectors.

OTC_SDK_API std::ostream &	operator<< (std::ostream &out, const Version &version)
	Ouput stream operator for Version objects.

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 MacAddress &mac) noexcept
	Output stream operator for MAC addresses.

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

OTC_SDK_API float	getFieldStat (const FieldStats &stats, FieldStat stat) noexcept
	Returns the value of the given field statistic.

OTC_SDK_API std::string	toString (FieldShape shape) noexcept
	Returns a string representation of the given field shape.

OTC_SDK_API std::string	toString (FieldStat stat) noexcept
	Returns a string representation of the given field statistic.

OTC_SDK_API std::ostream &	operator<< (std::ostream &out, FieldShape shape) noexcept
	Ouput stream operator for field shapes.

OTC_SDK_API std::ostream &	operator<< (std::ostream &out, FieldStat stat) noexcept
	Ouput stream operator for field statistics.

OTC_SDK_API std::ostream &	operator<< (std::ostream &out, const FieldStats &stats) noexcept
	Ouput stream operator for field stats.

OTC_SDK_API std::ostream &	operator<< (std::ostream &out, const FieldStatus &status)
	Output stream operator for measurement field status.

OTC_SDK_API std::ostream &	operator<< (std::ostream &out, const FieldShapeConfig &fieldShapeConfig) noexcept
	Ouput stream operator for field shape configurations.

OTC_SDK_API std::ostream &	operator<< (std::ostream &out, const MeasurementFieldConfig &config) noexcept
	Ouput stream operator for measurement field configurations.

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

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

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

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

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

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

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

OTC_SDK_API float	lowerLimit (PifAoOutputMode outputMode) noexcept
	Returns the lower limit of the specified PIF analog output mode as a number value.

OTC_SDK_API float	upperLimit (PifAoOutputMode outputMode) noexcept
	Returns the upper limit of the specified PIF analog output mode as a number value.

OTC_SDK_API float	clampValue (float value, PifAoOutputMode outputMode) noexcept
	Clamps the given value to the limits of the specified PIF analog output mode.

bool	operator== (const PifIndex &lhs, const PifIndex &rhs) noexcept
	Equality operator for PIF indices.

bool	operator!= (const PifIndex &lhs, const PifIndex &rhs) noexcept
	Inequality operator for PIF indices.

OTC_SDK_API std::string	toString (const PifIndex &index) noexcept
	Returns a string representation of the given PIF index.

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

OTC_SDK_API std::string	toString (PifAiMode analogInputMode) noexcept
	Returns a string representation of the given PIF analog input mode.

OTC_SDK_API std::string	toString (PifDiMode digitalInputMode) noexcept
	Returns a string representation of the given PIF digital input mode.

OTC_SDK_API std::string	toString (PifAoMode analogOutputMode) noexcept
	Returns a string representation of the given PIF analog output mode.

OTC_SDK_API std::string	toString (PifDoMode digitalOutputMode) noexcept
	Returns a string representation of the given PIF digital output mode.

OTC_SDK_API std::string	toString (PifFsMode failSafeMode) noexcept
	Returns a string representation of the given PIF fail safe mode.

OTC_SDK_API std::string	toString (PifAoOutputMode outputMode) noexcept
	Returns a string representation of the given PIF analog output mode.

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

OTC_SDK_API std::ostream &	operator<< (std::ostream &out, PifAiMode analogInputMode) noexcept
	Output stream operator for PIF analog input modes.

OTC_SDK_API std::ostream &	operator<< (std::ostream &out, PifDiMode digitalInputMode) noexcept
	Output stream operator for PIF digital input modes.

OTC_SDK_API std::ostream &	operator<< (std::ostream &out, PifAoMode analogOutputMode) noexcept
	Output stream operator for PIF analog output modes.

OTC_SDK_API std::ostream &	operator<< (std::ostream &out, PifDoMode digitalOutputMode) noexcept
	Output stream operator for PIF digital output modes.

OTC_SDK_API std::ostream &	operator<< (std::ostream &out, PifFsMode failSafeMode) noexcept
	Output stream operator for PIF fail safe modes.

OTC_SDK_API std::ostream &	operator<< (std::ostream &out, PifAoOutputMode outputMode) noexcept
	Output stream operator for PIF analog output mode.

OTC_SDK_API std::ostream &	operator<< (std::ostream &out, PifIndex index) noexcept
	Output stream operator for PIF indices.

OTC_SDK_API std::ostream &	operator<< (std::ostream &out, const UncommittedValueStatus &status)
	Output stream operator for uncommitted value status.

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

◆ AlarmInput

enum class optris::AlarmInput

strong

Represents the different inputs that an alarm channel monitors.

Enumerator
MeasurementField	Monitors a statistical value of a measurement field.
InternalTemperature	Monitors the internal temperature of the device.
ChipTemperature	Monitors the temperature of the sensor chip.
UncommittedValue	Monitors an uncommitted value generated by a PIF analog input channel.

◆ AlarmRangeRelation

enum class optris::AlarmRangeRelation

strong

Represents the relation of an alarm input value to an alarm range.

Enumerator
Unknown	The relation of the value to the alarm range is unknown.
BelowRange	The alarm input value is below the alarm range (less than its minimum).
InRange	The alarm input value is in the alarm range.
AboveRange	The alarm input value is above the alarm range (greater than its maximum).

◆ AlarmState

enum class optris::AlarmState

strong

Represents the different states an alarm channel can be in.

Enumerator
Unknown	Alarm channel state is unknown because no input has yet been received.
Disabled	Alarm channel is disabled.
Orphaned	Alarm channel is orphaned because its input was removed.
Clear	Alarm is clear.
PreActive	A preliminary alarm is active.
Active	Alarm is active.

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

◆ ChipHeatingMode

enum class optris::ChipHeatingMode

strong

Represents the available chip heating modes.

Enumerator
Floating	The sensor chip will not be heated.
Auto	The sensor chip will be heated to the temperature specified in the calibrations.
Fixed	The sensor chip will be heated to a configurable fixed temperature.

◆ 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).

◆ ConnectionState

enum class optris::ConnectionState

strong

Represents the current connection state.

Enumerator
Disconnected	The device connection is being closed.
Connecting	The device connection is closed.
CaliAccessInternet	The device connection is being established.
CaliInternetDownload	The Sdk is asking for permission to access the internet to download missing calibration files.
CaliDeviceDownload	The Sdk is trying to download missing calibration files from the internet.
CaliCopy	The Sdk is trying to download missing calibration files from the device.
CaliCopySourceDirectory	The Sdk is trying to copy missing calibration files from the filesystem.
CaliAcquired	The directory specified via Sdk::setCalibrationFileSourceDirectory() did not contain everything. Provide another source directory.
CaliMissing	All missing calibration files have been successfully acquired.
Failed	Missing calibration files could not be acquired. Thermal data will be invalid.
Connected	The connection attempt failed.
Lost	The device connection is established.
Timeout	The device connection is lost. The device connection timed out, e.g. due to a network issue.

◆ FieldShape

enum class optris::FieldShape

strong

Represents the different available field shapes.

Enumerator
Rectangle	Rectangular field.
Ellipse	Elliptical field.
Polygon	Polygonal field defined by a set of vertices.
Splines	Spline based field defined by a set of vertices.

◆ FieldStat

enum class optris::FieldStat

strong

Represents the different field statistics that can be used by other components (PIF, alarms).

Enumerator
Minimum	Minimum field temperature.
Maximum	Maximum field temperature.
Mean	Mean field temperature.
Median	Median field temperature.

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

◆ PifAiMode

enum class optris::PifAiMode

strong

Represents the available modes for PIF analog input channels.

Enumerator
Off	Off.
FlagControl	The shutter flag is controlled by the input voltage.
Emissivity	Emissivity for the thermal frame is derived from the input voltage.
AmbientTemperature	Ambient temperature for the thermal frame is derived from the input voltage.
UncommittedValue	The input voltage value is transformed and provided to IRImagerClients via a callback.

◆ PifAoMode

enum class optris::PifAoMode

strong

Represents the available modes for PIF analog output channels.

Enumerator
Off	Off.
FlagStatus	The status of the shutter flag is output.
FrameSync	Every time a new frame is capture a pulse is output.
FailSafe	A heart beat signal is provided that indicates whether the camera and SDK are working correctly.
ExternalCommunication	The output value can be controlled by clients of the SDK.
MeasurementField	The set data point of a measurement field is output.
InternalTemperature	The internal camera temperature is output.
Alarm	The status of a configured alarm channels are output.

◆ PifAoOutputMode

enum class optris::PifAoOutputMode

strong

Represents the available output modes for PIF analog output channels.

Enumerator
_0_20mA	0 mA - 20 mA
_4_20mA	4 mA - 20 mA
_0_10V	0 V - 10 V

◆ PifDeviceType

enum class optris::PifDeviceType

strong

Represents the supported PIF device types.

Enumerator
Automatic	Use the PIF type reported by the camera firmware.
None	No PIF.
Standard	Standard PIF.
IndustrialMV	Industrial PIF with voltage based analog outputs.
IndustrialMA	Industrial PIF with current based analog outputs.
Internal	Internal PIF.
Stackable	Stackable PIF.
TemperatureProbe	Instead of a PIF an external temperature probe is used.
Proprietary	The pins of the PIF connector on the camera are used directly.

◆ PifDiMode

enum class optris::PifDiMode

strong

Represents the available modes for PIF digital input channels.

Enumerator
Off	Off.
FlagControl	The flag is controlled by the input signal.

◆ PifDoMode

enum class optris::PifDoMode

strong

Represents the available modes for PIF digital output channels.

Enumerator
Off	Off.
FlagStatus	The status of the shutter flag is output.
FrameSync	Every time a new frame is capture a high pulse is output.
FailSafe	A heart beat signal is provided that indicates whether the camera and SDK are working correctly.
ExternalCommunication	The output value can be controlled by clients of the SDK.
Alarm	The status of a configured alarm channels are output.

◆ PifFsMode

enum class optris::PifFsMode

strong

Represents the available modes for PIF fail safe channels.

Enumerator
Off	Off.
On	On.

◆ RadiationParameterSource

enum class optris::RadiationParameterSource

strong

Represents the different sources of radiation parameters.

Enumerator
Sdk	The radiation parameter are/can be set via the SDK.
Pif	The radiation parameter is set by the processing interface (PIF).

◆ RdcMode

enum class optris::RdcMode

strong

Represents the different modes for radial distortion correction.

Enumerator
Off	Deactivated.
Normal	Normal mode.
Wide	Wide mode.
Unknown	Unknown mode. Used for error handling.

◆ TemperaturePrecision

enum class optris::TemperaturePrecision

strong

Represents the available temperature precisions.

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

◆ TemperatureScalingMode

enum class optris::TemperatureScalingMode

strong

Represents the different mode to scale temperatures when generating a false color image.

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 Sigma1, but with factor 3.

◆ 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

◆ clampValue()

OTC_SDK_API float optris::clampValue	(	float	value,
		PifAoOutputMode	outputMode )

noexcept

Clamps the given value to the limits of the specified PIF analog output mode.

Parameters

[in]	value	to clamp.
[in]	outputMode	to which the provided value should be clamped.

Returns: the given value to the limits of the specified PIF analog output mode.

◆ getFieldStat()

OTC_SDK_API float optris::getFieldStat	(	const FieldStats &	stats,
		FieldStat	stat )

noexcept

Returns the value of the given field statistic.

Parameters

[in]	stats	field statistics.
[in]	stat	to retrieve from the field statistics.

Returns: value of the given field statistic.

◆ hasFocusMotor()

OTC_SDK_API bool optris::hasFocusMotor ( DeviceType type )

noexcept

Returns whether the given device has a focus motor.

Parameters

[in] type imager device type to check.

Returns: true if the given device has a focus motor. False otherwise.

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

◆ isAutonomousDevice()

OTC_SDK_API bool optris::isAutonomousDevice ( DeviceType type )

noexcept

Returns whether the given device supports the autonomous mode.

Parameters

[in] type imager device type to check.

Returns: true if the given device supports the autonomous mode. False otherwise.

◆ isDeviceAnsweringAllCommands()

OTC_SDK_API bool optris::isDeviceAnsweringAllCommands ( DeviceType type )

noexcept

Returns whether the given device will answer on all commands, also on commands with no answer needed (such as set commands).

Parameters

[in] type imager device type to check.

Returns: true if the given device answers on all commands. False otherwise.

◆ isEthernetDevice()

OTC_SDK_API bool optris::isEthernetDevice ( DeviceType type )

noexcept

Returns whether the given device supports Ethernet.

Parameters

[in] type imager device type to check.

Returns: true if the given device supports Ethernet. False otherwise.

◆ isIn()

template<typename T>

bool optris::isIn	(	const T &	value,
		const Range< T > &	range )

inlinenoexcept

Checks if a value is within a given range.

Parameters

[in]	value	value to check.
[in]	range	range to check against.

Returns: true, if the value is within the range. False otherwise.

◆ isMTDevice()

OTC_SDK_API bool optris::isMTDevice ( DeviceType type )

noexcept

Returns whether the given device is an MT device.

Parameters

[in] type imager device type to check.

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

◆ isPI()

OTC_SDK_API bool optris::isPI ( DeviceType type )

noexcept

Returns whether the given device is PI.

Parameters

[in] type imager device type to check.

Returns: true if the given device is a PI. False otherwise.

◆ isXI()

OTC_SDK_API bool optris::isXI ( DeviceType type )

noexcept

Returns whether the given device is a Xi.

Parameters

[in] type imager device type to check.

Returns: true if the given device is a Xi. False otherwise.

◆ lowerLimit()

OTC_SDK_API float optris::lowerLimit ( PifAoOutputMode outputMode )

noexcept

Returns the lower limit of the specified PIF analog output mode as a number value.

Parameters

[in] outputMode for which the lower limit is desired.

Returns: lower limit of the specified PIF analog output mode as a number value.

◆ operator!=() [1/4]

bool optris::operator!=	(	const PifIndex &	lhs,
		const PifIndex &	rhs )

inlinenoexcept

Inequality operator for PIF indices.

Parameters

[in]	lhs	left-hand side index.
[in]	rhs	right-hand side index.

Returns: true if the indices are unequal, false otherwise.

◆ operator!=() [2/4]

bool optris::operator!=	(	const RadiationParameters &	lhs,
		const RadiationParameters &	rhs )

noexcept

Checks if two radiation parameter sets are unequal.

Parameters

[in]	lhs	first radiation parameter set to compare.
[in]	rhs	second radiation parameter set to compare.

Returns: true, if the radiation parameter sets are unequal.False otherwise.

◆ operator!=() [3/4]

template<typename T>

bool optris::operator!=	(	const Range< T > &	lhs,
		const Range< T > &	rhs )

inlinenoexcept

Checks if two ranges are unequal.

Parameters

[in]	lhs	first range to compare.
[in]	rhs	second range to compare.

Returns: true, if the ranges are unequal.False otherwise.

◆ operator!=() [4/4]

template<typename T>

bool optris::operator!=	(	const Vector2< T > &	lhs,
		const Vector2< T > &	rhs )

inlinenoexcept

Checks if two vectors are unequal.

Parameters

[in]	lhs	first vector to compare.
[in]	rhs	second vector set to compare.

Returns: true, if the vectors are unequal.False otherwise.

◆ operator+()

template<typename T>

Vector2< T > optris::operator+	(	const Vector2< T > &	lhs,
		const Vector2< T > &	rhs )

inlinenoexcept

Adds two vectors together.

Parameters

[in]	lhs	first vector to add.
[in]	rhs	second vector to add.

Returns: resulting vector of the addition.

◆ operator-()

template<typename T>

Vector2< T > optris::operator-	(	const Vector2< T > &	lhs,
		const Vector2< T > &	rhs )

inlinenoexcept

Subtracts two vectors.

Parameters

[in]	lhs	first vector to subtract.
[in]	rhs	second vector to subtract.

Returns: resulting vector of the subtraction.

◆ operator<<() [1/45]

OTC_SDK_API std::ostream & optris::operator<<	(	std::ostream &	out,
		AlarmInput	alarmInput )

noexcept

Output stream operator for alarm inputs.

Parameters

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

Returns: used output stream.

◆ operator<<() [2/45]

OTC_SDK_API std::ostream & optris::operator<<	(	std::ostream &	out,
		AlarmRangeRelation	alarmRangeRelation )

noexcept

Output stream operator for alarm range relations.

Parameters

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

Returns: used output stream.

◆ operator<<() [3/45]

OTC_SDK_API std::ostream & optris::operator<<	(	std::ostream &	out,
		AlarmState	alarmState )

noexcept

Output stream operator for alarm states.

Parameters

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

Returns: used output stream.

◆ operator<<() [4/45]

OTC_SDK_API std::ostream & optris::operator<<	(	std::ostream &	out,
		ChipHeatingMode	mode )

noexcept

Ouput stream operator for chip heating mode.

Parameters

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

Returns: used output stream.

◆ operator<<() [5/45]

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

noexcept

Ouput stream operator for connection state.

Parameters

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

Returns: used output stream.

◆ operator<<() [6/45]

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

noexcept

Output stream operator for alarm channel configurations.

Parameters

[in]	out	stream to use.
[in]	config	alarm channel configuration to output.

Returns: used output stream.

◆ operator<<() [7/45]

OTC_SDK_API std::ostream & optris::operator<<	(	std::ostream &	out,
		const AlarmChannelStatus &	status )

Output stream operator for alarm channel status.

Parameters

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

Returns: used output stream.

◆ operator<<() [8/45]

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

noexcept

Output stream operator for the alarm configuration.

Parameters

[in]	out	stream to use.
[in]	config	alarm configuration to output.

Returns: used output stream.

◆ operator<<() [9/45]

OTC_SDK_API std::ostream & optris::operator<<	(	std::ostream &	out,
		const CompositeAlarmStatus &	status )

Output stream operator for composite alarm status.

Parameters

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

Returns: used output stream.

◆ operator<<() [10/45]

OTC_SDK_API std::ostream & optris::operator<<	(	std::ostream &	out,
		const FieldShapeConfig &	fieldShapeConfig )

noexcept

Ouput stream operator for field shape configurations.

Parameters

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

Returns: used output stream.

◆ operator<<() [11/45]

OTC_SDK_API std::ostream & optris::operator<<	(	std::ostream &	out,
		const FieldStats &	stats )

noexcept

Ouput stream operator for field stats.

Parameters

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

Returns: used output stream.

◆ operator<<() [12/45]

OTC_SDK_API std::ostream & optris::operator<<	(	std::ostream &	out,
		const FieldStatus &	status )

Output stream operator for measurement field status.

Parameters

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

Returns: used output stream.

◆ operator<<() [13/45]

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<<() [14/45]

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<<() [15/45]

OTC_SDK_API std::ostream & optris::operator<<	(	std::ostream &	out,
		const MacAddress &	mac )

noexcept

Output stream operator for MAC addresses.

Parameters

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

Returns: used output stream.

◆ operator<<() [16/45]

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

noexcept

Ouput stream operator for measurement field configurations.

Parameters

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

Returns: used output stream.

◆ operator<<() [17/45]

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

noexcept

Output stream operator for PifAiConfig.

Parameters

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

Returns: used output stream.

◆ operator<<() [18/45]

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

noexcept

Output stream operator for PifAoConfig.

Parameters

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

Returns: used output stream.

◆ operator<<() [19/45]

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

noexcept

Output stream operator for the PifConfig.

Parameters

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

Returns: used output stream.

◆ operator<<() [20/45]

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

noexcept

Output stream operator for PifDiConfig.

Parameters

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

Returns: used output stream.

◆ operator<<() [21/45]

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

noexcept

Output stream operator for PifDoConfig.

Parameters

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

Returns: used output stream.

◆ operator<<() [22/45]

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

noexcept

Output stream operator for PifFsConfig.

Parameters

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

Returns: used output stream.

◆ operator<<() [23/45]

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<<() [24/45]

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<<() [25/45]

OTC_SDK_API std::ostream & optris::operator<<	(	std::ostream &	out,
		const RadiationParameters &	radiation )

noexcept

Ouput stream operator for radiation parameters.

Parameters

[in]	out	stream to ouput to.
[in]	radiation	parameters to output.

Returns: used output stream.

◆ operator<<() [26/45]

template<typename T>

std::ostream & optris::operator<<	(	std::ostream &	out,
		const Range< T > &	range )

noexcept

Ouput stream operator for ranges.

Parameters

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

Returns: used output stream.

◆ operator<<() [27/45]

std::ostream & optris::operator<<	(	std::ostream &	out,
		const Slope &	slope )

inlinenoexcept

Output stream operator for Slope.

Parameters

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

Returns: used output stream.

◆ operator<<() [28/45]

OTC_SDK_API std::ostream & optris::operator<<	(	std::ostream &	out,
		const UncommittedValueStatus &	status )

Output stream operator for uncommitted value status.

Parameters

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

Returns: used output stream.

◆ operator<<() [29/45]

template<typename T>

std::ostream & optris::operator<<	(	std::ostream &	out,
		const Vector2< T > &	vector )

noexcept

Ouput stream operator for vectors.

Parameters

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

Returns: used output stream.

◆ operator<<() [30/45]

OTC_SDK_API std::ostream & optris::operator<<	(	std::ostream &	out,
		const Version &	version )

Ouput stream operator for Version objects.

Parameters

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

Returns: used output stream.

◆ operator<<() [31/45]

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<<() [32/45]

OTC_SDK_API std::ostream & optris::operator<<	(	std::ostream &	out,
		FieldShape	shape )

noexcept

Ouput stream operator for field shapes.

Parameters

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

Returns: used output stream.

◆ operator<<() [33/45]

OTC_SDK_API std::ostream & optris::operator<<	(	std::ostream &	out,
		FieldStat	stat )

noexcept

Ouput stream operator for field statistics.

Parameters

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

Returns: used output stream.

◆ operator<<() [34/45]

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.

◆ operator<<() [35/45]

OTC_SDK_API std::ostream & optris::operator<<	(	std::ostream &	out,
		PifAiMode	analogInputMode )

noexcept

Output stream operator for PIF analog input modes.

Parameters

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

Returns: used output stream.

◆ operator<<() [36/45]

OTC_SDK_API std::ostream & optris::operator<<	(	std::ostream &	out,
		PifAoMode	analogOutputMode )

noexcept

Output stream operator for PIF analog output modes.

Parameters

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

Returns: used output stream.

◆ operator<<() [37/45]

OTC_SDK_API std::ostream & optris::operator<<	(	std::ostream &	out,
		PifAoOutputMode	outputMode )

noexcept

Output stream operator for PIF analog output mode.

Parameters

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

Returns: used output stream.

◆ operator<<() [38/45]

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

noexcept

Output stream operator for PIF device types.

Parameters

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

Returns: used output stream.

◆ operator<<() [39/45]

OTC_SDK_API std::ostream & optris::operator<<	(	std::ostream &	out,
		PifDiMode	digitalInputMode )

noexcept

Output stream operator for PIF digital input modes.

Parameters

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

Returns: used output stream.

◆ operator<<() [40/45]

OTC_SDK_API std::ostream & optris::operator<<	(	std::ostream &	out,
		PifDoMode	digitalOutputMode )

noexcept

Output stream operator for PIF digital output modes.

Parameters

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

Returns: used output stream.

◆ operator<<() [41/45]

OTC_SDK_API std::ostream & optris::operator<<	(	std::ostream &	out,
		PifFsMode	failSafeMode )

noexcept

Output stream operator for PIF fail safe modes.

Parameters

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

Returns: used output stream.

◆ operator<<() [42/45]

OTC_SDK_API std::ostream & optris::operator<<	(	std::ostream &	out,
		PifIndex	index )

noexcept

Output stream operator for PIF indices.

Parameters

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

Returns: used output stream.

◆ operator<<() [43/45]

OTC_SDK_API std::ostream & optris::operator<<	(	std::ostream &	out,
		RadiationParameterSource	source )

noexcept

Ouput stream operator for radiation parameter sources.

Parameters

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

Returns: used output stream.

◆ operator<<() [44/45]

OTC_SDK_API std::ostream & optris::operator<<	(	std::ostream &	out,
		RdcMode	mode )

noexcept

Ouput stream operator for radial distortion correction modes.

Parameters

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

Returns: the output stream.

◆ operator<<() [45/45]

OTC_SDK_API std::ostream & optris::operator<<	(	std::ostream &	out,
		TemperaturePrecision	precision )

noexcept

Ouput stream operator for temperature precisions.

Parameters

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

Returns: used output stream.

◆ operator==() [1/4]

bool optris::operator==	(	const PifIndex &	lhs,
		const PifIndex &	rhs )

inlinenoexcept

Equality operator for PIF indices.

Parameters

[in]	lhs	left-hand side index.
[in]	rhs	right-hand side index.

Returns: true if the indices are equal, false otherwise.

◆ operator==() [2/4]

bool optris::operator==	(	const RadiationParameters &	lhs,
		const RadiationParameters &	rhs )

noexcept

Checks if two radiation parameter sets are equal.

Parameters

[in]	lhs	first radiation parameter set to compare.
[in]	rhs	second radiation parameter set to compare.

Returns: true, if the radiation parameter sets are equal.False otherwise.

◆ operator==() [3/4]

template<typename T>

bool optris::operator==	(	const Range< T > &	lhs,
		const Range< T > &	rhs )

inlinenoexcept

Checks if two ranges are equal.

Parameters

[in]	lhs	first range to compare.
[in]	rhs	second range to compare.

Returns: true, if the ranges are equal.False otherwise.

◆ operator==() [4/4]

template<typename T>

bool optris::operator==	(	const Vector2< T > &	lhs,
		const Vector2< T > &	rhs )

inlinenoexcept

Checks if two vectors are equal.

Parameters

[in]	lhs	first vector to compare.
[in]	rhs	second vector set to compare.

Returns: true, if the vectors are equal.False otherwise.

◆ toString() [1/20]

OTC_SDK_API std::string optris::toString ( AlarmInput alarmInput )

noexcept

Returns a string representation of the given alarm input.

Note: Use alarmInputToString() in Python instead.

Parameters

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

Returns: string respresentation of the given alarm input.

◆ toString() [2/20]

OTC_SDK_API std::string optris::toString ( AlarmRangeRelation alarmRangeRelation )

noexcept

Returns a string representation of the given alarm range relation.

Note: Use alarmRangeRelationToString() in Python instead.

Parameters

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

Returns: string respresentation of the given alarm range relation.

◆ toString() [3/20]

OTC_SDK_API std::string optris::toString ( AlarmState alarmState )

noexcept

Returns a string representation of the given alarm state.

Note: Use alarmStateToString() in Python instead.

Parameters

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

Returns: string respresentation of the given alarm state.

◆ toString() [4/20]

OTC_SDK_API std::string optris::toString ( ChipHeatingMode mode )

noexcept

Returns a string representation of the given chip heating mode.

Note: Use chipHeatingModeToString() in Python instead.

Parameters

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

Returns: string representation of the given chip heating mode.

◆ toString() [5/20]

OTC_SDK_API std::string optris::toString ( ConnectionState state )

noexcept

Returns a string representation of the given connection state.

Note: Use connectionStateToString() in Python instead.

Parameters

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

Returns: string representation of the given connection state.

◆ toString() [6/20]

OTC_SDK_API std::string optris::toString ( const PifIndex & index )

noexcept

Returns a string representation of the given PIF index.

Note: Use pifIndexToString() in Python instead.

Parameters

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

Returns: string representation of the given PIF index.

◆ toString() [7/20]

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

noexcept

Returns a string representation of the given device type.

Note: Use deviceTypeToString() in Python instead.

Parameters

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

Returns: string respresentation of the given device type.

◆ toString() [8/20]

OTC_SDK_API std::string optris::toString ( FieldShape shape )

noexcept

Returns a string representation of the given field shape.

Note: Use fieldShapeToString() in Python instead.

Parameters

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

Returns: string representation of the given field shape.

◆ toString() [9/20]

OTC_SDK_API std::string optris::toString ( FieldStat stat )

noexcept

Returns a string representation of the given field statistic.

Note: Use fieldStatToString() in Python instead.

Parameters

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

Returns: string representation of the given field statistic.

◆ toString() [10/20]

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

noexcept

Returns a string representation of the given flag state.

Note: Use flagStateToString() in Python instead.

Parameters

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

Returns: string representation of the given flag state.

◆ toString() [11/20]

OTC_SDK_API std::string optris::toString ( PifAiMode analogInputMode )

noexcept

Returns a string representation of the given PIF analog input mode.

Note: Use pifAiModeToString() in Python instead.

Parameters

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

Returns: string respresentation of the given PIF analog input mode.

◆ toString() [12/20]

OTC_SDK_API std::string optris::toString ( PifAoMode analogOutputMode )

noexcept

Returns a string representation of the given PIF analog output mode.

Note: Use pifAoModeToString() in Python instead.

Parameters

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

Returns: string respresentation of the given PIF analog output mode.

◆ toString() [13/20]

OTC_SDK_API std::string optris::toString ( PifAoOutputMode outputMode )

noexcept

Returns a string representation of the given PIF analog output mode.

Note: Use pifAoOutputModeToString() in Python instead.

Parameters

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

Returns: string respresentation of the given PIF analog output mode.

◆ toString() [14/20]

OTC_SDK_API std::string optris::toString ( PifDeviceType type )

noexcept

Returns a string representation of the given PIF device type.

Note: Use pifDeviceTypeToString() in Python instead.

Parameters

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

Returns: string respresentation of the given PIF device type.

◆ toString() [15/20]

OTC_SDK_API std::string optris::toString ( PifDiMode digitalInputMode )

noexcept

Returns a string representation of the given PIF digital input mode.

Note: Use pifDiModeToString() in Python instead.

Parameters

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

Returns: string respresentation of the given PIF digital input mode.

◆ toString() [16/20]

OTC_SDK_API std::string optris::toString ( PifDoMode digitalOutputMode )

noexcept

Returns a string representation of the given PIF digital output mode.

Note: Use pifDoModeToString() in Python instead.

Parameters

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

Returns: string respresentation of the given PIF digital output mode.

◆ toString() [17/20]

OTC_SDK_API std::string optris::toString ( PifFsMode failSafeMode )

noexcept

Returns a string representation of the given PIF fail safe mode.

Note: Use pifFsModeToString() in Python instead.

Parameters

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

Returns: string respresentation of the given PIF fail safe mode.

◆ toString() [18/20]

OTC_SDK_API std::string optris::toString ( RadiationParameterSource source )

noexcept

Returns a string representation of the given radiation parameter source.

Note: Use radiationParameterSourceToString() in Python instead.

Parameters

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

Returns: string representation of the given radiation parameter source.

◆ toString() [19/20]

OTC_SDK_API std::string optris::toString ( RdcMode mode )

noexcept

Returns a string representation of the given radial distortion correction mode.

Note: Use rdcModeToString() in Python instead.

Parameters

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

Returns: string representation of the given radial distortion correction mode.

◆ toString() [20/20]

OTC_SDK_API std::string optris::toString ( TemperaturePrecision precision )

noexcept

Returns a string representation of the given temperature precision.

Note: Use temperaturePrecisionToString() in Python instead.

Parameters

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

Returns: string respresentation of the given temperature precision.

◆ upperLimit()

OTC_SDK_API float optris::upperLimit ( PifAoOutputMode outputMode )

noexcept

Returns the upper limit of the specified PIF analog output mode as a number value.

Parameters

[in] outputMode for which the upper limit is desired.

Returns: upper limit of the specified PIF analog output mode as a number value.

Classes

Typedefs

Enumerations

Functions

Variables

Detailed Description

Enumeration Type Documentation

◆ AlarmInput

◆ AlarmRangeRelation

◆ AlarmState

◆ CalibrationFileSource

◆ ChipHeatingMode

◆ ColorFormat

◆ ConnectionState

◆ FieldShape

◆ FieldStat

◆ FlagState

◆ PifAiMode

◆ PifAoMode

◆ PifAoOutputMode

◆ PifDeviceType

◆ PifDiMode

◆ PifDoMode

◆ PifFsMode

◆ RadiationParameterSource

◆ RdcMode

◆ TemperaturePrecision

◆ TemperatureScalingMode

◆ Verbosity

◆ WidthAlignment

Function Documentation

◆ clampValue()

◆ getFieldStat()

◆ hasFocusMotor()

◆ is1MDevice()

◆ isAutonomousDevice()

◆ isDeviceAnsweringAllCommands()

◆ isEthernetDevice()

◆ isIn()

◆ isMTDevice()

◆ isPI()

◆ isXI()

◆ lowerLimit()

◆ operator!=() [1/4]

◆ operator!=() [2/4]

◆ operator!=() [3/4]

◆ operator!=() [4/4]

◆ operator+()

◆ operator-()

◆ operator<<() [1/45]

◆ operator<<() [2/45]

◆ operator<<() [3/45]

◆ operator<<() [4/45]

◆ operator<<() [5/45]

◆ operator<<() [6/45]

◆ operator<<() [7/45]

◆ operator<<() [8/45]

◆ operator<<() [9/45]

◆ operator<<() [10/45]

◆ operator<<() [11/45]

◆ operator<<() [12/45]

◆ operator<<() [13/45]

◆ operator<<() [14/45]

◆ operator<<() [15/45]

◆ operator<<() [16/45]

◆ operator<<() [17/45]

◆ operator<<() [18/45]

◆ operator<<() [19/45]

◆ operator<<() [20/45]

◆ operator<<() [21/45]

◆ operator<<() [22/45]

◆ operator<<() [23/45]

◆ operator<<() [24/45]

◆ operator<<() [25/45]

◆ operator<<() [26/45]

◆ operator<<() [27/45]

◆ operator<<() [28/45]

◆ operator<<() [29/45]

◆ operator<<() [30/45]

◆ operator<<() [31/45]