added docs and moved files for new beat detectors

docs/functions/mmpdv2_beat_detector.md

@@ -0,0 +1,33 @@
+# `MMPDV2_BEAT_DETECTOR` - MMPD PPG beat detector.
+MMPDV2_BEAT_DETECTOR detects beats in a photoplethysmogram (PPG) signal
+using the 'Mountaineer's Method for Peak Detection' beat detector
+
+##  Inputs
++   sig : a vector of PPG values
+
++   fs  : the sampling frequency of the PPG in Hz
+
+##  Outputs
++   peaks : indices of detected pulse peaks
+
++   onsets : indices of detected pulse onsets
+
+##  Reference
+E. J. A. Prada, 'The mountaineer's method for peak detection in photoplethysmographic signals,' Revista Facultad de Ingenieria, vol. 90, pp. 42-50, 2019. <https://doi.org/10.17533/udea.redin.n90a06>
+
+##  Author
++   E. J. Arguello Prada - wrote the code: 'Alpinista_simple_4_todos'
+
++   Peter H. Charlton - did very little, just wrote this wrapper
+
+##  Documentation
+<https://ppg-beats.readthedocs.io/>
+
+##  Version
+1.0
+
+##  License - MIT
+       Copyright (c) 2024 E. J. Arguello Prada and Peter H. Charlton
+       Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+       The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+       THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

docs/functions/msptdfastv2_beat_detector.md

@@ -0,0 +1,31 @@
+# `MSPTDFASTV1_BEAT_DETECTOR` - MSPTDfastv2 (v2.0) PPG beat detector.
+MSPTDFASTV1_BEAT_DETECTOR detects beats in a photoplethysmogram (PPG) signal
+using a refinement of the 'Multi-Scale Peak and Trough Detection' beat detector
+
+##  Inputs
++   sig : a vector of PPG values
+
++   fs  : the sampling frequency of the PPG in Hz
+
+##  Outputs
++   peaks : indices of detected pulse peaks
+
++   onsets : indices of detected pulse troughs (i.e. onsets)
+
+##  Reference
+P. H. Charlton et al., 'The MSPTDfast photoplethysmography beat detection algorithm: Design, benchmarking, and open-source distribution,' Under Review, <URL TBC>
+
+##  Author
+Peter H. Charlton
+
+##  Documentation
+<https://ppg-beats.readthedocs.io/>
+
+##  Version
+1.1
+
+##  License - MIT
+       Copyright (c) 2024 Peter H. Charlton
+       Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+       The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+       THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

docs/functions/wepd_beat_detector.md

@@ -0,0 +1,31 @@
+# `WEPD_BEAT_DETECTOR` - WEPD PPG beat detector.
+WEPD_BEAT_DETECTOR detects beats in a photoplethysmogram (PPG) signal
+using the 'waveform envelope peak detection' (WEPD) beat detector
+
+##  Inputs
++   sig : a vector of PPG values
+
++   fs  : the sampling frequency of the PPG in Hz
+
+##  Outputs
++   peaks : indices of detected pulse peaks
+
++   onsets : indices of detected pulse onsets
+
+##  Reference
+D. Han et al., 'A Real-Time PPG Peak Detection Method for Accurate Determination of Heart Rate during Sinus Rhythm and Cardiac Arrhythmia,' Biosensors, vol. 12, no. 2, p. 82, 2022. <https://doi.org/10.3390/bios12020082>
+
+##  Author
+Peter H. Charlton
+
+##  Documentation
+<https://ppg-beats.readthedocs.io/>
+
+##  Version
+1.1
+
+##  License - MIT
+       Copyright (c) 2022 Peter H. Charlton
+       Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+       The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+       THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.