\hypertarget{classhrv_1_1HRV}{}\doxysection{hrv.\+H\+RV Class Reference}
\label{classhrv_1_1HRV}\index{hrv.HRV@{hrv.HRV}}
\doxysubsection*{Public Member Functions}
\begin{DoxyCompactItemize}
\item 
def \mbox{\hyperlink{classhrv_1_1HRV_a84adb37c163b24e0d7a41b8dfbcfd53a}{\+\_\+\+\_\+init\+\_\+\+\_\+}} (self, sampling\+\_\+frequency)
\item 
def \mbox{\hyperlink{classhrv_1_1HRV_a89ad722309b569b4531b1491d61cfc32}{S\+D\+NN}} (self, rr\+\_\+samples, normalise=False)
\item 
def \mbox{\hyperlink{classhrv_1_1HRV_a2f06b90967d0aaf25aed8e3acf1a0963}{S\+D\+A\+NN}} (self, rr\+\_\+samples, average\+\_\+period=5.\+0, normalise=False)
\item 
def \mbox{\hyperlink{classhrv_1_1HRV_ad12f86c3d620bddd74d33892d0103e55}{R\+M\+S\+SD}} (self, rr\+\_\+samples, normalise=False)
\item 
def \mbox{\hyperlink{classhrv_1_1HRV_a3b7bfd38942d77d2e7989102c1971eee}{S\+D\+SD}} (self, rr\+\_\+samples)
\item 
def \mbox{\hyperlink{classhrv_1_1HRV_a433e98fde9df804b6b4f6beb99404504}{N\+N50}} (self, rr\+\_\+samples)
\item 
def \mbox{\hyperlink{classhrv_1_1HRV_adafa1274e727951a2a27bdad801e9674}{p\+N\+N50}} (self, rr\+\_\+samples)
\item 
def \mbox{\hyperlink{classhrv_1_1HRV_a6f120509a245ea92d8d878d80f31ea10}{N\+N20}} (self, rr\+\_\+samples)
\item 
def \mbox{\hyperlink{classhrv_1_1HRV_ab46afaa8580b2e591fe049022ebbf1bc}{p\+N\+N20}} (self, rr\+\_\+samples)
\item 
def \mbox{\hyperlink{classhrv_1_1HRV_a117bb3f4632b2c5d89ebc185becf7160}{HR}} (self, rr\+\_\+samples)
\item 
def \mbox{\hyperlink{classhrv_1_1HRV_a0a698751d77bee2a56a84f8a9d7cf666}{add\+\_\+rr\+\_\+error}} (self, rr\+\_\+samples, error)
\item 
def \mbox{\hyperlink{classhrv_1_1HRV_ae8514ce516204e64cbf42a0ef173a45a}{f\+Analysis}} (self, rr\+\_\+samples)
\end{DoxyCompactItemize}
\doxysubsection*{Public Attributes}
\begin{DoxyCompactItemize}
\item 
\mbox{\Hypertarget{classhrv_1_1HRV_ae6e526c5f102b7baf207e66a8d34ed0a}\label{classhrv_1_1HRV_ae6e526c5f102b7baf207e66a8d34ed0a}} 
{\bfseries fs}
\item 
\mbox{\Hypertarget{classhrv_1_1HRV_acd2eae5273e269f16ec2ca20717e66b5}\label{classhrv_1_1HRV_acd2eae5273e269f16ec2ca20717e66b5}} 
{\bfseries period}
\item 
\mbox{\Hypertarget{classhrv_1_1HRV_a0c8c1d0d7dbb827f4be425cfd983ae85}\label{classhrv_1_1HRV_a0c8c1d0d7dbb827f4be425cfd983ae85}} 
{\bfseries hr\+\_\+discrete}
\item 
\mbox{\Hypertarget{classhrv_1_1HRV_a20dc7b99f48286ca5206ada19cdfcb88}\label{classhrv_1_1HRV_a20dc7b99f48286ca5206ada19cdfcb88}} 
{\bfseries t\+\_\+hr\+\_\+discrete}
\item 
\mbox{\Hypertarget{classhrv_1_1HRV_a0b435323c1a34d9dfe8b053ca64ce06c}\label{classhrv_1_1HRV_a0b435323c1a34d9dfe8b053ca64ce06c}} 
{\bfseries hr\+\_\+func}
\item 
\mbox{\Hypertarget{classhrv_1_1HRV_a8db9dfd2b16db2306420a3ff2a4844ee}\label{classhrv_1_1HRV_a8db9dfd2b16db2306420a3ff2a4844ee}} 
{\bfseries t\+\_\+hr\+\_\+linear}
\item 
\mbox{\Hypertarget{classhrv_1_1HRV_acb4801447ddb38bf2871103716110b56}\label{classhrv_1_1HRV_acb4801447ddb38bf2871103716110b56}} 
{\bfseries hr\+\_\+linear}
\item 
\mbox{\Hypertarget{classhrv_1_1HRV_a14fcd0fa0ace5458ac8906f48e31f5b0}\label{classhrv_1_1HRV_a14fcd0fa0ace5458ac8906f48e31f5b0}} 
{\bfseries f\+\_\+hr}
\item 
\mbox{\Hypertarget{classhrv_1_1HRV_a9f61845175a361317aecd3ccdd209651}\label{classhrv_1_1HRV_a9f61845175a361317aecd3ccdd209651}} 
{\bfseries f\+\_\+hr\+\_\+axis}
\item 
\mbox{\Hypertarget{classhrv_1_1HRV_a032512b484efc183b6d8e30f391781aa}\label{classhrv_1_1HRV_a032512b484efc183b6d8e30f391781aa}} 
{\bfseries lf}
\item 
\mbox{\Hypertarget{classhrv_1_1HRV_ae479363bcb314aa3133c9f4a1a263311}\label{classhrv_1_1HRV_ae479363bcb314aa3133c9f4a1a263311}} 
{\bfseries hf}
\end{DoxyCompactItemize}


