ilabs-flir 1.0.0

package/ios/Flir/Framework/ThermalSDK/FLIRCameraImport.h

@@ -0,0 +1,204 @@
+//
+//  FLIRCameraImport.h
+//
+//  Copyright © 2019 Teledyne FLIR. All rights reserved.
+//
+//  Initialize and perform import (list and import images).
+
+#import <UIKit/UIKit.h>
+
+#import "FLIRIdentity.h"
+
+/** Describes different possible file locations in the cameras filesystem. */
+typedef NS_ENUM(NSInteger, FLIRLocation)
+{
+    /** Unknown root. */
+    FLIRLocationUnknown,
+    /** The active camera folder used for storing images. */
+    FLIRLocationActive,
+    /** Base folder for images (e.g. "DCIM" on the SD card). */
+    FLIRLocationImageBase
+};
+
+/// Options for listing images
+typedef NS_OPTIONS(NSInteger, FLIRListImagesFlags) {
+    /// recurse all found folders
+    FLIRListImagesRecursive = 1 << 0,
+    /// include hidden files
+    FLIRListImagesShowHidden = 1 << 1
+};
+
+/**
+ *  Abstract file path on camera's filesystem.
+ */
+@interface FLIRFileReference : NSObject
+/** Defines base part of the file path. */
+@property (nonatomic, readwrite) FLIRLocation location;
+/** Relative path to location.
+ *
+ * Example: Both "image.jpg" and "/image.jpg" would refer to an image file in the folder of `location`, and both "" and "/" would refer to the folder of `location`.
+ * @note The path is expressed in a camera-compatible format using forward slashes (/) as the separator.
+ */
+@property (nonatomic, nonnull, readwrite) NSString *path;
+@end
+
+/**
+ *  Abstract directory path on camera's filesystem.
+ */
+@interface FLIRFolderReference : NSObject
+/** Defines base part of the file path. */
+@property (nonatomic, readwrite) FLIRLocation location;
+/** Relative path to location.
+ *
+ * @note The path is expressed in a camera-compatible format using forward slashes (/) as the separator.
+ */
+@property (nonatomic, nonnull, readwrite) NSString *path;
+
+@end
+
+@class FLIRThumbnail;
+
+/**
+ *  Delegate to return events when files are found on a camera.
+ */
+@protocol FLIRCameraImportEventDelegate <NSObject>
+
+/**
+ *  This is called when a file is imported from the camera to the device.
+ *  Note: you should NOT try to call `FLIRCamera.disconnect()` directly from this callback. Instead i.e. spawn a new thread.
+ *
+ *  @param filename The path to a new file.
+ */
+- (void)fileAdded:(NSString * _Nonnull)filename;
+
+/**
+ *  This is called when error occurs when downloading a file.
+ *  Note: you should NOT try to call `FLIRCamera.disconnect()` directly from this callback. Instead i.e. spawn a new thread.
+ *
+ *  @param e Dictionary with error information (error message and filename)
+ */
+- (void)importError:(NSDictionary<NSString *, NSString *> * _Nonnull)e;
+
+
+/**
+ *  This is called to show the progress of downloading image files from the device.
+ *  Note: you should NOT try to call `FLIRCamera.disconnect()` directly from this callback. Instead i.e. spawn a new thread.
+ *
+ *  @param progress The number of bytes downloaded so far.
+ *  @param total The total number of bytes of the file downloading.
+ *  @param file   The reference of the file currently being downloaded. Remember to compare files using `isEqual`.
+ */
+- (void)fileProgress:(NSInteger)progress total:(NSInteger)total file:(FLIRFileReference * _Nonnull)file;
+
+@optional
+
+/**
+ *  This is called when a thumbnail is downloaded
+ *
+ *  @param thumbnail A thumbnail with a reference to the original image and a thumbnail as a UIImage
+ */
+- (void)gotThumbnail:(FLIRThumbnail * _Nonnull)thumbnail;
+
+/**
+ * This is called when a file is deleted
+ * @param file The reference of the file that was deleted
+ */
+- (void)fileDeleted:(FLIRFileReference * _Nonnull)file;
+
+@end
+
+/**
+ *  Objects returned by listImages
+ */
+
+@interface  FLIRFileInfo : NSObject
+/** The name of the file, without the path (like Unix's basename)  */
+@property (nonatomic, nonnull) NSString *name;
+/** Abstract path to the file. */
+@property (nonatomic, nonnull) FLIRFileReference *reference;
+/** The time this file was last changed */
+@property (nonatomic, nonnull) NSDateComponents *time;
+/** The file size in bytes */
+@property (nonatomic) long long size;
+/** True if this file object represents a directory, false otherwise */
+@property (nonatomic) bool isDirectory;
+@end
+
+@interface FLIRThumbnail : NSObject
+/** File reference */
+@property (nonatomic, nonnull) FLIRFileReference *reference;
+/** Thumbnail */
+@property (nonatomic, nonnull) UIImage* thumbnail;
+@end
+
+/**
+ *  This class facilitates importing images from Camera.
+ */
+@interface FLIRCameraImport : NSObject
+
+/**
+ *  Import files from camera.
+ *
+ *  @param imageList List of files to import. Use `listImages` or `listImagesInWorkFolder` to obtain an image list.
+ *  @param destPath  Destination path.
+ *
+ *  @return TRUE if all is OK.
+ */
+- (BOOL)startImport:(NSArray<FLIRFileReference *> * _Nonnull)imageList withDestPath:(NSString * _Nonnull)destPath;
+
+/**
+ * Import thumbnails for files.
+ *
+ * @param imageList List of images. If a thumbnail is available, it will be imported, and the delegate will be called.
+ */
+- (void)startImportThumbnails:(NSArray<FLIRFileReference *> * _Nonnull)imageList;
+
+/**
+ *  Cancels the import session
+ */
+- (void)cancelImport;
+
+/**
+ *  A delegate to handle the events in FLIRCameraImportEventDelegate.
+ */
+@property (nonatomic, weak, nullable) id<FLIRCameraImportEventDelegate> delegate;
+
+/**
+ *  List all Flir files from default active folder in camera.
+ *
+ *  @return Array with FLIRFileInfos.
+ */
+-(NSArray<FLIRFileInfo *> * _Nullable)listImages:(out NSError *_Nullable *_Nullable)error;
+
+/**
+ *  List all Flir files in camera.
+ *
+ *  @param folder the folder to list, nil will use the active default folder
+ *  @param flags flags for recursive listing and including hidden folder
+ *
+ *  @return Array with FLIRFileInfos.
+ */
+- (NSArray<FLIRFileInfo *> * _Nullable)listImages:(FLIRFileReference * _Nullable)folder
+                                            flags:(FLIRListImagesFlags)flags
+                                            error: (out NSError *_Nullable *_Nullable)error;
+
+/**
+ *  List all Flir files from folder in camera.
+ *
+ *  @param folder workfolder with files.
+ *
+ *  @return Array with FLIRFileInfos.
+ */
+
+- (NSArray<FLIRFileInfo *> * _Nullable)listImagesInWorkFolder:(FLIRFileReference * _Nonnull)folder error:(out NSError *_Nullable *_Nullable)error;
+
+/**
+ * Gets workfolders as a list of folders from the specified camera.
+ *
+ * @return Returns workfolders as a list of folders from the camera. List may be empty.
+ */
+- (NSArray<FLIRFileInfo *> * _Nullable)listWorkfolders:(out NSError *_Nullable *_Nullable)error;
+
+- (void)startDeleteFiles:(NSArray<FLIRFileReference *> * _Nonnull)fileList;
+
+@end

