Atlas-Cronos  7.0.1
Public Member Functions | Static Public Attributes | Protected Member Functions | Properties | Events | List of all members
Flir.Atlas.Image.ThermalImage Class Reference

Specifies the base features for an ThermalImage. More...

Inheritance diagram for Flir.Atlas.Image.ThermalImage:
Flir.Atlas.Image.ImageBase Flir.Atlas.Image.Helpers.DisposableObject Flir.Atlas.Image.ThermalImageFile

Public Member Functions

override void SaveSnapshot (string filename, Bitmap overlay)
 Saves the current image to disk. More...
 
new void Dispose ()
 Releases all resources used by this Thermal-image. More...
 
override bool Create (string formatId, bool loadAll=true)
 Create the underlying format (internal use) More...
 
bool CreateFFF ()
 Create empty image. This is method is mainly for internal use. More...
 
new void SaveSnapshot (string filename)
 Saves the current image to disk. More...
 
ThermalValue GetValueAt (Point location)
 Gets a ThermalValue from a position in the Thermal Image. More...
 
int GetSignalFromOutput (double value)
 Extrapolate a signal value from an output value. More...
 
double GetValueFromSignal (int signal)
 Gets a temperature value from a signal. More...
 
double [] GetValues (Point[] points)
 Gets temperature values from an array of points. More...
 
double [] GetValues (Rectangle rectangle)
 Gets temperatures from a signal. More...
 
void GetValues (Rectangle rectangle, ref double [] data)
 Get values by reference to data buffer More...
 
double GetEmissivityFromValue (double temperatureMeasured, double actualTemperature)
 Calculates emissivity from a known temperature. More...
 
double GetEmissivityFromValue (int x, int y, double actualTemperature)
 Calculates emissivity from a known temperature. More...
 
double GetValueFromEmissivity (double emissivity, double temperature)
 Calculates temperature in current TemperatureUnit. More...
 
double CalculateEmissivity (double radiationMeasured, double? emissivityMeasured, double radiationKnown, double radiationReflected)
 Calculates the emissivity from reference temperature. More...
 
override void RenderTo (Flir.Atlas.Image.Interfaces.IPixels imagePixels)
 Render the new image to the input image buffer IPixels. More...
 
byte [,,] ImageArray ()
 Returns a byte array representing the image. More...
 
Bitmap Rotate (int angle)
 Rotate the image. !WARNING: The bitmap is created per-request, dispose when not needed! More...
 
void SetRotate (int angle)
 Rotate the image. More...
 
void SetSketch (bool value)
 Sets sketch on or off. More...
 
Bitmap GetPhoto ()
 Gets the embedded photo. More...
 
override void Copy (ImageBase src)
 Deep copy a ThermalImage from source except of pixel data. More...
 
- Public Member Functions inherited from Flir.Atlas.Image.ImageBase
virtual bool Load (byte[] image, int size)
 Loads a FFF image from memory More...
 
virtual bool Load (byte[] image)
 Loads an Thermal FFF Image from a byte array.
More...
 
virtual bool Load (byte[] image, ImageLoadParameters loadParams)
 Loads an Thermal FFF Image from a byte array.
More...
 
virtual byte [] GetData ()
 Get embedded radiometric data blob FFF. This method shall not be used for accessing the pixel data instead use the methods and properties found in ImageProcessing. More...
 
virtual byte [] GetFormattedImageData ()
 Get embedded radiometric data blob FFF with applied image data. This method shall not be used for accessing the pixel data instead use the methods and properties found in ImageProcessing. More...
 
virtual bool GetData (Stream stream)
 Get embedded radiometric data blob FFF. This method shall not be used for accessing the pixel data instead use the methods and properties found in ImageProcessing. More...
 
void SaveSnapshot (string filename)
 Saves the current image to disk. More...
 
void InternalSaveSnapshot (string filename, Bitmap overlay)
 
void Swap ()
 Manually swaps the image back buffer. More...
 
void EnterLock ()
 Acquires an exclusive lock. More...
 
bool TryEnterLock ()
 Attempts to acquire an exclusive lock. More...
 
void ExitLock ()
 Releases an exclusive lock. More...
 
virtual bool HasSketch ()
 Return true if the image has a sketch image. More...
 
