Click or drag to resize
ThermalImageFile Class
This class represents an Thermal image.
Inheritance Hierarchy

Namespace: Flir.Atlas.Image
Assembly: Flir.Atlas.Image (in Flir.Atlas.Image.dll) Version: 3.1
Syntax
C#
public sealed class ThermalImageFile : ThermalImage, 
	IDisposable

The ThermalImageFile type exposes the following members.

Constructors
  NameDescription
Public methodThermalImageFile
Creates an instance of a ThermalImageFile.
Public methodThermalImageFile(String)
Creates an instance of an IRImage from a file on the specified path.
Top
Methods
  NameDescription
Public methodCalculateEmissivity
Calculates the emissivity from reference temperature.
(Inherited from ThermalImage.)
Public methodClose
Closes the file stream.
Public methodConvertToUltraMax
Converts the image to an UltraMax image
Public methodCount
Gets the number of frames.
Public methodDispose
Releases all resources used by the ThermalImageFile
Public methodEnterLock
Acquires an exclusive lock.
(Inherited from ImageBase.)
Public methodEquals
Determines whether the specified Object is equal to the current Object.
(Inherited from Object.)
Public methodExitLock
Releases an exclusive lock.
(Inherited from ImageBase.)
Public methodGetData
Get embedded radiometric data blob.
(Inherited from ImageBase.)
Public methodGetEmissivityFromValue(Double, Double)
Calculates emissivity from a known temperature.
(Inherited from ThermalImage.)
Public methodGetEmissivityFromValue(Int32, Int32, Double)
Calculates emissivity from a known temperature.
(Inherited from ThermalImage.)
Public methodGetHashCode
Serves as a hash function for a particular type.
(Inherited from Object.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodGetValueAt
Gets an ThermalValue from a position in the Thermal Image.
(Inherited from ThermalImage.)
Public methodGetValueFromEmissivity
Calculates temperature in current TemperatureUnit.
(Inherited from ThermalImage.)
Public methodGetValueFromSignal
Gets a ThermalValue from a signal.
(Inherited from ThermalImage.)
Public methodGetValues(Point)
Gets a ThermalValue from a signal.
(Inherited from ThermalImage.)
Public methodGetValues(Rectangle)
Gets a ThermalValue from a signal.
(Inherited from ThermalImage.)
Public methodImageArray
Returns a double array representing the image.
(Inherited from ThermalImage.)
Public methodStatic memberIsThermalImage
Check if the file contains thermal data.
Public methodLoad
Loads an Thermal FFF Image from a byte array.
(Inherited from ImageBase.)
Public methodOpen
Opens an Thermal Image from the specified file.
Public methodRenderTo
Render the new image to the input image buffer IPixels.
(Inherited from ThermalImage.)
Public methodSave
Saves the Thermal Image to file.
Public methodSave(Bitmap)
Saves the Thermal Image to file.
Public methodSave(String)
Saves the Thermal Image to the specified file.
Public methodSave(String, Bitmap)
Saves the Thermal Image to the specified file.
Public methodSaveSnapshot(String)
Saves the current image to disk.
(Inherited from ThermalImage.)
Public methodSaveSnapshot(String, Bitmap)
Saves the current image to disk.
(Inherited from ImageBase.)
Public methodSetRotate
Rotate the image.
(Inherited from ThermalImage.)
Public methodSwap
Manually swaps the image back buffer.
(Inherited from ImageBase.)
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Public methodTryEnterLock
Attempts to acquire an exclusive lock.
(Inherited from ImageBase.)
Top
Properties
  NameDescription
Public propertyAlarms
Gets the collection of isotherms.
(Inherited from ThermalImage.)
Public propertyCameraInformation
Gets information about the camera used to create this Thermal image.
(Inherited from ThermalImage.)
Public propertyColorDistribution
Gets or sets the Thermal image color distribution.
(Inherited from ThermalImage.)
Public propertyCompassInformation
Gets the compassInformation of the image.
(Inherited from ImageBase.)
Public propertyContainsUltraMaxData
Check if the image contains UltraMax data. Images containing UltraMax data can be converted to UltraMax, see ConvertToUltraMax
Public propertyDateTime
Gets the image creation date and time.
(Inherited from ThermalImage.)
Public propertyDescription
Gets or sets the image description.
Public propertyDistanceUnit
Gets or sets the distance unit.
(Inherited from ThermalImage.)
Public propertyFileName
Gets the name of the current opened file.
Public propertyFusion
Gets the Fusion object.
(Inherited from ThermalImage.)
Public propertyGpsInformation
Gets the GPS information from the image.
(Inherited from ImageBase.)
Public propertyHeight
Gets the height of the image in pixels.
(Inherited from ImageBase.)
Public propertyImage
Returns a Bitmap representing the image.
(Inherited from ThermalImage.)
Public propertyImageProcessing
Advanced image processing.
(Inherited from ImageBase.)
Public propertyIsotherms
Gets the collection of isotherms.
(Inherited from ThermalImage.)
Public propertyMaxSignalValue
Gets the maximum signal value of the image.
(Inherited from ThermalImage.)
Public propertyMeasurements
Gets the measurements collection.
(Inherited from ThermalImage.)
Public propertyMinSignalValue
Gets the minimum signal value of the image.
(Inherited from ThermalImage.)
Public propertyOverflowSignalValue
Gets the overflow signal value.
(Inherited from ThermalImage.)
Public propertyPalette
Handle palette selections
(Inherited from ThermalImage.)
Public propertyPaletteManager
Gets the palette object.
(Inherited from ThermalImage.)
Public propertyPrecision
Presentation precision gets number of decimals.
(Inherited from ThermalImage.)
Public propertyScale
Gets the scale object.
(Inherited from ThermalImage.)
Public propertySensorsCollection
Gets a collection of sensor data objects.
Public propertySize
Gets the width and height of the image in pixels.
(Inherited from ImageBase.)
Public propertyStatistics
Gets the image results ImageStatistics
(Inherited from ThermalImage.)
Public propertyTemperatureUnit
Gets or sets the temperature unit and will propagate a TemperatureUnitChanged event when changed.
(Inherited from ThermalImage.)
Public propertyTextAnnotations
Gets a collection of text annotation objects.
Public propertyThermalParameters
Gets the image statistics i.e. max, min etc.
(Inherited from ThermalImage.)
Public propertyThermalSequencePlayer
Gets the ThermalSequencePlayer Plays seq, csq and fcf files. If Count > 1 it is a sequence
Public propertyTitle
Gets the image title.
Public propertyTrigger
Gets the trigger settings for this image.
(Inherited from ThermalImage.)
Public propertyUnderflowSignalValue
Gets the underflow signal value.
(Inherited from ThermalImage.)
Public propertyVoiceAnnotation
Gets the voice annotation object.
Public propertyWidth
Gets the width of the image in pixels.
(Inherited from ImageBase.)
Public propertyZoom
Image zoom settings.
(Inherited from ThermalImage.)
Top
Events
  NameDescription
Public eventChanged
Occurs when an image has changed e.g. needs to be uppdated.
(Inherited from ImageBase.)
Public eventTemperatureUnitChanged
Occurs when the temperature unit is changed.
(Inherited from ThermalImage.)
Top
Examples
The following code example demonstrates how to construct a new ThermalImageFile from a file, using the IRImage constructor. This example is designed to be used with a Windows Forms that contains a PictureBox, and Button named PictureBox1, and Button1, respectively. Paste the code into the form and associate the Button1_Click method with the button's Click event.
private void button1_Click(object sender, EventArgs e)
{
    var irImage = new ThermalImageFile(@"C:\Images\IR_2034.jpg");
    pictureBox1.Image = irImage.Image;
}
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.
See Also