package/ios/Flir/Framework/ThermalSDK/FLIRColorDistributionSettings.h

@@ -0,0 +1,204 @@
+//
+//  FLIRColorDistributionSettings.h
+//  ThermalSDK
+//
+//  Created by FLIR on 2021-09-03.
+//  Copyright © 2022 Teledyne FLIR. All rights reserved.
+//
+
+#import <Foundation/Foundation.h>
+
+NS_ASSUME_NONNULL_BEGIN
+
+/**
+ *  These methods transform each slot histogram bin x into the weight y.
+ */
+typedef NS_ENUM(NSUInteger, FLIRHistogramModifier) {
+    /** y = x^(1/2).
+    * If all pixels in a slot were collected within a circle,
+    * the radius of this circle is proportional to the slot weight.
+    */
+    FLIRSquareRoot,
+
+    /**  y = x^(1/3) */
+    FLIRCubicRoot,
+
+    /**  ln(x) if x >= 2 else 0. Every doubling of a slot's pixel count
+    *  will increase the slot weight by a fixed amount.
+    */
+    FLIRLn,
+
+    /**  Scaled LN (y = y_LN / 2.3), which has no effect on the normalized weights. */
+    FLIRLog10,
+
+    /** y = min(x, plateauCount)
+    * Put the cap @p ulPlateauCount on each of this histogram's bins.
+    */
+    FLIRPlateau,
+
+    /** y = x */
+    FLIRNone
+};
+
+/**
+ *  Specifies the color distributions used when running the colorizer on an image.
+ */
+@interface FLIRColorDistributionSettings : NSObject
+
+@end
+
+/**
+ *  The color information in the image is distributed linear to the temperature values of the image.
+ *
+ *  @note The palette colors used for each pixel is mapped in a linear fashion between the min and max temperatures of the image.
+ *  Pixels above and below min and max will contain a color defined in the @ref atlas::image::Palette.
+ */
+@interface FLIRTemperatureLinearSettings : FLIRColorDistributionSettings
+
+@end
+
+/**
+ *  The colors are evenly distributed over the existing temperatures of the image and enhance the contrast.
+ *
+ *  This color distribution can be particularly successful when the image contains few peaks of very low or
+ *  high temperature's values.
+ */
+@interface FLIRHistogramEqualizationSettings : FLIRColorDistributionSettings
+
+/** Minimum heq slope limit. */
+@property (nonatomic, assign) float linearPercent;
+/** Maximum heq slope limit. */
+@property (nonatomic, assign) int plateauTruncation;
+/** How many pixels to ignore. */
+@property (nonatomic, assign) float tailPercent;
+/** Decrease to make the histogram more responsive to new scene content. */
+@property (nonatomic, assign) float histogramDf;
+/** Temporal filtering of span limits. */
+@property (nonatomic, assign) float scaleDf;
+/** Mode to transform each slot histogram bin x into the weight y. */
+@property (nonatomic, assign) FLIRHistogramModifier modifierMode;
+
+@end
+
+/**
+ *  The color information in the image is distributed linear to the signal values of the image.
+ *
+ *  @note The palette colors used for each pixel is mapped in a linear fashion between the min and max signal values of the image. Pixels above and below min and max will contain a color defined in the @ref atlas::image::Palette.
+*/
+@interface FLIRSignalLinearSettings : FLIRColorDistributionSettings
+
+@end
+
+/**
+ *  Specifies parameters for the plateau histogram equalization mode.
+ *
+ *  The colors are evenly distributed over the existing temperatures of the image and enhance the contrast.
+ *  @note This color distribution can be particularly successful when the image contains few peaks
+ *  of very low or high temperature's values.
+ */
+@interface FLIRPlateauHistogramEqSettings : FLIRColorDistributionSettings
+
+/** Limits the maximum slope of the mapping function. */
+@property (nonatomic, assign) float maxGain;
+/** Limits the population of any single histogram bin. */
+@property (nonatomic, assign) float percentPerBin;
+/** Increasing values of Linear Percent more accurately preserves the visual representation of an object */
+@property (nonatomic, assign) float linearPercent;
+/** Determines the percentage of the histogram tails which are not ignored when generating the mapping function.*/
+@property (nonatomic, assign) float outlierPercent;
+/** Used to adjust the perceived brightness of the image. */
+@property (nonatomic, assign) float gamma;
+
+@end
+
+/**
+ *  Specifies parameters for the Digital Detail Enhancement (DDE) and Entropy modes.
+ *  Entropy modes reserve more shades of gray/colors for areas with more entropy by assigning areas with lower entropy lesser gray shades.
+ *
+ *  @note In this mode one color might not map to a specific temperature. Which means that the output
+ *  scale is not radiometric accurate.
+ */
+@interface FLIRDDESettings : FLIRPlateauHistogramEqSettings
+
+/** Detail to background ratio. */
+@property (nonatomic, assign) float detailToBackground;
+/** DDE smoothing factor */
+@property (nonatomic, assign) float smoothingFactor;
+/** Headroom for detail at dynamic range extremes */
+@property (nonatomic, assign) float detailHeadroom;
+
+@end
+
+
+/**
+ *  Specifies parameters for Entropy modes.
+ *  Entropy modes reserve more shades of gray/colors for areas with more entropy by assigning areas
+ *  with lower entropy lesser gray shades.
+ *
+ *  @note In this mode one color might not map to a specific temperature. Which means that the output
+ *  scale is not radiometric accurate.
+ */
+@interface FLIREntropySettings : FLIRDDESettings
+
+@end
+
+/**
+ *  Specifies parameters for the Adaptive Detail Enhancement (ADE) mode.
+ *  Adaptive detail enhancement which is using a edge-preserving and noise-reducing smoothing filter
+ *  to enhance the contrast in the image.
+ *
+ *  @note In this mode one color might not map to a specific temperature. Which means that the
+ *  output scale is not radiometric accurate.
+ */
+@interface FLIRADESettings : FLIRColorDistributionSettings
+
+/** Noise amplification limit (LF) (Low value=Disable this feature) */
+@property (nonatomic, assign) float alphaNoise;
+/** Edge preserving limit (LF); Too avoid halos around sharp edges (High value=Disable this feature). */
+@property (nonatomic, assign) float betaLf;
+/** Edge preserving limit (HF); Too avoid halos around sharp edges (High value=Disable this feature). */
+@property (nonatomic, assign) float betaHf;
+/** LF/HF crossover level; Low value=Only HF enhancement;High value=Only LF enhancement. */
+@property (nonatomic, assign) float betaMix;
+/** Amount of the high pass filter that should be used. */
+@property (nonatomic, assign) float hpBlendingAmount;
+/** Low part of the histogram that is discarded. */
+@property (nonatomic, assign) float lowLimit;
+/** High part of the histogram that is discarded. */
+@property (nonatomic, assign) float highLimit;
+/** Headroom for details at dynamic range extremes. */
+@property (nonatomic, assign) float headRoom;
+/** Footroom for details at dynamic range extremes. */
+@property (nonatomic, assign) float footRoom;
+/** Limits the maximum slope of the mapping function. */
+@property (nonatomic, assign) float gain;
+/** Linear portion used for mapping the colors. */
+@property (nonatomic, assign) float linearMix;
+
+@end
+
+/**
+ *  Specifies parameters for the FSX mode.
+ *  FSX is using a edge-preserving and noise-reducing smoothing filter
+ *  to enhance the contrast in the image.
+ */
+@interface FLIRFSXSettings : FLIRColorDistributionSettings
+
+/** Maximum allowed difference in the bilateral filtering. */
+@property (nonatomic, assign) float sigmaR;
+/** The weight factor applied to image details. */
+@property (nonatomic, assign) unsigned short alpha;
+
+@end
+
+/**
+ *  Specifies parameters for the local contrast enhancement (LCE) mode.
+ */
+@interface FLIRLCESettings : FLIRDDESettings
+
+/** Can be used to enhance the contrast. */
+@property (nonatomic, assign) int contrast;
+
+@end
+
+NS_ASSUME_NONNULL_END

