Added video recording

Author: ecyoung3

.gitignore

@@ -9,6 +9,7 @@ __pycache__/
 # IDE files
 .vscode/
 .spyproject/
+*.code-workspace
 
 # Distribution / packaging
 .Python

frheed/__init__.py

@@ -1,5 +1,3 @@
-# -*- coding: utf-8 -*-
-
 __author__ = "Elliot Young"
 __email__ = "elliot.young1996@gmail.com"
 # __version__ = "3.0.0"

frheed/calcs.py

@@ -1,4 +1,3 @@
-# -*- coding: utf-8 -*-
 """
 Functions for computing values from plots.
 """
@@ -16,8 +15,7 @@
 
 
 def calc_fft(x: list, y: list) -> tuple:
-    """
-    Calculate the FFT of a 1D series.
+    """Calculate the FFT of a 1D series.
 
     Parameters
     ----------
@@ -89,24 +87,46 @@ def apply_cutoffs(
         y: list, 
         minval: Optional[float] = None, 
         maxval: Optional[float] = None
-        ) -> tuple:
-    """ Return data that falls between a certain range. Pass None to use min or max. """
+    ) -> tuple:
+    """Return data that falls between a certain range. Pass None to use min or max of the array. 
+
+    Args:
+        x (list): x values; data is filtered based on these values
+        y (list): y values
+        minval (Optional[float], optional): Cutoff minimum (inclusive). Defaults to None if no lower bound.
+        maxval (Optional[float], optional): Cutoff maximum (inclusive). Defaults to None if no upper bound.
+
+    Returns:
+        tuple: the filtered x and y arrays
+    """
 
-    # Return if x or y is empty
-    if len(x) + len(y) == 0:
+    # Return if x or y is empty or if min or max not provided
+    if (len(x) + len(y) == 0) or (minval is None and maxval is None):
         return (x, y)
+
+    # Convert x and y to numpy arrays
     x, y = map(np.array, (x, y))
-    minval = minval or min(x)
-    maxval = maxval or max(x)
-    orig_x = x.copy()
-    mask = (orig_x >= minval) & (orig_x <= maxval)
+
+    # Create mask if there's a minimum cutoff but not maximum
+    if minval is not None and maxval is None:
+        mask = (x >= minval)
+
+    # Create mask if there's a maximum cutoff but not minimum
+    elif maxval is not None and minval is None:
+        mask = (x <= maxval)
+
+    # Mask both
+    else:
+        mask = (x >= minval) & (x <= maxval)
+
+    # Return masked elements
     return (x[mask], y[mask])
 
 def detect_peaks(
         x: Union[list, tuple, np.ndarray],
         y: Union[list, tuple, np.ndarray],
         min_freq: Optional[float] = 0.0
-        ) -> list:
+    ) -> list:
 
     # Catch numpy RuntimeWarning as exceptions
     import warnings
