Home > classes > @tsdata > collapseX.m

collapseX

PURPOSE ^

COLLAPSEX Checks whether the x vector is evenly sampled and then removes it

SYNOPSIS ^

function varargout = collapseX(varargin)

DESCRIPTION ^

 COLLAPSEX Checks whether the x vector is evenly sampled and then removes it
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

 DESCRIPTION: Checks whether the x vector is evenly sampled and then removes
              it after setting the t0 field.

 CALL:        obj = collapseX(obj)

 INPUT:       obj - tsdata object

 OUTPUT:      obj - tsdata object

 VERSION:     $Id: collapseX.m,v 1.2 2008/09/04 15:29:32 ingo Exp $

 HISTORY:     12-06-2008 M Hewitson
                 Creation

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

CROSS-REFERENCE INFORMATION ^

This function calls: This function is called by:

SUBFUNCTIONS ^

SOURCE CODE ^

0001 % COLLAPSEX Checks whether the x vector is evenly sampled and then removes it
0002 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
0003 %
0004 % DESCRIPTION: Checks whether the x vector is evenly sampled and then removes
0005 %              it after setting the t0 field.
0006 %
0007 % CALL:        obj = collapseX(obj)
0008 %
0009 % INPUT:       obj - tsdata object
0010 %
0011 % OUTPUT:      obj - tsdata object
0012 %
0013 % VERSION:     $Id: collapseX.m,v 1.2 2008/09/04 15:29:32 ingo Exp $
0014 %
0015 % HISTORY:     12-06-2008 M Hewitson
0016 %                 Creation
0017 %
0018 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
0019 
0020 function varargout = collapseX(varargin)
0021 
0022   %%% Check if this is a call for parameters
0023   if utils.helper.isinfocall(varargin{:})
0024     varargout{1} = getInfo(varargin{3});
0025     return
0026   end
0027 
0028   obj = varargin{1};
0029 
0030   %%% decide whether we modify the pz-object, or create a new one.
0031   obj = copy(obj, nargout);
0032 
0033   [fs,t0,fitted] = tsdata.fitfs(obj.x);
0034   if ~fitted
0035     % adjust T0
0036     obj.t0 = obj.t0 + obj.x(1);
0037     % adjust Nsecs
0038     obj.nsecs = length(obj.y)/obj.fs;
0039     % remove X samples
0040     obj.x  = [];
0041   end
0042 
0043   varargout{1} = obj;
0044 end
0045 
0046 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
0047 %                               Local Functions                               %
0048 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
0049 
0050 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
0051 %
0052 % FUNCTION:    getInfo
0053 %
0054 % DESCRIPTION: Get Info Object
0055 %
0056 % HISTORY:     11-07-07 M Hewitson
0057 %                Creation.
0058 %
0059 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
0060 
0061 function ii = getInfo(varargin)
0062   if nargin == 1 && strcmpi(varargin{1}, 'None')
0063     sets = {};
0064     pl   = [];
0065   else
0066     sets = {'Default'};
0067     pl   = getDefaultPlist;
0068   end
0069   % Build info object
0070   ii = minfo(mfilename, 'tsdata', '', utils.const.categories.internal, '$Id: collapseX.m,v 1.2 2008/09/04 15:29:32 ingo Exp $', sets, pl);
0071 end
0072 
0073 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
0074 %
0075 % FUNCTION:    getDefaultPlist
0076 %
0077 % DESCRIPTION: Get Default Plist
0078 %
0079 % HISTORY:     11-07-07 M Hewitson
0080 %                Creation.
0081 %
0082 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
0083 
0084 function plo = getDefaultPlist()
0085   plo = plist();
0086 end
0087

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