package/ios/Flir/Framework/ThermalSDK/FLIRColorizer.h

@@ -0,0 +1,82 @@
+//
+//  FLIRColorizer.h
+//  ThermalSDK
+//
+//  Created by FLIR on 2021-10-27.
+//  Copyright © 2021 Teledyne FLIR. All rights reserved.
+//
+
+
+#pragma once
+
+#import <UIKit/UIKit.h>
+
+#import "FLIRRenderer.h"
+
+@class FLIRRange;
+
+/**
+ *  Protocol for classes colorizing thermal images or streams
+ */
+@protocol FLIRColorizer<FLIRRenderer>
+
+/**
+ *  Automatic scale
+ *
+ *  If true rendered images will have scale automatically set based on the min and max values in the image.
+ *  @note auto-adjusted scale is disabled by default
+ *
+ *  @note Calling this function does not trigger any render. Use `getImage()` if necessary to "re-render".
+ *  @note it is recommended to keep the rendering setting consistent with the FLIRThermalImage information within FLIRScale.
+ *  For this purpose code similar to the following could be used:
+ *  // auto scale enabled
+ *  let colorizer = ... // FLIRColorizer
+ *  colorizer.autoScale = true
+ *  // calling getImage(), among other internal work, will re-calculate scale range that we can then apply to Scale object
+ *  colorizer.getImage()
+ *  let scale = ... // obtain FLIRScale instance from FLIRThermalImage or in live stream from FLIRThermalStreamer.withThermalImage()
+ *  // set the range calculated by the colorizer
+ *  auto tempRange = colorizer.getScaleRange();
+ *  scale.setRangeMin(tempRange.min);
+ *  scale.setRangeMax(tempRange.max);
+ *  //
+ *  // auto scale disabled
+ *  let colorizer = ... // FLIRColorizer
+ *  colorizer.autoScale = false
+ *  // first get scale
+ *  let scale = ... // obtain FLIRScale instance from FLIRThermalImage or in live stream from FLIRThermalStreamer.withThermalImage()
+ *  // then set manual range provided from the user
+ *  scale.setRangeMin(userMinScaleValue);
+ *  scale.setRangeMax(userMaxScaleValue);
+ *  // finally update the colorizer so the rendered image is colorized using user-defined scale range
+ *  colorizer.getImage()
+ */
+@property (nonatomic, assign) BOOL autoScale;
+
+/**
+ *  Render scale
+ *
+ *  If true the scale will be rendered when the image is rendered
+ *  @note scale rendering is disabled by default
+ */
+@property (nonatomic, assign) BOOL renderScale;
+
+/**
+ *  Get an image with the scale
+ *
+ *  @note if scale rendering was disabled during last call to @ref update, the result from this function may be out of sync .
+ *  @note For getting rendered image without scale, see @ref getImage
+ *  @return Returns an UIImage, or nil if update hasn't been called with scale rendering enabled
+ */
+- (UIImage * _Nullable)getScaleImage;
+
+/**
+ *  Get the range of the scale
+ *
+ *  If auto scale is on, get the min and max temperature
+ *  @return FLIRRange with min and max
+ */
+
+- (FLIRRange * _Nullable)getScaleRange;
+
+@end

