Atlas-Cronos 7.6.0
Loading...
Searching...
No Matches
Public Member Functions | List of all members
Flir.Atlas.Live.Remote.RemoteCameraSettings Class Reference

Public Member Functions

Range< double >[] EnumerateTemperatureRanges ()
 Array of temperature ranges (in Kelvin). Use this method to determine the number of available temperature ranges. Use the array index to modify the temperature range SetTemperatureRangeIndex.
 
void SetTemperatureRangeIndex (int index)
 Set Temperature range index EnumerateTemperatureRanges for a list of ranges.
 
int GetTemperatureRangeIndex ()
 Current selected temperature range index.
 
void SetPaletteByName (string name)
 Select palette by name i.e. iron.pal.
 
string GetPaletteName ()
 Get current palette name.
 
bool IsBatteryCharging ()
 Check if the camera battery is charging.
 
int GetTimeUntilCameraIsReady ()
 Time in seconds until the camera is cooled down. Cooled cameras i.e. GF300a needs time until cooled down before streaming can be started.
 
VideoMode GetVideoMode ()
 Get camera video mode (PAL or NTSC).
 
void SetVideoMode (VideoMode mode)
 Set camera video mode (PAL or NTSC).
 
TemperatureUnit GetTemperatureUnit ()
 Get used temperature unit from the camera.
 
void SetTemperatureUnit (TemperatureUnit unit)
 Set display temperature unit in the camera.
 
DistanceUnit GetDistanceUnit ()
 Get distance unit used in the camera.
 
void SetDistanceUnit (DistanceUnit unit)
 Set distance unit used in the camera.
 
double GetExternalOpticsTemperature ()
 External optics temperature (in Kelvin). Range 0 - 5000.
 
void SetExternalOpticsTemperature (double value)
 External optics temperature (in Kelvin). Range 0 - 5000.
 
double GetReferenceTemperature ()
 Reference temperature (in Kelvin). Range 0 - 5000.
 
void SetReferenceTemperature (double value)
 Reference temperature (in Kelvin). Range 0 - 5000.
 
double GetAtmosphericTemperature ()
 Atmospheric temperature (in Kelvin). Range 0 - 5000.
 
void SetAtmosphericTemperature (double value)
 Atmospheric temperature (in Kelvin). Range 0 - 5000.
 
double GetReflectedTemperature ()
 ReflectedTemperature temperature (in Kelvin). Range 0 - 5000.
 
void SetReflectedTemperature (double value)
 ReflectedTemperature temperature (in Kelvin). Range 0 - 5000.
 
void SetScaleAdjustMode (ScaleAdjustMode mode)
 Set scale adjust mode.
 
void SetScaleAdjustEnabled (bool value)
 Enable/Disable the adjust mode.
 
bool GetIsScaleAdjustEnabled ()
 Get if the scale adjust is active.
 
ScaleAdjustMode GetScaleAdjustMode ()
 Get scale adjust mode.
 
Range< double > GetScaleLimits ()
 Get scale range.
 
void SetScaleLimits (Range< double > limits)
 Scale temperature (in Kelvin). Range 0 - 5000.
 
double GetObjectDistance ()
 Object distance (in meter). Range 0 - 10000.
 
void SetObjectDistance (double value)
 Object distance (in meter). Range 0 - 10000.
 
double GetObjectEmissivity ()
 Object emissivity. Range 0.01 - 1.00.
 
void SetObjectEmissivity (double value)
 Object emissivity. Range 0.01 - 1.00.
 
double GetRelativeHumidity ()
 Relative humidity (in percentage). Range 0 - 100%.
 
void SetRelativeHumidity (double value)
 Relative humidity (in percentage). Range 0.1 - 100.0%.
 
double GetExternalOpticsTransmission ()
 External optics transmission (in percentage). Range 0.1 - 100.0%.
 
void SetExternalOpticsTransmission (double value)
 External optics transmission (in percentage). Range 0.1 - 100.0%.
 
double GetZoomFactor ()
 Zoom factor range.
 
void SetZoomFactor (double value)
 Zoom factor range.
 
bool IsShutterSupported ()
 Check if shutter is supported.
 
bool IsShutterEnabled ()
 Check if shutter is enabled.
 
void SetShutterEnabled (bool enable)
 Enable or disable shutter.
 
bool IsHighSensitivityModeSupported ()
 Check if the camera supports High Sensitivity Mode.
 
