Flir.Atlas.Image.Scale Class Reference

Represents a scale object. More...

Inheritance diagram for Flir.Atlas.Image.Scale:

Public Member Functions
void	Copy (Scale src)
	Deep copy a Scale object. More...
void	Dispose ()

Protected Member Functions
void	OnChanged (ScaleChangedEventArgs e)
	Raises the Changed event. More...
void	OnScaleImageChange (ScaleChangedEventArgs e)
	Raises the Changed event. More...
void	OnMinMaxChanged (ScaleChangedEventArgs e)
	Raises the MinMaxChanged event. More...

Properties
double	Span [get, set]
	Get or set the scale span (Range max - Range min). More...
double	Level [get, set]
	The Scale level (Range min + Span/2) More...
Range< double >	Range [get, set]
	Get/set the current minimum and maximum scale values. More...
Range< double >	AutoAdjust [get]
	Gets the auto adjusted minimum and maximum scale values (Histogram Equalization of the image). More...
bool	IsAutoAdjustEnabled [get, set]
	Gets or sets auto adjust enabled. More...
bool	SetGFScale [get, set]
	Enable the GFScale to set the default scale range to include all temperatures in the image. More...
Bitmap	Image [get]
	Gets the scale image as bitmap. The bitmap represents the scale with width=1 and height=224 or more colors. !WARNING: The bitmap is created per-request, dispose when not needed! More...
bool	UseUnderflowAndOverflowColors [get, set]
	Gets or sets to use under flow colors. More...
bool	UseBelowAndAboveSpanColors [get, set]
	Gets or sets to use below and above span colors. More...
AutoGainControl	AutoAdjustRegion [get, set]
	Auto adjust region. Image colorization based on region of interest. More...
AutoGainControl	AutoGainControl [get, set]
	Auto gain control. Image colorization based on region of interest. More...

Events
EventHandler< ScaleChangedEventArgs >	Changed
	Occurs when changed. More...
EventHandler< ScaleChangedEventArgs >	ScaleImageChanged
	Occurs when scale image has changed. More...

Detailed Description

Represents a scale object.

A scale is an interval of the measurement range where colors from a selected palette is applied.

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Member Function Documentation

Copy()

void Flir.Atlas.Image.Scale.Copy ( Scale  src )

inline

Deep copy a Scale object.

Parameters

src	Scale to copy from

OnChanged()

void Flir.Atlas.Image.Scale.OnChanged ( ScaleChangedEventArgs  e )

inlineprotected

Raises the Changed event.

Parameters

e	The ScaleChangedEventArgs instance containing the event data.

OnMinMaxChanged()

void Flir.Atlas.Image.Scale.OnMinMaxChanged ( ScaleChangedEventArgs  e )

inlineprotected

Raises the MinMaxChanged event.

Parameters

e	The ScaleChangedEventArgs instance containing the event data.

OnScaleImageChange()

void Flir.Atlas.Image.Scale.OnScaleImageChange ( ScaleChangedEventArgs  e )

inlineprotected

Raises the Changed event.

Parameters

e	The ScaleChangedEventArgs instance containing the event data.

Property Documentation

AutoAdjust

Range<double> Flir.Atlas.Image.Scale.AutoAdjust

get

Gets the auto adjusted minimum and maximum scale values (Histogram Equalization of the image).

AutoAdjustRegion

AutoGainControl Flir.Atlas.Image.Scale.AutoAdjustRegion

getset

Auto adjust region. Image colorization based on region of interest.

AutoGainControl

AutoGainControl Flir.Atlas.Image.Scale.AutoGainControl

getset

Auto gain control. Image colorization based on region of interest.

Image

Bitmap Flir.Atlas.Image.Scale.Image

get

Gets the scale image as bitmap. The bitmap represents the scale with width=1 and height=224 or more colors. !WARNING: The bitmap is created per-request, dispose when not needed!

Returns

The IR-image.

The bitmap contains the colors used to create the IR image.

Examples

WinForms with a picture box named pictureBoxScale.

 <![CDATA[using Flir.Atlas.Image;
   var bmp = new Bitmap(pictureBoxScale.ClientSize.Width, pictureBoxScale.ClientSize.Height);
   var scaleImage = _image.Scale.Image;
   using (var g = Graphics.FromImage(bmp))
   {
       //Use gdi+ to interpolate with nearest neighbor
      g.InterpolationMode = System.Drawing.Drawing2D.InterpolationMode.NearestNeighbor;
      g.DrawImage(scaleImage, 0, 0, bmp.Width * 2, bmp.Height);
   }
  pictureBoxScale.Image = bmp;
]]>

IsAutoAdjustEnabled

bool Flir.Atlas.Image.Scale.IsAutoAdjustEnabled

getset

Gets or sets auto adjust enabled.

Level

double Flir.Atlas.Image.Scale.Level

getset

The Scale level (Range min + Span/2)

This property is turning off the auto adjust of the image.

Range

Range<double> Flir.Atlas.Image.Scale.Range

getset

Get/set the current minimum and maximum scale values.

This property is turning off the auto adjust of the image.

Examples

 <![CDATA[
var image = new ThermalImageFile(pathToImage);
// set new min and max value, 40.0 - 50.0 in current temperature unit.
image.Scale.Range = new Range<double>(40.0, 50.0);
// change the max value to 60.0.
image.Scale.Range = new Range<double>(image.Scale.Range.Minimum, 60.0);
// calculate the level and span (or use Level and Span).
double span = thImg.Scale.Range.Maximum - thImg.Scale.Range.Minimum;
double level = thImg.Scale.Range.Minimum + span / 2.0;
]]>

SetGFScale

bool Flir.Atlas.Image.Scale.SetGFScale

getset

Enable the GFScale to set the default scale range to include all temperatures in the image.

Span

double Flir.Atlas.Image.Scale.Span

getset

Get or set the scale span (Range max - Range min).

This property is turning off the auto adjust of the image.

UseBelowAndAboveSpanColors

bool Flir.Atlas.Image.Scale.UseBelowAndAboveSpanColors

getset

Gets or sets to use below and above span colors.

UseUnderflowAndOverflowColors

bool Flir.Atlas.Image.Scale.UseUnderflowAndOverflowColors

getset

Gets or sets to use under flow colors.

Event Documentation

Changed

EventHandler<ScaleChangedEventArgs> Flir.Atlas.Image.Scale.Changed

Occurs when changed.

ScaleImageChanged

EventHandler<ScaleChangedEventArgs> Flir.Atlas.Image.Scale.ScaleImageChanged

Occurs when scale image has changed.