package/ios/Flir/Framework/ThermalSDK/FLIRDiscoveredCamera.h

@@ -0,0 +1,44 @@
+//
+//  FLIRDiscoveredCamera.h
+//  ThermalSDK
+//
+//  Created by FLIR on 2022-02-03.
+//  Copyright © 2022 Teledyne FLIR. All rights reserved.
+//
+
+#import <Foundation/Foundation.h>
+
+@class FLIRIdentity;
+@class FLIRWirelessCameraDetails;
+
+NS_ASSUME_NONNULL_BEGIN
+
+/// Describes how connect may be called
+typedef NS_OPTIONS(NSUInteger, FLIRConnectMethod) {
+    /// Allows normal usage of connect
+    CM_normal = 0x1,
+    /// Allows connect "connecting" over SSL
+    CM_secure = 0x2,
+};
+
+/// Plain information of discovered camera, including connection settings.
+@interface FLIRDiscoveredCamera : NSObject
+
+/// The Identity to use when connecting to a camera
+@property (nonatomic, nonnull, readonly, strong) FLIRIdentity *identity;
+
+/// Human readable name of the camera
+@property (nonatomic, nonnull, readonly) NSString *displayName;
+
+/// Describes how connect may be called
+@property (nonatomic, readonly) FLIRConnectMethod  supportedConnectMethods;
+
+/// Additional custom data received during discovery
+@property (nonatomic, nonnull, readonly) NSDictionary<NSString *, NSString *> *records;
+
+/// Optional wireless details for F1 wireless
+@property (nonatomic, nullable, readonly, strong) FLIRWirelessCameraDetails* wirelessCameraDetails;
+
+@end
+
+NS_ASSUME_NONNULL_END