\doxysubsection{Detailed Description}
\begin{DoxyVerb}Heartrate variability class which calcualtes the standard HRV
parameters with the help of Python functions and for cross
validation also via the physionet's get_hrv script.
\end{DoxyVerb}
 

\doxysubsection{Constructor \& Destructor Documentation}
\mbox{\Hypertarget{classhrv_1_1HRV_a84adb37c163b24e0d7a41b8dfbcfd53a}\label{classhrv_1_1HRV_a84adb37c163b24e0d7a41b8dfbcfd53a}} 
\index{hrv.HRV@{hrv.HRV}!\_\_init\_\_@{\_\_init\_\_}}
\index{\_\_init\_\_@{\_\_init\_\_}!hrv.HRV@{hrv.HRV}}
\doxysubsubsection{\texorpdfstring{\_\_init\_\_()}{\_\_init\_\_()}}
{\footnotesize\ttfamily def hrv.\+H\+R\+V.\+\_\+\+\_\+init\+\_\+\+\_\+ (\begin{DoxyParamCaption}\item[{}]{self,  }\item[{}]{sampling\+\_\+frequency }\end{DoxyParamCaption})}

\begin{DoxyVerb}Constructor takes the sampling frequency.
All rr_sample data is in sample number and
will assume it's at this sampling rate.
\end{DoxyVerb}
 

\doxysubsection{Member Function Documentation}
\mbox{\Hypertarget{classhrv_1_1HRV_a0a698751d77bee2a56a84f8a9d7cf666}\label{classhrv_1_1HRV_a0a698751d77bee2a56a84f8a9d7cf666}} 
\index{hrv.HRV@{hrv.HRV}!add\_rr\_error@{add\_rr\_error}}
\index{add\_rr\_error@{add\_rr\_error}!hrv.HRV@{hrv.HRV}}
\doxysubsubsection{\texorpdfstring{add\_rr\_error()}{add\_rr\_error()}}
{\footnotesize\ttfamily def hrv.\+H\+R\+V.\+add\+\_\+rr\+\_\+error (\begin{DoxyParamCaption}\item[{}]{self,  }\item[{}]{rr\+\_\+samples,  }\item[{}]{error }\end{DoxyParamCaption})}

\begin{DoxyVerb}Adds jitter to the heartrate timestamps. 
The error and the rr_samples are in timestamps.
Returns the noisy timestamps in samples.
\end{DoxyVerb}
 \mbox{\Hypertarget{classhrv_1_1HRV_ae8514ce516204e64cbf42a0ef173a45a}\label{classhrv_1_1HRV_ae8514ce516204e64cbf42a0ef173a45a}} 
\index{hrv.HRV@{hrv.HRV}!fAnalysis@{fAnalysis}}
\index{fAnalysis@{fAnalysis}!hrv.HRV@{hrv.HRV}}
\doxysubsubsection{\texorpdfstring{fAnalysis()}{fAnalysis()}}
{\footnotesize\ttfamily def hrv.\+H\+R\+V.\+f\+Analysis (\begin{DoxyParamCaption}\item[{}]{self,  }\item[{}]{rr\+\_\+samples }\end{DoxyParamCaption})}

\begin{DoxyVerb}Frequency analysis to calc self.lf, self.hf, returns the LF/HF-ratio and
also calculates the spectrum as pairs of (self.f_hr_axis,self.f_hr).
The input arrary is in sample points where R peaks have been detected.
\end{DoxyVerb}
 \mbox{\Hypertarget{classhrv_1_1HRV_a117bb3f4632b2c5d89ebc185becf7160}\label{classhrv_1_1HRV_a117bb3f4632b2c5d89ebc185becf7160}} 