bool IsSketchEnabled ()
 Return true if the image has a sketch image and it is enabled. More...
 
- Public Member Functions inherited from Flir.Atlas.Image.Helpers.DisposableObject
void Dispose ()
 

Static Public Attributes

static TemperatureUnit DefaultTemperatureUnit = TemperatureUnit.Celsius
 Gets or sets the default temperature unit used in all instances of ThermalImage More...
 
static DistanceUnit DefaultDistanceUnit = DistanceUnit.Meter
 Gets or sets the default distance unit used in all instances of ThermalImage More...
 

Protected Member Functions

virtual void Initialize ()
 Initializes the Thermal Image. More...
 
void SetupFusion ()
 Check if the image contains Fusion data and set up event handling More...
 
void SetColorDistribution (ColorDistribution value)
 Set color distribution. More...
 
void SetColorDistributionSettings (ColorDistributionSettings value)
 Set color distribution. More...
 
Rectangle GetZoomPosition (Rectangle rectPos, IFrame frame)
 Calculate the position of the rectangle in a zoomed in image. More...
 
Rectangle GetZoomPositionRotate (Rectangle rectPos, IFrame frame)
 Calculate the position of the rectangle in a zoomed in image. More...
 
void GetZoomAndPan (out float zoomFactor, out short panX, out short panY, IFrame frame)
 Gets the zoom and pan settings. More...
 
virtual void CurrentTemperature_UnitChanged (object sender, TemperatureUnitEventArgs e)
 Will be called whenever the temperatuer unit is changed. More...
 
override void RaiseChangedEvent ()
 Shall be raised for any changes made to the Thermal-image. More...
 
- Protected Member Functions inherited from Flir.Atlas.Image.ImageBase
override void DisposeManagedResources ()
 
- Protected Member Functions inherited from Flir.Atlas.Image.Helpers.DisposableObject
virtual void DisposeUnmanagedResources ()
 

Properties

Bitmap JpegImage [get, set]
 Gets or sets the jpeg representation of the Thermal image. More...
 
int OverflowSignalValue [get]
 Gets the overflow signal value. More...
 
int UnderflowSignalValue [get]
 Gets the underflow signal value. More...
 
int MinSignalValue [get]
 Gets the minimum signal value of the image. More...
 
int MaxSignalValue [get]
 Gets the maximum signal value of the image. More...
 
int Precision [get]
 Presentation precision gets number of decimals. More...
 
ZoomSettings Zoom [get]
 Image zoom settings. More...
 
ColorDistribution ColorDistribution [get, set]
 Gets or sets the Thermal image color distribution. More...
 
Calculator ThermalMeasurements [get]
 Calculate advanced measurements More...
 
ImageStatistics Statistics [get]
 Gets the image results ImageStatistics More...
 
ImageParameters ThermalParameters [get, protected set]
 Gets the image object parameters i.e. emissivity, distance etc. More...
 
TemperatureUnit TemperatureUnit [get, set]
 Gets or sets the temperature unit and will propagate a TemperatureUnitChanged event when changed. More...
 
DistanceUnit DistanceUnit [get, set]
 Gets or sets the distance unit. More...
 
CameraInformation CameraInformation [get, set]
 Gets information about the camera used to create this Thermal image. More...
 
Histogram Histogram [get]
 Gets the image Histogram. More...
 
MeasurementCollection Measurements [get]
 Gets the measurements collection. More...
 
TriggerData Trigger [get]
 Gets the trigger settings for this image. More...
 
Scale Scale [get, set]
 Gets the scale object. More...
 
Palettes.PaletteManager PaletteManager [get]
 Gets the palette object. More...
 
Palette Palette [get, set]
 Handle palette selections More...
 
IsothermCollection Isotherms [get]
 Gets the collection of isotherms. More...
 
AlarmCollection Alarms [get]
 Gets the collection of alarms. More...
 
Fusion.Fusion Fusion [get, protected set]
 Gets the Fusion object. More...
 
override Bitmap Image [get]
 Returns a System.Drawing.Bitmap representing the image. !WARNING: The bitmap is created per-request, dispose when not needed! More...
 
DateTime DateTime [get, set]
 Gets the image creation UTC date and time. More...
 
DateTime DateTaken [get]
 Gets the date and time when the image was shot/taken More...
 