bool IsHighSensitivityModeEnabled ()
 Check if High Sensitivity Mode is enabled.
 
void SetHighSensitivityModeEnabled (bool enable)
 Enable or disable High Sensitivity Mode.
 
bool GetIsExtOptTransmAltActive ()
 Check if external optics (window) is activated.
 
void SetIsExtOptTransmAltActive (bool isEnabled)
 Enable or disable external optics (window)
 
bool GetSendLensTemp ()
 Check if a virtual temperature sensor is active. This virtual temp sensor estimates a window temperature value based on the camera internal temperature. Not working well for current GF77a as of Sept 2021 but works for A4/5/7xx series sold with housing.
 
void SetSendLensTemp (bool value)
 Enable/disable virtual temperature sensor. This virtual temp sensor estimates a window temperature value based on the camera internal temperature. Not working well for current GF77a as of Sept 2021 but works for A4/5/7xx series sold with housing.
 
double GetExtOptTransmAltVal ()
 Get external optics (window) transmission.
 
void SetExtOptTransAltVal (double value)
 Set external optics (window) transmission.
 
void SetTLensExt (double value)
 Set external temperature sensor (sets the external optics/ window temperature)
 
double GetTLensExt ()
 Get external temperature sensor (gets the external optics/ window temperature)
 

Member Function Documentation

◆ EnumerateTemperatureRanges()

Range< double >[] Flir.Atlas.Live.Remote.RemoteCameraSettings.EnumerateTemperatureRanges ( )
inline

Array of temperature ranges (in Kelvin). Use this method to determine the number of available temperature ranges. Use the array index to modify the temperature range SetTemperatureRangeIndex.

Returns
Array of temperature ranges.
Exceptions
InvalidOperationException
CommandFailedException
ArgumentException
Examples
var ranges = _camera.RemoteControl.CameraSettings.EnumerateTemperatureRanges();
if (ranges.Any())
{
foreach (var enumerateTemperatureRange in ranges)
{
string value = string.Format("{0:F};{1:F}", enumerateTemperatureRange.Minimum, enumerateTemperatureRange.Maximum);
comboBoxTempRanges.Items.Add(value);
}
int index = _camera.RemoteControl.CameraSettings.GetTemperatureRangeIndex();
if (index \>= 0)
{
comboBoxTempRanges.SelectedIndex = index;
}
comboBoxTempRanges.Enabled = true;
}

◆ GetAtmosphericTemperature()

double Flir.Atlas.Live.Remote.RemoteCameraSettings.GetAtmosphericTemperature ( )
inline

Atmospheric temperature (in Kelvin). Range 0 - 5000.

Returns
Reference temperature.
Exceptions
InvalidOperationException
CommandFailedException

◆ GetDistanceUnit()

DistanceUnit Flir.Atlas.Live.Remote.RemoteCameraSettings.GetDistanceUnit ( )
inline

Get distance unit used in the camera.

Returns
Used distance unit in the camera.
Exceptions
InvalidOperationException
CommandFailedException

◆ GetExternalOpticsTemperature()

double Flir.Atlas.Live.Remote.RemoteCameraSettings.GetExternalOpticsTemperature ( )
inline

External optics temperature (in Kelvin). Range 0 - 5000.

Returns
External optics temperature.
Exceptions
InvalidOperationException
CommandFailedException

◆ GetExternalOpticsTransmission()

double Flir.Atlas.Live.Remote.RemoteCameraSettings.GetExternalOpticsTransmission ( )
inline

External optics transmission (in percentage). Range 0.1 - 100.0%.

Returns
Transmission.
Exceptions
InvalidOperationException
CommandFailedException

◆ GetExtOptTransmAltVal()

double Flir.Atlas.Live.Remote.RemoteCameraSettings.GetExtOptTransmAltVal ( )
inline

Get external optics (window) transmission.

Returns
The external optics transmission

◆ GetIsExtOptTransmAltActive()

bool Flir.Atlas.Live.Remote.RemoteCameraSettings.GetIsExtOptTransmAltActive ( )
inline

Check if external optics (window) is activated.

Returns
true if active

◆ GetIsScaleAdjustEnabled()

bool Flir.Atlas.Live.Remote.RemoteCameraSettings.GetIsScaleAdjustEnabled ( )
inline

Get if the scale adjust is active.

Returns
true if active

◆ GetObjectDistance()

double Flir.Atlas.Live.Remote.RemoteCameraSettings.GetObjectDistance ( )
inline

Object distance (in meter). Range 0 - 10000.

