implement suggestions from code review

lumispy/hyperspy_extension.yaml

@@ -150,9 +150,10 @@ signals:
     lazy: True
     module: lumispy.signals.luminescence_transient
 
-  TransientSpectrumCasting:
-    signal_type: TransientSpec
+  TransientSpectrumCasting: # allows casting to either Luminescence or Transient when dimensionality is reduced
+    signal_type: TransientSpectrum
     signal_type_aliases:
+      - TransientSpec
       - TRLumiSpec
       - TR luminescence spectrum
       - time-resolved luminescence spectrum
@@ -162,8 +163,9 @@ signals:
     hidden: True
     module: lumispy.signals.luminescence_transientspec
   LumiTransientSpectrum:
-    signal_type: TransientSpec
+    signal_type: TransientSpectrum
     signal_type_aliases:
+      - TransientSpec
       - TRLumiSpec
       - TR luminescence spectrum
       - time-resolved luminescence spectrum
@@ -172,8 +174,9 @@ signals:
     lazy: False
     module: lumispy.signals.luminescence_transientspec
   LazyLumiTransientSpectrum:
-    signal_type: TransientSpec
+    signal_type: TransientSpectrum
     signal_type_aliases:
+      - TransientSpec
       - TRLumiSpec
       - TR luminescence spectrum
       - time-resolved luminescence spectrum

lumispy/signals/luminescence_transient.py

@@ -33,6 +33,9 @@ class LumiTransient(Signal1D, CommonTransient):
     _signal_type = "Transient"
     _signal_dimension = 1
 
+    def __init(self, *args, **kwargs):
+        super().__init__(*args, **kwargs)
+
 
 class LazyLumiTransient(LazySignal, LumiTransient):
     """**General lazy 1D luminescence signal class (transient/time resolved)**"""

lumispy/signals/luminescence_transientspec.py

@@ -21,6 +21,8 @@
 -------------------------------------------------
 """
 
+import pint
+
 from hyperspy.signals import Signal1D, Signal2D
 from hyperspy._signals.lazy import LazySignal
 
@@ -30,34 +32,41 @@
 
 
 class TransientSpectrumCasting(Signal1D, CommonLumi, CommonTransient):
-    """**1D signal class for casting reduced LumiTransientSpectrum to either Luminescence or Transient**"""
+    """**Hidden signal class**
+    1D version of ``TransientSpectrum`` signal class for casting
+    ``LumiTransientSpectrum` to either ``Luminescence`` or ``Transient``
+    when the signal dimensionality is reduced.
+
+    Example:
+    --------
+
+    >>> s = LumiTransientSpectrum(np.random.random((10, 10, 10, 10))) * 2
+    >>> s.axes_manager.signal_axes[-1].units = 'ps'
+    >>> s.axes_manager.signal_axes[0].units = 'nm'
+    >>> s.sum(axis=-1)
+    >>> s
+    <LumiSpectrum, title: , dimensions: (10, 10|10)>
+    """
 
-    _signal_type = "TransientSpec"
+    _signal_type = "TransientSpectrum"
     _signal_dimension = 1
 
     def __init__(self, *args, **kwargs):
-        if hasattr(self, "axes_manager") and self.axes_manager[-1].units in [
-            "fs",
-            "ps",
-            "ns",
-            "µs",
-            "mus",
-            "ms",
-            "s",
-        ]:
-            self.metadata.Signal.signal_type = "Transient"
-            self.__class__ = LumiTransient
-            self.__init__(*args, **kwargs)
+        ureg = pint.UnitRegistry()
+        if (
+            hasattr(self, "axes_manager")
+            and ureg(self.axes_manager.signal_axes[-1].units).dimensionality
+            == ureg("s").dimensionality
+        ):
+            self.set_signal_type("Transient")
         else:
-            self.metadata.Signal.signal_type = "Luminescence"
-            self.__class__ = LumiSpectrum
-            self.__init__(*args, **kwargs)
+            self.set_signal_type("Luminescence")
 
 
 class LumiTransientSpectrum(Signal2D, CommonLumi, CommonTransient):
     """**2D luminescence signal class (spectrum+transient/time resolved dimensions)**"""
 
-    _signal_type = "TransientSpec"
+    _signal_type = "TransientSpectrum"
     _signal_dimension = 2
 
 

lumispy/tests/signals/test_common_luminescence.py

@@ -57,6 +57,8 @@ def test_remove_negative(self):
     def test_scale_by_exposure(self):
         s1 = LumiSpectrum(np.ones((10, 10, 10)))
         s2 = LumiTransientSpectrum(np.ones((10, 10, 10, 10)))
+        s2.axes_manager.signal_axes[-1].units = "ns"
+        s2.axes_manager.signal_axes[0].units = "nm"
         s4 = LumiSpectrum(np.ones((10)))
         s2.metadata.set_item("Acquisition_instrument.Detector.integration_time", 2)
         s2.metadata.set_item("Signal.quantity", "Intensity (Counts)")
@@ -98,6 +100,8 @@ def test_scale_by_exposure(self):
     def test_normalize(self):
         s1 = LumiSpectrum(np.random.random((10, 10, 10))) * 2
         s2 = LumiTransientSpectrum(np.random.random((10, 10, 10, 10))) * 2
+        s2.axes_manager.signal_axes[-1].units = "ps"
+        s2.axes_manager.signal_axes[0].units = "nm"
         s3 = LumiSpectrum(np.random.random((10, 10))) * 2
         s4 = LumiSpectrum(np.random.random((10))) * 2
         s4.metadata.set_item("Signal.quantity", "Intensity (counts)")

pyproject.toml

@@ -26,6 +26,7 @@ dependencies = [
     "hyperspy >= 1.7",  # earlier versions do not provide non-uniform axes
     "numpy",
     "scipy",
+    "pint>=0.10",
 ]
 keywords = [
     "CL",