package/ios/Flir/Framework/ThermalSDK/FLIRDiscovery.h

@@ -0,0 +1,132 @@
+//
+//  FLIRDiscovery.h
+//
+//  Copyright © 2019 Teledyne FLIR. All rights reserved.
+//
+//  An interface for discovering cameras in vicinity.
+//
+
+#ifndef FLIRDiscovery_h
+#define FLIRDiscovery_h
+
+#import "FLIRIdentity.h"
+#import "FLIRDiscoveredCamera.h"
+
+/**
+ *  Delegate to return events detected in the camera scanner
+ */
+@protocol FLIRDiscoveryEventDelegate <NSObject>
+
+/**
+ *  This event is raised when a camera device is returning an error.
+ *
+ *  @param error The error.
+ *
+ *  @param nsnetserviceserror The NSNetServicesError code
+ *
+ *  @param iface The interface where the discovery error was encountered.
+ */
+-(void)discoveryError:(nonnull NSString *)error netServiceError:(int)nsnetserviceserror on:(FLIRCommunicationInterface)iface;
+
+@optional
+
+/**
+ *  This event is raised when new camera device is found.
+ *  @Deprecated Implement `cameraDiscovered:` instead
+ */
+-(void)cameraFound:(nonnull FLIRIdentity *)cameraIdentity  __attribute((deprecated("Implement cameraDiscovered: instead.")));;
+
+/**
+ *  This event is raised when a camera device is removed from the collection.
+ */
+-(void)cameraLost:(nonnull FLIRIdentity *)cameraIdentity;
+
+/**
+ * This event is called when discovery is finished (i.e. OS limitation).
+ * this event it NOT called after "FLIRDiscovery#stop()" is called
+ *
+ *  @param iface The interface where the discovery was finished .
+ */
+-(void) discoveryFinished:(FLIRCommunicationInterface)iface;
+
+/**
+ * This event is called when a camera is discovered, it provides more information than `cameraFound:`
+ */
+- (void)cameraDiscovered:(nonnull FLIRDiscoveredCamera *)discoveredCamera;
+
+@end
+
+
+/**
+ Discover cameras on your connected network. Finds a FLIR ONE if connected to your device.
+ 
+ @note Cameras can be reported as found even if they aren't connectable, depending on the implementation (entries could be cached in system services).
+       Similarly camera lost events might be delayed, depending on the implementation (some implementations are only refreshed once per 5 minutes).
+       One should use `FLIRCamera.connect(...)` if faster feedback is required.
+
+ ### Example Usage
+ ```swift
+ import UIKit
+ import ThermalSDK
+ 
+ class ViewController: UIViewController, FLIRDiscoveryEventDelegate {
+ 
+    // Create a discovery object.
+    let discoverer = FLIRDiscovery()
+
+    override func viewDidLoad() {
+        super.viewDidLoad()
+        // Set the discovere delegate to self.
+        discoverer.delegate = self
+        // Start discovery on all supported interfaces.
+        discoverer.start(FLIRCommunicationInterface.FLIRCommunicationInterfaceLightning)
+    }
+ 
+    func cameraFound(_ cameraIdentity: FLIRIdentity) {
+        // Handle discovered camera identity object...
+    }
+ 
+    // Etc ...
+ }
+ ```
+ */
+@interface FLIRDiscovery : NSObject
+
+/**
+ *  Start searching for devices on specified interfaces.
+ *  The operation is asynchronous, scanning will continue in the background until FLIRDiscovery#stop() is called or OS cancels the operation
+ *  @param iface specifying the interfaces to use eg "FLIRCommunicationInterface#FLIRCommunicationInterfaceLightning".
+ */
+-(void) start: (FLIRCommunicationInterface)iface;
+
+/**
+ *  Start searching for devices on specified interfaces.
+ *  The operation is asynchronous, scanning will continue in the background until FLIRDiscovery#stop() is called or OS cancels the operation
+ *  @param iface specifying the interfaces to use eg "FLIRCommunicationInterface#FLIRCommunicationInterfaceLightning".
+ *  @param type specify a specific type to scan for (currently only supported for the emulator)
+ */
+- (void)start:(FLIRCommunicationInterface)iface cameraType:(FLIRCameraType)type;
+
+
+/**
+ *  Stop scanning for devices.
+ *  Does nothing if no scan is active.
+ *  The operation is asynchronous
+ */
+-(void) stop;
+
+/**
+ *  Checks if the scanner is active.
+ *
+ *  @return YES if still scanning for cameras, otherwise NO.
+ */
+-(BOOL) isDiscovering;
+
+/**
+ *  A delegate to handle the events in FLIRDiscoveryEventDelegate.
+ */
+@property (nonatomic, assign, nullable) id<FLIRDiscoveryEventDelegate> delegate;
+
+@end
+
+#endif