Returns
Distance in meter.
Exceptions
InvalidOperationException
CommandFailedException

◆ GetObjectEmissivity()

double Flir.Atlas.Live.Remote.RemoteCameraSettings.GetObjectEmissivity ( )
inline

Object emissivity. Range 0.01 - 1.00.

Returns
Emissivity.
Exceptions
InvalidOperationException
CommandFailedException

◆ GetPaletteName()

string Flir.Atlas.Live.Remote.RemoteCameraSettings.GetPaletteName ( )
inline

Get current palette name.

Returns
The palette name.
Exceptions
InvalidOperationException
CommandFailedException

◆ GetReferenceTemperature()

double Flir.Atlas.Live.Remote.RemoteCameraSettings.GetReferenceTemperature ( )
inline

Reference temperature (in Kelvin). Range 0 - 5000.

Returns
Reference temperature.
Exceptions
InvalidOperationException
CommandFailedException

◆ GetReflectedTemperature()

double Flir.Atlas.Live.Remote.RemoteCameraSettings.GetReflectedTemperature ( )
inline

ReflectedTemperature temperature (in Kelvin). Range 0 - 5000.

Returns
Reference temperature.
Exceptions
InvalidOperationException
CommandFailedException

◆ GetRelativeHumidity()

double Flir.Atlas.Live.Remote.RemoteCameraSettings.GetRelativeHumidity ( )
inline

Relative humidity (in percentage). Range 0 - 100%.

Returns
Humidity.
Exceptions
InvalidOperationException
CommandFailedException

◆ GetScaleAdjustMode()

ScaleAdjustMode Flir.Atlas.Live.Remote.RemoteCameraSettings.GetScaleAdjustMode ( )
inline

Get scale adjust mode.

Returns
Exceptions
InvalidOperationException
CommandFailedException

◆ GetScaleLimits()

Range< double > Flir.Atlas.Live.Remote.RemoteCameraSettings.GetScaleLimits ( )
inline

Get scale range.

Returns
Scale limits.
Exceptions
InvalidOperationException
CommandFailedException

◆ GetSendLensTemp()

bool Flir.Atlas.Live.Remote.RemoteCameraSettings.GetSendLensTemp ( )
inline

Check if a virtual temperature sensor is active. This virtual temp sensor estimates a window temperature value based on the camera internal temperature. Not working well for current GF77a as of Sept 2021 but works for A4/5/7xx series sold with housing.

Returns
True if virtual sensor is activated.

◆ GetTemperatureRangeIndex()

int Flir.Atlas.Live.Remote.RemoteCameraSettings.GetTemperatureRangeIndex ( )
inline

Current selected temperature range index.

Returns
Zero based index.
Exceptions
InvalidOperationException
CommandFailedException

◆ GetTemperatureUnit()

TemperatureUnit Flir.Atlas.Live.Remote.RemoteCameraSettings.GetTemperatureUnit ( )
inline

Get used temperature unit from the camera.

Returns
Exceptions
InvalidOperationException
CommandFailedException

◆ GetTimeUntilCameraIsReady()

int Flir.Atlas.Live.Remote.RemoteCameraSettings.GetTimeUntilCameraIsReady ( )
inline

Time in seconds until the camera is cooled down. Cooled cameras i.e. GF300a needs time until cooled down before streaming can be started.

Returns

◆ GetTLensExt()

double Flir.Atlas.Live.Remote.RemoteCameraSettings.GetTLensExt ( )
inline

Get external temperature sensor (gets the external optics/ window temperature)

Returns
the external temperature

There is two ways of setting the window temperature to ensure that the effect of the thermal radiation for the window is taken into account for to ensure good measurement accuracy.

  1. Using a virtual temperature sensor to estimate the window temperature, see Get/SetSendLensTemp.This feature will be supported when we release the housing for GF77a and will be for all GF77a sold from that point and onwards.
  2. Setting the temperature via Atlas SDK using SetTLensExt. This allows you to yourself estimate the window temperature and set it yourself. For both cases, the transmission of the window must be set via SetExtOptTransAltVal

◆ GetVideoMode()

VideoMode Flir.Atlas.Live.Remote.RemoteCameraSettings.GetVideoMode ( )
inline

Get camera video mode (PAL or NTSC).

Returns
Current video mode.
Exceptions
InvalidOperationException
CommandFailedException

◆ GetZoomFactor()

double Flir.Atlas.Live.Remote.RemoteCameraSettings.GetZoomFactor ( )
inline