@@ -130,13 +150,13 @@ def detect_peaks(
             prominence = None
 
             # Find peaks
-            peak_indices, props = find_peaks(
-                                        y, 
-                                        height = height,
-                                        threshold = threshold,
-                                        distance = distance,
-                                        prominence = prominence
-                                        )
+            peak_indices, _ = find_peaks(
+                y, 
+                height = height,
+                threshold = threshold,
+                distance = distance,
+                prominence = prominence
+            )
 
             # Get corresponding x-coordinates
             return [x[idx] for idx in peak_indices]

frheed/cameras/__init__.py

@@ -1,4 +1,2 @@
-# -*- coding: utf-8 -*-
-
 class CameraError(Exception):
     pass

frheed/cameras/flir/__init__.py

@@ -1,4 +1,3 @@
-# -*- coding: utf-8 -*-
 """
 Connecting to FLIR cameras.
 Adapted from simple_pyspin: https://github.com/klecknerlab/simple_pyspin
@@ -7,6 +6,7 @@
 from typing import Tuple, Union
 import time
 import numpy as np
+from collections import deque
 
 from frheed.cameras import CameraError
 
@@ -219,7 +219,7 @@ def __init__(self, src: Union[int, str] = 0, lock: bool = False):
 
         # Other attributes which may be accessed later
         self._running = False
-        self._frame_times = []
+        self._frame_times = deque()
         self._incomplete_image_count = 0
 
     def __getattr__(self, attr: str) -> object:
@@ -362,15 +362,11 @@ def real_fps(self) -> float:
         if len(self._frame_times) <= 1:
             return 0.
 
-        # When fewer than 60 frames have been captured in this acquisition
-        elif len(self._frame_times) < 60:
+        # Calculate average of all frames
+        else:
             dt = (self._frame_times[-1] - self._frame_times[0])
             return len(self._frame_times) / max(dt, 1)
 
-        # Return the average frame time of the last 60 frames
-        else:
-            return 60 / (self._frame_times[-1] - self._frame_times[-60])
-
     @property
     def width(self) -> int:
         if not self.initialized:
@@ -464,7 +460,7 @@ def stop(self) -> None:
 
         if self.running:
             self.cam.EndAcquisition()
-        self._frame_times = []
+        self._frame_times = deque()
         self._incomplete_image_count = 0
         self._running = False
 
@@ -554,10 +550,13 @@ def get_array(
         # Store frame time for real FPS calculation
         self._frame_times.append(time.time())
 
+        # Remove the oldest frame if there are more than 60
+        if len(self._frame_times) > 3600:
+            self._frame_times.popleft()
+
         if get_chunk:
             return img.GetNDArray(), img.GetChunkData()
         else:
-            self._frame_times.append(time.time())
             return img.GetNDArray()
 
     def get_info(self, name: str) -> dict:
@@ -592,11 +591,9 @@ def get_info(self, name: str) -> dict:
         if hasattr(node, "GetAccessMode"):
             access = node.GetAccessMode()
             info["access"] = self._rw_modes.get(access, access)
-            # print(info["access"])
             if isinstance(info["access"], str) and "read" in info["access"]:
                 info["value"] = getattr(self, name)
 
-        # print(info)
         if info.get("access") != 0:
             for attr in ("description", "unit", "min", "max"):
                 fname = "Get" + attr.capitalize()

frheed/cameras/flir/install_pyspin.py

@@ -1,7 +1,7 @@
-# -*- coding: utf-8 -*-
-
 """
 Install the spinnaker .whl file located in /spinnaker/...
+Spinnaker can be downloaded from the Teledyne FLIR website: 
+    https://flir.app.boxcn.net/v/SpinnakerSDK
 """
 
 import os
@@ -14,15 +14,26 @@
 logger = get_logger()
 
 
-def install_pyspin() -> None:
-    """ Install PySpin from the appropriate .whl file """
+def install_pyspin(reinstall: bool=False) -> None:
+    """Install PySpin from the downloaded .whl file located in a ./spinnaker folder.
+
+    Args:
+        reinstall (bool, optional): Whether or not to install even if PySpin is already installed. Defaults to False.
+
+    Raises:
+        ValueError: If the current platform is unsupported (only 32 and 64-bit windows are supported).
+        ValueError: If an appropriate .whl file is not found for the current platform.
+    """
 
     # Check if PySpin is already installed
     try:
         import PySpin
         if __name__ == "__main__":
             logger.info("PySpin is already installed")
-        return 
+
+        # Return if not reinstalling
+        if not reinstall:
+            return 
 
     except ImportError:
         pass
@@ -70,9 +81,11 @@ def install_pyspin() -> None:
     except ImportError:
         logger.info(f"PySpin failed to install from {whl_filepath}")
 
+
 if __name__ == "__main__":
-    def test():
-        os.chdir(str(Path(__file__).parents[3]))
-        install_pyspin()
-        
-    test()
+    #install_pyspin(reinstall=True)
+    import PySpin
+    system = PySpin.System#.GetInstance()
+    print(system)
+    import os
+    print(os.environ["FLIR_GENTL64_CTI_VS140"])

frheed/cameras/flir/spinnaker_win32/README.txt

@@ -38,6 +38,8 @@ TABLE OF CONTENTS
 1.3 INSTALLATION ON MACOS
 2. API DIFFERENCES
 3. REMOVE PYSPIN
+4. TROUBLESHOOT
+4.1 TROUBLESHOOT LINUX ISSUES
 
 =============================================================================
 1. INSTALLATION
@@ -201,12 +203,12 @@ using the following:
 -----------------------------------------------------------------------------
 
 1. Check that Python is installed. MacOS comes with Python 2.7 installed,
-   but it may be an older build of Python. 
+   but it may be an older build of Python.
    There are several ways to install Up-to-date Python packages,
-   but the recommended way is to use pyenv - the python package manager, 
+   but the recommended way is to use pyenv - the python package manager,
    which manages multiple versions of Python effectively.
    (installing python using a method that does not use pyenv, can result in run-time errors due to mixed running Python versions)
-   
+
    - For example: to install the specific python version python 3.7.7 do the following steps:
    # Update brew
    brew update
@@ -379,3 +381,27 @@ For Linux or MacOS, if you need to remove PySpin from a site-wide install the
 following command needs to be run as sudo to remove your associated Python version:
 
 sudo <python version> -m pip uninstall spinnaker-python
+
+
+=============================================================================
+4. TROUBLESHOOT
+=============================================================================
+
+-----------------------------------------------------------------------------
+4.1 LINUX ISSUES
+-----------------------------------------------------------------------------
+
+There is an existing issue with numpy 1.19.5 on Linux ARM64 architecture where
+importing PySpin could result in an 'Illegal instruction' error. The issue
+originates from a numpy bug that is fixed in 1.20 but the new version will not
+be available for older versions of python (<= 3.6).
+
+More details for the numpy issue can be found here:
+https://github.com/numpy/numpy/issues/18131#issuecomment-794200556
+
+You can workaround the issue by:
+- Downgrading numpy to version 1.19.4
+- Upgrading numpy to version 1.20.x (if you are using python > 3.6)
+- Setting the environment variable OPENBLAS_CORETYPE=ARMV8
+- Compiling from source on the failing ARM hardware
+  pip install --no-binary :all: numpy==1.19.5

frheed/cameras/flir/spinnaker_win32/licenses/Spinnaker-Open-Source-Licenses.pdf

@@ -38,6 +38,8 @@ TABLE OF CONTENTS
 1.3 INSTALLATION ON MACOS
 2. API DIFFERENCES
 3. REMOVE PYSPIN
+4. TROUBLESHOOT
+4.1 TROUBLESHOOT LINUX ISSUES
 
 =============================================================================
 1. INSTALLATION
@@ -201,12 +203,12 @@ using the following:
 -----------------------------------------------------------------------------
 
 1. Check that Python is installed. MacOS comes with Python 2.7 installed,
-   but it may be an older build of Python. 
+   but it may be an older build of Python.
    There are several ways to install Up-to-date Python packages,
-   but the recommended way is to use pyenv - the python package manager, 
+   but the recommended way is to use pyenv - the python package manager,
    which manages multiple versions of Python effectively.
    (installing python using a method that does not use pyenv, can result in run-time errors due to mixed running Python versions)
-   
+
    - For example: to install the specific python version python 3.7.7 do the following steps:
    # Update brew
    brew update
@@ -379,3 +381,27 @@ For Linux or MacOS, if you need to remove PySpin from a site-wide install the
 following command needs to be run as sudo to remove your associated Python version:
 
 sudo <python version> -m pip uninstall spinnaker-python
+
+
+=============================================================================
+4. TROUBLESHOOT
+=============================================================================
+
+-----------------------------------------------------------------------------
+4.1 LINUX ISSUES
+-----------------------------------------------------------------------------
+
+There is an existing issue with numpy 1.19.5 on Linux ARM64 architecture where
+importing PySpin could result in an 'Illegal instruction' error. The issue
+originates from a numpy bug that is fixed in 1.20 but the new version will not
+be available for older versions of python (<= 3.6).
+
+More details for the numpy issue can be found here:
+https://github.com/numpy/numpy/issues/18131#issuecomment-794200556
+
+You can workaround the issue by:
+- Downgrading numpy to version 1.19.4
+- Upgrading numpy to version 1.20.x (if you are using python > 3.6)
+- Setting the environment variable OPENBLAS_CORETYPE=ARMV8
+- Compiling from source on the failing ARM hardware
+  pip install --no-binary :all: numpy==1.19.5

frheed/cameras/flir/spinnaker_win32/spinnaker_python-2.4.0.144-cp38-cp38-win32.whl frheed/cameras/flir/spinnaker_win32/spinnaker_python-2.7.0.128-cp38-cp38-win32.whl

@@ -0,0 +1 @@
+<meta http-equiv="Refresh" content="0; url='https://www.flir.ca/support-center/iis/machine-vision/knowledge-base/mv-getting-started/'" />