Base class for all FLIR images. More...

Inheritance diagram for Flir.Atlas.Image.ImageBase:

Public Member Functions
virtual void	Copy (ImageBase src)
	Deep copy an ImageBase from source except of pixel data. More...

virtual bool	Create (string formatId, bool loadAll=true)
	Create the underlying format (internal use) More...

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

virtual void	SaveSnapshot (string filename, Bitmap overlay)
	Saves the current image to disk. More...

void	InternalSaveSnapshot (string filename, Bitmap overlay)

void	Swap ()
	Manually swaps the image back buffer. More...

abstract void	RenderTo (Flir.Atlas.Image.Interfaces.IPixels imagePixels)
	Render the image to IPixels. BitmapSourceWrapper for advanced rendering. 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 ()

Public Attributes
ImageProcessing.ImageProcessing	ImageProcessing => _imageProcessing
	Advanced image processing. More...

virtual int	Width => (FindSize()).Width
	Gets the width of the image in pixels. More...

virtual int	Height => (FindSize()).Height
	Gets the height of the image in pixels. More...

virtual Size	Size => FindSize()
	Gets the width and height of the image in pixels. More...

bool	IsDisposed => Disposed
	True if this instance has been disposed More...

Protected Member Functions
override void	DisposeManagedResources ()

virtual void	RaiseChangedEvent ()
	Fires the Image Changed event. More...

Protected Member Functions inherited from Flir.Atlas.Image.Helpers.DisposableObject
virtual void	DisposeUnmanagedResources ()

Protected Attributes
ImageProcessing.ImageProcessing	_imageProcessing

Cronos.IR.RotateFlipType	_RotationAngle

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

ThermalPipeline	ThermalPipeline `[get]`
	Gets the pipeline Pipeline. More...

CompassInfo	CompassInformation `[get]`
	Gets the compassInformation of the image. More...

GPSInfo	GpsInformation `[get]`
	Gets the GPS information from the image. More...

GasQuantificationInput	GasQuantificationInput `[get]`
	Gets the Quantification input from the image. More...

GasQuantificationResult	GasQuantificationResult `[get]`
	Gets the Quantification result from the image. More...

virtual string	Description `[get, set]`
	Gets or sets the image description from the Exif (Exchangeable image file format) data. 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< ImageChangedEventArgs >	Changed
	Occurs when an image has changed e.g. needs to be updated. More...

Detailed Description

Base class for all FLIR images.

Member Function Documentation

◆ Copy()

virtual void Flir.Atlas.Image.ImageBase.Copy ( ImageBase src )

inlinevirtual

Deep copy an ImageBase from source except of pixel data.

Parameters

src	ImageBase to copy from

Reimplemented in Flir.Atlas.Image.ThermalImage.

◆ Create()

virtual bool Flir.Atlas.Image.ImageBase.Create	(	string	formatId,
		bool	loadAll = `true`
	)

inlinevirtual

Create the underlying format (internal use)

Parameters

formatId
loadAll

Returns

Reimplemented in Flir.Atlas.Image.ThermalImage.

◆ EnterLock()

void Flir.Atlas.Image.ImageBase.EnterLock ( )

inline

Acquires an exclusive lock.

ExitLock must be invoked before other threads waiting on the object will unblock.

◆ ExitLock()

void Flir.Atlas.Image.ImageBase.ExitLock ( )

inline

Releases an exclusive lock.

◆ GetData() [1/2]

virtual byte [] Flir.Atlas.Image.ImageBase.GetData ( )

inlinevirtual

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.

Returns

Exceptions

ThermalException

◆ GetData() [2/2]

virtual bool Flir.Atlas.Image.ImageBase.GetData ( Stream stream )

inlinevirtual

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.

Parameters

stream Stream to write to.

◆ GetFormattedImageData()

virtual byte [] Flir.Atlas.Image.ImageBase.GetFormattedImageData ( )

inlinevirtual

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.

Returns

Exceptions

ThermalException

◆ HasSketch()

virtual bool Flir.Atlas.Image.ImageBase.HasSketch ( )

inlinevirtual

Return true if the image has a sketch image.

Reimplemented in Flir.Atlas.Image.VisualImageFile.

◆ IsSketchEnabled()

bool Flir.Atlas.Image.ImageBase.IsSketchEnabled ( )

inline

Return true if the image has a sketch image and it is enabled.

◆ Load() [1/3]

virtual bool Flir.Atlas.Image.ImageBase.Load	(	byte []	image,
		int	size
	)

inlinevirtual

Loads a FFF image from memory

Parameters

image	FFF
size	Size of fff.

Returns

◆ Load() [2/3]

virtual bool Flir.Atlas.Image.ImageBase.Load ( byte [] image )

inlinevirtual

Loads an Thermal FFF Image from a byte array.

Parameters

image A byte array containing a valid Thermal FFF image

Exceptions

Flir.Atlas.Image.ThermalException Failed to open Thermal image.

◆ Load() [3/3]

virtual bool Flir.Atlas.Image.ImageBase.Load	(	byte []	image,
		ImageLoadParameters	loadParams
	)

inlinevirtual

Loads an Thermal FFF Image from a byte array.

Parameters

image	A byte array containing a valid Thermal FFF image
loadParams	Flags

Exceptions

