Darien Figueroa / Mbed 2 deprecated repo3

repo time

Dependencies:   mbed MAX14720 MAX30205 USBDevice

HspGuiSourceV301/HSPGui/Algorithm/MaximAlgorithmClass.cs@20:6d2af70c92ab, 2021-04-06 (annotated)

Committer:
darienf
Date:
Tue Apr 06 06:41:40 2021 +0000
Revision:
20:6d2af70c92ab
another repo

Who changed what in which revision?

UserRevisionLine numberNew contents of line
darienf 20:6d2af70c92ab 1 /*******************************************************************************
darienf 20:6d2af70c92ab 2 * Copyright (C) 2016 Maxim Integrated Products, Inc., All rights Reserved.
darienf 20:6d2af70c92ab 3 *
darienf 20:6d2af70c92ab 4 * This software is protected by copyright laws of the United States and
darienf 20:6d2af70c92ab 5 * of foreign countries. This material may also be protected by patent laws
darienf 20:6d2af70c92ab 6 * and technology transfer regulations of the United States and of foreign
darienf 20:6d2af70c92ab 7 * countries. This software is furnished under a license agreement and/or a
darienf 20:6d2af70c92ab 8 * nondisclosure agreement and may only be used or reproduced in accordance
darienf 20:6d2af70c92ab 9 * with the terms of those agreements. Dissemination of this information to
darienf 20:6d2af70c92ab 10 * any party or parties not specified in the license agreement and/or
darienf 20:6d2af70c92ab 11 * nondisclosure agreement is expressly prohibited.
darienf 20:6d2af70c92ab 12 *
darienf 20:6d2af70c92ab 13 * The above copyright notice and this permission notice shall be included
darienf 20:6d2af70c92ab 14 * in all copies or substantial portions of the Software.
darienf 20:6d2af70c92ab 15 *
darienf 20:6d2af70c92ab 16 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
darienf 20:6d2af70c92ab 17 * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
darienf 20:6d2af70c92ab 18 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
darienf 20:6d2af70c92ab 19 * IN NO EVENT SHALL MAXIM INTEGRATED BE LIABLE FOR ANY CLAIM, DAMAGES
darienf 20:6d2af70c92ab 20 * OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
darienf 20:6d2af70c92ab 21 * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
darienf 20:6d2af70c92ab 22 * OTHER DEALINGS IN THE SOFTWARE.
darienf 20:6d2af70c92ab 23 *
darienf 20:6d2af70c92ab 24 * Except as contained in this notice, the name of Maxim Integrated
darienf 20:6d2af70c92ab 25 * Products, Inc. shall not be used except as stated in the Maxim Integrated
darienf 20:6d2af70c92ab 26 * Products, Inc. Branding Policy.
darienf 20:6d2af70c92ab 27 *
darienf 20:6d2af70c92ab 28 * The mere transfer of this software does not imply any licenses
darienf 20:6d2af70c92ab 29 * of trade secrets, proprietary technology, copyrights, patents,
darienf 20:6d2af70c92ab 30 * trademarks, maskwork rights, or any other form of intellectual
darienf 20:6d2af70c92ab 31 * property whatsoever. Maxim Integrated Products, Inc. retains all
darienf 20:6d2af70c92ab 32 * ownership rights.
darienf 20:6d2af70c92ab 33 *******************************************************************************
darienf 20:6d2af70c92ab 34 */
darienf 20:6d2af70c92ab 35
darienf 20:6d2af70c92ab 36 using System;
darienf 20:6d2af70c92ab 37 using System.Collections.Generic;
darienf 20:6d2af70c92ab 38 using System.Linq;
darienf 20:6d2af70c92ab 39 using System.Text;
darienf 20:6d2af70c92ab 40
darienf 20:6d2af70c92ab 41 //------------------------------------------------------------------------------------------
darienf 20:6d2af70c92ab 42 // OS24EVK-59 split into HeartRateApp EXE and MAX30101 DLL.
darienf 20:6d2af70c92ab 43 // Moved all MAX30101 DLL classes into namespace Maxim.MAX30101GUI
darienf 20:6d2af70c92ab 44 // Moved all HeartRateApp GUI classes into namespace Maxim.MAX30101
darienf 20:6d2af70c92ab 45 // OS24EVK-59 Create separate project that builds Maxim.MAX30101GUI DLL library
darienf 20:6d2af70c92ab 46
darienf 20:6d2af70c92ab 47 namespace Maxim.MAX30101GUI
darienf 20:6d2af70c92ab 48 {
darienf 20:6d2af70c92ab 49 /// <summary>
darienf 20:6d2af70c92ab 50 /// Base class common to any HeartRate / SpO2 algorithm.
darienf 20:6d2af70c92ab 51 /// Input is Red / IR / Green LED data, output is Heart Rate and SpO2.
darienf 20:6d2af70c92ab 52 /// </summary>
darienf 20:6d2af70c92ab 53 public class MaximAlgorithmClass : InterfaceRedIRGreenLEDdataConsumer
darienf 20:6d2af70c92ab 54 {
darienf 20:6d2af70c92ab 55 public MaximAlgorithmClass()
darienf 20:6d2af70c92ab 56 {
darienf 20:6d2af70c92ab 57 Name = "Maxim Generic Algorithm Base Class";
darienf 20:6d2af70c92ab 58 }
darienf 20:6d2af70c92ab 59
darienf 20:6d2af70c92ab 60 public string Name;
darienf 20:6d2af70c92ab 61 public int _sampleNumber;
darienf 20:6d2af70c92ab 62 public int _sampleNumberLastValidHR;
darienf 20:6d2af70c92ab 63 public int _sampleNumberLastValidSpO2;
darienf 20:6d2af70c92ab 64
darienf 20:6d2af70c92ab 65 public double _heartRateBPM;
darienf 20:6d2af70c92ab 66 public bool _heartRateBPMValid;
darienf 20:6d2af70c92ab 67 public double _heartRateBPMSignalStrength;
darienf 20:6d2af70c92ab 68 public double _spO2Percent;
darienf 20:6d2af70c92ab 69 public bool _spO2PercentValid;
darienf 20:6d2af70c92ab 70 public double _spO2PercentSignalStrength;
darienf 20:6d2af70c92ab 71
darienf 20:6d2af70c92ab 72 /// <summary>
darienf 20:6d2af70c92ab 73 /// Clear any internal class members,
darienf 20:6d2af70c92ab 74 /// in response to startMonitorToolStripMenuItem
darienf 20:6d2af70c92ab 75 /// </summary>
darienf 20:6d2af70c92ab 76 public virtual void Clear()
darienf 20:6d2af70c92ab 77 {
darienf 20:6d2af70c92ab 78 }
darienf 20:6d2af70c92ab 79
darienf 20:6d2af70c92ab 80 /// <summary>
darienf 20:6d2af70c92ab 81 /// <para>InterfaceRedIRGreenLEDdataConsumer</para>
darienf 20:6d2af70c92ab 82 /// <para>Producer-Consumer data sink for
darienf 20:6d2af70c92ab 83 /// raw Red/IR/Green LED data.
darienf 20:6d2af70c92ab 84 /// Produced by MAX30101, consumed by algorithm.
darienf 20:6d2af70c92ab 85 /// </para>
darienf 20:6d2af70c92ab 86 /// </summary>
darienf 20:6d2af70c92ab 87 /// <param name="sampleNumber"></param>
darienf 20:6d2af70c92ab 88 /// <param name="rawIR"></param>
darienf 20:6d2af70c92ab 89 /// <param name="rawRed"></param>
darienf 20:6d2af70c92ab 90 /// <param name="rawGreen"></param>
darienf 20:6d2af70c92ab 91 /// <param name="rawIRvalid"></param>
darienf 20:6d2af70c92ab 92 /// <param name="rawRedvalid"></param>
darienf 20:6d2af70c92ab 93 /// <param name="rawGreenvalid"></param>
darienf 20:6d2af70c92ab 94 public virtual void ConsumeRedIRGreenLEDdata(
darienf 20:6d2af70c92ab 95 int sampleNumber,
darienf 20:6d2af70c92ab 96 int rawIR,
darienf 20:6d2af70c92ab 97 int rawRed,
darienf 20:6d2af70c92ab 98 int rawGreen,
darienf 20:6d2af70c92ab 99 bool rawIRvalid,
darienf 20:6d2af70c92ab 100 bool rawRedvalid,
darienf 20:6d2af70c92ab 101 bool rawGreenvalid
darienf 20:6d2af70c92ab 102 )
darienf 20:6d2af70c92ab 103 {
darienf 20:6d2af70c92ab 104 _sampleNumber = sampleNumber;
darienf 20:6d2af70c92ab 105 }
darienf 20:6d2af70c92ab 106
darienf 20:6d2af70c92ab 107 // prepare for OS24EVK-37 by adding SensorTemperatureDegreesC(double) to InterfaceRedIRGreenLEDdataConsumer
darienf 20:6d2af70c92ab 108 public double _temperatureDegreesC;
darienf 20:6d2af70c92ab 109
darienf 20:6d2af70c92ab 110 /// <summary>
darienf 20:6d2af70c92ab 111 /// <para>Temperature measured at MAX30101, optionally used by algorithm to estimate actual Red LED wavelength.</para>
darienf 20:6d2af70c92ab 112 /// </summary>
darienf 20:6d2af70c92ab 113 /// <param name="temperatureDegreesC"></param>
darienf 20:6d2af70c92ab 114 public void SensorTemperatureDegreesC(double temperatureDegreesC)
darienf 20:6d2af70c92ab 115 {
darienf 20:6d2af70c92ab 116 _temperatureDegreesC = temperatureDegreesC;
darienf 20:6d2af70c92ab 117 }
darienf 20:6d2af70c92ab 118
darienf 20:6d2af70c92ab 119 /// <summary>
darienf 20:6d2af70c92ab 120 /// <para>Delegate type for event <see cref="OnHeartRateSpO2dataAvailable"/></para>
darienf 20:6d2af70c92ab 121 /// </summary>
darienf 20:6d2af70c92ab 122 /// <param name="heartRateBPM"></param>
darienf 20:6d2af70c92ab 123 /// <param name="heartRateBPMValid"></param>
darienf 20:6d2af70c92ab 124 /// <param name="heartRateBPMSignalStrength"></param>
darienf 20:6d2af70c92ab 125 /// <param name="spO2Percent"></param>
darienf 20:6d2af70c92ab 126 /// <param name="spO2PercentValid"></param>
darienf 20:6d2af70c92ab 127 /// <param name="spO2PercentSignalStrength"></param>
darienf 20:6d2af70c92ab 128 public delegate void OnHeartRateSpO2dataAvailableHandler(
darienf 20:6d2af70c92ab 129 double heartRateBPM,
darienf 20:6d2af70c92ab 130 bool heartRateBPMValid,
darienf 20:6d2af70c92ab 131 double heartRateBPMSignalStrength,
darienf 20:6d2af70c92ab 132 double spO2Percent,
darienf 20:6d2af70c92ab 133 bool spO2PercentValid,
darienf 20:6d2af70c92ab 134 double spO2PercentSignalStrength
darienf 20:6d2af70c92ab 135 );
darienf 20:6d2af70c92ab 136
darienf 20:6d2af70c92ab 137 /// <summary>
darienf 20:6d2af70c92ab 138 /// <para>Occurs when HeartRate Data Available Event happens.
darienf 20:6d2af70c92ab 139 /// </para>
darienf 20:6d2af70c92ab 140 /// <para>An algorithm reports its results by invoking
darienf 20:6d2af70c92ab 141 /// <code>OnHeartRateSpO2dataAvailable(heartRateBPM, heartRateBPMValid, heartRateBPMSignalStrength, spO2Percent, spO2PercentValid, spO2PercentSignalStrength);</code>
darienf 20:6d2af70c92ab 142 /// </para>
darienf 20:6d2af70c92ab 143 /// </summary>
darienf 20:6d2af70c92ab 144 public event OnHeartRateSpO2dataAvailableHandler OnHeartRateSpO2dataAvailable;
darienf 20:6d2af70c92ab 145
darienf 20:6d2af70c92ab 146 /// <summary>
darienf 20:6d2af70c92ab 147 /// Report the results of running the algorithm,
darienf 20:6d2af70c92ab 148 /// by firing the OnHeartRateSpO2dataAvailable event.
darienf 20:6d2af70c92ab 149 /// </summary>
darienf 20:6d2af70c92ab 150 /// <param name="heartRateBPM"></param>
darienf 20:6d2af70c92ab 151 /// <param name="heartRateBPMValid"></param>
darienf 20:6d2af70c92ab 152 /// <param name="heartRateBPMSignalStrength"></param>
darienf 20:6d2af70c92ab 153 /// <param name="spO2Percent"></param>
darienf 20:6d2af70c92ab 154 /// <param name="spO2PercentValid"></param>
darienf 20:6d2af70c92ab 155 /// <param name="spO2PercentSignalStrength"></param>
darienf 20:6d2af70c92ab 156 public void ReportResultsHeartRateSpO2dataAvailable(
darienf 20:6d2af70c92ab 157 double heartRateBPM,
darienf 20:6d2af70c92ab 158 bool heartRateBPMValid,
darienf 20:6d2af70c92ab 159 double heartRateBPMSignalStrength,
darienf 20:6d2af70c92ab 160 double spO2Percent,
darienf 20:6d2af70c92ab 161 bool spO2PercentValid,
darienf 20:6d2af70c92ab 162 double spO2PercentSignalStrength
darienf 20:6d2af70c92ab 163 )
darienf 20:6d2af70c92ab 164 {
darienf 20:6d2af70c92ab 165 _heartRateBPM = heartRateBPM;
darienf 20:6d2af70c92ab 166 _heartRateBPMValid = heartRateBPMValid;
darienf 20:6d2af70c92ab 167 _heartRateBPMSignalStrength = heartRateBPMSignalStrength;
darienf 20:6d2af70c92ab 168 _spO2Percent = spO2Percent;
darienf 20:6d2af70c92ab 169 _spO2PercentValid = spO2PercentValid;
darienf 20:6d2af70c92ab 170 _spO2PercentSignalStrength = spO2PercentSignalStrength;
darienf 20:6d2af70c92ab 171 if (heartRateBPMValid)
darienf 20:6d2af70c92ab 172 {
darienf 20:6d2af70c92ab 173 _sampleNumberLastValidHR = _sampleNumber;
darienf 20:6d2af70c92ab 174 }
darienf 20:6d2af70c92ab 175 if (spO2PercentValid)
darienf 20:6d2af70c92ab 176 {
darienf 20:6d2af70c92ab 177 _sampleNumberLastValidSpO2 = _sampleNumber;
darienf 20:6d2af70c92ab 178 }
darienf 20:6d2af70c92ab 179 if (OnHeartRateSpO2dataAvailable != null)
darienf 20:6d2af70c92ab 180 {
darienf 20:6d2af70c92ab 181 OnHeartRateSpO2dataAvailable(heartRateBPM, heartRateBPMValid, heartRateBPMSignalStrength, spO2Percent, spO2PercentValid, spO2PercentSignalStrength);
darienf 20:6d2af70c92ab 182 }
darienf 20:6d2af70c92ab 183 }
darienf 20:6d2af70c92ab 184
darienf 20:6d2af70c92ab 185 }
darienf 20:6d2af70c92ab 186 }