diff --git a/src/bulksigs/Bulk_add_signal.m b/src/bulksigs/Bulk_add_signal.m index 6da8a40..b68044c 100644 --- a/src/bulksigs/Bulk_add_signal.m +++ b/src/bulksigs/Bulk_add_signal.m @@ -12,16 +12,16 @@ % %You should have received a copy of the GNU General Public License %along with TEAP. If not, see . - +% %> @file Bulk_add_signal.m %> @brief Adds a signal to the bulk signal (and I love repetitions) - +% %> @param BulkSig the bulk collection %> @param signame the signal name (ex: 'HST') %> @param sig the actual signal (ex: after HST_aqn_variable) - +% %> @retval BulkSig the bulksignal with the signal added -%Copyright Frank Villaro-Dixon, 2014 +%> @author Copyright Frank Villaro-Dixon, 2014 function [BulkSig] = Bulk_add_signal(BulkSig, signame, sig) diff --git a/src/bulksigs/Bulk_assert_mine.m b/src/bulksigs/Bulk_assert_mine.m index d6822a5..9dd9702 100644 --- a/src/bulksigs/Bulk_assert_mine.m +++ b/src/bulksigs/Bulk_assert_mine.m @@ -12,10 +12,10 @@ % %You should have received a copy of the GNU General Public License %along with TEAP. If not, see . - +% %> @file Bulk_assert_mine.m %> @brief Asserts that the signal is a TEAP bulk signal - +% %> @param BulkSignal the signal to test %Copyright Frank Villaro-Dixon, 2014 diff --git a/src/bulksigs/Bulk_get_signal.m b/src/bulksigs/Bulk_get_signal.m index f3a8b00..e7b7966 100644 --- a/src/bulksigs/Bulk_get_signal.m +++ b/src/bulksigs/Bulk_get_signal.m @@ -12,13 +12,13 @@ % %You should have received a copy of the GNU General Public License %along with TEAP. If not, see . - +% %> @file Bulk_get_signal.m %> @brief Takes a specific signal from a bulk signal - +% %> @param BulkSignal the bulk signal containing all the specific signals %> @param typeWanted the type you want (ex: 'HST', etc. Defined by SSS_get_signame !) - +% %> @retval Signal the wanted signal. FAILS if does not exist %Copyright Frank Villaro-Dixon, 2014 diff --git a/src/bulksigs/Bulk_get_signals.m b/src/bulksigs/Bulk_get_signals.m index 18dcb4a..2edfc76 100644 --- a/src/bulksigs/Bulk_get_signals.m +++ b/src/bulksigs/Bulk_get_signals.m @@ -14,9 +14,9 @@ %along with TEAP. If not, see . %> @file Bulk_get_signals.m %> @brief Gets the list of the signals of the bulk signal. Ex: ['GSR'; 'EEG']. - +% %> @param BulkSig the bulk signal - +% %> @retval signals the array containing the signals name (ex: ['GSR'; 'EEG']) %Copyright Frank Villaro-Dixon, 2014 diff --git a/src/bulksigs/Bulk_new_empty.m b/src/bulksigs/Bulk_new_empty.m index b90d460..7d38bc4 100644 --- a/src/bulksigs/Bulk_new_empty.m +++ b/src/bulksigs/Bulk_new_empty.m @@ -1,8 +1,24 @@ +%This file is part of TEAP. +% +%TEAP is free software: you can redistribute it and/or modify +%it under the terms of the GNU General Public License as published by +%the Free Software Foundation, either version 3 of the License, or +%(at your option) any later version. +% +%TEAP is distributed in the hope that it will be useful, +%but WITHOUT ANY WARRANTY; without even the implied warranty of +%MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +%GNU General Public License for more details. +% +%You should have received a copy of the GNU General Public License +%along with TEAP. If not, see . +% %> @file Bulk_new_empty.m %> @brief Creates a new empty Bulk signal %> @retval BulkSig an empty bulk signal +%> @author Copyright Frank Villaro-Dixon, Public Domain, 2014 function [BulkSig] = Bulk_new_empty() -%Copyright Frank Villaro-Dixon, Public Domain, 2014 + BulkSig.TEAP = 'B'; %See Signal__new_empty for more doc diff --git a/src/bulksigs/Bulk_update_signal.m b/src/bulksigs/Bulk_update_signal.m index 73c783c..62a4a6e 100644 --- a/src/bulksigs/Bulk_update_signal.m +++ b/src/bulksigs/Bulk_update_signal.m @@ -12,14 +12,14 @@ % %You should have received a copy of the GNU General Public License %along with TEAP. If not, see . - +% %> @file Bulk_update_signal.m %> @brief Updates a signal in the bulk signal - +% %> @param BulkSig the bulk collection %> @param signame the signal name (ex: 'HST') %> @param sig the actual signal (ex: after HST_aqn_variable) - +% %> @retval BulkSig the bulksignal with the signal updated function [BulkSig] = Bulk_update_signal(BulkSig, signame, sig) %Copyright Frank Villaro-Dixon, Guillaume Chanel, 2014 diff --git a/src/bulksigs/loading/Bulk_load.m b/src/bulksigs/loading/Bulk_load.m index 9e95849..6ae5c78 100644 --- a/src/bulksigs/loading/Bulk_load.m +++ b/src/bulksigs/loading/Bulk_load.m @@ -12,13 +12,13 @@ % %You should have received a copy of the GNU General Public License %along with TEAP. If not, see . - +% %> @file Bulk_load.m %> @brief Loads a bdf file, into a TEAP bulk signal, containing EEG, ECG, %> GSR, etc. %> @param file_name: this variable includes the full path; %> it can be any file supported by biogs sload/sopn - +% %> @retval BulkSig a TEAP bulk signal vector function [BulkSig] = Bulk_load(file_name) diff --git a/src/bulksigs/loading/Bulk_load_eeglab.m b/src/bulksigs/loading/Bulk_load_eeglab.m index adff2d2..13323d4 100644 --- a/src/bulksigs/loading/Bulk_load_eeglab.m +++ b/src/bulksigs/loading/Bulk_load_eeglab.m @@ -12,13 +12,13 @@ % %You should have received a copy of the GNU General Public License %along with TEAP. If not, see . - +% %> @file Bulk_load_eeglab.m %> @brief Loads an EEGLab variable, into a TEAP bulk signal, containing EEG, ECG, %> GSR, etc. - +% %> @param EEGV the variable given by EEGLab (ex: load A.mat; Bulk_load_eeglab(EEG)) - +% %> @retval BulkSig a TEAP bulk signal vector function [BulkSig] = Bulk_load_eeglab(EEGV) diff --git a/src/bulksigs/visualisation/Bulk_plot.m b/src/bulksigs/visualisation/Bulk_plot.m index e9ad49a..abbbcf0 100644 --- a/src/bulksigs/visualisation/Bulk_plot.m +++ b/src/bulksigs/visualisation/Bulk_plot.m @@ -12,11 +12,11 @@ % %You should have received a copy of the GNU General Public License %along with TEAP. If not, see . - +% %> @file Bulk_plot.m %> @brief Plots a bulk signal: for each signal of the bulk signal, creates a figure and %> displays the signal - +% %> @param BulkSig the bulk signal %> @param title the optional title diff --git a/src/signals/BVP/BVP__assert_type.m b/src/signals/BVP/BVP__assert_type.m index aa4d7db..894d549 100644 --- a/src/signals/BVP/BVP__assert_type.m +++ b/src/signals/BVP/BVP__assert_type.m @@ -12,7 +12,7 @@ % %You should have received a copy of the GNU General Public License %along with TEAP. If not, see . - +% %> @file BVP__assert_type.m %> @brief Asserts that the given signal is a @b BVP one %> Please refer to @c Signal__assert_type for more and extensive documentation ;) diff --git a/src/signals/BVP/BVP__get_signame.m b/src/signals/BVP/BVP__get_signame.m index bf3fcec..e7a481b 100644 --- a/src/signals/BVP/BVP__get_signame.m +++ b/src/signals/BVP/BVP__get_signame.m @@ -1,3 +1,18 @@ +%This file is part of TEAP. +% +%TEAP is free software: you can redistribute it and/or modify +%it under the terms of the GNU General Public License as published by +%the Free Software Foundation, either version 3 of the License, or +%(at your option) any later version. +% +%TEAP is distributed in the hope that it will be useful, +%but WITHOUT ANY WARRANTY; without even the implied warranty of +%MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +%GNU General Public License for more details. +% +%You should have received a copy of the GNU General Public License +%along with TEAP. If not, see . +% %> @file BVP__get_signame.m %> @brief Returns the name of a @b BVP signal %> @retval name: the name of the @b BVP signal. In this case: 'BVP' diff --git a/src/signals/BVP/BVP__new_empty.m b/src/signals/BVP/BVP__new_empty.m index 195f6f1..41a9049 100644 --- a/src/signals/BVP/BVP__new_empty.m +++ b/src/signals/BVP/BVP__new_empty.m @@ -12,7 +12,7 @@ % %You should have received a copy of the GNU General Public License %along with TEAP. If not, see . - +% %> @file BVP__new_empty.m %> @brief Creates a new BVP empty signal %> @retval Signal an empty @b BVP signal diff --git a/src/signals/BVP/BVP_filter_basic.m b/src/signals/BVP/BVP_filter_basic.m index e9f665d..6044793 100644 --- a/src/signals/BVP/BVP_filter_basic.m +++ b/src/signals/BVP/BVP_filter_basic.m @@ -12,7 +12,7 @@ % %You should have received a copy of the GNU General Public License %along with TEAP. If not, see . - +% %> @file BVP_filter_basic.m %> @brief Cleans a signal adding a low-pass median filter to it. The window equals the %> sample rate, aka 1 sec. diff --git a/src/signals/BVP/acquisition/BVP_aqn_variable.m b/src/signals/BVP/acquisition/BVP_aqn_variable.m index ef823e8..93d1e6b 100644 --- a/src/signals/BVP/acquisition/BVP_aqn_variable.m +++ b/src/signals/BVP/acquisition/BVP_aqn_variable.m @@ -12,15 +12,15 @@ % %You should have received a copy of the GNU General Public License %along with TEAP. If not, see . - +% %> @file BVP_aqn_variable.m %> @brief BVP_aqn_variable gets a BVP signal from a variable - +% %> @param rawBVP [1xN]: the raw BVP signal %> @param sampRate [1x1]: the sampling rate, in Hz - +% %> @retval Signal: A BVP TEAP signal - +% %> @author Copyright Frank Villaro-Dixon, 2014 function Signal = BVP_aqn_variable(rawBVP, sampRate) diff --git a/src/signals/BVP/features/BVP__compute_IBI.m b/src/signals/BVP/features/BVP__compute_IBI.m index 36f30f8..ddef0cc 100644 --- a/src/signals/BVP/features/BVP__compute_IBI.m +++ b/src/signals/BVP/features/BVP__compute_IBI.m @@ -12,7 +12,7 @@ % %You should have received a copy of the GNU General Public License %along with TEAP. If not, see . - +% %> @file BVP__compute_IBI.m %> @brief Computes the IBI if it is not yet available %> @param BVPSignal: the BVP signal diff --git a/src/signals/BVP/features/BVP_feat_BPM.m b/src/signals/BVP/features/BVP_feat_BPM.m index fc70825..5fd814e 100644 --- a/src/signals/BVP/features/BVP_feat_BPM.m +++ b/src/signals/BVP/features/BVP_feat_BPM.m @@ -12,12 +12,12 @@ % %You should have received a copy of the GNU General Public License %along with TEAP. If not, see . - +% %> @file BVP_feat_BPM.m %> @brief Computes the BPM from a BVP signal - +% %> @param BVPSignal: the BVP signal - +% %> @retval BPM: the beats per minute % %> @author Copyright Mohammad Soleymani 2013 diff --git a/src/signals/BVP/features/BVP_feat_extr.m b/src/signals/BVP/features/BVP_feat_extr.m index a2cdaa9..6982a4d 100644 --- a/src/signals/BVP/features/BVP_feat_extr.m +++ b/src/signals/BVP/features/BVP_feat_extr.m @@ -12,18 +12,17 @@ % %You should have received a copy of the GNU General Public License %along with TEAP. If not, see . - +% %> @file BVP_feat_extr.m %> @brief Computes @b BVP features %> @param BVPsignal: the BVP signal. %> @param varargin: you can choose which features to extract (see featureSelector) %> -%> TODO update the list correctly %> the list of available features is: %> - mean_: averaged BVP - ralated to blood pressure %> - HRV: heart rate variability calculated based on the standard %> deviation IBI differences -%> - HR: mean heart rate (beat per minute) +%> - meanIBI: mean heart rate (beat per minute) %> - MSE: Multi-Scale Entropy at 5 levels 1-5 %> - sp0001: spectral power in 0.0-0.1Hz band %> - sp0102: spectral power in 0.1-2.1Hz band @@ -31,14 +30,14 @@ %> - sp0304: spectral power in 0.3-4.1Hz band %> - sp_energyRatio: spectral power ratio between 0.0-0.08Hz and %> 0.15-0.5Hz bands -%> - tachogram_LFSP: Tachogram's low freqneucy spectral content +%> - tachogram_LF: Tachogram's low freqneucy spectral content %> <0.08Hz -%> - tachogram_MFSP: Tachogram's medium freqneucy spectral content +%> - tachogram_MF: Tachogram's medium freqneucy spectral content %> 0.08Hz> and <0.15Hz -%> - tachogram_HFSP: Tachogram's high freqneucy spectral content +%> - tachogram_HF: Tachogram's high freqneucy spectral content %> 0.15Hz> and <0.5Hz %> - tachogram_energy_ratio: energu ratio tachogram_MFSP/(tachogram_HSP+tachogram_LFSP) - +% %> @retval BVP_feats: list of features values %> @retval BVP_feats_names: names of the computed features (it is good pratice to %> check this vector since the order of requested features @@ -46,7 +45,7 @@ %> @retval Bulk: if the input to the function is a Bulk than the Bulk is returned %> with the updated BVP signal, including IBI. Otherwise NaN is %> returned - +% %> @author Copyright Guillaume Chanel 2013 %> @author Copyright Frank Villaro-Dixon, 2014 function [BVP_feats, BVP_feats_names, Bulk] = BVP_feat_extr(BVPSignal,varargin) @@ -94,8 +93,6 @@ mean_ = mean(rawSignal); end - - if any(strcmp('meanIBI',BVP_feats_names)) || any(strcmp('HRV',BVP_feats_names)) HRV = std(IBI); meanIBI = mean(IBI); diff --git a/src/signals/BVP/features/BVP_feat_mean.m b/src/signals/BVP/features/BVP_feat_mean.m index 406bf73..d06452e 100644 --- a/src/signals/BVP/features/BVP_feat_mean.m +++ b/src/signals/BVP/features/BVP_feat_mean.m @@ -12,7 +12,7 @@ % %You should have received a copy of the GNU General Public License %along with TEAP. If not, see . - +% %> @file BVP_feat_mean.m %> @brief Computes the mean of a @b BVP signal %> @param BVPs: the BVP signal diff --git a/src/signals/BVP/features/BVP_feat_std.m b/src/signals/BVP/features/BVP_feat_std.m index 9381835..a612b6b 100644 --- a/src/signals/BVP/features/BVP_feat_std.m +++ b/src/signals/BVP/features/BVP_feat_std.m @@ -12,7 +12,7 @@ % %You should have received a copy of the GNU General Public License %along with TEAP. If not, see . - +% %> @file BVP_feat_std.m %> @brief Computes the std of a BVP signal %> @param BVPs: the BVP signal diff --git a/src/signals/BVP/features/BVP_feat_var.m b/src/signals/BVP/features/BVP_feat_var.m index 2d2430e..5f5bc72 100644 --- a/src/signals/BVP/features/BVP_feat_var.m +++ b/src/signals/BVP/features/BVP_feat_var.m @@ -12,7 +12,7 @@ % %You should have received a copy of the GNU General Public License %along with TEAP. If not, see . - +% %> @file BVP_feat_var.m %> @brief Computes the variance of a @b BVP signal %> @param BVPSignal: the @b BVP signal diff --git a/src/signals/DMY/DMY_assert_type.m b/src/signals/DMY/DMY_assert_type.m index 9fa871f..d5469ab 100644 --- a/src/signals/DMY/DMY_assert_type.m +++ b/src/signals/DMY/DMY_assert_type.m @@ -12,7 +12,7 @@ % %You should have received a copy of the GNU General Public License %along with TEAP. If not, see . - +% %> @file DMY_assert_type.m function Signal = DMY_assert_type(Signal) %Asserts that the given signal is a DMY one diff --git a/src/signals/DMY/DMY_new_empty.m b/src/signals/DMY/DMY_new_empty.m index 1586141..09ad21e 100644 --- a/src/signals/DMY/DMY_new_empty.m +++ b/src/signals/DMY/DMY_new_empty.m @@ -12,7 +12,7 @@ % %You should have received a copy of the GNU General Public License %along with TEAP. If not, see . - +% %> @file DMY_new_empty.m function Signal = DMY_new_empty() % Creates a new DMY empty signal diff --git a/src/signals/DMY/acquisition/DMY_aqn_file.m b/src/signals/DMY/acquisition/DMY_aqn_file.m index 42f611c..6635583 100644 --- a/src/signals/DMY/acquisition/DMY_aqn_file.m +++ b/src/signals/DMY/acquisition/DMY_aqn_file.m @@ -12,7 +12,7 @@ % %You should have received a copy of the GNU General Public License %along with TEAP. If not, see . - +% %> @file DMY_aqn_file.m function Signal = DMY_aqn_file(filename) % DMY_AQN_FILE gets a DMY signal from a filename diff --git a/src/signals/DMY/examples/DMY_example_1.m b/src/signals/DMY/examples/DMY_example_1.m index c1abd7b..0b86b46 100644 --- a/src/signals/DMY/examples/DMY_example_1.m +++ b/src/signals/DMY/examples/DMY_example_1.m @@ -12,7 +12,7 @@ % %You should have received a copy of the GNU General Public License %along with TEAP. If not, see . - +% %> @file DMY_example_1.m Sig = DMY_aqn_file(); diff --git a/src/signals/DMY/features/DMY_feat_feat1.m b/src/signals/DMY/features/DMY_feat_feat1.m index 1e5c164..ad5a355 100644 --- a/src/signals/DMY/features/DMY_feat_feat1.m +++ b/src/signals/DMY/features/DMY_feat_feat1.m @@ -12,7 +12,7 @@ % %You should have received a copy of the GNU General Public License %along with TEAP. If not, see . - +% %> @file DMY_feat_feat1.m %> @brief Computes feature feat1 from a DMY signal Signal. The result is stored in the %> signal cache, then returned. diff --git a/src/signals/ECG/ECG__assert_type.m b/src/signals/ECG/ECG__assert_type.m index 75b573c..85fd211 100644 --- a/src/signals/ECG/ECG__assert_type.m +++ b/src/signals/ECG/ECG__assert_type.m @@ -12,7 +12,7 @@ % %You should have received a copy of the GNU General Public License %along with TEAP. If not, see . - +% %> @file ECG__assert_type.m %> @brief Makes sure that the given signal is an ECG one %> Please refer to @c Signal__assert_type for more documentation diff --git a/src/signals/ECG/acquisition/ECG_aqn_variable.m b/src/signals/ECG/acquisition/ECG_aqn_variable.m index f18f746..fdfeb71 100644 --- a/src/signals/ECG/acquisition/ECG_aqn_variable.m +++ b/src/signals/ECG/acquisition/ECG_aqn_variable.m @@ -12,7 +12,7 @@ % %You should have received a copy of the GNU General Public License %along with TEAP. If not, see . - +% %> @file ECG_aqn_variable.m %> @brief ECG_aqn_variable gets an ECG signal from a variable %> @attention USAGE: @@ -22,13 +22,13 @@ %> If, however, the difference was already calculated by your device, you can %> call the function that way: %> @c ECG_aqn_variable(electrodesDiff, sampRate); - +% %> @param ECG [1xN]: the ECG signal %> @param ECG2 [1xN]: the other pair ECG signal (optional if difference already calc.) %> @param sampRate [1x1]: the sampling rate, in Hz - +% %> @retval Signal: An ECG TEAP signal - +% %> @author Copyright Frank Villaro-Dixon, 2014 function Signal = ECG_aqn_variable(ECG, ECG2, sampRate) diff --git a/src/signals/ECG/examples/ECG_feat_IBI_example.m b/src/signals/ECG/examples/ECG_feat_IBI_example.m index 64324d1..39538a9 100644 --- a/src/signals/ECG/examples/ECG_feat_IBI_example.m +++ b/src/signals/ECG/examples/ECG_feat_IBI_example.m @@ -12,7 +12,7 @@ % %You should have received a copy of the GNU General Public License %along with TEAP. If not, see . - +% %> @file ECG_feat_IBI_example.m addpath(genpath('../../../')); %load the toolbox diff --git a/src/signals/ECG/features/ECG__compute_IBI.m b/src/signals/ECG/features/ECG__compute_IBI.m index 3075d5f..008dae1 100644 --- a/src/signals/ECG/features/ECG__compute_IBI.m +++ b/src/signals/ECG/features/ECG__compute_IBI.m @@ -12,7 +12,7 @@ % %You should have received a copy of the GNU General Public License %along with TEAP. If not, see . - +% %> @file ECG__compute_IBI.m %> @brief Computes the IBI if it is not yet available %> @param ECGSignal: the ECG signal diff --git a/src/signals/ECG/features/ECG_feat_IBImean.m b/src/signals/ECG/features/ECG_feat_IBImean.m index 19964d6..e4ac7e5 100644 --- a/src/signals/ECG/features/ECG_feat_IBImean.m +++ b/src/signals/ECG/features/ECG_feat_IBImean.m @@ -12,7 +12,7 @@ % %You should have received a copy of the GNU General Public License %along with TEAP. If not, see . - +% %> @file ECG_feat_IBImean.m %> @brief Computes the InterBeatInterval mean of an ECG signal %> @param ECGSignal: the ECG signal diff --git a/src/signals/ECG/features/ECG_feat_IBIvar.m b/src/signals/ECG/features/ECG_feat_IBIvar.m index 0647960..f1ff4fc 100644 --- a/src/signals/ECG/features/ECG_feat_IBIvar.m +++ b/src/signals/ECG/features/ECG_feat_IBIvar.m @@ -12,7 +12,7 @@ % %You should have received a copy of the GNU General Public License %along with TEAP. If not, see . - +% %> @file ECG_feat_IBIvar.m %> @brief Computes the InterBeatInterval variance of an ECG signal %> @param ECGSignal: the ECG signal diff --git a/src/signals/ECG/features/ECG_feat_extr.m b/src/signals/ECG/features/ECG_feat_extr.m index 0e54abf..5174652 100644 --- a/src/signals/ECG/features/ECG_feat_extr.m +++ b/src/signals/ECG/features/ECG_feat_extr.m @@ -12,7 +12,7 @@ % %You should have received a copy of the GNU General Public License %along with TEAP. If not, see . - +% %> @file ECG_feat_extr.m %> @brief Computes ECG features %TODO: clarifiy the help @@ -24,8 +24,22 @@ % Inputs: %> @param ECGSignal: the ECG signal (already subtracted from one lead) %> @param varargin: you can choose which features to extract -%> default or no input will result in extracting all the features - +%> default or no input will result in extracting all the features +%> (see feature Extractor) +%> featues names include: +%> - meanIBI: mean interbeat interval +%> - HRV: heart rate variability (deviation of IBI) +%> - MSE: Multi-Scale Entropy at 5 levels 1-5 (5 features) +%> - sp0001: Spectral power 0-0.1Hz, +%> - sp0102: Spectral power 0.1-0.2Hz, +%> - sp0203: Spectral power 0.2-0.3Hz, +%> - sp0304: Spectral power 0.3-0.4Hz, +%> - energyRatio: Spectral energy ratio between f<0.08Hz/f>0.15Hz and f<5.0Hz +%> - tachogram_LF: Low frequency spectral power in tachogram (HRV) [0.01-0.08Hz] +%> - tachogram_MF: Medium frequency spectral power in tachogram (HRV) [0.08-0.15Hz] +%> - tachogram_HF: High frequency spectral power in tachogram (HRV) [0.15-0.5Hz] +%> - tachogram_energy_ratio: Energy ratio for tachogram spectral content (MF/(LF+HF)) +% %> @retval ECG_features: vector of features among the following features %> @retval ECG_feats_names: the names of the features is the same order than in %> 'ECG_features' @@ -33,21 +47,7 @@ %> with the updated ECG signal, including IBI. Otherwise NaN is %> returned %> -%>TODO update feature names there -%1. 2. mean HRV, 3. mean heart rate, -%4-8. Multiscale entropy at 5 levels on HRV (5 feaures), -%9. Spectral power 0-0.1Hz, -%10. Spectral power 0.1-0.2Hz, -%11. Spectral power 0.2-0.3 -%12. Spectral power 0.3-0.4Hz, -%13. Spectral energy ratio between f<0.08Hz/f>0.15Hz and f<5.0Hz -%14. Low frequency spectral power in tachogram (HRV) [0.01-0.08Hz] -%15. Medium frequency spectral power in tachogram (HRV) [0.08-0.15Hz] -%16. High frequency spectral power in tachogram (HRV) [0.15-0.5Hz] -%17. Energy ratio for tachogram spectral content (MF/(LF+HF)) -% ECG_feats_names: names of features corresponding to th ECG_features -% values - +% %> @author Copyright Guillaume Chanel 2013, 2015 %> @author Copyright Frank Villaro-Dixon, 2014 function [ECG_features, ECG_feats_names, Bulk] = ECG_feat_extr(ECGSignal,varargin) diff --git a/src/signals/EEG/EEG__assert_type.m b/src/signals/EEG/EEG__assert_type.m index a753e57..38ce95d 100644 --- a/src/signals/EEG/EEG__assert_type.m +++ b/src/signals/EEG/EEG__assert_type.m @@ -12,7 +12,7 @@ % %You should have received a copy of the GNU General Public License %along with TEAP. If not, see . - +% %> @file EEG__assert_type.m %> @brief Asserts that the given signal is an EEG one %> Please refer to @c Signal__assert_type for more extensive documentation diff --git a/src/signals/EEG/EEG__get_signame.m b/src/signals/EEG/EEG__get_signame.m index 623be27..97d9ac4 100644 --- a/src/signals/EEG/EEG__get_signame.m +++ b/src/signals/EEG/EEG__get_signame.m @@ -1,3 +1,18 @@ +%This file is part of TEAP. +% +%TEAP is free software: you can redistribute it and/or modify +%it under the terms of the GNU General Public License as published by +%the Free Software Foundation, either version 3 of the License, or +%(at your option) any later version. +% +%TEAP is distributed in the hope that it will be useful, +%but WITHOUT ANY WARRANTY; without even the implied warranty of +%MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +%GNU General Public License for more details. +% +%You should have received a copy of the GNU General Public License +%along with TEAP. If not, see . +% %> @file EEG__get_signame.m %> @brief Gets the name of a @b EEG signal %> @retval name: the name of the @b EEG signal, in this case, 'EEG' diff --git a/src/signals/EEG/EEG__new_empty.m b/src/signals/EEG/EEG__new_empty.m index 4840307..7107e3b 100644 --- a/src/signals/EEG/EEG__new_empty.m +++ b/src/signals/EEG/EEG__new_empty.m @@ -12,7 +12,7 @@ % %You should have received a copy of the GNU General Public License %along with TEAP. If not, see . - +% %> @file EEG__new_empty.m %> @brief Creates a new EEG empty signal function Signal = EEG__new_empty() diff --git a/src/signals/EEG/EEG_get_channel.m b/src/signals/EEG/EEG_get_channel.m index 55cefdc..fc81551 100644 --- a/src/signals/EEG/EEG_get_channel.m +++ b/src/signals/EEG/EEG_get_channel.m @@ -12,15 +12,15 @@ % %You should have received a copy of the GNU General Public License %along with TEAP. If not, see . - +% %> @file EEG_get_channel.m %> @brief Gets the channel data from the EEG signal - +% %> @param Signal: the signal %> @param channelName: the name of the channel you want to take - +% %> @retval Data: the data of the channel - +% %> @author Copyright Frank Villaro-Dixon, 2014 function Data = EEG_get_channel(Signal, channelName) diff --git a/src/signals/EEG/EEG_get_elname.m b/src/signals/EEG/EEG_get_elname.m index b18e0e7..b828450 100644 --- a/src/signals/EEG/EEG_get_elname.m +++ b/src/signals/EEG/EEG_get_elname.m @@ -12,14 +12,14 @@ % %You should have received a copy of the GNU General Public License %along with TEAP. If not, see . - +% %> @file EEG_get_elname.m %> @brief Gets the electrode name from a number - +% %> @param num: the electrode number (eg: 2) - +% %> @retval name: the name (eg: 'AF3') - +% %> @author Copyright Frank Villaro-Dixon, 2014 function [name] = EEG_get_elname(num) diff --git a/src/signals/EEG/EEG_has_channel.m b/src/signals/EEG/EEG_has_channel.m index 7c1eef7..cb800bd 100644 --- a/src/signals/EEG/EEG_has_channel.m +++ b/src/signals/EEG/EEG_has_channel.m @@ -12,15 +12,15 @@ % %You should have received a copy of the GNU General Public License %along with TEAP. If not, see . - +% %> @file EEG_has_channel.m %> @brief Simply tells you if that specific channel on the @b EEG signal exists. - +% %> @param EEGSignal: the EEG signal %> @param channelName: the channelName (ex: 'Fp1') - +% %> @retval ChannelExists: a boolean variable - +% %> @author Copyright Frank Villaro-Dixon, 2014 function ChannelExists = EEG_has_channel(EEGSignal, channelName) diff --git a/src/signals/EEG/EEG_reference_mean.m b/src/signals/EEG/EEG_reference_mean.m index c7559e0..9a24ebe 100644 --- a/src/signals/EEG/EEG_reference_mean.m +++ b/src/signals/EEG/EEG_reference_mean.m @@ -12,11 +12,11 @@ % %You should have received a copy of the GNU General Public License %along with TEAP. If not, see . - +% %> @file EEG_reference_mean.m %> @brief re-references the @b EEG signals to their mean %> Creates a reference for the @b EEG signal; removed average reference' the signal - +% %> @param EEGSignal: the @b EEG signal %> @retval EEGSignal: the referenced @b EEG signal % diff --git a/src/signals/EEG/EEG_set_channel.m b/src/signals/EEG/EEG_set_channel.m index 6d3d2e9..0ada32a 100644 --- a/src/signals/EEG/EEG_set_channel.m +++ b/src/signals/EEG/EEG_set_channel.m @@ -12,16 +12,16 @@ % %You should have received a copy of the GNU General Public License %along with TEAP. If not, see . - +% %> @file EEG_set_channel.m %> @brief Sets the channel 'channelName' of the EEG signal - +% %> @param Signal: the EEG signal %> @param channelName: the name of the channel (ex: 'AF3') %> @param channelData: the data - +% %> @retval Signal The set signal - +% %> @author Copyright Frank Villaro-Dixon, 2014 function Signal = EEG_set_channel(Signal, channelName, channelData) diff --git a/src/signals/EEG/acquisition/EEG_aqn_variable.m b/src/signals/EEG/acquisition/EEG_aqn_variable.m index ea950e6..58f0fbf 100644 --- a/src/signals/EEG/acquisition/EEG_aqn_variable.m +++ b/src/signals/EEG/acquisition/EEG_aqn_variable.m @@ -12,14 +12,14 @@ % %You should have received a copy of the GNU General Public License %along with TEAP. If not, see . - +% %> @file EEG_aqn_variable.m %> @brief EEG_aqn_variable gets an EEG signal from a variable. - +% %> @param eegChannels [Cxstrings]: a vector specifying the C EEG channels given %> @param eegData [CxN]: a matrix containing the EEG data %> @param sampRate [1x1]: the sampling rate, in Hz - +% %> @retval Signal: An EEG TEAP signal function Signal = EEG_aqn_variable(eegChannels, eegData, sampRate) diff --git a/src/signals/EEG/examples/EEG_aqn_var_example.m b/src/signals/EEG/examples/EEG_aqn_var_example.m index b9e50b6..35cfe92 100644 --- a/src/signals/EEG/examples/EEG_aqn_var_example.m +++ b/src/signals/EEG/examples/EEG_aqn_var_example.m @@ -12,7 +12,7 @@ % %You should have received a copy of the GNU General Public License %along with TEAP. If not, see . - +% %> @file EEG_aqn_var_example.m addpath(genpath('../../../')); diff --git a/src/signals/EEG/features/EEG_feat_bandENR.m b/src/signals/EEG/features/EEG_feat_bandENR.m index 10cbdf2..954f623 100644 --- a/src/signals/EEG/features/EEG_feat_bandENR.m +++ b/src/signals/EEG/features/EEG_feat_bandENR.m @@ -12,12 +12,12 @@ % %You should have received a copy of the GNU General Public License %along with TEAP. If not, see . - +% %> @file EEG_feat_bandENR.m %> @brief Computes the band energy (trial/baseline) for the @b EEG signal. - +% %> @param EEGSignal: the @b EEG signal - +% %> @retval thetaBand: 1xN vector; N number of electrodes %> @retval alphaBand: 1xN vector; N number of electrodes %> @retval betaBand: 1xN vector; N number of electrodes diff --git a/src/signals/EEG/features/EEG_feat_extr.m b/src/signals/EEG/features/EEG_feat_extr.m index 12fba8e..312e036 100644 --- a/src/signals/EEG/features/EEG_feat_extr.m +++ b/src/signals/EEG/features/EEG_feat_extr.m @@ -12,7 +12,7 @@ % %You should have received a copy of the GNU General Public License %along with TEAP. If not, see . - +% %> @file EEG_feat_extr.m %> @brief Computes Skin respiration features %> @param EEGsignal: the respiration signal. @@ -24,14 +24,14 @@ %> - SP_alpha: power spectral power for alpha band [8,12[ Hz %> - SP_beta: power spectral power for beta band [12,30[ Hz %> - SP_gamma: power spectral power for gamma band >30Hz - +% %> @retval EEG_feats: list of features values %> @retval EEG_feats_names: names of the computed features (it is good pratice to %> check this vector since the order of requested features %> can be different than the requested one) %> the features are per electode and therefore 1xN (N= number of electrodes) %> and the final output is a 2dimensional array whose size is N_features x N_electrodes - +% %> @author Copyright Mohammad Soleymani, Guillaume Chanel, Frank Villaro-Dixon, 2015 function [EEG_feats, EEG_feats_names] = EEG_feat_extr(EEGsignal,varargin) diff --git a/src/signals/EMG/EMG__assert_type.m b/src/signals/EMG/EMG__assert_type.m index 958d2d6..804ca58 100644 --- a/src/signals/EMG/EMG__assert_type.m +++ b/src/signals/EMG/EMG__assert_type.m @@ -12,7 +12,7 @@ % %You should have received a copy of the GNU General Public License %along with TEAP. If not, see . - +% %> @file EMG__assert_type.m %> @brief Makes sure that the given signal is an EMG one %> Please refer to Signal__assert_type for more documentation diff --git a/src/signals/EMG/EMG__get_signame.m b/src/signals/EMG/EMG__get_signame.m index 861abc2..ed9c178 100644 --- a/src/signals/EMG/EMG__get_signame.m +++ b/src/signals/EMG/EMG__get_signame.m @@ -1,8 +1,8 @@ %> @file EMG__get_signame.m %> @brief Get the name of a EMG signal - +% %> @retval name: the name of the EMG signal, in this case, 'EMG' - +% %> @author Copyright Frank Villaro-Dixon, Public Domain, 2014 function name = EMG__get_signame() diff --git a/src/signals/EMG/EMG__new_empty.m b/src/signals/EMG/EMG__new_empty.m index 5ac0b9c..1aec826 100644 --- a/src/signals/EMG/EMG__new_empty.m +++ b/src/signals/EMG/EMG__new_empty.m @@ -12,7 +12,7 @@ % %You should have received a copy of the GNU General Public License %along with TEAP. If not, see . - +% %> @file EMG__new_empty.m %> @brief Creates a new EMG empty signal function Signal = EMG__new_empty() diff --git a/src/signals/EMG/acquisition/EMG_aqn_variable.m b/src/signals/EMG/acquisition/EMG_aqn_variable.m index ed82d80..8151760 100644 --- a/src/signals/EMG/acquisition/EMG_aqn_variable.m +++ b/src/signals/EMG/acquisition/EMG_aqn_variable.m @@ -12,7 +12,7 @@ % %You should have received a copy of the GNU General Public License %along with TEAP. If not, see . - +% %> @file EMG_aqn_variable.m %> @brief EMG_aqn_variable gets an EMG signal from a variable %> @b USAGE: @@ -30,7 +30,7 @@ %> @param EMG [1xN]: the EMG signal %> @param EMG2 [1xN]: the other pair EMG signal (optional if difference already calc.) %> @param sampRate [1x1]: the sampling rate, in Hz - +% %> @retval Signal An EMG TEAP signal % %> @author Copyright Frank Villaro-Dixon, 2014 diff --git a/src/signals/GSR/GSR__assert_type.m b/src/signals/GSR/GSR__assert_type.m index 5cf6846..ade45b9 100644 --- a/src/signals/GSR/GSR__assert_type.m +++ b/src/signals/GSR/GSR__assert_type.m @@ -12,7 +12,7 @@ % %You should have received a copy of the GNU General Public License %along with TEAP. If not, see . - +% %> @file GSR__assert_type.m %> @brief Makes sure that the given signal is a GSR one %> Please refer to it's father function (Signal__assert_type()) for more doc ;) diff --git a/src/signals/GSR/GSR__new_empty.m b/src/signals/GSR/GSR__new_empty.m index 61a3dc7..5e228dc 100644 --- a/src/signals/GSR/GSR__new_empty.m +++ b/src/signals/GSR/GSR__new_empty.m @@ -12,7 +12,7 @@ % %You should have received a copy of the GNU General Public License %along with TEAP. If not, see . - +% %> @file GSR__new_empty.m %> @brief Creates a new GSR empty signal function Signal = GSR__new_empty() diff --git a/src/signals/GSR/GSR_filter_basic.m b/src/signals/GSR/GSR_filter_basic.m index a3b7f6f..1a3cd20 100644 --- a/src/signals/GSR/GSR_filter_basic.m +++ b/src/signals/GSR/GSR_filter_basic.m @@ -12,14 +12,14 @@ % %You should have received a copy of the GNU General Public License %along with TEAP. If not, see . - +% %> @file GSR_filter_basic.m %> @brief Cleans a signal adding a low-pass mean filter to it. The window equals the %> sample rate, aka 1 sec. - +% %> @param GSRsignal: the GSR signal. %> @retval Signal: the filtered GSR signal - +% %> @author Copyright Frank Villaro-Dixon, 2014 function GSRsignal = GSR_filter_basic(GSRsignal) diff --git a/src/signals/GSR/acquisition/GSR_aqn_variable.m b/src/signals/GSR/acquisition/GSR_aqn_variable.m index 5d7b2f8..729dcdb 100644 --- a/src/signals/GSR/acquisition/GSR_aqn_variable.m +++ b/src/signals/GSR/acquisition/GSR_aqn_variable.m @@ -12,15 +12,15 @@ % %You should have received a copy of the GNU General Public License %along with TEAP. If not, see . - +% %> @file GSR_aqn_variable.m %> @brief GSR_aqn_variable gets a GSR signal from a variable - +% %> @param rawGSR [1xN]: the raw GSR signal %> @param sampRate [1x1]: the sampling rate, in Hz - +% %> @retval Signal: A GSR TEAP signal - +% %> @author Copyright Frank Villaro-Dixon, 2014 function Signal = GSR_aqn_variable(rawGSR, sampRate) diff --git a/src/signals/GSR/examples/GSR_feat_peaks_example.m b/src/signals/GSR/examples/GSR_feat_peaks_example.m index fb8fe8b..1cd3f6e 100644 --- a/src/signals/GSR/examples/GSR_feat_peaks_example.m +++ b/src/signals/GSR/examples/GSR_feat_peaks_example.m @@ -12,10 +12,10 @@ % %You should have received a copy of the GNU General Public License %along with TEAP. If not, see . - +% %> @file GSR_feat_peaks_example.m %> @brief Loads a GSR signal, computes it's attributes and displays the signal - +% %Before all, load TEAP addpath(genpath('../../../')) diff --git a/src/signals/GSR/features/GSR_feat_extr.m b/src/signals/GSR/features/GSR_feat_extr.m index 546acb4..805fb37 100644 --- a/src/signals/GSR/features/GSR_feat_extr.m +++ b/src/signals/GSR/features/GSR_feat_extr.m @@ -12,10 +12,10 @@ % %You should have received a copy of the GNU General Public License %along with TEAP. If not, see . - +% %> @file GSR_feat_extr.m %> @brief Computes GSR features - +% %> @param GSRsignal: the GSR signal. %> @param varargin: you can choose which features to extract (see featureSelector) %> the list of available features is: @@ -24,7 +24,7 @@ %> - riseTime: average rise time of peaks %> - meanGSR: average GSR value %> - stdGSR: variance of GSR - +% %> @retval GSR_feats: list of features values %> @retval GSR_feats_names: names of the computed features (it is good pratice to %> check this vector since the order of requested features diff --git a/src/signals/GSR/features/GSR_feat_peaks.m b/src/signals/GSR/features/GSR_feat_peaks.m index a594161..2af3968 100644 --- a/src/signals/GSR/features/GSR_feat_peaks.m +++ b/src/signals/GSR/features/GSR_feat_peaks.m @@ -12,20 +12,20 @@ % %You should have received a copy of the GNU General Public License %along with TEAP. If not, see . - +% %> @file GSR_feat_peaks.m %> @brief Computes the number of peaks from a GSR signal. It is based on the analysis of %> local minima and local maxima preceding the local minima. - +% %> @param GSRsignal: the GSR signal. %> @param ampThresh: the amplitude threshold in Ohms from which a peak is detected. %> Default is 100 Ohm - +% %> @retval nbPeaks: the # of peaks in the signal %> @retval ampPeaks [1xP]: the amplitude of the peaks (maxima - minima) %> @retval riseTime [1xP]: the duration of the rise time of each peak %> @retval posPeaks [1xP]: index of the detected peaks in the GSR signal - +% %> @author Copyright XXX 2011 %> @author Copyright Frank Villaro-Dixon, 2014 function [nbPeaks, ampPeaks, riseTime, posPeaks] = GSR_feat_peaks(GSRsignal, ampThresh) diff --git a/src/signals/HST/HST__assert_type.m b/src/signals/HST/HST__assert_type.m index 31e5a7d..ae5f5d3 100644 --- a/src/signals/HST/HST__assert_type.m +++ b/src/signals/HST/HST__assert_type.m @@ -12,7 +12,7 @@ % %You should have received a copy of the GNU General Public License %along with TEAP. If not, see . - +% %> @file HST__assert_type.m %> @brief Asserts that the given signal is a HST one %> Yo: if you want to know how this works, please see my master:Signal__assert_type diff --git a/src/signals/HST/HST__get_signame.m b/src/signals/HST/HST__get_signame.m index 9df6cc3..b96ee0d 100644 --- a/src/signals/HST/HST__get_signame.m +++ b/src/signals/HST/HST__get_signame.m @@ -1,7 +1,7 @@ %> @file HST__get_signame.m %> @brief Gets the name of a HST signal %> Copyright Frank Villaro-Dixon, Public Domain, 2014 - +% %> @retval name the name of the HST signal, in this case, 'HST' function name = HST__get_signame() diff --git a/src/signals/HST/HST__new_empty.m b/src/signals/HST/HST__new_empty.m index 600d461..1c4747b 100644 --- a/src/signals/HST/HST__new_empty.m +++ b/src/signals/HST/HST__new_empty.m @@ -12,7 +12,7 @@ % %You should have received a copy of the GNU General Public License %along with TEAP. If not, see . - +% %> @file HST__new_empty.m %> @brief Creates a new HST empty signal function Signal = HST__new_empty() diff --git a/src/signals/HST/HST_filter_basic.m b/src/signals/HST/HST_filter_basic.m index 864cc7f..f27163e 100644 --- a/src/signals/HST/HST_filter_basic.m +++ b/src/signals/HST/HST_filter_basic.m @@ -12,12 +12,12 @@ % %You should have received a copy of the GNU General Public License %along with TEAP. If not, see . - +% %> @file HST_filter_basic.m %> @brief Cleans an HST signal using a low-pass mean filter. The window equals the sample %> rate, aka 1sec %> Copyright Frank Villaro-Dixon, 2014 - +% %> @param HSTSignal the HST signal to filter %> @retval HSTSignal the HST signal filtered diff --git a/src/signals/HST/acquisition/HST_aqn_variable.m b/src/signals/HST/acquisition/HST_aqn_variable.m index 057e752..b5e2014 100644 --- a/src/signals/HST/acquisition/HST_aqn_variable.m +++ b/src/signals/HST/acquisition/HST_aqn_variable.m @@ -12,14 +12,14 @@ % %You should have received a copy of the GNU General Public License %along with TEAP. If not, see . - +% %> @file HST_aqn_variable.m %> @brief HST_aqn_variable gets a HST signal from a variable - +% %> @param rawHST [1xN] the raw HST signal %> @param sampRate [1x1] the sampling rate, in Hz %> @retval Signal A HST TEAP signal - +% %> Copyright Frank Villaro-Dixon, 2014 function Signal = HST_aqn_variable(rawHST, sampRate) diff --git a/src/signals/HST/features/HST_feat_extr.m b/src/signals/HST/features/HST_feat_extr.m index d2dd570..3862222 100644 --- a/src/signals/HST/features/HST_feat_extr.m +++ b/src/signals/HST/features/HST_feat_extr.m @@ -12,20 +12,22 @@ % %You should have received a copy of the GNU General Public License %along with TEAP. If not, see . - +% %> @file HST_feat_extr.m %> @brief Computes Skin temperature features %> @b WARNING: this function will give 'strange' results when applied on a relative %> signal - +% %> @param HSTsignal the temperature signal. %> @param varargin you can choose which features to extract (see featureSelector) %> the list of available features is: -%> - mean: average temprature -%> - std: standard deviation of the temperature -%> - kurtosis: Kurtosis of the temperature -%> - skewness: skewness of the temperature - +%> - mean_: average temprature +%> - std_: standard deviation of the temperature +%> - kurtosis_: Kurtosis of the temperature +%> - skewness_: skewness of the temperature +%> - sp0001: Spectral power 0-0.1Hz, +%> - sp0102: Spectral power 0.1-0.2Hz, +% %> @retval HST_feats list of features values %> @retval HST_feats_names names of the computed features (it is good pratice to %> check this vector since the order of requested features diff --git a/src/signals/HST/features/HST_feat_mean.m b/src/signals/HST/features/HST_feat_mean.m index a0cf823..09a1708 100644 --- a/src/signals/HST/features/HST_feat_mean.m +++ b/src/signals/HST/features/HST_feat_mean.m @@ -12,13 +12,13 @@ % %You should have received a copy of the GNU General Public License %along with TEAP. If not, see . - +% %> @file HST_feat_mean.m %> @brief Computes the mean of the HST signal (aka the mean temperature) %> @b WARNING: this function will give 'strange' results when applied on a relative %> signal %> @author Copyright Frank Villaro-Dixon, 2014 - +% %> @param HSTsignal the HST signal. %> @retval meanTemp the mean temperature, in °C diff --git a/src/signals/HST/features/HST_feat_meanderiv.m b/src/signals/HST/features/HST_feat_meanderiv.m index b58e2b8..72911b6 100644 --- a/src/signals/HST/features/HST_feat_meanderiv.m +++ b/src/signals/HST/features/HST_feat_meanderiv.m @@ -12,11 +12,11 @@ % %You should have received a copy of the GNU General Public License %along with TEAP. If not, see . - +% %> @file HST_feat_meanderiv.m %> @brief Computes the mean derivation of the HST signal. %> @author Copyright Frank Villaro-Dixon, 2014 - +% %> @param HSTsignal the HST signal. %> @retval meanTemp the mean derivation of the temperature, in d°C/dt (= dK/dt) diff --git a/src/signals/RES/RES__assert_type.m b/src/signals/RES/RES__assert_type.m index 823fe0e..aac552d 100644 --- a/src/signals/RES/RES__assert_type.m +++ b/src/signals/RES/RES__assert_type.m @@ -12,7 +12,7 @@ % %You should have received a copy of the GNU General Public License %along with TEAP. If not, see . - +% %> @file RES__assert_type.m %> @brief Makes sure that the given signal is a RES one %> If you want to know more about that, please see Signal__assert_type's document… diff --git a/src/signals/RES/RES__get_signame.m b/src/signals/RES/RES__get_signame.m index f2fc604..716ce3c 100644 --- a/src/signals/RES/RES__get_signame.m +++ b/src/signals/RES/RES__get_signame.m @@ -1,3 +1,18 @@ +%This file is part of TEAP. +% +%TEAP is free software: you can redistribute it and/or modify +%it under the terms of the GNU General Public License as published by +%the Free Software Foundation, either version 3 of the License, or +%(at your option) any later version. +% +%TEAP is distributed in the hope that it will be useful, +%but WITHOUT ANY WARRANTY; without even the implied warranty of +%MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +%GNU General Public License for more details. +% +%You should have received a copy of the GNU General Public License +%along with TEAP. If not, see . +% %> @file RES__get_signame.m %> @brief Get the name of a RES signal %> @retval name: the name of the RES signal, in this case, 'RES' diff --git a/src/signals/RES/RES__new_empty.m b/src/signals/RES/RES__new_empty.m index deb8ce5..ec332ed 100644 --- a/src/signals/RES/RES__new_empty.m +++ b/src/signals/RES/RES__new_empty.m @@ -12,7 +12,7 @@ % %You should have received a copy of the GNU General Public License %along with TEAP. If not, see . - +% %> @file RES__new_empty.m %> @brief Creates a new RES empty signal %> @retval Signal: an empty RES signal. diff --git a/src/signals/RES/RES_filter_basic.m b/src/signals/RES/RES_filter_basic.m index 3ba96a9..e883af0 100644 --- a/src/signals/RES/RES_filter_basic.m +++ b/src/signals/RES/RES_filter_basic.m @@ -12,7 +12,7 @@ % %You should have received a copy of the GNU General Public License %along with TEAP. If not, see . - +% %> @file RES_filter_basic.m %> @brief Cleans a signal adding a low-pass mean filter to it. The window equals the %> sample rate, aka 1 sec. diff --git a/src/signals/RES/acquisition/RES_aqn_variable.m b/src/signals/RES/acquisition/RES_aqn_variable.m index c7113ba..6f8ca56 100644 --- a/src/signals/RES/acquisition/RES_aqn_variable.m +++ b/src/signals/RES/acquisition/RES_aqn_variable.m @@ -12,13 +12,13 @@ % %You should have received a copy of the GNU General Public License %along with TEAP. If not, see . - +% %> @file RES_aqn_variable.m %> @brief RES_aqn_variable gets a RES signal from a variable - +% %> @param rawRES [1xN]: the raw RES signal %> @param sampRate [1x1]: the sampling rate, in Hz - +% %> @retval Signal: A RES TEAP signal %> @author Copyright Frank Villaro-Dixon, 2014 function Signal = RES_aqn_variable(rawRES, sampRate) diff --git a/src/signals/RES/features/RES_feat_energy.m b/src/signals/RES/features/RES_feat_energy.m index 2c83487..f9e738f 100644 --- a/src/signals/RES/features/RES_feat_energy.m +++ b/src/signals/RES/features/RES_feat_energy.m @@ -12,14 +12,14 @@ % %You should have received a copy of the GNU General Public License %along with TEAP. If not, see . - +% %> @file RES_feat_energy.m %> @brief Computes the energy of a respiration signal. - +% %> @param RESsignal: the RES signal. - +% %> @retval energy: the energy of the signal - +% %> @author Copyright Guillaume Chanel, Frank Villaro-Dixon, 2013-2014 %> @author Copyright Frank Villaro-Dixon, 2014 function [energy] = RES_feat_energy(RESsignal) diff --git a/src/signals/RES/features/RES_feat_extr.m b/src/signals/RES/features/RES_feat_extr.m index 71d54b0..1552a03 100644 --- a/src/signals/RES/features/RES_feat_extr.m +++ b/src/signals/RES/features/RES_feat_extr.m @@ -12,7 +12,7 @@ % %You should have received a copy of the GNU General Public License %along with TEAP. If not, see . - +% %> @file RES_feat_extr.m %> @brief Computes Skin respiration features %> @param RESsignal: the respiration signal. @@ -24,6 +24,8 @@ %> - skewness_: skewness of the respiration %> - main_freq: main frenquency of the respiration %> - spxxyy: power spectral power between [xx,yy] /10 Hz +%> available values are: 'sp0001', 'sp0102','sp0203', 'sp0304', +%> 'sp0407', 'sp0710','sp1025' %> @retval RES_feats: list of features values %> @retval RES_feats_names: names of the computed features (it is good pratice to %> check this vector since the order of requested features diff --git a/src/signals/RES/features/RES_feat_mainfreq.m b/src/signals/RES/features/RES_feat_mainfreq.m index f2ff85d..63f5868 100644 --- a/src/signals/RES/features/RES_feat_mainfreq.m +++ b/src/signals/RES/features/RES_feat_mainfreq.m @@ -12,14 +12,14 @@ % %You should have received a copy of the GNU General Public License %along with TEAP. If not, see . - +% %> @file RES_feat_mainfreq.m %> @brief Computes the main frequency of a respiration signal. - +% %> @param RESsignal: the RES signal. - +% %> @retval mainFreq: the main respiration frequency, given in Hz - +% %> @author Copyright Guillaume Chanel 2013 %> @author Copyright Frank Villaro-Dixon, 2014 diff --git a/src/signals/RES/features/RES_feat_minmax.m b/src/signals/RES/features/RES_feat_minmax.m index 9aae2e6..218e44e 100644 --- a/src/signals/RES/features/RES_feat_minmax.m +++ b/src/signals/RES/features/RES_feat_minmax.m @@ -12,7 +12,7 @@ % %You should have received a copy of the GNU General Public License %along with TEAP. If not, see . - +% %> @file RES_feat_minmax.m %> @brief Computes the peak-to-peak value of a respiration signal (aka greatest breath). %> @param RESsignal the RES signal. diff --git a/src/signals/Raw_convert_1D.m b/src/signals/Raw_convert_1D.m index 25e46b6..9f14155 100644 --- a/src/signals/Raw_convert_1D.m +++ b/src/signals/Raw_convert_1D.m @@ -12,7 +12,7 @@ % %You should have received a copy of the GNU General Public License %along with TEAP. If not, see . - +% %> @file Raw_convert_1D.m %> @brief Takes a raw signal and reshapes-it into a good form (aka 1D horizontal signal, %> [1xN]; diff --git a/src/signals/Signal__assert_mine.m b/src/signals/Signal__assert_mine.m index e57cca3..106d31c 100644 --- a/src/signals/Signal__assert_mine.m +++ b/src/signals/Signal__assert_mine.m @@ -12,12 +12,12 @@ % %You should have received a copy of the GNU General Public License %along with TEAP. If not, see . - +% %> @file Signal__assert_mine.m %> @brief Asserts that the signal is a TEAP one - +% %> @param Signal: the signal to test - +% %> @author Copyright Frank Villaro-Dixon, 2014 function Signal__assert_mine(Signal) diff --git a/src/signals/Signal__assert_range.m b/src/signals/Signal__assert_range.m index 14809bc..1320000 100644 --- a/src/signals/Signal__assert_range.m +++ b/src/signals/Signal__assert_range.m @@ -12,10 +12,10 @@ % %You should have received a copy of the GNU General Public License %along with TEAP. If not, see . - +% %> @file Signal__assert_range.m %> @brief Asserts that the signal is a TEAP one - +% %> @param Signal: the signal to test %> @param minVal: the minimum value (default to -Inf) %> @param maxVal: the maximum value (defaults to +Inf) diff --git a/src/signals/Signal__assert_type.m b/src/signals/Signal__assert_type.m index d808772..d94effa 100644 --- a/src/signals/Signal__assert_type.m +++ b/src/signals/Signal__assert_type.m @@ -12,20 +12,20 @@ % %You should have received a copy of the GNU General Public License %along with TEAP. If not, see . - +% %> @file Signal__assert_type.m %> @brief Checks that the signal given on the input is of the type nameWanted %> This function is mainly used by @b SSS_assert_type(Sig), with params @b Sig and @b SSS. - +% %> @attention NOTA BENE: in the case that Signal is a BULK signal, this function will %> return, if it exists, the wanted signal, or fail if it doesn't. - +% %> @param Signal: The signal you want to make sure of the type (can be a BULK signal, %> in that case, will take the component. %> Bulk: if the input is a bulk than the bulk is also returned to keep a %> backup of it. An empty vector is returned if the input is not a Bulk %> @param nameWanted: the type the signal must be of (ex: 'GSR'). - +% %> @retval Signal: the signal. Can be the same as the input if single signal, or the %> signal from the bulk if the input signal is a bulk one. diff --git a/src/signals/Signal__get_absolute.m b/src/signals/Signal__get_absolute.m index 7a355eb..82986fe 100644 --- a/src/signals/Signal__get_absolute.m +++ b/src/signals/Signal__get_absolute.m @@ -12,7 +12,7 @@ % %You should have received a copy of the GNU General Public License %along with TEAP. If not, see . - +% %> @file Signal__get_absolute.m %> @brief Is the signal data absolute or relative ? %> @param Signal diff --git a/src/signals/Signal__get_offset.m b/src/signals/Signal__get_offset.m index fa79f88..d7de601 100644 --- a/src/signals/Signal__get_offset.m +++ b/src/signals/Signal__get_offset.m @@ -12,7 +12,7 @@ % %You should have received a copy of the GNU General Public License %along with TEAP. If not, see . - +% %> @file Signal__get_offset.m %> @brief Gets the offset(in frames) relative to its parent (the first it had, non recursive). %> @param Signal: the signal you want to know the offset diff --git a/src/signals/Signal__get_raw.m b/src/signals/Signal__get_raw.m index f5dabdc..b25970d 100644 --- a/src/signals/Signal__get_raw.m +++ b/src/signals/Signal__get_raw.m @@ -12,7 +12,7 @@ % %You should have received a copy of the GNU General Public License %along with TEAP. If not, see . - +% %> @file Signal__get_raw.m %> @brief Returns the raw data of the signal %> @param Signal: the signal you want the raw data of diff --git a/src/signals/Signal__get_samprate.m b/src/signals/Signal__get_samprate.m index 34ffb8b..8d7f7ff 100644 --- a/src/signals/Signal__get_samprate.m +++ b/src/signals/Signal__get_samprate.m @@ -12,12 +12,12 @@ % %You should have received a copy of the GNU General Public License %along with TEAP. If not, see . - +% %> @file Signal__get_samprate.m %> @brief Returns the sampling rate of a signal - +% %> @param Signal: the signal you want to get the sampling rate - +% %> @retval samprate: the sampling rate of the signal, in hertz % %> @author Copyright Frank Villaro-Dixon, 2014 diff --git a/src/signals/Signal__get_signame.m b/src/signals/Signal__get_signame.m index afe407e..bdc8cc2 100644 --- a/src/signals/Signal__get_signame.m +++ b/src/signals/Signal__get_signame.m @@ -12,7 +12,7 @@ % %You should have received a copy of the GNU General Public License %along with TEAP. If not, see . - +% %> @file Signal__get_signame.m %> @brief Gets the name of a signal, eg: 'GSR' for a Galvanic Skin Response signal %> @param Signal: the signal you want to get the name of. diff --git a/src/signals/Signal__get_unit.m b/src/signals/Signal__get_unit.m index f0ddf57..c39a252 100644 --- a/src/signals/Signal__get_unit.m +++ b/src/signals/Signal__get_unit.m @@ -12,7 +12,7 @@ % %You should have received a copy of the GNU General Public License %along with TEAP. If not, see . - +% %> @file Signal__get_unit.m %> @brief Gets the unit of a signal (ex: 'Ohm' for a GSR signal) %> @param Signal: the signal diff --git a/src/signals/Signal__get_window.m b/src/signals/Signal__get_window.m index c1127da..b2c64a1 100644 --- a/src/signals/Signal__get_window.m +++ b/src/signals/Signal__get_window.m @@ -12,18 +12,18 @@ % %You should have received a copy of the GNU General Public License %along with TEAP. If not, see . - +% %> @file Signal__get_window.m %> @brief Takes a portion of a signal between startT and endT seconds. NB: that the %> child signal will memorize the offset to its father (the first-one, non recursive) %> start: useful if you want to plot the signal with logical times. %> If you want to specify frames (aka. samples) instead of seconds, you should %> use @c Signal__get_window_frames() - +% %> @param Signal: the signal you want to take a portion of. %> @param startT: the start time (s) %> @param endT: the end time (s) - +% %> @retval Signal: son signal % %> @attention SEE ALSO: diff --git a/src/signals/Signal__get_window_frames.m b/src/signals/Signal__get_window_frames.m index ef83989..4bd82f5 100644 --- a/src/signals/Signal__get_window_frames.m +++ b/src/signals/Signal__get_window_frames.m @@ -12,7 +12,7 @@ % %You should have received a copy of the GNU General Public License %along with TEAP. If not, see . - +% %> @file Signal__get_window_frames.m %> @brief Takes a portion of a signal between startT and endT frames. NB: that the %> child signal will memorize the offset to its father (the first-one, non recursive) @@ -26,10 +26,9 @@ %> @param Signal: the signal you want to take a portion of. %> @param startT: the start time (frames) %> @param endT: the end time (frames) - +% %> @retval Child: the cut signal % -% %> @author Copyright Frank Villaro-Dixon, 2014 function Child = Signal__get_window_frames(Signal, startT, endT) diff --git a/src/signals/Signal__has_preproc.m b/src/signals/Signal__has_preproc.m index 1cd989e..a73b51e 100644 --- a/src/signals/Signal__has_preproc.m +++ b/src/signals/Signal__has_preproc.m @@ -12,7 +12,7 @@ % %You should have received a copy of the GNU General Public License %along with TEAP. If not, see . - +% %> @file Signal__has_preproc.m %> @brief Has the given signal been through this preprocessing step %> @param Signal: the signal diff --git a/src/signals/Signal__new_empty.m b/src/signals/Signal__new_empty.m index 68544bb..680d53c 100644 --- a/src/signals/Signal__new_empty.m +++ b/src/signals/Signal__new_empty.m @@ -12,7 +12,7 @@ % %You should have received a copy of the GNU General Public License %along with TEAP. If not, see . - +% %> @file Signal__new_empty.m %> @brief Creates a new, empty, signal. This is mainly to represent the data structure %> @retval Signal: an empty signal diff --git a/src/signals/Signal__set_absolute.m b/src/signals/Signal__set_absolute.m index 1508a27..bb46842 100644 --- a/src/signals/Signal__set_absolute.m +++ b/src/signals/Signal__set_absolute.m @@ -12,16 +12,16 @@ % %You should have received a copy of the GNU General Public License %along with TEAP. If not, see . - +% %> @file Signal__set_absolute.m %> @brief Sets the data of the signal to absolute or relative %> %> Example: for a HST signal, do you have samples like [37, 37.5, 37.6] or more %> like [0, 0.5, 0.6] ? If true, the data is absolute (37), if false, it is relative (0). - +% %> @param Signal: the signal to set the flag %> @param isAbsolute: true/false - +% %> @retval Signal: the same signal with the flag set % %> @author Copyright Frank Villaro-Dixon, 2014 diff --git a/src/signals/Signal__set_offset.m b/src/signals/Signal__set_offset.m index f856ed1..83d1226 100644 --- a/src/signals/Signal__set_offset.m +++ b/src/signals/Signal__set_offset.m @@ -12,7 +12,7 @@ % %You should have received a copy of the GNU General Public License %along with TEAP. If not, see . - +% %> @file Signal__set_offset.m %> @brief Sets the offset of the specified signal %> @param Signal: the signal diff --git a/src/signals/Signal__set_preproc.m b/src/signals/Signal__set_preproc.m index 9cfc2a3..c08da19 100644 --- a/src/signals/Signal__set_preproc.m +++ b/src/signals/Signal__set_preproc.m @@ -12,10 +12,10 @@ % %You should have received a copy of the GNU General Public License %along with TEAP. If not, see . - +% %> @file Signal__set_preproc.m %> @brief Set a preprocessing attribute for a signal. Ex: lowPass, highPass - +% %> @param Signal: the signal %> @param preprocName: the name of the preprocessing calculus done diff --git a/src/signals/Signal__set_raw.m b/src/signals/Signal__set_raw.m index c444633..723ed43 100644 --- a/src/signals/Signal__set_raw.m +++ b/src/signals/Signal__set_raw.m @@ -12,7 +12,7 @@ % %You should have received a copy of the GNU General Public License %along with TEAP. If not, see . - +% %> @file Signal__set_raw.m %> @brief Sets the raw data of the signal S function Signal = Signal__set_raw(Signal, raw) diff --git a/src/signals/Signal__set_samprate.m b/src/signals/Signal__set_samprate.m index c2e990e..c2b871c 100644 --- a/src/signals/Signal__set_samprate.m +++ b/src/signals/Signal__set_samprate.m @@ -12,7 +12,7 @@ % %You should have received a copy of the GNU General Public License %along with TEAP. If not, see . - +% %> @file Signal__set_samprate.m %> @brief Sets the sampling rate of a signal %> @param Signal: the signal diff --git a/src/signals/Signal__set_signame.m b/src/signals/Signal__set_signame.m index 68607fa..7140988 100644 --- a/src/signals/Signal__set_signame.m +++ b/src/signals/Signal__set_signame.m @@ -12,16 +12,16 @@ % %You should have received a copy of the GNU General Public License %along with TEAP. If not, see . - +% %> @file Signal__set_signame.m %> @brief Sets the name of a signal (ex: 'GSR', 'ECG', etc…) you should NOT use this function, %> only TEAP uses-it - +% %> @param Signal: the signal you want to set the name %> @param nameStr: the name string - +% %> @retval Signal: the modified signal - +% %> @author Copyright Frank Villaro-Dixon, 2014 function Signal = Signal__set_signame(Signal, nameStr) diff --git a/src/signals/Signal__set_unit.m b/src/signals/Signal__set_unit.m index 5b1b431..89348b0 100644 --- a/src/signals/Signal__set_unit.m +++ b/src/signals/Signal__set_unit.m @@ -12,15 +12,15 @@ % %You should have received a copy of the GNU General Public License %along with TEAP. If not, see . - +% %> @file Signal__set_unit.m %> @brief Sets the unit of a signal - +% %> @param Signal the signal you want to add the unit to %> @param unitStr the unit name (ex: 'Ohm'); - +% %> @retval Signal the newly modified signal - +% %> @author Copyright Frank Villaro-Dixon, 2014 function Signal = Signal__set_unit(Signal, unitStr) diff --git a/src/signals/Signal_feat_bandEnergy.m b/src/signals/Signal_feat_bandEnergy.m index e0bddbc..25eb60e 100644 --- a/src/signals/Signal_feat_bandEnergy.m +++ b/src/signals/Signal_feat_bandEnergy.m @@ -12,11 +12,11 @@ % %You should have received a copy of the GNU General Public License %along with TEAP. If not, see . - +% %> @file Signal_feat_bandEnergy.m %> @brief Computes the standard deviation of a given signal %> @author Copyright Mohammad Soleymani, 2015 - +% %> @param Signal %> @param bands a 2 x n dimenional array including the bands lower and upper %> bounds diff --git a/src/signals/Signal_feat_energy.m b/src/signals/Signal_feat_energy.m index 7ac6716..17cc2ca 100644 --- a/src/signals/Signal_feat_energy.m +++ b/src/signals/Signal_feat_energy.m @@ -12,7 +12,7 @@ % %You should have received a copy of the GNU General Public License %along with TEAP. If not, see . - +% %> @file Signal_feat_energy.m %> @brief Computes the energy of a signal %> @param Signal: diff --git a/src/signals/Signal_feat_mean.m b/src/signals/Signal_feat_mean.m index 78edfc3..a66268f 100644 --- a/src/signals/Signal_feat_mean.m +++ b/src/signals/Signal_feat_mean.m @@ -12,7 +12,7 @@ % %You should have received a copy of the GNU General Public License %along with TEAP. If not, see . - +% %> @file Signal_feat_mean.m %> @brief Computes the mean of a signal %> @param Signal: The signal you want to calculate the mean diff --git a/src/signals/Signal_feat_stat_moments.m b/src/signals/Signal_feat_stat_moments.m index 1f53760..55c0cc5 100644 --- a/src/signals/Signal_feat_stat_moments.m +++ b/src/signals/Signal_feat_stat_moments.m @@ -12,17 +12,17 @@ % %You should have received a copy of the GNU General Public License %along with TEAP. If not, see . - +% %> @file Signal_feat_stat_moments.m %> @brief Computes the statistical moments for the input signals - +% %> @param Signal The signal to compute - +% %> @retval mean_: the calculated std, using the @c mean() function %> @retval std_: the calculated std, using the @c std() function %> @retval kurtosis_: the calculated Kurtosis, using the @c kurtosis() function %> @retval skewness_: the calculated skewness, using the @c skewness() function - +% %> @author Copyright Moahmmad Soleymani and Frank Villaro-Dixon, 2015 function [mean_,std_, kurtosis_, skewness_]= Signal_feat_stat_moments(Signal) diff --git a/src/signals/Signal_feat_std.m b/src/signals/Signal_feat_std.m index 5563fa8..ea383a4 100644 --- a/src/signals/Signal_feat_std.m +++ b/src/signals/Signal_feat_std.m @@ -12,7 +12,7 @@ % %You should have received a copy of the GNU General Public License %along with TEAP. If not, see . - +% %> @file Signal_feat_std.m %> @brief Computes the standard deviation of a given signal %> @param Signal diff --git a/src/signals/Signal_feat_var.m b/src/signals/Signal_feat_var.m index 40781f7..055b974 100644 --- a/src/signals/Signal_feat_var.m +++ b/src/signals/Signal_feat_var.m @@ -12,7 +12,7 @@ % %You should have received a copy of the GNU General Public License %along with TEAP. If not, see . - +% %> @file Signal_feat_var.m %> @brief Computes the variance of a signal %> @param Signal diff --git a/src/signals/filters/Signal__has_preproc_lowpass.m b/src/signals/filters/Signal__has_preproc_lowpass.m index aa0863a..808950c 100644 --- a/src/signals/filters/Signal__has_preproc_lowpass.m +++ b/src/signals/filters/Signal__has_preproc_lowpass.m @@ -1,3 +1,18 @@ +%This file is part of TEAP. +% +%TEAP is free software: you can redistribute it and/or modify +%it under the terms of the GNU General Public License as published by +%the Free Software Foundation, either version 3 of the License, or +%(at your option) any later version. +% +%TEAP is distributed in the hope that it will be useful, +%but WITHOUT ANY WARRANTY; without even the implied warranty of +%MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +%GNU General Public License for more details. +% +%You should have received a copy of the GNU General Public License +%along with TEAP. If not, see . +% %> @file Signal__has_preproc_lowpass.m %> @brief Has the signal been low-passed ? %> @param Signal diff --git a/src/signals/filters/Signal__set_preproc_lowpass.m b/src/signals/filters/Signal__set_preproc_lowpass.m index a6a51f2..08bbd26 100644 --- a/src/signals/filters/Signal__set_preproc_lowpass.m +++ b/src/signals/filters/Signal__set_preproc_lowpass.m @@ -12,7 +12,7 @@ % %You should have received a copy of the GNU General Public License %along with TEAP. If not, see . - +% %> @file Signal__set_preproc_lowpass.m %> @brief Sets the pre-processing property of low-pass for the signal %> @param Signal diff --git a/src/signals/filters/Signal_filter1_low_mean.m b/src/signals/filters/Signal_filter1_low_mean.m index f55f3f2..3444486 100644 --- a/src/signals/filters/Signal_filter1_low_mean.m +++ b/src/signals/filters/Signal_filter1_low_mean.m @@ -12,13 +12,13 @@ % %You should have received a copy of the GNU General Public License %along with TEAP. If not, see . - +% %> @file Signal_filter1_low_mean.m %> @brief Filters the signal with a low pass mean filtering - +% %> @param Signal: the signal to filter. Not a bulk signal ! %> @param windowSize: the window size (in samples) - +% %> @retval Signal: the newly filtered signal % %> @author Copyright Frank Villaro-Dixon, 2014 diff --git a/src/signals/filters/Signal_filter1_low_median.m b/src/signals/filters/Signal_filter1_low_median.m index dd682ec..65716df 100644 --- a/src/signals/filters/Signal_filter1_low_median.m +++ b/src/signals/filters/Signal_filter1_low_median.m @@ -12,14 +12,14 @@ % %You should have received a copy of the GNU General Public License %along with TEAP. If not, see . - +% %> @file Signal_filter1_low_median.m %> @brief Filters the signal with a low pass median filtering method %> @param Signal: the signal to filter. Not a bulk signal ! %> @param windowSize: the window size (in samples) - +% %> @retval Signal: the newly filtered signal - +% %> @author Copyright Frank Villaro-Dixon, 2014 function Signal = Signal_filter1_low_median(Signal, windowSize) diff --git a/src/signals/filters/Signal_filter1_low_pass.m b/src/signals/filters/Signal_filter1_low_pass.m index 4f2c53a..5af46a4 100644 --- a/src/signals/filters/Signal_filter1_low_pass.m +++ b/src/signals/filters/Signal_filter1_low_pass.m @@ -12,15 +12,15 @@ % %You should have received a copy of the GNU General Public License %along with TEAP. If not, see . - +% %> @file Signal_filter1_low_pass.m %> @brief A simple low-pass filter applyed to 1D signals (such as GSR, ECG, etc…). - +% %> @param Signal: the signal to filter (will use the .raw component). Not a bulk sig. ! %> @param cutOffFreq: the cutOff frequency of the filter - +% %> @retval Signal: the low-passed-signal - +% %> @author Copyright Frank Villaro-Dixon, 2014 function Signal = Signal_filter1_low_pass(Signal, cutOffFreq) diff --git a/src/signals/utils/PICtoBPM.m b/src/signals/utils/PICtoBPM.m index 7ff0152..7088752 100644 --- a/src/signals/utils/PICtoBPM.m +++ b/src/signals/utils/PICtoBPM.m @@ -1,3 +1,18 @@ +%This file is part of TEAP. +% +%TEAP is free software: you can redistribute it and/or modify +%it under the terms of the GNU General Public License as published by +%the Free Software Foundation, either version 3 of the License, or +%(at your option) any later version. +% +%TEAP is distributed in the hope that it will be useful, +%but WITHOUT ANY WARRANTY; without even the implied warranty of +%MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +%GNU General Public License for more details. +% +%You should have received a copy of the GNU General Public License +%along with TEAP. If not, see . +% %> @file PICtoBPM.m %> @brief Computes BPM and IBI from a list of pics %> @b Author: Guillaume Chanel @@ -8,8 +23,9 @@ %> @retval bpm beat per minuts %> @retval delta_t Interbeat intervals (IBI) %> @retval sample (possibly 1/2 samples) at which the IBI is computed, this is -%>in fact the average of the start and end beats samples (i.e. the HR -%> considered to lies inbetween the two beats). +%> in fact the average of the start and end beats samples (i.e. the HR +%> considered to lies inbetween the two beats). +%> @author Guillaume Chanel function [bpm delta_t t] = PICtoBPM(listePic, fe) bpm =[]; diff --git a/src/signals/utils/PLETtoBPM.m b/src/signals/utils/PLETtoBPM.m index 2a39c7a..9ed0be1 100644 --- a/src/signals/utils/PLETtoBPM.m +++ b/src/signals/utils/PLETtoBPM.m @@ -12,12 +12,12 @@ % %You should have received a copy of the GNU General Public License %along with TEAP. If not, see . - +% %> @file PLETtoBPM.m -%> @brief calcul le heart rate bpm a partir du fichier des données data +%> @brief calcul le heart rate bpm a partir du fichier des donn�es data %> le signal a une frequence d'echantillonage fe. Search for the upper peak, %> if systolic upstroke is desired, simply negate the signal - +% %> @param data the pletysmograph data %> @param fe sampling frequency %> @param methodPeak detection method for choice in case of many peak (default 'max') @@ -26,16 +26,16 @@ %> 'first': the first peak of the two %> @param SizeWindow for mean filtering, 0-> no fitlering (default fe/50) %> @param verbose display a graph of the result if 1 (default 0) - +% %> @retval bpm Heart rate in bpm %> @retval delta Heart rate in time %> @retval t vecteur contenant les samples central des deux pics ayant servi a %> calculer le bpm -%> @retval listePic liste des echantillon ou il y a eu des pics detecté -%> Ver 2 : n'utilise pas les wavlet mais seulement la dérivée du signal +%> @retval listePic liste des echantillon ou il y a eu des pics detect� +%> Ver 2 : n'utilise pas les wavlet mais seulement la d�riv�e du signal %> Ver 3 : plus de gros filtrage et choix des pics suivant differetes methodes - -%> Copyright Guillaume Chanel 2015 +% +%> @author Guillaume Chanel 2015 function [bpm, delta_t, t, listePic] = PLETtoBPM(data, fe, methodPeak, SizeWindow, verbose) diff --git a/src/signals/utils/correctBPM.m b/src/signals/utils/correctBPM.m index 72aedfe..56f352a 100644 --- a/src/signals/utils/correctBPM.m +++ b/src/signals/utils/correctBPM.m @@ -1,16 +1,31 @@ +%This file is part of TEAP. +% +%TEAP is free software: you can redistribute it and/or modify +%it under the terms of the GNU General Public License as published by +%the Free Software Foundation, either version 3 of the License, or +%(at your option) any later version. +% +%TEAP is distributed in the hope that it will be useful, +%but WITHOUT ANY WARRANTY; without even the implied warranty of +%MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +%GNU General Public License for more details. +% +%You should have received a copy of the GNU General Public License +%along with TEAP. If not, see . +% %> @file correctBPM.m %> @b DEPENDANCIES : %> PICtoBPM : compute BPM from of vector of peaks %> Guillaume Chanel (thanks to Joep) %> 4/09/2008 - +% %> @param listePic_in [1*N] : vector of peaks with position of peak in sample for each %> peak ([1 8 20] 3 peaks at samples 1, 8 and 20) %> @param fe ampling frequency %> @param thresh limit between two peaks for detection of miss or bad peak. %> decreasing this limit will not always augment the number of %> corrections (see First step, Decide which problems are true ones in the code) - +% %> @retval bpm new computed bpm from the corrected list of peaks %> @retval listPic corrected list of peaks diff --git a/src/signals/utils/featuresSelector.m b/src/signals/utils/featuresSelector.m index cce7fb6..371e9c3 100644 --- a/src/signals/utils/featuresSelector.m +++ b/src/signals/utils/featuresSelector.m @@ -1,3 +1,18 @@ +%This file is part of TEAP. +% +%TEAP is free software: you can redistribute it and/or modify +%it under the terms of the GNU General Public License as published by +%the Free Software Foundation, either version 3 of the License, or +%(at your option) any later version. +% +%TEAP is distributed in the hope that it will be useful, +%but WITHOUT ANY WARRANTY; without even the implied warranty of +%MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +%GNU General Public License for more details. +% +%You should have received a copy of the GNU General Public License +%along with TEAP. If not, see . +% %> @file featuresSelector.m %> @brief This function select a subset of features from 'featuresNames' based on %> 'include' / 'exclude' satements. @@ -16,15 +31,15 @@ %> returns {'A','C'} %> featuresSelector({'A','B',C'},'Exclude',{'A'}) %> returns {'B','C'} -%> @b Author: Guillaume Chanel - +%> @author Guillaume Chanel +% %> @param featuresNames cell array containing the complete list of features %> names %> @param varargin pair of arguments in the matlab style. The second argument %> represent a subset of features as a cell array. The first %> argument tells if the subset should be removed from the full %> set of features ('exclude') or included in an empty set ('include') - +% %> @retval selFeatures a cell array of selected features function [selfeatures] = featuresSelector(featuresNames,varargin) diff --git a/src/signals/utils/iirpeak.m b/src/signals/utils/iirpeak.m index 329617e..63d59d4 100644 --- a/src/signals/utils/iirpeak.m +++ b/src/signals/utils/iirpeak.m @@ -20,11 +20,11 @@ % fvtool(b, a); % % See also IIRNOTCH, IIRCOMB, FIRGR. - +% % Author(s): P. Pacheco % Copyright 1999-2006 The MathWorks, Inc. % $Revision: 1.1.4.4 $ $Date: 2007/12/14 14:34:01 $ - +% % References: % [1] Sophocles J. Orfanidis, Introduction To Signal Processing % Prentice-Hall 1996. diff --git a/src/signals/utils/interpIBI.m b/src/signals/utils/interpIBI.m index 5736221..44d22b7 100644 --- a/src/signals/utils/interpIBI.m +++ b/src/signals/utils/interpIBI.m @@ -1,4 +1,37 @@ -%> @file interpIBI.m +%This file is part of TEAP. +% +%TEAP is free software: you can redistribute it and/or modify +%it under the terms of the GNU General Public License as published by +%the Free Software Foundation, either version 3 of the License, or +%(at your option) any later version. +% +%TEAP is distributed in the hope that it will be useful, +%but WITHOUT ANY WARRANTY; without even the implied warranty of +%MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +%GNU General Public License for more details. +% +%You should have received a copy of the GNU General Public License +%along with TEAP. If not, see . +% +%> @file interpIBI.m +%> @brief This function interpolate an HR/IBI signal (from a list of peaks) with the +%> method proposed in: +%> Berger et al., "An Efficient Algorithm for Spectral Analysis of +%> Heart Rate Variability", IEEE Trans. on Biomedical Engineering, +%> Vol. 33, No. 9, sept. 1986 +%> @param peaks: a list of R peaks expressed in seconds (e.g. [0.3 1.4 2.3 3.2]) +%> @param fs: sampling frequency desired for the interpolated HR/IBI signal +%> @param duration: duration desired. Concerning time aspects, the first sample +%> is assumed to lie at time 1/fs (which can be before the first peak) and +%> the last at time 'duration'. If point in time that are not computable +%> because of lack of peaks (beginning and end of the output signals), they are +%> simply padded with the closest computed value. +% +%> @retval IBI [1*N]: N interbeat intervals (in seconds) +%> @retval HR [1*N]: N heart rate values +%> @retval t [1*N]: N time stamps corresponding to the IBI and HR values +% +% @author: Guillaume Chanel function [IBI,HR,t] = interpIBI(peaks,fs,duration, silent) % function [IBI,HR,t] = interpIBI(peaks,fs,duration) % @@ -26,7 +59,7 @@ % % HR [1*N]: N heart rate values % -% t [1*N]; N time stamps corresponding to the IBI and HR values +% t [1*N]: N time stamps corresponding to the IBI and HR values % % Author: Guillaume Chanel % Date: 7/12/2009 diff --git a/src/signals/visualisation/Signal_plot.m b/src/signals/visualisation/Signal_plot.m index f235b00..03b6d91 100644 --- a/src/signals/visualisation/Signal_plot.m +++ b/src/signals/visualisation/Signal_plot.m @@ -12,12 +12,12 @@ % %You should have received a copy of the GNU General Public License %along with TEAP. If not, see . - +% %> @file Signal_plot.m %> @brief Plots a signal: value vs time, between startT and entT. %> @c Signal_plot(sig); @c Signal_plot(sig, start); @c Signal_plot(sig, start, end); %> @attention NOTA BENE: if you want to display a bulk signal instead, use Bulk_plot(Bulk); - +% %> @param Signal: the sigal to plot %> @param startT: the start time, in frames (optional) %> @param endT: the end time, or 0 if all the signal (optional) diff --git a/src/signals/visualisation/Signal_plot1D.m b/src/signals/visualisation/Signal_plot1D.m index 15770b6..7a652aa 100644 --- a/src/signals/visualisation/Signal_plot1D.m +++ b/src/signals/visualisation/Signal_plot1D.m @@ -12,12 +12,12 @@ % %You should have received a copy of the GNU General Public License %along with TEAP. If not, see . - +% %> @file Signal_plot1D.m %> @brief Plots a signal: value vs time, between startT and entT. %> @c Signal_plot1D(sig); @c Signal_plot1D(sig, start); @c Signal_plot1D(sig, start, end); %> @attention NOTA BENE: if you want to display a bulk signal instead, use Bulk_plot(Bulk); - +% %> @param Signal: the sigal to plot %> @param startT: the start time, in frames (optional) %> @param endT: the end time, or 0 if all the signal (optional) diff --git a/src/signals/visualisation/Signal_plot_pts.m b/src/signals/visualisation/Signal_plot_pts.m index b40e0ee..d34d3ff 100644 --- a/src/signals/visualisation/Signal_plot_pts.m +++ b/src/signals/visualisation/Signal_plot_pts.m @@ -12,7 +12,7 @@ % %You should have received a copy of the GNU General Public License %along with TEAP. If not, see . - +% %> @file Signal_plot_pts.m %> @brief Plots some (xval, yval) points on the graph. You have to use this function if %> your xvals are in the frame domain (aka not secs like the graph produced by