ilabs-flir 1.0.2 → 1.0.4

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

@@ -1,192 +1,192 @@
-//
-//  FLIRFusion.h
-//
-//  Copyright © 2019 Teledyne FLIR. All rights reserved.
-//
-
-#ifndef FLIRFusion_h
-#define FLIRFusion_h
-#endif 
-
-#import "FLIRFusion.h"
-#import "FLIRThermalValue.h"
-#import "FLIRFusionTransformation.h"
-
-/**
- *  Specifies the fusion modes of the thermal image.
- */
-typedef enum FUSION_MODE
-{
-    /** Ordinary IR image. */
-    IR_MODE,
-    
-    /** 
-     * Visual image is zoomed and fused with IR image.
-     * Note: for not aligned DC image use FLIRThermalImage#getPhoto().
-     */
-    VISUAL_MODE,
-    
-    /** Picture in picture fusion, where a defined box/rectangle shape with IR image pixels is placed on top of the visual image. */
-    FUSION_PIP_MODE,
-    
-    /** IR image is blended with visual image based on the specified {@link com.flir.thermalsdk.image.ThermalValue} threshold. */
-    FUSION_THERMAL_MODE,
-    
-    /** Thermal MSX (Multi Spectral Dynamic Imaging) mode displays an infrared image where the edges of the objects are enhanced with information from the visual image. */
-    FUSION_MSX_MODE,
-    
-    /** IR image is blended with visual image based on the specified blending factor value. Use Blending mode to display a blended image that uses a mix of infrared pixels and digital photo pixels. */
-    FUSION_BLENDING_MODE,
-} /**  Specifies the fusion modes of the thermal image. */ FusionMode;
-
-/**
- *  Enumeration of the different fusion color modes.
- */
-typedef enum ColorMode
-{
-				/// <summary>
-				/// Fusion image has visual image in color.
-				/// </summary>
-				Color = 0,
-
-				/// <summary>
-				/// Fusion image has visual image in b/w.
-				/// </summary>
-				BlackAndWhite = 1
-} /** Enumeration of the different fusion color modes. */ VisualColorMode;
-
-/**
- *  This class provides functionality for image fusion.
- *
- *  @note Image fusion is a function that will merge the Thermal image with a photo depending on
- *  the selected fusion mode.
- */
-@interface FLIRFusion : NSObject
-
-/** 
- *  Set the fusion mode
- *
- *  @param mode	The fusion mode.
- */
--(void) setFusionMode: (FusionMode) mode;
-
-/**
- *  Get the fusion mode.
- *
- *  @return The fusion mode.
- */
--(FusionMode) getFusionMode;
-
-/**
- *  Defines multi-spectral fusion image mode.
- *  Thermal MSX (Multi Spectral Dynamic Imaging) mode displays an infrared image where the edges of the objects are enhanced with information from the visual image.
- *  The higher the alpha level, the more edges will be detected.
- *  Thermal image may appear a bit differently for the same MSX alpha value depending on the camera's resolution.
- *  Thus the value should be based on the expected results and visible effect, but typical and suggested values are:
- *  - FLIR ONE gen 2: 2.0 or 3.0
- *  - FLIR ONE gen 3: 8.0 or higher
- *
- *  @note Does no longer change the fusion mode.
- *  @param alpha The intensity of the MSX, indicate how much the visual image is blended with IR (valid value range: [0.0, 100.0]).
- */
--(void) setMSX: (double) alpha;
-
-/**
- * Get thermal image MSX settings.
- */
--(double) getMSX;
-
-/**
- *  Defines the fusion image mode, where Thermal image is displayed in defined area on top of the Visual image.
- *
- *  @note Does no longer change the fusion mode.
- *  @param rect The rectangle where the Thermal image will be placed inside the photo.
- */
--(void) setPictureInPicture: (CGRect) rect;
-
-/**
- *  Get the picture in picture rectangle.
- *
- *  @return Rectangle that defines the PiP position and size.
- */
-- (CGRect) getPictureInPictureRect;
-
-/**
- *  Defines the fusion image mode, where only the visual image is displayed. Settings for FusionMode Visual.
- *  This mode hides the Thermal Image, only the digital photo is displayed.
- *  Note: visual image is zoomed and fused with IR image. For not aligned DC image use FLIRThermalImage#getPhoto().
- *
- *  @note Does no longer change the fusion mode.
- *  @param mode Currently used color scheme the visual image is displayed in.
- */
--(void) setVisualOnly:(VisualColorMode) mode;
-
- /**
-  * Get thermal image visual only settings.
-  */
--(VisualColorMode) getVisualOnly;
-
-/**
- *  Defines the image fusion mode, where thermal and visual image is combined for an output image.
- *
- *  @note Does no longer change the fusion mode.
- *  @param min The minimum blending level between thermal and visual image.
- *  @param max The maximum blending level between thermal and visual image.
- */
-- (void)setThermalFusionWithMin:(FLIRThermalValue * _Nonnull)min andMax:(FLIRThermalValue * _Nonnull) max;
-
-/**
- *  Defines the image fusion mode, where thermal and visual image is combined for an output image.
- *
- *  @note Does no longer change the fusion mode.
- *  @param min The minimum blending level between thermal and visual image.
- */
-- (void)setThermalFusionWithMin:(FLIRThermalValue * _Nonnull)min;
-
-/**
- *  Defines the image fusion mode, where thermal and visual image is combined for an output image.
- *
- *  @note Does no longer change the fusion mode.
- *  @param max The maximum blending level between thermal and visual image.
- */
-- (void)setThermalFusionWithMax:(FLIRThermalValue * _Nonnull)max;
-
-/**
- * Get thermal image thermal fusion min level.
- */
-- (FLIRThermalValue * _Nonnull)getThermalFusionMin;
-
-/**
- * Get thermal image thermal fusion max level.
- */
-- (FLIRThermalValue * _Nonnull)getThermalFusionMax;
-
-
-/**
- *  Defines the fusion image mode, where Thermal image blends with the Visual image.
- *  Use Blending mode to display a blended image that uses a mix of infrared pixels and digital photo pixels.
- *  The blending level between both images can be adjusted based on the temperatures stored for the Thermal image.
- *
- *  @note Does no longer change the fusion mode.
- *  @param level The blending level between thermal and visual image. (1.0 = only IR, 0.0 = only visual).
- *  @param colorMode The color scheme the visual image is displayed in.
- */
-- (void)setBlending:(double)level ColorMode:(VisualColorMode)colorMode;
-
-/**
- * Get thermal image thermal blending level.
- */
-- (double)getBlendingLevel;
-
-/**
- * Get thermal image thermal blending colormode.
- */
-- (VisualColorMode)getBlendingColorMode;
-
-/**  Set fusion transformation. */
-- (void)setTransformation:(FLIRFusionTransformation * _Nonnull)transformation;
-
-/**  Get fusion transformation. */
-- (FLIRFusionTransformation * _Nonnull)getTransformation;
-
-@end
+//
+//  FLIRFusion.h
+//
+//  Copyright © 2019 Teledyne FLIR. All rights reserved.
+//
+
+#ifndef FLIRFusion_h
+#define FLIRFusion_h
+#endif 
+
+#import "FLIRFusion.h"
+#import "FLIRThermalValue.h"
+#import "FLIRFusionTransformation.h"
+
+/**
+ *  Specifies the fusion modes of the thermal image.
+ */
+typedef enum FUSION_MODE
+{
+    /** Ordinary IR image. */
+    IR_MODE,
+    
+    /** 
+     * Visual image is zoomed and fused with IR image.
+     * Note: for not aligned DC image use FLIRThermalImage#getPhoto().
+     */
+    VISUAL_MODE,
+    
+    /** Picture in picture fusion, where a defined box/rectangle shape with IR image pixels is placed on top of the visual image. */
+    FUSION_PIP_MODE,
+    
+    /** IR image is blended with visual image based on the specified {@link com.flir.thermalsdk.image.ThermalValue} threshold. */
+    FUSION_THERMAL_MODE,
+    
+    /** Thermal MSX (Multi Spectral Dynamic Imaging) mode displays an infrared image where the edges of the objects are enhanced with information from the visual image. */
+    FUSION_MSX_MODE,
+    
+    /** IR image is blended with visual image based on the specified blending factor value. Use Blending mode to display a blended image that uses a mix of infrared pixels and digital photo pixels. */
+    FUSION_BLENDING_MODE,
+} /**  Specifies the fusion modes of the thermal image. */ FusionMode;
+
+/**
+ *  Enumeration of the different fusion color modes.
+ */
+typedef enum ColorMode
+{
+				/// <summary>
+				/// Fusion image has visual image in color.
+				/// </summary>
+				Color = 0,
+
+				/// <summary>
+				/// Fusion image has visual image in b/w.
+				/// </summary>
+				BlackAndWhite = 1
+} /** Enumeration of the different fusion color modes. */ VisualColorMode;
+
+/**
+ *  This class provides functionality for image fusion.
+ *
+ *  @note Image fusion is a function that will merge the Thermal image with a photo depending on
+ *  the selected fusion mode.
+ */
+@interface FLIRFusion : NSObject
+
+/** 
+ *  Set the fusion mode
+ *
+ *  @param mode	The fusion mode.
+ */
+-(void) setFusionMode: (FusionMode) mode;
+
+/**
+ *  Get the fusion mode.
+ *
+ *  @return The fusion mode.
+ */
+-(FusionMode) getFusionMode;
+
+/**
+ *  Defines multi-spectral fusion image mode.
+ *  Thermal MSX (Multi Spectral Dynamic Imaging) mode displays an infrared image where the edges of the objects are enhanced with information from the visual image.
+ *  The higher the alpha level, the more edges will be detected.
+ *  Thermal image may appear a bit differently for the same MSX alpha value depending on the camera's resolution.
+ *  Thus the value should be based on the expected results and visible effect, but typical and suggested values are:
+ *  - FLIR ONE gen 2: 2.0 or 3.0
+ *  - FLIR ONE gen 3: 8.0 or higher
+ *
+ *  @note Does no longer change the fusion mode.
+ *  @param alpha The intensity of the MSX, indicate how much the visual image is blended with IR (valid value range: [0.0, 100.0]).
+ */
+-(void) setMSX: (double) alpha;
+
+/**
+ * Get thermal image MSX settings.
+ */
+-(double) getMSX;
+
+/**
+ *  Defines the fusion image mode, where Thermal image is displayed in defined area on top of the Visual image.
+ *
+ *  @note Does no longer change the fusion mode.
+ *  @param rect The rectangle where the Thermal image will be placed inside the photo.
+ */
+-(void) setPictureInPicture: (CGRect) rect;
+
+/**
+ *  Get the picture in picture rectangle.
+ *
+ *  @return Rectangle that defines the PiP position and size.
+ */
+- (CGRect) getPictureInPictureRect;
+
+/**
+ *  Defines the fusion image mode, where only the visual image is displayed. Settings for FusionMode Visual.
+ *  This mode hides the Thermal Image, only the digital photo is displayed.
+ *  Note: visual image is zoomed and fused with IR image. For not aligned DC image use FLIRThermalImage#getPhoto().
+ *
+ *  @note Does no longer change the fusion mode.
+ *  @param mode Currently used color scheme the visual image is displayed in.
+ */
+-(void) setVisualOnly:(VisualColorMode) mode;
+
+ /**
+  * Get thermal image visual only settings.
+  */
+-(VisualColorMode) getVisualOnly;
+
+/**
+ *  Defines the image fusion mode, where thermal and visual image is combined for an output image.
+ *
+ *  @note Does no longer change the fusion mode.
+ *  @param min The minimum blending level between thermal and visual image.
+ *  @param max The maximum blending level between thermal and visual image.
+ */
+- (void)setThermalFusionWithMin:(FLIRThermalValue * _Nonnull)min andMax:(FLIRThermalValue * _Nonnull) max;
+
+/**
+ *  Defines the image fusion mode, where thermal and visual image is combined for an output image.
+ *
+ *  @note Does no longer change the fusion mode.
+ *  @param min The minimum blending level between thermal and visual image.
+ */
+- (void)setThermalFusionWithMin:(FLIRThermalValue * _Nonnull)min;
+
+/**
+ *  Defines the image fusion mode, where thermal and visual image is combined for an output image.
+ *
+ *  @note Does no longer change the fusion mode.
+ *  @param max The maximum blending level between thermal and visual image.
+ */
+- (void)setThermalFusionWithMax:(FLIRThermalValue * _Nonnull)max;
+
+/**
+ * Get thermal image thermal fusion min level.
+ */
+- (FLIRThermalValue * _Nonnull)getThermalFusionMin;
+
+/**
+ * Get thermal image thermal fusion max level.
+ */
+- (FLIRThermalValue * _Nonnull)getThermalFusionMax;
+
+
+/**
+ *  Defines the fusion image mode, where Thermal image blends with the Visual image.
+ *  Use Blending mode to display a blended image that uses a mix of infrared pixels and digital photo pixels.
+ *  The blending level between both images can be adjusted based on the temperatures stored for the Thermal image.
+ *
+ *  @note Does no longer change the fusion mode.
+ *  @param level The blending level between thermal and visual image. (1.0 = only IR, 0.0 = only visual).
+ *  @param colorMode The color scheme the visual image is displayed in.
+ */
+- (void)setBlending:(double)level ColorMode:(VisualColorMode)colorMode;
+
+/**
+ * Get thermal image thermal blending level.
+ */
+- (double)getBlendingLevel;
+
+/**
+ * Get thermal image thermal blending colormode.
+ */
+- (VisualColorMode)getBlendingColorMode;
+
+/**  Set fusion transformation. */
+- (void)setTransformation:(FLIRFusionTransformation * _Nonnull)transformation;
+
+/**  Get fusion transformation. */
+- (FLIRFusionTransformation * _Nonnull)getTransformation;
+
+@end

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

