optris::PifAiConfig Struct Reference

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

#include <PifChannelConfigs.h>

Collaboration diagram for optris::PifAiConfig:

Static Public Member Functions
static OTC_SDK_API PifAiConfig	createOff (int deviceIndex, int pinIndex) noexcept
	Creates a configuration for the mode PifAiMode::Off.
static OTC_SDK_API PifAiConfig	createAmbientTemperature (int deviceIndex, int pinIndex, float gain, float offset) noexcept
	Creates a configuration for the mode PifAiMode::AmbientTemperature.
static OTC_SDK_API PifAiConfig	createEmissivity (int deviceIndex, int pinIndex, float gain, float offset) noexcept
	Creates a configuration for the mode PifAiMode::Emissivity.
static OTC_SDK_API PifAiConfig	createFlagControl (int deviceIndex, int pinIndex, float threshold, bool openIfLow) noexcept
	Creates a configuration for the mode PifAiMode::FlagControl.
static OTC_SDK_API PifAiConfig	createUncommittedValue (int deviceIndex, int pinIndex, const std::string &name, const std::string &unit, float gain, float offset) noexcept
	Creates a configuration for the mode PifAiMode::UncommittedValue.

Public Attributes
PifIndex	index = {0, 0}
	Identifies the channel by the indices of its pin and the PIF device on which it is located.
PifAiMode	mode = PifAiMode::Off
	Mode to be applied to the channel.
Slope	slope = {1.F, 0.F}
	Defines how input voltages are converted into the desired target values.
float	triggerThreshold = 0.F
	Trigger threshold for the input voltage.
bool	triggerLowActive = true
	Indicates whether the trigger will be pulled if the input voltage is below or above the threshold.
std::string	uncommittedValueName
	Name of the uncommitted value.
std::string	uncommittedValueUnit
	Unit of the uncommitted value.

Detailed Description

Encapsulates the configuration for a PIF analog input channel.

For a detailed overview of all available modes and parameters please refer to the corresponding section in the documentation of the configuration file.

Member Function Documentation

createAmbientTemperature()

static OTC_SDK_API PifAiConfig optris::PifAiConfig::createAmbientTemperature ( int deviceIndex, int pinIndex, float gain, float offset )

staticnoexcept

Creates a configuration for the mode PifAiMode::AmbientTemperature.

The input voltage U_in is converted to the ambient temperature t_ambient as follows:

t_ambient = (U_in - offset) / gain

Attention

This mode is unique and can only be applied once for all channels.

Parameters

[in]	deviceIndex	identifying the channel.
[in]	pinIndex	identifying the channel.
[in]	gain	for converting the input voltage into the ambient temperature.
[in]	offset	for converting the input voltage into the ambient temperature.

Returns

configuration for the mode PifAiMode::AmbientTemperature.

createEmissivity()

static OTC_SDK_API PifAiConfig optris::PifAiConfig::createEmissivity ( int deviceIndex, int pinIndex, float gain, float offset )

staticnoexcept

Creates a configuration for the mode PifAiMode::Emissivity.

The input voltage U_in is converted to the emissivity e as follows:

e = (U_in - offset) / gain

Attention

This mode is unique and can only be applied once for all channels.

Parameters

[in]	deviceIndex	identifying the channel.
[in]	pinIndex	identifying the channel.
[in]	gain	for converting the input voltage into the emissivity.
[in]	offset	for converting the input voltage into the emissivity.

Returns

configuration for the mode PifAiMode::Emissivity.

createFlagControl()

static OTC_SDK_API PifAiConfig optris::PifAiConfig::createFlagControl ( int deviceIndex, int pinIndex, float threshold, bool openIfLow )

staticnoexcept

Creates a configuration for the mode PifAiMode::FlagControl.

Attention

This mode is unique and can only be applied once for all channels.

Parameters

[in]	deviceIndex	identifying the channel.
[in]	pinIndex	identifying the channel.
[in]	threshold	voltage level.
[in]	openIfLow	if true, the shutter flag will be opened, if the input voltage is lower than the threshold.

Returns

configuration for the mode PifAiMode::FlagControl.

createOff()

static OTC_SDK_API PifAiConfig optris::PifAiConfig::createOff ( int deviceIndex, int pinIndex )

staticnoexcept

Creates a configuration for the mode PifAiMode::Off.

Parameters

[in]	deviceIndex	identifying the channel.
[in]	pinIndex	identifying the channel.

Returns

configuration for the mode PifAiMode::Off.

createUncommittedValue()

static OTC_SDK_API PifAiConfig optris::PifAiConfig::createUncommittedValue ( int deviceIndex, int pinIndex, const std::string & name, const std::string & unit, float gain, float offset )

staticnoexcept

Creates a configuration for the mode PifAiMode::UncommittedValue.

The input voltage U_in is converted to the uncommitted value x as follows:

x = (U_in - offset) / gain

When ever U_in changes the SDK will trigger the callback IRImagerClient::onPifUncommittedValue().

Parameters

[in]	deviceIndex	identifying the channel.
[in]	pinIndex	identifying the channel.
[in]	name	of the uncommitted value.
[in]	unit	of the uncommitted value.
[in]	gain	for converting the input voltage into the emissivity.
[in]	offset	for converting the input voltage into the emissivity.

Returns

configuration for the mode PifAiMode::UncommittedValue.

---

The documentation for this struct was generated from the following file:

• PifChannelConfigs.h