Dictionary< string, string > TextAnnotations [get]
 Gets a collection of text annotation objects. Text annotations are Key, Value items i.e. Location – area 51. More...
 
SensorsCollection SensorsCollection [get]
 Gets a collection of sensor data objects. More...
 
VoiceAnnotation VoiceAnnotation [get]
 Gets the voice annotation object. More...
 
- Properties inherited from Flir.Atlas.Image.ImageBase
abstract Bitmap Image [get]
 Returns a System.Drawing.Bitmap representing the image. !WARNING: The bitmap is created per-request, dispose when not needed! More...
 
bool IsSilent [get, set]
 Set to true if no events is wanted from the image. More...
 
ImageProcessing.ImageProcessing ImageProcessing [get]
 Advanced image processing. More...
 
ThermalPipeline ThermalPipeline [get]
 Gets the pipeline Pipeline. More...
 
virtual int Width [get]
 Gets the width of the image in pixels. More...
 
virtual int Height [get]
 Gets the height of the image in pixels. More...
 
virtual Size Size [get]
 Gets the width and height of the image in pixels. More...
 
CompassInfo CompassInformation [get]
 Gets the compassInformation of the image. More...
 
Flir.Atlas.Image.GPSInfo GpsInformation [get]
 Gets the GPS information from the image. More...
 
virtual string Description [get, set]
 Gets or sets the image description from the Exif (Exchangeable image file format) data. More...
 
bool IsDisposed [get]
 True if this instance has been disposed More...
 
static string Version [get]
 Gets the used Atlas Image version. More...
 
- Properties inherited from Flir.Atlas.Image.Helpers.DisposableObject
bool Disposed [get]
 

Events

EventHandler< TemperatureUnitEventArgsTemperatureUnitChanged
 Occurs when the temperature unit is changed. More...
 
- Events inherited from Flir.Atlas.Image.ImageBase
EventHandler< ImageChangedEventArgsChanged
 Occurs when an image has changed e.g. needs to be updated. More...
 

Additional Inherited Members

- Protected Attributes inherited from Flir.Atlas.Image.ImageBase
ImageProcessing.ImageProcessing _imageProcessing
 
Cronos.IR.RotateFlipType _RotationAngle
 

Detailed Description

Specifies the base features for an ThermalImage.

Member Function Documentation

◆ CalculateEmissivity()

double Flir.Atlas.Image.ThermalImage.CalculateEmissivity ( double  radiationMeasured,
double?  emissivityMeasured,
double  radiationKnown,
double  radiationReflected 
)
inline

Calculates the emissivity from reference temperature.

Parameters
radiationMeasuredThe temperature measured in current TemperatureUnit.
emissivityMeasuredThe emissivity measured. If null then the emissivity of the image is used
radiationKnownThe known temperature in current TemperatureUnit.
radiationReflectedThe temperature ambient in current TemperatureUnit.
Returns
A calculated emissivity value.

Consider if the radiation value to be adjusted is close to ambient energy value.

"Energy value" may be the same as existance from object, object signal, etc.

◆ Copy()

override void Flir.Atlas.Image.ThermalImage.Copy ( ImageBase  src)
inlinevirtual

Deep copy a ThermalImage from source except of pixel data.

Parameters
srcThermalImage to copy from

Reimplemented from Flir.Atlas.Image.ImageBase.

◆ Create()

override bool Flir.Atlas.Image.ThermalImage.Create ( string  formatId,
bool  loadAll = true 
)
inlinevirtual

Create the underlying format (internal use)

Parameters
formatId
loadAll
Returns

Reimplemented from Flir.Atlas.Image.ImageBase.

◆ CreateFFF()

bool Flir.Atlas.Image.ThermalImage.CreateFFF ( )
inline

Create empty image. This is method is mainly for internal use.

Returns

◆ CurrentTemperature_UnitChanged()

virtual void Flir.Atlas.Image.ThermalImage.CurrentTemperature_UnitChanged ( object  sender,
TemperatureUnitEventArgs  e 
)
inlineprotectedvirtual

Will be called whenever the temperatuer unit is changed.

Parameters
senderThe sender
eThe temperature event argument

◆ Dispose()

new void Flir.Atlas.Image.ThermalImage.Dispose ( )
inline

Releases all resources used by this Thermal-image.

◆ GetEmissivityFromValue() [1/2]

