Merge pull request #3 from myokit/imaxabs

Added iabs_max_on

datkit/__init__.py

@@ -49,6 +49,7 @@
 
 from ._points import (  # noqa
     abs_max_on,
+    iabs_max_on,
     imax_on,
     imin_on,
     index,

datkit/_points.py

@@ -22,6 +22,18 @@ def abs_max_on(times, values, t0=None, t1=None, include_left=True,
     return times[i], values[i]
 
 
+def iabs_max_on(times, values, t0=None, t1=None, include_left=True,
+                include_right=False):
+    """
+    Returns the index ``i`` corresponding to the maximum of ``abs(values)`` on
+    the interval from ``t0`` to ``t1``.
+
+    See also :meth:`index_on`.
+    """
+    i, j = index_on(times, t0, t1, include_left, include_right)
+    return i + np.argmax(np.abs(values[i:j]))
+
+
 def imax_on(times, values, t0=None, t1=None, include_left=True,
             include_right=False):
     """

datkit/tests/test_points.py

@@ -25,6 +25,16 @@ def test_abs_max_on(self):
         self.assertEqual(d.abs_max_on(t, v, 1.5, 2), (t[99], v[99]))
         self.assertEqual(d.abs_max_on(t, v, 1.5, 2, False, True), (2, 1))
 
+    def test_iabs_max_on(self):
+        t = np.linspace(0, 2, 101)
+        v = np.cos(t * np.pi)
+        self.assertEqual(d.iabs_max_on(t, v, 0, 1), 0)
+        self.assertEqual(d.iabs_max_on(t, v, 0.5, 1), 49)
+        self.assertEqual(d.iabs_max_on(t, v, 0.5, 1, True, True), 50)
+        self.assertEqual(d.iabs_max_on(t, v, 0.6, 1.5), 50)
+        self.assertEqual(d.iabs_max_on(t, v, 1.5, 2), 99)
+        self.assertEqual(d.iabs_max_on(t, v, 1.5, 2, False, True), 100)
+
     def test_imax_on(self):
         t = np.linspace(0, 2, 101)
         v = np.cos(t * np.pi)

docs/source/finding_points.rst

@@ -26,3 +26,5 @@ Finding points
 
 .. autofunction:: imin_on
 
+.. autofunction:: iabs_max_on
+