RES_feat_energy.m

Go to the documentation of this file.

%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 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)
 
%Make sure we have a RES signal
RESsignal = RES__assert_type(RESsignal);
 
%Compute the features
if(~Signal__has_preproc_lowpass(RESsignal))
    warning(['For the function to work well, you should low-pass the signal' ...
             '. Preferably with a median filter']);
end
 
raw = Signal__get_raw(RESsignal);
 
energy = var(raw);