double Flir.Atlas.Image.ThermalImage.GetEmissivityFromValue ( double  temperatureMeasured,
double  actualTemperature 
)
inline

Calculates emissivity from a known temperature.

Parameters
temperatureMeasuredThe temperature measured in current TemperatureUnit.
actualTemperatureThe known temperature in current TemperatureUnit.
Returns
A calculated emissivity value. Returns -1 if an error occurs

◆ GetEmissivityFromValue() [2/2]

double Flir.Atlas.Image.ThermalImage.GetEmissivityFromValue ( int  x,
int  y,
double  actualTemperature 
)
inline

Calculates emissivity from a known temperature.

Parameters
xThe temperature measured in current image at position x.
yThe temperature measured in current image at position y.
actualTemperatureThe known temperature in current TemperatureUnit.
Returns
A calculated emissivity value. Returns -1 if an error occurs

◆ GetPhoto()

Bitmap Flir.Atlas.Image.ThermalImage.GetPhoto ( )
inline

Gets the embedded photo.

Returns
The embedded photo, null if not available.

◆ GetSignalFromOutput()

int Flir.Atlas.Image.ThermalImage.GetSignalFromOutput ( double  value)
inline

Extrapolate a signal value from an output value.

Parameters
valueValue in current unit
Returns
Signal

◆ GetValueAt()

ThermalValue Flir.Atlas.Image.ThermalImage.GetValueAt ( Point  location)
inline

Gets a ThermalValue from a position in the Thermal Image.

Parameters
locationA point that specifies the location for the value to read.
Returns
The ThermalValue including value and stateThermalValue.

◆ GetValueFromEmissivity()

double Flir.Atlas.Image.ThermalImage.GetValueFromEmissivity ( double  emissivity,
double  temperature 
)
inline

Calculates temperature in current TemperatureUnit.

Parameters
emissivityThe known emissivity.
temperatureThe radiation as a signal value.
Returns
A calculated temperature value.

◆ GetValueFromSignal()

double Flir.Atlas.Image.ThermalImage.GetValueFromSignal ( int  signal)
inline

Gets a temperature value from a signal.

Parameters
signalSignal value
Returns
Temperature value

◆ GetValues() [1/3]

double [] Flir.Atlas.Image.ThermalImage.GetValues ( Point []  points)
inline

Gets temperature values from an array of points.

Parameters
pointsA list of points which specifies the location for the value to read
Returns
temperature value

◆ GetValues() [2/3]

double [] Flir.Atlas.Image.ThermalImage.GetValues ( Rectangle  rectangle)
inline

Gets temperatures from a signal.

Parameters
rectangleA rectangle which specifies the location for the value to be read
Returns
temperature values

◆ GetValues() [3/3]

void Flir.Atlas.Image.ThermalImage.GetValues ( Rectangle  rectangle,
ref double []  data 
)
inline

Get values by reference to data buffer

Parameters
rectangleA rectangle which specifies the location for the value to be read
data

◆ GetZoomAndPan()

void Flir.Atlas.Image.ThermalImage.GetZoomAndPan ( out float  zoomFactor,
out short  panX,
out short  panY,
IFrame  frame 
)
inlineprotected

Gets the zoom and pan settings.

Parameters
zoomFactorRetrieves the low zoomFactor value.
panXRetrieves the panX value.
panYRetrieves the panY value.
frameRetrieves the frame value.

◆ GetZoomPosition()

Rectangle Flir.Atlas.Image.ThermalImage.GetZoomPosition ( Rectangle  rectPos,
IFrame  frame 
)
inlineprotected

Calculate the position of the rectangle in a zoomed in image.

Parameters
rectPosrectangle in image
frameCurrent frame
Returns
Position in zoomed window.

◆ GetZoomPositionRotate()

Rectangle Flir.Atlas.Image.ThermalImage.GetZoomPositionRotate ( Rectangle  rectPos,
IFrame  frame 
)
inlineprotected

Calculate the position of the rectangle in a zoomed in image.

Parameters
rectPosrectangle in image
frameCurrent frame
Returns
Position in zoomed window not rotated.

◆ ImageArray()

byte [, ,] Flir.Atlas.Image.ThermalImage.ImageArray ( )
inline

Returns a byte array representing the image.