Flir.Atlas.Image.ThermalException Failed to open Thermal image.

◆ RaiseChangedEvent()

virtual void Flir.Atlas.Image.ImageBase.RaiseChangedEvent ( )

inlineprotectedvirtual

Fires the Image Changed event.

Reimplemented in Flir.Atlas.Image.ThermalImage.

◆ RenderTo()

abstract void Flir.Atlas.Image.ImageBase.RenderTo ( Flir.Atlas.Image.Interfaces.IPixels imagePixels )

pure virtual

Render the image to IPixels. BitmapSourceWrapper for advanced rendering.

Parameters

imagePixels

Exceptions

InvalidOperationException

Implemented in Flir.Atlas.Image.ThermalImage, and Flir.Atlas.Image.VisualImage.

◆ SaveSnapshot() [1/2]

void Flir.Atlas.Image.ImageBase.SaveSnapshot ( string filename )

inline

Saves the current image to disk.

Parameters

filename A string that specifies the path to the location on which to save the file

Exceptions

System.ArgumentException	The fileName is null or empty.
Flir.Atlas.Image.ThermalException	Failed to save Thermal image.

◆ SaveSnapshot() [2/2]

virtual void Flir.Atlas.Image.ImageBase.SaveSnapshot	(	string	filename,
		Bitmap	overlay
	)

inlinevirtual

Saves the current image to disk.

Parameters

filename	A string that specifies the path to the location on which to save the file
overlay	The jpeg representation of the Thermal image.

Exceptions

System.ArgumentException	The fileName is null or empty.
Flir.Atlas.Image.ThermalException	Failed to save Thermal image.

Reimplemented in Flir.Atlas.Image.ThermalImage.

◆ Swap()

void Flir.Atlas.Image.ImageBase.Swap ( )

inline

Manually swaps the image back buffer.

This method can be called if there is a need to swap the back buffer when running live data.

◆ TryEnterLock()

bool Flir.Atlas.Image.ImageBase.TryEnterLock ( )

inline

Attempts to acquire an exclusive lock.

Returns: true if the current thread acquires the lock; otherwise, false.

Member Data Documentation

◆ Height

virtual int Flir.Atlas.Image.ImageBase.Height => (FindSize()).Height

Gets the height of the image in pixels.

◆ ImageProcessing

ImageProcessing.ImageProcessing Flir.Atlas.Image.ImageBase.ImageProcessing => _imageProcessing

Advanced image processing.

◆ IsDisposed

bool Flir.Atlas.Image.ImageBase.IsDisposed => Disposed

True if this instance has been disposed

◆ Size

virtual Size Flir.Atlas.Image.ImageBase.Size => FindSize()

Gets the width and height of the image in pixels.

◆ Width

virtual int Flir.Atlas.Image.ImageBase.Width => (FindSize()).Width

Gets the width of the image in pixels.

Property Documentation

◆ CompassInformation

CompassInfo Flir.Atlas.Image.ImageBase.CompassInformation

get

Gets the compassInformation of the image.

◆ Description

virtual string Flir.Atlas.Image.ImageBase.Description

getset

Gets or sets the image description from the Exif (Exchangeable image file format) data.

◆ GasQuantificationInput

GasQuantificationInput Flir.Atlas.Image.ImageBase.GasQuantificationInput

get

Gets the Quantification input from the image.

◆ GasQuantificationResult

GasQuantificationResult Flir.Atlas.Image.ImageBase.GasQuantificationResult

get

Gets the Quantification result from the image.

◆ GpsInformation

GPSInfo Flir.Atlas.Image.ImageBase.GpsInformation

get

Gets the GPS information from the image.

◆ Image

abstract Bitmap Flir.Atlas.Image.ImageBase.Image

get

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

◆ IsSilent

bool Flir.Atlas.Image.ImageBase.IsSilent

getset

Set to true if no events is wanted from the image.

◆ ThermalPipeline

ThermalPipeline Flir.Atlas.Image.ImageBase.ThermalPipeline

get

Gets the pipeline Pipeline.

Returns: A Pipeline

◆ Version

string Flir.Atlas.Image.ImageBase.Version

staticget

Gets the used Atlas Image version.

Event Documentation

◆ Changed

EventHandler<ImageChangedEventArgs> Flir.Atlas.Image.ImageBase.Changed

Occurs when an image has changed e.g. needs to be updated.

Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Properties

Events

Detailed Description

Member Function Documentation

◆ Copy()

◆ Create()

◆ EnterLock()

◆ ExitLock()

◆ GetData() [1/2]

◆ GetData() [2/2]

◆ GetFormattedImageData()

◆ HasSketch()

◆ IsSketchEnabled()

◆ Load() [1/3]

◆ Load() [2/3]

◆ Load() [3/3]

◆ RaiseChangedEvent()

◆ RenderTo()

◆ SaveSnapshot() [1/2]

◆ SaveSnapshot() [2/2]

◆ Swap()

◆ TryEnterLock()

Member Data Documentation

◆ Height

◆ ImageProcessing

◆ IsDisposed

◆ Size

◆ Width

Property Documentation

◆ CompassInformation

◆ Description

◆ GasQuantificationInput

◆ GasQuantificationResult

◆ GpsInformation

◆ Image

◆ IsSilent

◆ ThermalPipeline

◆ Version

Event Documentation

◆ Changed