Documentation was upgraded to work under matlab

- now works with matlab (by addin % chars on empty line between header
  comments
- Licence notive was added in several files
- Some parameters were corrected in the documentation

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 <http://www.gnu.org/licenses/>.
-
+%
 %> @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)
 

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 <http://www.gnu.org/licenses/>.
-
+% 
 %> @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
 

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 <http://www.gnu.org/licenses/>.
-
+% 
 %> @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
 

src/bulksigs/Bulk_get_signals.m

@@ -14,9 +14,9 @@
 %along with TEAP.  If not, see <http://www.gnu.org/licenses/>.
 %> @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
 

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 <http://www.gnu.org/licenses/>.
+%
 %> @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
 

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 <http://www.gnu.org/licenses/>.
-
+% 
 %> @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

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 <http://www.gnu.org/licenses/>.
-
+% 
 %> @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)

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 <http://www.gnu.org/licenses/>.
-
+% 
 %> @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)

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 <http://www.gnu.org/licenses/>.
-
+% 
 %> @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
 

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 <http://www.gnu.org/licenses/>.
-
+% 
 %> @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 ;)

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 <http://www.gnu.org/licenses/>.
+% 
 %> @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'

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 <http://www.gnu.org/licenses/>.
-
+% 
 %> @file BVP__new_empty.m
 %> @brief Creates a new BVP empty signal
 %> @retval Signal an empty @b BVP signal

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 <http://www.gnu.org/licenses/>.
-
+% 
 %> @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.

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 <http://www.gnu.org/licenses/>.
-
+% 
 %> @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)
 

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 <http://www.gnu.org/licenses/>.
-
+% 
 %> @file BVP__compute_IBI.m
 %> @brief Computes the IBI if it is not yet available
 %> @param  BVPSignal: the BVP signal

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 <http://www.gnu.org/licenses/>.
-
+% 
 %> @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

src/signals/BVP/features/BVP_feat_extr.m

@@ -12,41 +12,40 @@
 %
 %You should have received a copy of the GNU General Public License
 %along with TEAP.  If not, see <http://www.gnu.org/licenses/>.
-
+% 
 %> @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
 %>           - sp0203: spectral power in 0.2-3.1Hz band
 %>           - 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
 %>                   can be different than the requested one)
 %> @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);

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 <http://www.gnu.org/licenses/>.
-
+% 
 %> @file BVP_feat_mean.m
 %> @brief Computes the mean of a @b BVP signal
 %> @param  BVPs: the BVP signal

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 <http://www.gnu.org/licenses/>.
-
+% 
 %> @file BVP_feat_std.m
 %> @brief Computes the std of a BVP signal
 %> @param  BVPs: the BVP signal

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 <http://www.gnu.org/licenses/>.
-
+% 
 %> @file BVP_feat_var.m
 %> @brief Computes the variance of a @b BVP signal
 %> @param  BVPSignal: the @b BVP signal

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 <http://www.gnu.org/licenses/>.
-
+% 
 %> @file DMY_assert_type.m
 function Signal = DMY_assert_type(Signal)
 %Asserts that the given signal is a DMY one

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 <http://www.gnu.org/licenses/>.
-
+% 
 %> @file DMY_new_empty.m
 function Signal = DMY_new_empty()
 % Creates a new DMY empty signal

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 <http://www.gnu.org/licenses/>.
-
+% 
 %> @file DMY_aqn_file.m
 function Signal = DMY_aqn_file(filename)
 % DMY_AQN_FILE gets a DMY signal from a filename

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 <http://www.gnu.org/licenses/>.
-
+% 
 %> @file DMY_example_1.m
 Sig = DMY_aqn_file();
 

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 <http://www.gnu.org/licenses/>.
-
+% 
 %> @file DMY_feat_feat1.m
 %> @brief Computes feature feat1 from a DMY signal Signal. The result is stored in the
 %> signal cache, then returned.

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 <http://www.gnu.org/licenses/>.
-
+% 
 %> @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