Returns
RGB byte array of the colorized image (3x8 bit)

◆ Initialize()

virtual void Flir.Atlas.Image.ThermalImage.Initialize ( )
inlineprotectedvirtual

Initializes the Thermal Image.

Reimplemented in Flir.Atlas.Image.ThermalImageFile.

◆ RaiseChangedEvent()

override void Flir.Atlas.Image.ThermalImage.RaiseChangedEvent ( )
inlineprotectedvirtual

Shall be raised for any changes made to the Thermal-image.

Reimplemented from Flir.Atlas.Image.ImageBase.

◆ RenderTo()

override void Flir.Atlas.Image.ThermalImage.RenderTo ( Flir.Atlas.Image.Interfaces.IPixels  imagePixels)
inlinevirtual

Render the new image to the input image buffer IPixels.

Parameters
imagePixelsImage buffer

Implements Flir.Atlas.Image.ImageBase.

◆ Rotate()

Bitmap Flir.Atlas.Image.ThermalImage.Rotate ( int  angle)
inline

Rotate the image. !WARNING: The bitmap is created per-request, dispose when not needed!

Parameters
angleThe angle can be +- 90, 180 or 270 degrees


Returns
Rotated image.

◆ SaveSnapshot() [1/2]

override void Flir.Atlas.Image.ThermalImage.SaveSnapshot ( string  filename,
Bitmap  overlay 
)
inlinevirtual

Saves the current image to disk.

Parameters
filenameA string that specifies the path to the location on which to save the file
overlayThe jpeg representation of the Thermal image.
Exceptions
System.ArgumentExceptionThe fileName is null or empty.
Flir.Atlas.Image.ThermalExceptionFailed to save Thermal image.

Reimplemented from Flir.Atlas.Image.ImageBase.

◆ SaveSnapshot() [2/2]

new void Flir.Atlas.Image.ThermalImage.SaveSnapshot ( string  filename)
inline

Saves the current image to disk.

Parameters
filenameA string that specifies the path to the location on which to save the file
Exceptions
System.ArgumentExceptionThe fileName is null or empty.
Flir.Atlas.Image.ThermalExceptionFailed to save Thermal image.

◆ SetColorDistribution()

void Flir.Atlas.Image.ThermalImage.SetColorDistribution ( ColorDistribution  value)
inlineprotected

Set color distribution.

Parameters
value
Exceptions
ArgumentOutOfRangeException

◆ SetColorDistributionSettings()

void Flir.Atlas.Image.ThermalImage.SetColorDistributionSettings ( ColorDistributionSettings  value)
inlineprotected

Set color distribution.

Parameters
value
Exceptions
ArgumentOutOfRangeException

◆ SetRotate()

void Flir.Atlas.Image.ThermalImage.SetRotate ( int  angle)
inline

Rotate the image.

Changes are applied when the image bitmap is recalled.

Parameters
angleThe angle can be +- 90, 180 or 270 degrees

◆ SetSketch()

void Flir.Atlas.Image.ThermalImage.SetSketch ( bool  value)
inline

Sets sketch on or off.

◆ SetupFusion()

void Flir.Atlas.Image.ThermalImage.SetupFusion ( )
inlineprotected

Check if the image contains Fusion data and set up event handling

Member Data Documentation

◆ DefaultDistanceUnit

DistanceUnit Flir.Atlas.Image.ThermalImage.DefaultDistanceUnit = DistanceUnit.Meter
static

Gets or sets the default distance unit used in all instances of ThermalImage

◆ DefaultTemperatureUnit

TemperatureUnit Flir.Atlas.Image.ThermalImage.DefaultTemperatureUnit = TemperatureUnit.Celsius
static

Gets or sets the default temperature unit used in all instances of ThermalImage

Property Documentation

◆ Alarms

AlarmCollection Flir.Atlas.Image.ThermalImage.Alarms
get

Gets the collection of alarms.

◆ CameraInformation

CameraInformation Flir.Atlas.Image.ThermalImage.CameraInformation
getset

Gets information about the camera used to create this Thermal image.

◆ ColorDistribution

ColorDistribution Flir.Atlas.Image.ThermalImage.ColorDistribution
getset

Gets or sets the Thermal image color distribution.

◆ DateTaken

DateTime Flir.Atlas.Image.ThermalImage.DateTaken
get