\index{hrv.HRV@{hrv.HRV}!HR@{HR}}
\index{HR@{HR}!hrv.HRV@{hrv.HRV}}
\doxysubsubsection{\texorpdfstring{HR()}{HR()}}
{\footnotesize\ttfamily def hrv.\+H\+R\+V.\+HR (\begin{DoxyParamCaption}\item[{}]{self,  }\item[{}]{rr\+\_\+samples }\end{DoxyParamCaption})}

\begin{DoxyVerb}Calculate heart-rates from R peak samples.

:param rr_samples: R peak sample locations
:type rr_samples: array_like
:return: Heart-rates in BPM
:rtype: ndarray
\end{DoxyVerb}
 \mbox{\Hypertarget{classhrv_1_1HRV_a6f120509a245ea92d8d878d80f31ea10}\label{classhrv_1_1HRV_a6f120509a245ea92d8d878d80f31ea10}} 
\index{hrv.HRV@{hrv.HRV}!NN20@{NN20}}
\index{NN20@{NN20}!hrv.HRV@{hrv.HRV}}
\doxysubsubsection{\texorpdfstring{NN20()}{NN20()}}
{\footnotesize\ttfamily def hrv.\+H\+R\+V.\+N\+N20 (\begin{DoxyParamCaption}\item[{}]{self,  }\item[{}]{rr\+\_\+samples }\end{DoxyParamCaption})}

\begin{DoxyVerb}Calculate NN20, the number of pairs of successive NNs that differ by more than 20 ms.

:param rr_samples: R peak sample locations
:type rr_samples: array_like
:return: NN20
:rtype: float
\end{DoxyVerb}
 \mbox{\Hypertarget{classhrv_1_1HRV_a433e98fde9df804b6b4f6beb99404504}\label{classhrv_1_1HRV_a433e98fde9df804b6b4f6beb99404504}} 
\index{hrv.HRV@{hrv.HRV}!NN50@{NN50}}
\index{NN50@{NN50}!hrv.HRV@{hrv.HRV}}
\doxysubsubsection{\texorpdfstring{NN50()}{NN50()}}
{\footnotesize\ttfamily def hrv.\+H\+R\+V.\+N\+N50 (\begin{DoxyParamCaption}\item[{}]{self,  }\item[{}]{rr\+\_\+samples }\end{DoxyParamCaption})}

\begin{DoxyVerb}Calculate NN50, the number of pairs of successive NNs that differ by more than 50 ms.

:param rr_samples: R peak sample locations
:type rr_samples: array_like
:return: NN50
:rtype: float
\end{DoxyVerb}
 \mbox{\Hypertarget{classhrv_1_1HRV_ab46afaa8580b2e591fe049022ebbf1bc}\label{classhrv_1_1HRV_ab46afaa8580b2e591fe049022ebbf1bc}} 
\index{hrv.HRV@{hrv.HRV}!pNN20@{pNN20}}
\index{pNN20@{pNN20}!hrv.HRV@{hrv.HRV}}
\doxysubsubsection{\texorpdfstring{pNN20()}{pNN20()}}
{\footnotesize\ttfamily def hrv.\+H\+R\+V.\+p\+N\+N20 (\begin{DoxyParamCaption}\item[{}]{self,  }\item[{}]{rr\+\_\+samples }\end{DoxyParamCaption})}

\begin{DoxyVerb}Calculate pNN20, the proportion of NN20 divided by total number of NNs.

:param rr_samples: R peak sample locations
:type rr_samples: array_like
:return: pNN20
:rtype: float
\end{DoxyVerb}
 \mbox{\Hypertarget{classhrv_1_1HRV_adafa1274e727951a2a27bdad801e9674}\label{classhrv_1_1HRV_adafa1274e727951a2a27bdad801e9674}} 
\index{hrv.HRV@{hrv.HRV}!pNN50@{pNN50}}
\index{pNN50@{pNN50}!hrv.HRV@{hrv.HRV}}
\doxysubsubsection{\texorpdfstring{pNN50()}{pNN50()}}
{\footnotesize\ttfamily def hrv.\+H\+R\+V.\+p\+N\+N50 (\begin{DoxyParamCaption}\item[{}]{self,  }\item[{}]{rr\+\_\+samples }\end{DoxyParamCaption})}

\begin{DoxyVerb}Calculate pNN50, the proportion of NN50 divided by total number of NNs.

:param rr_samples: R peak sample locations
:type rr_samples: array_like
:return: pNN50
:rtype: float
\end{DoxyVerb}
 \mbox{\Hypertarget{classhrv_1_1HRV_ad12f86c3d620bddd74d33892d0103e55}\label{classhrv_1_1HRV_ad12f86c3d620bddd74d33892d0103e55}} 
