TEAP (Toolbox for Emotion Analysis using Physiological Signals) doc
Signal__get_signame.m
Go to the documentation of this file.
1 %This file is part of TEAP.
2 %
3 %TEAP is free software: you can redistribute it and/or modify
4 %it under the terms of the GNU General Public License as published by
5 %the Free Software Foundation, either version 3 of the License, or
6 %(at your option) any later version.
7 %
8 %TEAP is distributed in the hope that it will be useful,
9 %but WITHOUT ANY WARRANTY; without even the implied warranty of
10 %MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11 %GNU General Public License for more details.
12 %
13 %You should have received a copy of the GNU General Public License
14 %along with TEAP. If not, see <http://www.gnu.org/licenses/>.
15 %
16 %> @file Signal__get_signame.m
17 %> @brief Gets the name of a signal, eg: 'GSR' for a Galvanic Skin Response signal
18 %> @param Signal: the signal you want to get the name of.
19 %> @retval signalName: the name of the signal (ex: 'GSR')
20 %
21 %> @author Copyright Frank Villaro-Dixon, 2014
22 function signalName = Signal__get_signame(Signal)
23 
24 
25 if(nargin ~= 1)
26  error('Usage: signalName = Signal__get_signame(Signal)');
27 end
28 
29 Signal__assert_mine(Signal);
30 
31 
32 if(~isfield(Signal, 'name'))
33  error('Signal given is not a TEAP signal')
34 end
35 
36 signalName = Signal.name;
37 
38 %!assert(strcmp(Signal__get_signame(Signal__new_empty()), 'invalid'))
39 
Signal__new_empty
function Signal__new_empty()
Signal__assert_mine
function Signal__assert_mine(in Signal)
Signal__get_signame
function Signal__get_signame(in Signal)