Flir.Atlas.Image.Measurements.MeasurementRectangle Class Reference

Represents a MeasurementRectangle object. More...

Inheritance diagram for Flir.Atlas.Image.Measurements.MeasurementRectangle:

Public Member Functions
override void	Copy (MeasurementShape source)
	Deep copy a MeasurementShape from source. More...
override bool	IsEqual (MeasurementShape source)
	Compares two measurements More...
override void	Offset (Point point)
	Adjusts the location of this measurement shape by the specified amount. More...
Public Member Functions inherited from Flir.Atlas.Image.Measurements.MeasurementShape
double []	GetValues ()
	Gets temperature values from the shape. More...

Public Attributes
Point	HotSpot => _area.Hotspot
	Point in the area More...
Point	ColdSpot => _area.Coldspot
	Point in the area More...
Public Attributes inherited from Flir.Atlas.Image.Measurements.MeasurementShape
Guid	Identity => _measurementObject.UniqueIdentifier
	Gets the identity on the measurement shape. More...

Properties
bool	IsHotSpotMarkerVisible [get, set]
	Marker is visible. The marker glyph should be displayed as seen in the camera overlay. More...
bool	IsHotSpotEnabled [get, set]
	Hot Spot is enabled. The hot spot value should be displayed in the result table as seen in the camera overlay. More...
bool	IsColdSpotEnabled [get, set]
	Cold spot is enabled. The cold spot value should be displayed in the result table as seen in the camera overlay. More...
bool	IsColdSpotMarkerVisible [get, set]
	Marker is visible. The marker glyph should be displayed as seen in the camera overlay. More...
bool	IsAverageEnabled [get, set]
	Average is enabled. The average value should be displayed in the result table as seen in the camera overlay. More...
ThermalValue	Min [get]
	Gets the minimum value of this MeasurementRectangle. More...
ThermalValue	Max [get]
	Gets the maximum value of this MeasurementRectangle. More...
ThermalValue	Average [get]
	Gets the average value of this MeasurementRectangle. More...
Point	Location [get, set]
	Gets or sets the location of this MeasurementRectangle. More...
bool	IsAreaEnabled [get, set]
	Area is enabled. The Area value should be displayed in the result table as seen in the camera overlay. More...
ThermalValue	ObjectArea [get]
	Gets the area (m2) of the measurement. The distance used in the calculation is the ObjectDistance More...
int	Width [get, set]
	Gets or sets the width of this MeasurementRectangle. More...
int	Height [get, set]
	Gets or sets the height of this MeasurementRectangle. More...
Rectangle	Rectangle [get, set]
	Gets or sets the rectangle area of this MeasurementRectangle. More...
Properties inherited from Flir.Atlas.Image.Measurements.MeasurementShape
string	Name [get, set]
	Gets or sets the name of the measurement shape. More...
MeasurementParameters	ThermalParameters [get]
	Gets the object parameters for this measurement shape. More...
bool	IsSilent [get, set]
	Temporary disable events from measurements More...

Additional Inherited Members
Protected Member Functions inherited from Flir.Atlas.Image.Measurements.MeasurementShape
virtual void	OnChanged (MeasurementEventArgs e)
	Raises the MeasurementEventArgs event. More...
void	UpdateIfNeeded ()
	Updates if needed. More...
void	VerifyState (Cronos.IR.IRValue value)
	Check if the state is invalid. More...

Detailed Description

Represents a MeasurementRectangle object.

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.

Examples

 <![CDATA[
using Flir.Atlas.Image;

using (ThermalImageFile image = new ThermalImageFile(File))
{
    //add and remove
    MeasurementRectangle rectangle = image.Measurements.Add(new Rectangle(10, 10, 70, 50));
    image.Measurements.Remove(rectangle);
}
]]>

Member Function Documentation

Copy()

override void Flir.Atlas.Image.Measurements.MeasurementRectangle.Copy ( MeasurementShape  source )

inlinevirtual

Deep copy a MeasurementShape from source.

Parameters

source

MeasurementShape to copy from.

Reimplemented from Flir.Atlas.Image.Measurements.MeasurementShape.

IsEqual()

override bool Flir.Atlas.Image.Measurements.MeasurementRectangle.IsEqual ( MeasurementShape  source )

inlinevirtual

Compares two measurements

Parameters

source

Returns

true if equal.

Reimplemented from Flir.Atlas.Image.Measurements.MeasurementShape.

Offset()

override void Flir.Atlas.Image.Measurements.MeasurementRectangle.Offset ( Point  point )

inlinevirtual

Adjusts the location of this measurement shape by the specified amount.

Parameters

point

Amount to offset the location.

Reimplemented from Flir.Atlas.Image.Measurements.MeasurementShape.

Member Data Documentation

ColdSpot

Point Flir.Atlas.Image.Measurements.MeasurementRectangle.ColdSpot => _area.Coldspot

Point in the area

HotSpot

Point Flir.Atlas.Image.Measurements.MeasurementRectangle.HotSpot => _area.Hotspot

Point in the area

Property Documentation

Average

ThermalValue Flir.Atlas.Image.Measurements.MeasurementRectangle.Average

get

Gets the average value of this MeasurementRectangle.

Height

int Flir.Atlas.Image.Measurements.MeasurementRectangle.Height

getset

Gets or sets the height of this MeasurementRectangle.

IsAreaEnabled

bool Flir.Atlas.Image.Measurements.MeasurementRectangle.IsAreaEnabled

getset

Area is enabled. The Area value should be displayed in the result table as seen in the camera overlay.

IsAverageEnabled

bool Flir.Atlas.Image.Measurements.MeasurementRectangle.IsAverageEnabled

getset

Average is enabled. The average value should be displayed in the result table as seen in the camera overlay.

IsColdSpotEnabled

bool Flir.Atlas.Image.Measurements.MeasurementRectangle.IsColdSpotEnabled

getset

Cold spot is enabled. The cold spot value should be displayed in the result table as seen in the camera overlay.

IsColdSpotMarkerVisible

bool Flir.Atlas.Image.Measurements.MeasurementRectangle.IsColdSpotMarkerVisible

getset

Marker is visible. The marker glyph should be displayed as seen in the camera overlay.

IsHotSpotEnabled

bool Flir.Atlas.Image.Measurements.MeasurementRectangle.IsHotSpotEnabled

getset

Hot Spot is enabled. The hot spot value should be displayed in the result table as seen in the camera overlay.

IsHotSpotMarkerVisible

bool Flir.Atlas.Image.Measurements.MeasurementRectangle.IsHotSpotMarkerVisible

getset

Marker is visible. The marker glyph should be displayed as seen in the camera overlay.

Location

Point Flir.Atlas.Image.Measurements.MeasurementRectangle.Location

getset

Gets or sets the location of this MeasurementRectangle.

Max

ThermalValue Flir.Atlas.Image.Measurements.MeasurementRectangle.Max

get

Gets the maximum value of this MeasurementRectangle.

Min

ThermalValue Flir.Atlas.Image.Measurements.MeasurementRectangle.Min

get

Gets the minimum value of this MeasurementRectangle.

ObjectArea

ThermalValue Flir.Atlas.Image.Measurements.MeasurementRectangle.ObjectArea

get

Gets the area (m2) of the measurement. The distance used in the calculation is the ObjectDistance

Rectangle

Rectangle Flir.Atlas.Image.Measurements.MeasurementRectangle.Rectangle

getset

Gets or sets the rectangle area of this MeasurementRectangle.

Width

int Flir.Atlas.Image.Measurements.MeasurementRectangle.Width

getset

Gets or sets the width of this MeasurementRectangle.