@@ -1,136 +1,136 @@
-//
-//  FLIRFusionController.h
-//  ThermalSDK
-//
-//  Created by FLIR on 2020-07-02.
-//  Copyright © 2020 Teledyne FLIR. All rights reserved.
-//
-
-#import <Foundation/Foundation.h>
-#import <CoreGraphics/CoreGraphics.h>
-
-NS_ASSUME_NONNULL_BEGIN
-
-/**
- * Defines how fusion span level is displayed.
- */
-typedef NS_ENUM(NSUInteger, FLIRFusionSpanLevel) {
-    DC = 0,
-    IR = 1,
-    THERMAL_FUSION = 7
-};
-
-/**
- * Channel mode/type used to display live view on the camera.
- */
-typedef NS_ENUM(NSUInteger, FLIRChannelType) {
-    IR_TYPE,
-    VISUAL,
-    FUSION
-};
-
-/**
- * Definition of image's display mode. Depending on selected mode thermal or visual data is used to
- * render the image. Provides detailed information for fusion.
- */
-typedef NS_ENUM(NSUInteger, FLIRDisplayMode) {
-    /**
-     * The camera sends video in basic mode: {@link ChannelType#IR} or {@link ChannelType#VISUAL}
-     */
-    NONE,
-    /**
-     * The camera video in fusion blending mode.
-     */
-    FUSION_MODE,
-    /**
-     * The camera video in picture in picture mode.
-     */
-    PIP,
-    /**
-     * The camera video in multi-spectral image mode.
-     */
-    MSX,
-    /**
-     * Image displayed a digital.
-     */
-    DIGITAL,
-    /**
-     * Image displayed as difference.
-     */
-    DIFF,
-    /**
-     * Image displayed as blending between thermal and digital images.
-     */
-    BLENDING
-};
-
-/** a wrapper for the display mode */
-@interface FLIRMode : NSObject
-/** display mode */
-@property (nonatomic, assign) FLIRDisplayMode mode;
-@end
-
-/** fusion options for the camera */
-@interface FLIRFusionController : NSObject
-
-/** 
- * Defines the active channel on displaying image on live view on the camera.
- * This property may change dynamically after displayMode property is changed. Emulated cameras are NOT affected.
- */
-- (FLIRChannelType)getActiveChannel;
-/** 
- * Defines the active channel on displaying image on live view on the camera.
- * This property may change dynamically after displayMode property is changed. Emulated cameras are NOT affected.
- * Writing this value should be done with caution, because in order to camera physically change the mode it is also required to apply proper values to displayMode and fusionSpanLevel.
- * This is highly recommended to use displayMode only, which automatically makes sure both fusionSpanLevel and this property are set accordingly.
- * Avoid setting this property while streaming.
- */
-- (BOOL)setActiveChannel: (FLIRChannelType)activeChannel  error: (out NSError * _Nullable *_Nullable)error;
-/** subscribe to changes of the active channel (delegate method will be called when channel changes) */
-- (BOOL)subscribeActiveChannel: (out NSError * _Nullable *_Nullable)error;
-/** unsubscribe to changes of the active channel */
-- (void)unsubscribeActiveChannel;
-
-/** list valid display modes for the camera */
-- (NSArray<FLIRMode*>* _Nullable)getValidModes;
-/** get true if msx is supported */
-- (BOOL)getMsxSupported;
-/** get a rectangle for picture in picture display */
-- (CGRect)getPIPWindow;
-/** set a rectangle for picture in picture display */
-- (BOOL)setPIPWindow: (CGRect)pipWindow error: (out NSError * _Nullable *_Nullable)error;
-/** get true if fusion is always on */
-- (BOOL)getFusionAlwaysOn;
-/** get or set the display mode used */
-- (FLIRDisplayMode)getDisplayMode;
-/** get or set the display mode used */
-- (BOOL)setDisplayMode: (FLIRDisplayMode)displayMode error: (out NSError * _Nullable *_Nullable)error;
-/** 
- * Defines how fusion span level is displayed.
- * This property may change dynamically after displayMode property is changed. Emulated cameras are NOT affected.
- */
-- (FLIRFusionSpanLevel)getFusionSpanLevel;
-/** 
- * Defines how fusion span level is displayed.
- * This property may change dynamically after displayMode property is changed. Emulated cameras are NOT affected.
- * Writing this value should be done with caution, because in order to camera physically change the mode it is also required to apply proper values to displayMode and activeChannel.
- * This is highly recommended to use displayMode only, which automatically makes sure both activeChannel and this property are set accordingly.
- */
-- (BOOL)setFusionSpanLevel: (FLIRFusionSpanLevel)fusionSpanLevel error: (out NSError * _Nullable *_Nullable)error;
-
-/**
- * Set the fusion distance in meters.
- * This is only to be used to modify the fusion distance on a live stream.
- * @param distance distance to the object in meters. Range 0.1 to 10.0
- *  @param error reason for error
-*/
--(BOOL) setFusionDistance:(double) distance error:(out NSError * _Nullable * _Nullable)error;
-
-/**
- *  Gets the fusion distance in meters.
- */
--(double) getFusionDistance;
-
-@end
-
-NS_ASSUME_NONNULL_END
+//
+//  FLIRFusionController.h
+//  ThermalSDK
+//
+//  Created by FLIR on 2020-07-02.
+//  Copyright © 2020 Teledyne FLIR. All rights reserved.
+//
+
+#import <Foundation/Foundation.h>
+#import <CoreGraphics/CoreGraphics.h>
+
+NS_ASSUME_NONNULL_BEGIN
+
+/**
+ * Defines how fusion span level is displayed.
+ */
+typedef NS_ENUM(NSUInteger, FLIRFusionSpanLevel) {
+    DC = 0,
+    IR = 1,
+    THERMAL_FUSION = 7
+};
+
+/**
+ * Channel mode/type used to display live view on the camera.
+ */
+typedef NS_ENUM(NSUInteger, FLIRChannelType) {
+    IR_TYPE,
+    VISUAL,
+    FUSION
+};
+
+/**
+ * Definition of image's display mode. Depending on selected mode thermal or visual data is used to
+ * render the image. Provides detailed information for fusion.
+ */
+typedef NS_ENUM(NSUInteger, FLIRDisplayMode) {
+    /**
+     * The camera sends video in basic mode: {@link ChannelType#IR} or {@link ChannelType#VISUAL}
+     */
+    NONE,
+    /**
+     * The camera video in fusion blending mode.
+     */
+    FUSION_MODE,
+    /**
+     * The camera video in picture in picture mode.
+     */
+    PIP,
+    /**
+     * The camera video in multi-spectral image mode.
+     */
+    MSX,
+    /**
+     * Image displayed a digital.
+     */
+    DIGITAL,
+    /**
+     * Image displayed as difference.
+     */
+    DIFF,
+    /**
+     * Image displayed as blending between thermal and digital images.
+     */
+    BLENDING
+};
+
+/** a wrapper for the display mode */
+@interface FLIRMode : NSObject
+/** display mode */
+@property (nonatomic, assign) FLIRDisplayMode mode;
+@end
+
+/** fusion options for the camera */
+@interface FLIRFusionController : NSObject
+
+/** 
+ * Defines the active channel on displaying image on live view on the camera.
+ * This property may change dynamically after displayMode property is changed. Emulated cameras are NOT affected.
+ */
+- (FLIRChannelType)getActiveChannel;
+/** 
+ * Defines the active channel on displaying image on live view on the camera.
+ * This property may change dynamically after displayMode property is changed. Emulated cameras are NOT affected.
+ * Writing this value should be done with caution, because in order to camera physically change the mode it is also required to apply proper values to displayMode and fusionSpanLevel.
+ * This is highly recommended to use displayMode only, which automatically makes sure both fusionSpanLevel and this property are set accordingly.
+ * Avoid setting this property while streaming.
+ */
+- (BOOL)setActiveChannel: (FLIRChannelType)activeChannel  error: (out NSError * _Nullable *_Nullable)error;
+/** subscribe to changes of the active channel (delegate method will be called when channel changes) */
+- (BOOL)subscribeActiveChannel: (out NSError * _Nullable *_Nullable)error;
+/** unsubscribe to changes of the active channel */
+- (void)unsubscribeActiveChannel;
+
+/** list valid display modes for the camera */
+- (NSArray<FLIRMode*>* _Nullable)getValidModes;
+/** get true if msx is supported */
+- (BOOL)getMsxSupported;
+/** get a rectangle for picture in picture display */
+- (CGRect)getPIPWindow;
+/** set a rectangle for picture in picture display */
+- (BOOL)setPIPWindow: (CGRect)pipWindow error: (out NSError * _Nullable *_Nullable)error;
+/** get true if fusion is always on */
+- (BOOL)getFusionAlwaysOn;
+/** get or set the display mode used */
+- (FLIRDisplayMode)getDisplayMode;
+/** get or set the display mode used */
+- (BOOL)setDisplayMode: (FLIRDisplayMode)displayMode error: (out NSError * _Nullable *_Nullable)error;
+/** 
+ * Defines how fusion span level is displayed.
+ * This property may change dynamically after displayMode property is changed. Emulated cameras are NOT affected.
+ */
+- (FLIRFusionSpanLevel)getFusionSpanLevel;
+/** 
+ * Defines how fusion span level is displayed.
+ * This property may change dynamically after displayMode property is changed. Emulated cameras are NOT affected.
+ * Writing this value should be done with caution, because in order to camera physically change the mode it is also required to apply proper values to displayMode and activeChannel.
+ * This is highly recommended to use displayMode only, which automatically makes sure both activeChannel and this property are set accordingly.
+ */
+- (BOOL)setFusionSpanLevel: (FLIRFusionSpanLevel)fusionSpanLevel error: (out NSError * _Nullable *_Nullable)error;
+
+/**
+ * Set the fusion distance in meters.
+ * This is only to be used to modify the fusion distance on a live stream.
+ * @param distance distance to the object in meters. Range 0.1 to 10.0
+ *  @param error reason for error
+*/
+-(BOOL) setFusionDistance:(double) distance error:(out NSError * _Nullable * _Nullable)error;
+
+/**
+ *  Gets the fusion distance in meters.
+ */
+-(double) getFusionDistance;
+
+@end
+
+NS_ASSUME_NONNULL_END