Difference between revisions of "EcgDevice Class"
NateColeman (talk | contribs) (→Method Detail) |
NateColeman (talk | contribs) (→Method Detail) |
||
Line 179: | Line 179: | ||
<h3>finalize</h3> | <h3>finalize</h3> | ||
− | <code>'''public void''' finalize() throws java.lang.Throwable</code> | + | <code><span style="color:#0066FF;">'''public void'''</span> finalize() <span style="color:#0066FF;">throws</span> java.lang.Throwable</code> |
<dl> | <dl> | ||
− | <dt | + | <dt>Overrides:</dt> |
<dd><code>finalize</code> in class <code>java.lang.Object</code></dd> | <dd><code>finalize</code> in class <code>java.lang.Object</code></dd> | ||
− | <dt | + | <dt>Throws:</dt> |
<dd><code>java.lang.Throwable</code></dd> | <dd><code>java.lang.Throwable</code></dd> | ||
</dl> | </dl> | ||
− | + | ||
− | < | + | |
− | + | <h3>close</h3> | |
− | + | <code><span style="color:#0066FF;">'''public void'''</span> close()</code> | |
− | </ | + | |
− | < | + | |
− | < | + | <h3>getName</h3> |
− | + | <code><span style="color:#0066FF;">'''public'''</span> java.lang.String getName()</code> | |
− | + | ||
− | + | <span>'''Description copied from class: '''</span>[[VisualizableDevice Class#getName|VisualizableDevice]] | |
− | < | + | |
− | + | Returns name of BLE device | |
− | |||
− | </ | ||
− | < | ||
− | < | ||
− | |||
− | |||
− | |||
− | |||
<dl> | <dl> | ||
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> | <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> | ||
− | <dd><code> | + | <dd><code>[[VisualizableDevice Class#getName|VisualizableDevice.getName()]]</code> in class VisualizableDevice</dd> |
− | <dt><span | + | <dt><span>Returns:</span></dt> |
<dd>BLE device name</dd> | <dd>BLE device name</dd> | ||
</dl> | </dl> | ||
− | + | ||
− | + | ||
− | + | <h3>getAddress</h3> | |
− | |||
− | |||
− | |||
− | |||
− | < | ||
<pre>public java.lang.String getAddress()</pre> | <pre>public java.lang.String getAddress()</pre> | ||
− | <div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../ru/neurotech/common/VisualizableDevice.html#getAddress--">VisualizableDevice</a></code></span></div> | + | <div class="block"> |
+ | |||
+ | <span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../ru/neurotech/common/VisualizableDevice.html#getAddress--">VisualizableDevice</a></code></span></div> | ||
<div class="block">Returns Bluetooth LE MAC address</div> | <div class="block">Returns Bluetooth LE MAC address</div> | ||
<dl> | <dl> | ||
Line 229: | Line 218: | ||
<dd>device unique address</dd> | <dd>device unique address</dd> | ||
</dl> | </dl> | ||
− | + | ||
− | + | ||
− | + | <h3>getBatteryLevel</h3> | |
− | |||
− | |||
− | |||
− | |||
− | < | ||
<pre>public int getBatteryLevel()</pre> | <pre>public int getBatteryLevel()</pre> | ||
<div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../ru/neurotech/common/VisualizableDevice.html#getBatteryLevel--">VisualizableDevice</a></code></span></div> | <div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../ru/neurotech/common/VisualizableDevice.html#getBatteryLevel--">VisualizableDevice</a></code></span></div> | ||
Line 246: | Line 230: | ||
<dd>battery charge level in percents</dd> | <dd>battery charge level in percents</dd> | ||
</dl> | </dl> | ||
− | + | ||
− | + | ||
− | + | <h3>getNeuroDevice</h3> | |
− | |||
− | |||
− | |||
− | |||
− | < | ||
<pre>public <a href="../../../../ru/neurotech/neurodevices/NeuroDevice.html" title="class in ru.neurotech.neurodevices">NeuroDevice</a> getNeuroDevice()</pre> | <pre>public <a href="../../../../ru/neurotech/neurodevices/NeuroDevice.html" title="class in ru.neurotech.neurodevices">NeuroDevice</a> getNeuroDevice()</pre> | ||
<div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../ru/neurotech/common/VisualizableDevice.html#getNeuroDevice--">VisualizableDevice</a></code></span></div> | <div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../ru/neurotech/common/VisualizableDevice.html#getNeuroDevice--">VisualizableDevice</a></code></span></div> | ||
Line 263: | Line 242: | ||
<dd>NeuroDevice of current visual device</dd> | <dd>NeuroDevice of current visual device</dd> | ||
</dl> | </dl> | ||
− | + | ||
− | + | ||
− | + | <h3>startReceive</h3> | |
− | |||
− | |||
− | |||
− | |||
− | < | ||
<pre>public void startReceive()</pre> | <pre>public void startReceive()</pre> | ||
− | + | ||
− | + | ||
− | + | <h3>stopReceive</h3> | |
− | |||
− | |||
− | |||
− | |||
− | < | ||
<pre>public void stopReceive()</pre> | <pre>public void stopReceive()</pre> | ||
− | + | ||
− | + | ||
− | + | <h3>reset</h3> | |
− | |||
− | |||
− | |||
− | |||
− | < | ||
<pre>public void reset()</pre> | <pre>public void reset()</pre> | ||
<div class="block">Clears signal buffer, sets duration to zero | <div class="block">Clears signal buffer, sets duration to zero | ||
and resets all parameters to default values</div> | and resets all parameters to default values</div> | ||
− | + | ||
− | + | ||
− | + | <h3>getTotalSignalDuration</h3> | |
− | |||
− | |||
− | |||
− | |||
− | < | ||
<pre>public double getTotalSignalDuration()</pre> | <pre>public double getTotalSignalDuration()</pre> | ||
<div class="block">Returns total signal duration in current test</div> | <div class="block">Returns total signal duration in current test</div> | ||
Line 306: | Line 265: | ||
<dd>signal duration in seconds</dd> | <dd>signal duration in seconds</dd> | ||
</dl> | </dl> | ||
− | + | ||
− | + | ||
− | + | <h3>getEcgSignal</h3> | |
− | |||
− | |||
− | |||
− | |||
− | < | ||
<pre>public double[] getEcgSignal(double time, | <pre>public double[] getEcgSignal(double time, | ||
double duration)</pre> | double duration)</pre> | ||
Line 326: | Line 280: | ||
<dd>Signal samples array</dd> | <dd>Signal samples array</dd> | ||
</dl> | </dl> | ||
− | + | ||
− | + | ||
− | + | <h3>getRWavesOnInterval</h3> | |
− | + | <pre>public [[RPeak Class|RPeak]][] getRWavesOnInterval(double startTime, | |
− | |||
− | |||
− | < | ||
− | |||
− | <pre>public | ||
double endTime)</pre> | double endTime)</pre> | ||
<div class="block">Detects R-waves in signal for specified time interval</div> | <div class="block">Detects R-waves in signal for specified time interval</div> | ||
Line 344: | Line 293: | ||
<dd>Array of RPeaks</dd> | <dd>Array of RPeaks</dd> | ||
</dl> | </dl> | ||
− | + | ||
− | + | ||
− | + | <h3>getCurrentHeartRate</h3> | |
− | |||
− | |||
− | |||
− | |||
− | < | ||
<pre>public int getCurrentHeartRate()</pre> | <pre>public int getCurrentHeartRate()</pre> | ||
<div class="block">Calculates heart rate for recently received ECG samples | <div class="block">Calculates heart rate for recently received ECG samples | ||
Line 361: | Line 305: | ||
<dd>Heart rate in beats per minute</dd> | <dd>Heart rate in beats per minute</dd> | ||
</dl> | </dl> | ||
− | + | ||
− | + | ||
− | + | <h3>getAverageHeartRateOnInterval</h3> | |
− | |||
− | |||
− | |||
− | |||
− | < | ||
<pre>public int getAverageHeartRateOnInterval(double startTime, | <pre>public int getAverageHeartRateOnInterval(double startTime, | ||
double endTime)</pre> | double endTime)</pre> | ||
Line 380: | Line 319: | ||
<dd>Heart rate in beats per minute</dd> | <dd>Heart rate in beats per minute</dd> | ||
</dl> | </dl> | ||
− | + | ||
− | + | ||
− | + | <h3>getCurrentHeartRateVariability</h3> | |
− | |||
− | |||
− | |||
− | |||
− | < | ||
<pre>public double getCurrentHeartRateVariability()</pre> | <pre>public double getCurrentHeartRateVariability()</pre> | ||
<div class="block">Returns currently detected value of heart rate variability | <div class="block">Returns currently detected value of heart rate variability | ||
Line 397: | Line 331: | ||
<dd>HRV value</dd> | <dd>HRV value</dd> | ||
</dl> | </dl> | ||
− | + | ||
− | + | ||
− | + | <h3>getHeartRateVariabilityForInterval</h3> | |
− | |||
− | |||
− | |||
− | |||
− | < | ||
<pre>public double getHeartRateVariabilityForInterval(double startTime, | <pre>public double getHeartRateVariabilityForInterval(double startTime, | ||
double endTime)</pre> | double endTime)</pre> | ||
Line 415: | Line 344: | ||
<dd>HRV value</dd> | <dd>HRV value</dd> | ||
</dl> | </dl> | ||
− | + | ||
− | + | ||
− | + | <h3>getCurrentStressIndex</h3> | |
− | |||
− | |||
− | |||
− | |||
− | < | ||
<pre>public double getCurrentStressIndex()</pre> | <pre>public double getCurrentStressIndex()</pre> | ||
<div class="block">Returns value of stress index for real-time monitoring | <div class="block">Returns value of stress index for real-time monitoring | ||
Line 432: | Line 356: | ||
<dd>Stress index of current signal</dd> | <dd>Stress index of current signal</dd> | ||
</dl> | </dl> | ||
− | + | ||
− | + | ||
− | + | <h3>getStressIndexForInterval</h3> | |
− | |||
− | |||
− | |||
− | |||
− | < | ||
<pre>public double getStressIndexForInterval(double startTime, | <pre>public double getStressIndexForInterval(double startTime, | ||
double endTime)</pre> | double endTime)</pre> | ||
Line 450: | Line 369: | ||
<dd>Stress index value</dd> | <dd>Stress index value</dd> | ||
</dl> | </dl> | ||
− | + | ||
− | + | ||
− | + | <h3>getElectrodesState</h3> | |
− | |||
− | |||
− | |||
− | |||
− | < | ||
<pre>public boolean getElectrodesState()</pre> | <pre>public boolean getElectrodesState()</pre> | ||
<div class="block">Returns flag indicating whether electrodes properly attached or not</div> | <div class="block">Returns flag indicating whether electrodes properly attached or not</div> |
Revision as of 09:11, 15 March 2017
ECG Device class implemets methods for using universal sensors as cardiography system.
Contents
- 1 Android
- 1.1 Related Classes
- 1.2 Classes hierarchy
- 1.3 Class definition
- 1.4 Fields Summary
- 1.5 Constructor Summary
- 1.6 Methods Summary
- 1.7 Field Detail
- 1.8 Constructor Detail
- 1.9 Method Detail
- 1.9.1 finalize
- 1.9.2 close
- 1.9.3 getName
- 1.9.4 getAddress
- 1.9.5 getBatteryLevel
- 1.9.6 getNeuroDevice
- 1.9.7 startReceive
- 1.9.8 stopReceive
- 1.9.9 reset
- 1.9.10 getTotalSignalDuration
- 1.9.11 getEcgSignal
- 1.9.12 getRWavesOnInterval
- 1.9.13 getCurrentHeartRate
- 1.9.14 getAverageHeartRateOnInterval
- 1.9.15 getCurrentHeartRateVariability
- 1.9.16 getHeartRateVariabilityForInterval
- 1.9.17 getCurrentStressIndex
- 1.9.18 getStressIndexForInterval
- 1.9.19 getElectrodesState
Android
ru.neurotech.neurodevices.ecg
Class EcgDevice
Related Classes
ru.neurotech.neurodevices.ecg.EcgDeviceConnector
ru.neurotech.neurodevices.ecg.RPeak
Classes hierarchy
- java.lang.Object
- ru.neurotech.common.VisualizableDevice
- ru.neurotech.neurodevices.ecg.EcgDevice
Class definition
public class EcgDevice extends VisualizableDevice
Fields Summary
Modifier and Type | Field and Description |
SubscribersNotifier<java.lang.Boolean> | electrodesAttachedStateChanged
Notifies when electrodes are attached or detached To get electrodes state manually use getElectrodesState |
SubscribersNotifier<java.lang.Double> | totalSignalDurationChanged
Notifies subscribers when signal duration is changed, when new samples received or data been loaded from external storage, or buffers been reset |
Fields inherited from class ru.neurotech.common.VisualizableDevice |
deviceStateChanged |
Constructor Summary
Constructor and Description |
---|
<a href="../../../../ru/neurotech/neurodevices/ecg/EcgDevice.html#EcgDevice-long-">EcgDevice</a>(long nativeObjPtr) |
Methods Summary
Modifier and Type | Method and Description |
void | close() |
void | finalize() |
java.lang.String | getAddress()
Returns Bluetooth LE MAC address |
int | getAverageHeartRateOnInterval
Returns average heart rate based on NN-interval values from specified time interval |
int | getBatteryLevel()
Returns battery charge level in percents |
int | getCurrentHeartRate()
Calculates heart rate for recently received ECG samples Use this method to monitor heart rate during signal receiving is active It's not recommended to use this method to calculate heart rate while signal receiving is stopped, use getAverageHeartRateOnInterval instead |
double | getCurrentHeartRateVariability()
Returns currently detected value of heart rate variability Use this method to monitor HRV during signal receiving To get HRV for various intervals while signal receiving is stopped use getHeartRateVariabilityForInterval |
double | getCurrentStressIndex()
Returns value of stress index for real-time monitoring Use this method to monitor stress index while signal receiving is active To get stress index for various intervals while signal receiving is stopped use getStressIndexForInterval |
double[] | getEcgSignal(double time, double duration)
Returns ECG signal stored in buffer for selected time interval If interval exceeds maximum or minimum buffer time, signal samples for these intervals will be equal to zero |
boolean | getElectrodesState()
Returns flag indicating whether electrodes properly attached or not |
double | getHeartRateVariabilityForInterval(double startTime, double endTime)
Returns average value of heart rate variability on interval |
java.lang.String | getName()
Returns name of BLE device |
NeuroDevice | getNeuroDevice()
Returns physical device object which this visual device represents |
RPeak[] | getRWavesOnInterval(double startTime, double endTime)
Detects R-waves in signal for specified time interval |
double | getStressIndexForInterval(double startTime, double endTime)
Returns average value of stress index on interval
|
double | getTotalSignalDuration()
Returns total signal duration in current test |
void | reset()
Clears signal buffer, sets duration to zero and resets all parameters to default values |
void | startReceive() |
void | stopReceive() |
Field Detail
totalSignalDurationChanged
public final SubscribersNotifier<java.lang.Double> totalSignalDurationChanged
Notifies subscribers when signal duration is changed, when new samples received or data been loaded from external storage, or buffers been reset
electrodesAttachedStateChanged
public final SubscribersNotifier<java.lang.Boolean> electrodesAttachedStateChanged
Notifies when electrodes are attached or detached. To get electrodes state manually use getElectrodesState
Constructor Detail
EcgDevice
public EcgDevice(long nativeObjPtr)
Method Detail
finalize
public void finalize() throws java.lang.Throwable
- Overrides:
finalize
in classjava.lang.Object
- Throws:
java.lang.Throwable
close
public void close()
getName
public java.lang.String getName()
Description copied from class: VisualizableDevice
Returns name of BLE device
- Specified by:
VisualizableDevice.getName()
in class VisualizableDevice- Returns:
- BLE device name
getAddress
public java.lang.String getAddress()
<a href="../../../../ru/neurotech/common/VisualizableDevice.html#getAddress--">VisualizableDevice</a>
- Specified by:
<a href="../../../../ru/neurotech/common/VisualizableDevice.html#getAddress--">getAddress</a>
in class[[VisualizableDevice Class|VisualizableDevice]
- Returns:
- device unique address
getBatteryLevel
public int getBatteryLevel()
<a href="../../../../ru/neurotech/common/VisualizableDevice.html#getBatteryLevel--">VisualizableDevice</a>
- Specified by:
<a href="../../../../ru/neurotech/common/VisualizableDevice.html#getBatteryLevel--">getBatteryLevel</a>
in class<a href="../../../../ru/neurotech/common/VisualizableDevice.html" title="class in ru.neurotech.common">VisualizableDevice</a>
- Returns:
- battery charge level in percents
getNeuroDevice
public <a href="../../../../ru/neurotech/neurodevices/NeuroDevice.html" title="class in ru.neurotech.neurodevices">NeuroDevice</a> getNeuroDevice()
<a href="../../../../ru/neurotech/common/VisualizableDevice.html#getNeuroDevice--">VisualizableDevice</a>
- Specified by:
<a href="../../../../ru/neurotech/common/VisualizableDevice.html#getNeuroDevice--">getNeuroDevice</a>
in class[[VisualizableDevice Class|VisualizableDevice]
- Returns:
- NeuroDevice of current visual device
startReceive
public void startReceive()
stopReceive
public void stopReceive()
reset
public void reset()
getTotalSignalDuration
public double getTotalSignalDuration()
- Returns:
- signal duration in seconds
getEcgSignal
public double[] getEcgSignal(double time, double duration)
If interval exceeds maximum or minimum buffer time, signal samplesfor these intervals will be equal to zero
- Parameters:
time
- Start time of intervalduration
- Duration of interval- Returns:
- Signal samples array
getRWavesOnInterval
public [[RPeak Class|RPeak]][] getRWavesOnInterval(double startTime, double endTime)
- Parameters:
startTime
- Start time of intervalendTime
- End time of interval- Returns:
- Array of RPeaks
getCurrentHeartRate
public int getCurrentHeartRate()
Use this method to monitor heart rate during signal receiving is active It's not recommended to use this method to calculate heart ratewhile signal receiving is stopped, use getAverageHeartRateOnInterval instead
- Returns:
- Heart rate in beats per minute
getAverageHeartRateOnInterval
public int getAverageHeartRateOnInterval(double startTime, double endTime)
- Parameters:
startTime
- Start time for heart rate calculationendTime
- End time for heart rate calculation- Returns:
- Heart rate in beats per minute
getCurrentHeartRateVariability
public double getCurrentHeartRateVariability()
Use this method to monitor HRV during signal receiving To get HRV for various intervals while signal receiving is stoppeduse getHeartRateVariabilityForInterval
- Returns:
- HRV value
getHeartRateVariabilityForInterval
public double getHeartRateVariabilityForInterval(double startTime, double endTime)
- Parameters:
startTime
- Start time of calculation intervalendTime
- End time of calculation interval- Returns:
- HRV value
getCurrentStressIndex
public double getCurrentStressIndex()
Use this method to monitor stress index while signal receiving is active To get stress index for various intervals while signal receiving is stoppeduse getStressIndexForInterval
- Returns:
- Stress index of current signal
getStressIndexForInterval
public double getStressIndexForInterval(double startTime, double endTime)
- Parameters:
startTime
- Start time of calculation intervalendTime
- End time of calculation interval- Returns:
- Stress index value
getElectrodesState
public boolean getElectrodesState()
- Returns:
- Is electrodes attached