package/ios/Flir/Framework/ThermalSDK/FLIRDisplaySettings.h

@@ -0,0 +1,29 @@
+//
+//  FLIRDisplaySettings.h
+//
+//  Copyright © 2020 Teledyne FLIR. All rights reserved.
+//
+
+#import <Foundation/Foundation.h>
+
+/**
+ *  The FLIRDisplaySettings exposes a range of visual attributes which specify how the image is
+ *  displayed. They also specify how image was displayed when it was initially taken by a camera.
+ *  FLIRDisplaySettings allows user to specify a "subsection" of interest, while still keeping the
+ *  entire image available for context.
+ *  For example: taking an image of a car engine, but "zoom-in" to a faulty spark-plug, while keeping
+ *  the entire image of the photographed engine for a context.
+ *  The FLIRDisplaySettings effects both the IR and visual image.
+ */
+@interface FLIRDisplaySettings : NSObject
+
+- (instancetype)initWithZoomFactor:(float)zoomFactor zoomPanX:(int)zoomPanX zoomPanY:(int)zoomPanY;
+
+/** Defines the image zoom factor, where value 1.0 means no zoom. */
+@property (nonatomic, readonly) float zoomFactor;
+/** Defines the image zoom pan/offset in X axis, where value 0 means centered. */
+@property (nonatomic, readonly) int zoomPanX;
+/** Defines the image zoom pan/offset in Y axis, where value 0 means centered. */
+@property (nonatomic, readonly) int zoomPanY;
+
+@end