Zoom factor range.

Returns
Zoom factor.
Exceptions
InvalidOperationException
CommandFailedException

◆ IsBatteryCharging()

bool Flir.Atlas.Live.Remote.RemoteCameraSettings.IsBatteryCharging ( )
inline

Check if the camera battery is charging.

Returns
true if charging.
Exceptions
InvalidOperationException
CommandFailedException

◆ IsHighSensitivityModeEnabled()

bool Flir.Atlas.Live.Remote.RemoteCameraSettings.IsHighSensitivityModeEnabled ( )
inline

Check if High Sensitivity Mode is enabled.

Returns
true if HSM is enabled.
Exceptions
InvalidOperationException
CommandFailedException

◆ IsHighSensitivityModeSupported()

bool Flir.Atlas.Live.Remote.RemoteCameraSettings.IsHighSensitivityModeSupported ( )
inline

Check if the camera supports High Sensitivity Mode.

Returns
Exceptions
InvalidOperationException
CommandFailedException

◆ IsShutterEnabled()

bool Flir.Atlas.Live.Remote.RemoteCameraSettings.IsShutterEnabled ( )
inline

Check if shutter is enabled.

Returns
true if shutter is enabled.
Exceptions
InvalidOperationException
CommandFailedException

◆ IsShutterSupported()

bool Flir.Atlas.Live.Remote.RemoteCameraSettings.IsShutterSupported ( )
inline

Check if shutter is supported.

Returns
true if shutter is supported.
Exceptions
InvalidOperationException
CommandFailedException

◆ SetAtmosphericTemperature()

void Flir.Atlas.Live.Remote.RemoteCameraSettings.SetAtmosphericTemperature ( double value)
inline

Atmospheric temperature (in Kelvin). Range 0 - 5000.

Parameters
valueTemperature in Kelvin.
Exceptions
InvalidOperationException

◆ SetDistanceUnit()

void Flir.Atlas.Live.Remote.RemoteCameraSettings.SetDistanceUnit ( DistanceUnit unit)
inline

Set distance unit used in the camera.

Parameters
unit
Exceptions
ArgumentOutOfRangeException
InvalidOperationException

◆ SetExternalOpticsTemperature()

void Flir.Atlas.Live.Remote.RemoteCameraSettings.SetExternalOpticsTemperature ( double value)
inline

External optics temperature (in Kelvin). Range 0 - 5000.

Parameters
valueTemperature in Kelvin.
Exceptions
InvalidOperationException

◆ SetExternalOpticsTransmission()

void Flir.Atlas.Live.Remote.RemoteCameraSettings.SetExternalOpticsTransmission ( double value)
inline

External optics transmission (in percentage). Range 0.1 - 100.0%.

Parameters
valueTransmission.
Exceptions
InvalidOperationException

◆ SetExtOptTransAltVal()

void Flir.Atlas.Live.Remote.RemoteCameraSettings.SetExtOptTransAltVal ( double value)
inline

Set external optics (window) transmission.

Parameters
valuerange between 0.1 to 1.0

◆ SetHighSensitivityModeEnabled()

void Flir.Atlas.Live.Remote.RemoteCameraSettings.SetHighSensitivityModeEnabled ( bool enable)
inline

Enable or disable High Sensitivity Mode.

Parameters
enableenable or disable HSM
Exceptions
InvalidOperationException

◆ SetIsExtOptTransmAltActive()

void Flir.Atlas.Live.Remote.RemoteCameraSettings.SetIsExtOptTransmAltActive ( bool isEnabled)
inline

Enable or disable external optics (window)

Returns
true if active

◆ SetObjectDistance()

void Flir.Atlas.Live.Remote.RemoteCameraSettings.SetObjectDistance ( double value)
inline

Object distance (in meter). Range 0 - 10000.

Parameters
valueDistance in meter.
Exceptions
InvalidOperationException

◆ SetObjectEmissivity()

void Flir.Atlas.Live.Remote.RemoteCameraSettings.SetObjectEmissivity ( double value)
inline

Object emissivity. Range 0.01 - 1.00.

Parameters
valueEmissivity.
Exceptions
InvalidOperationException

◆ SetPaletteByName()

void Flir.Atlas.Live.Remote.RemoteCameraSettings.SetPaletteByName ( string name)
inline

Select palette by name i.e. iron.pal.

Parameters
namepalette filename in the camera.
Exceptions
InvalidOperationException

