Home > m > sigproc > time_domain > ltpda_spikecleaning.m

ltpda_spikecleaning

PURPOSE ^

LTPDA_spikecleaning detects and corrects possible spikes in analysis objects

SYNOPSIS ^

function varargout=ltpda_spikecleaning(varargin)

DESCRIPTION ^

 LTPDA_spikecleaning detects and corrects possible spikes in analysis objects

%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

 DESCRIPTION: LTPDA_ SPIKECLEANING detects spikes in the temperature data and
               replaces them by artificial values depending on the method chosen ('random',
               'mean', 'previous').
               Spikes are defined as singular samples with an (absolute) value
               higher than kspike times the standard deviation of the high-pass
               filtered (IIR filter) input AO.

 CALL:        b = ltpda_spikecleaning(a1, a2, ..., an, pl)

 INPUTS:      aN - a list of analysis objects
               pl - parameter list

 OUTPUTS:     b - a list of analysis objects with "spike values" removed
              and corrected

 PARAMETERES: 'kspike' - set the kspike value. High values imply
                         not correction of relative low amplitude spike
                         [default: 3.3]
               'method' - method used to replace the spike value: 'random,
                         'mean', 'previous' [default:random]
               'fc' - frequency cut-off of the IIR filter [default: 0.025]
               'order' - order of the IIR filter [default: 2]
               'ripple' - specify pass/stop-band ripple for bandpass
                         and bandreject filters
                         <<default: 0.5>>

 VERSION:     $Id: ltpda_spikecleaning.m,v 1.5 2008/08/10 20:24:50 hewitson Exp $

 HISTORY:     24-12-2007 J Sanjuan
                 Creation

%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

CROSS-REFERENCE INFORMATION ^

This function calls: This function is called by:

SOURCE CODE ^

0001   % LTPDA_spikecleaning detects and corrects possible spikes in analysis objects
0002   %
0003   %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
0004   %
0005   % DESCRIPTION: LTPDA_ SPIKECLEANING detects spikes in the temperature data and
0006   %               replaces them by artificial values depending on the method chosen ('random',
0007   %               'mean', 'previous').
0008   %               Spikes are defined as singular samples with an (absolute) value
0009   %               higher than kspike times the standard deviation of the high-pass
0010   %               filtered (IIR filter) input AO.
0011   %
0012   % CALL:        b = ltpda_spikecleaning(a1, a2, ..., an, pl)
0013   %
0014   % INPUTS:      aN - a list of analysis objects
0015   %               pl - parameter list
0016   %
0017   % OUTPUTS:     b - a list of analysis objects with "spike values" removed
0018   %              and corrected
0019   %
0020   % PARAMETERES: 'kspike' - set the kspike value. High values imply
0021   %                         not correction of relative low amplitude spike
0022   %                         [default: 3.3]
0023   %               'method' - method used to replace the spike value: 'random,
0024   %                         'mean', 'previous' [default:random]
0025   %               'fc' - frequency cut-off of the IIR filter [default: 0.025]
0026   %               'order' - order of the IIR filter [default: 2]
0027   %               'ripple' - specify pass/stop-band ripple for bandpass
0028   %                         and bandreject filters
0029   %                         <<default: 0.5>>
0030   %
0031   % VERSION:     $Id: ltpda_spikecleaning.m,v 1.5 2008/08/10 20:24:50 hewitson Exp $
0032   %
0033   % HISTORY:     24-12-2007 J Sanjuan
0034   %                 Creation
0035   %
0036   %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
0037 
0038 function varargout=ltpda_spikecleaning(varargin)
0039   warning('!!! This function is deprecated and will be removed from future versions of LTPDA. Use ao/spikecleaning now.');
0040 
0041   % Call ao/spikecleaning
0042   bs =  spikecleaning(varargin{:});
0043 
0044   % set output
0045   varargout{1} = bs;
0046 
0047 end
0048

Generated on Mon 08-Sep-2008 13:18:47 by m2html © 2003