\index{hrv.HRV@{hrv.HRV}!RMSSD@{RMSSD}}
\index{RMSSD@{RMSSD}!hrv.HRV@{hrv.HRV}}
\doxysubsubsection{\texorpdfstring{RMSSD()}{RMSSD()}}
{\footnotesize\ttfamily def hrv.\+H\+R\+V.\+R\+M\+S\+SD (\begin{DoxyParamCaption}\item[{}]{self,  }\item[{}]{rr\+\_\+samples,  }\item[{}]{normalise = {\ttfamily False} }\end{DoxyParamCaption})}

\begin{DoxyVerb}Calculate RMSSD (root mean square of successive differences).

:param rr_samples: R peak sample locations
:type rr_samples: array_like
:param normalise: normalise the RMSSD against the average RR interval, defaults to False
:type normalise: bool, optional
:return: RMSSD (root mean square of successive differences)
:rtype: float
\end{DoxyVerb}
 \mbox{\Hypertarget{classhrv_1_1HRV_a2f06b90967d0aaf25aed8e3acf1a0963}\label{classhrv_1_1HRV_a2f06b90967d0aaf25aed8e3acf1a0963}} 
\index{hrv.HRV@{hrv.HRV}!SDANN@{SDANN}}
\index{SDANN@{SDANN}!hrv.HRV@{hrv.HRV}}
\doxysubsubsection{\texorpdfstring{SDANN()}{SDANN()}}
{\footnotesize\ttfamily def hrv.\+H\+R\+V.\+S\+D\+A\+NN (\begin{DoxyParamCaption}\item[{}]{self,  }\item[{}]{rr\+\_\+samples,  }\item[{}]{average\+\_\+period = {\ttfamily 5.0},  }\item[{}]{normalise = {\ttfamily False} }\end{DoxyParamCaption})}

\begin{DoxyVerb}Calculate SDANN, the standard deviation of the average RR intervals calculated over short periods.

:param rr_samples: R peak sample locations
:type rr_samples: array_like
:param average_period: The averging period in minutes, defaults to 5.0
:type average_period: float, optional
:param normalise: normalise the SDANN against the average RR interval, defaults to False
:type normalise: bool, optional
:return: SDANN, the standard deviation of the average RR intervals calculated over short periods
:rtype: float
\end{DoxyVerb}
 \mbox{\Hypertarget{classhrv_1_1HRV_a89ad722309b569b4531b1491d61cfc32}\label{classhrv_1_1HRV_a89ad722309b569b4531b1491d61cfc32}} 
\index{hrv.HRV@{hrv.HRV}!SDNN@{SDNN}}
\index{SDNN@{SDNN}!hrv.HRV@{hrv.HRV}}
\doxysubsubsection{\texorpdfstring{SDNN()}{SDNN()}}
{\footnotesize\ttfamily def hrv.\+H\+R\+V.\+S\+D\+NN (\begin{DoxyParamCaption}\item[{}]{self,  }\item[{}]{rr\+\_\+samples,  }\item[{}]{normalise = {\ttfamily False} }\end{DoxyParamCaption})}

\begin{DoxyVerb}Calculate SDNN, the standard deviation of NN intervals.

:param rr_samples: R peak sample locations
:type rr_samples: array_like
:param normalise: normalise the SDNN against the average RR interval, defaults to False
:type normalise: bool, optional
:return: SDNN, the standard deviation of NN intervals
:rtype: float
\end{DoxyVerb}
 \mbox{\Hypertarget{classhrv_1_1HRV_a3b7bfd38942d77d2e7989102c1971eee}\label{classhrv_1_1HRV_a3b7bfd38942d77d2e7989102c1971eee}} 
\index{hrv.HRV@{hrv.HRV}!SDSD@{SDSD}}
\index{SDSD@{SDSD}!hrv.HRV@{hrv.HRV}}
\doxysubsubsection{\texorpdfstring{SDSD()}{SDSD()}}
{\footnotesize\ttfamily def hrv.\+H\+R\+V.\+S\+D\+SD (\begin{DoxyParamCaption}\item[{}]{self,  }\item[{}]{rr\+\_\+samples }\end{DoxyParamCaption})}

\begin{DoxyVerb}Calculate SDSD (standard deviation of successive differences), the standard deviation of the successive differences between adjacent NNs.

:param rr_samples: R peak sample locations
:type rr_samples: array_like
:return: SDSD (standard deviation of successive differences)
:rtype: float
\end{DoxyVerb}
 

The documentation for this class was generated from the following file\+:\begin{DoxyCompactItemize}
\item 
hrv.\+py\end{DoxyCompactItemize}
