ilabs-flir 1.0.2 → 1.0.3

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

@@ -1,204 +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
+//
+//  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

@@ -1,82 +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
+//
+//  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

@@ -1,44 +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
+//
+//  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