Gets the date and time when the image was shot/taken

◆ DateTime

DateTime Flir.Atlas.Image.ThermalImage.DateTime
getset

Gets the image creation UTC date and time.

◆ DistanceUnit

DistanceUnit Flir.Atlas.Image.ThermalImage.DistanceUnit
getset

Gets or sets the distance unit.

Exceptions
System.ArgumentOutOfRangeExceptionSetting of distance unit is out of range.

◆ Fusion

Fusion.Fusion Flir.Atlas.Image.ThermalImage.Fusion
getprotected set

Gets the Fusion object.

◆ Histogram

Histogram Flir.Atlas.Image.ThermalImage.Histogram
get

Gets the image Histogram.

◆ Image

override Bitmap Flir.Atlas.Image.ThermalImage.Image
get

Returns a System.Drawing.Bitmap representing the image. !WARNING: The bitmap is created per-request, dispose when not needed!

◆ Isotherms

IsothermCollection Flir.Atlas.Image.ThermalImage.Isotherms
get

Gets the collection of isotherms.

◆ JpegImage

Bitmap Flir.Atlas.Image.ThermalImage.JpegImage
getsetprotected

Gets or sets the jpeg representation of the Thermal image.

This is the image that will be seen when viewing the Thermal image in Windows Explorer or an external image viewer. Only works with jpeg images.

◆ MaxSignalValue

int Flir.Atlas.Image.ThermalImage.MaxSignalValue
get

Gets the maximum signal value of the image.

◆ Measurements

MeasurementCollection Flir.Atlas.Image.ThermalImage.Measurements
get

Gets the measurements collection.

◆ MinSignalValue

int Flir.Atlas.Image.ThermalImage.MinSignalValue
get

Gets the minimum signal value of the image.

◆ OverflowSignalValue

int Flir.Atlas.Image.ThermalImage.OverflowSignalValue
get

Gets the overflow signal value.

◆ Palette

Palette Flir.Atlas.Image.ThermalImage.Palette
getset

Handle palette selections

◆ PaletteManager

Palettes.PaletteManager Flir.Atlas.Image.ThermalImage.PaletteManager
get

Gets the palette object.

◆ Precision

int Flir.Atlas.Image.ThermalImage.Precision
get

Presentation precision gets number of decimals.

◆ Scale

Scale Flir.Atlas.Image.ThermalImage.Scale
getset

Gets the scale object.

◆ SensorsCollection

SensorsCollection Flir.Atlas.Image.ThermalImage.SensorsCollection
get

Gets a collection of sensor data objects.

◆ Statistics

ImageStatistics Flir.Atlas.Image.ThermalImage.Statistics
get

Gets the image results ImageStatistics

◆ TemperatureUnit

TemperatureUnit Flir.Atlas.Image.ThermalImage.TemperatureUnit
getset

Gets or sets the temperature unit and will propagate a TemperatureUnitChanged event when changed.

◆ TextAnnotations

Dictionary<string, string> Flir.Atlas.Image.ThermalImage.TextAnnotations
get

Gets a collection of text annotation objects. Text annotations are Key, Value items i.e. Location – area 51.

◆ ThermalMeasurements

Calculator Flir.Atlas.Image.ThermalImage.ThermalMeasurements
get

Calculate advanced measurements

◆ ThermalParameters

ImageParameters Flir.Atlas.Image.ThermalImage.ThermalParameters
getprotected set

Gets the image object parameters i.e. emissivity, distance etc.

◆ Trigger

TriggerData Flir.Atlas.Image.ThermalImage.Trigger
get

Gets the trigger settings for this image.

◆ UnderflowSignalValue

int Flir.Atlas.Image.ThermalImage.UnderflowSignalValue
get

Gets the underflow signal value.

◆ VoiceAnnotation

VoiceAnnotation Flir.Atlas.Image.ThermalImage.VoiceAnnotation
get

Gets the voice annotation object.

null if there is no voice annotation.

◆ Zoom

ZoomSettings Flir.Atlas.Image.ThermalImage.Zoom
get

Image zoom settings.

Event Documentation

◆ TemperatureUnitChanged

EventHandler<TemperatureUnitEventArgs> Flir.Atlas.Image.ThermalImage.TemperatureUnitChanged

Occurs when the temperature unit is changed.