◆ SetReferenceTemperature()

void Flir.Atlas.Live.Remote.RemoteCameraSettings.SetReferenceTemperature ( double value)
inline

Reference temperature (in Kelvin). Range 0 - 5000.

Parameters
valueTemperature in Kelvin.
Exceptions
InvalidOperationException

◆ SetReflectedTemperature()

void Flir.Atlas.Live.Remote.RemoteCameraSettings.SetReflectedTemperature ( double value)
inline

ReflectedTemperature temperature (in Kelvin). Range 0 - 5000.

Parameters
valueTemperature in Kelvin.
Exceptions
InvalidOperationException

◆ SetRelativeHumidity()

void Flir.Atlas.Live.Remote.RemoteCameraSettings.SetRelativeHumidity ( double value)
inline

Relative humidity (in percentage). Range 0.1 - 100.0%.

Parameters
valueHumidity.
Exceptions
InvalidOperationException

◆ SetScaleAdjustEnabled()

void Flir.Atlas.Live.Remote.RemoteCameraSettings.SetScaleAdjustEnabled ( bool value)
inline

Enable/Disable the adjust mode.

Parameters
value

◆ SetScaleAdjustMode()

void Flir.Atlas.Live.Remote.RemoteCameraSettings.SetScaleAdjustMode ( ScaleAdjustMode mode)
inline

Set scale adjust mode.

Parameters
mode
Exceptions
InvalidOperationException
ArgumentOutOfRangeException

◆ SetScaleLimits()

void Flir.Atlas.Live.Remote.RemoteCameraSettings.SetScaleLimits ( Range< double > limits)
inline

Scale temperature (in Kelvin). Range 0 - 5000.

Parameters
limitsTemperature in Kelvin.
Exceptions
InvalidOperationException

◆ SetSendLensTemp()

void Flir.Atlas.Live.Remote.RemoteCameraSettings.SetSendLensTemp ( bool value)
inline

Enable/disable virtual temperature sensor. This virtual temp sensor estimates a window temperature value based on the camera internal temperature. Not working well for current GF77a as of Sept 2021 but works for A4/5/7xx series sold with housing.

Parameters
valueset to true if virtual sensor shall be activated or false to deactivate.

◆ SetShutterEnabled()

void Flir.Atlas.Live.Remote.RemoteCameraSettings.SetShutterEnabled ( bool enable)
inline

Enable or disable shutter.

Parameters
enableset to true if the shutter shall be enabled.
Exceptions
InvalidOperationException

◆ SetTemperatureRangeIndex()

void Flir.Atlas.Live.Remote.RemoteCameraSettings.SetTemperatureRangeIndex ( int index)
inline

Set Temperature range index EnumerateTemperatureRanges for a list of ranges.

Parameters
indexZero based index.
Exceptions
InvalidOperationException

◆ SetTemperatureUnit()

void Flir.Atlas.Live.Remote.RemoteCameraSettings.SetTemperatureUnit ( TemperatureUnit unit)
inline

Set display temperature unit in the camera.

Parameters
unitFahrenheit or Celsius are supported values for temperature unit.
Exceptions
InvalidOperationException

◆ SetTLensExt()

void Flir.Atlas.Live.Remote.RemoteCameraSettings.SetTLensExt ( double value)
inline

Set external temperature sensor (sets the external optics/ window temperature)

Parameters
valuevalue in Kelvin

There is two ways of setting the window temperature to ensure that the effect of the thermal radiation for the window is taken into account for to ensure good measurement accuracy.

  1. Using a virtual temperature sensor to estimate the window temperature, see Get/SetSendLensTemp.This feature will be supported when we release the housing for GF77a and will be for all GF77a sold from that point and onwards.
  2. Setting the temperature via Atlas SDK using SetTLensExt. This allows you to yourself estimate the window temperature and set it yourself. For both cases, the transmission of the window must be set via SetExtOptTransAltVal

◆ SetVideoMode()

void Flir.Atlas.Live.Remote.RemoteCameraSettings.SetVideoMode ( VideoMode mode)
inline

Set camera video mode (PAL or NTSC).

Parameters
mode
Exceptions
ArgumentOutOfRangeException
InvalidOperationException

◆ SetZoomFactor()

void Flir.Atlas.Live.Remote.RemoteCameraSettings.SetZoomFactor ( double value)
inline

Zoom factor range.

Parameters
valueZoom factor.

See camera documentation for valid range.

Exceptions
InvalidOperationException