--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/testing/utp_1.1/utps/ao/utp_ao_detrend.m	Tue Dec 06 18:42:11 2011 +0100
@@ -0,0 +1,655 @@
+% UTP_AO_DETREND a set of UTPs for the ao/detrend method
+%
+% M Hewitson 06-08-08
+%
+% $Id: utp_ao_detrend.m,v 1.13 2010/09/20 21:14:06 mauro Exp $
+%
+
+% <MethodDescription>
+%
+% The detrend method of the ao class detrends time-series AOs.
+%
+% </MethodDescription>
+
+function results = utp_ao_detrend(varargin)
+
+  % Check the inputs
+  if nargin == 0
+
+    % Some keywords
+    class   = 'ao';
+    mthd    = 'detrend';
+
+    results = [];
+    disp('******************************************************');
+    disp(['****  Running UTPs for ' class '/' mthd]);
+    disp('******************************************************');
+
+    % Test AOs
+    [at1,at2,at3,at4,at5,at6,atvec,atmat] = eval(['get_test_objects_' class]);
+
+    % Exception list for the UTPs:
+    [ple1,ple2,ple3,ple4,ple5,ple6] = get_test_ples();
+
+    % Run the tests
+    atvec = [at1 at5 at6];
+    atmat = [at1 at5 at6; at5 at6 at1];
+    pli = plist('order', 10, 'neval', true);
+    
+    results = [results utp_01];    % getInfo call
+    results = [results utp_02(mthd, atvec, @algo_test_y, pli, ple3)];    % Vector input
+    results = [results utp_03(mthd, atmat, @algo_test_y, pli, ple3)];    % Matrix input
+    results = [results utp_04(mthd, at1, at5, at6, @algo_test_y, pli, ple3)];    % List input
+    results = [results utp_05(mthd, at1, atvec, atmat, @algo_test_y, pli, ple3)];    % Test with mixed input
+    results = [results utp_06(mthd, at1, pli, ple2)];    % Test history is working
+    results = [results utp_07(mthd, at1, pli, ple2)];    % Test the modify call works
+    results = [results utp_09(mthd, at5, at6)];    % Test input data shape == output data shape
+    results = [results utp_10(mthd, at1, at5, ple2)];    % Test output of the data
+    results = [results utp_11(mthd, at1, ple1)];    % Test plotinfo doesn't disappear
+    results = [results utp_12(mthd, at4, ple1)];    % Test errors are cleared
+
+    disp('Done.');
+    disp('******************************************************');
+
+  elseif nargin == 1 % Check for UTP functions
+    if strcmp(varargin{1}, 'isutp')
+      results = 1;
+    else
+      results = 0;
+    end
+  else
+    error('### Incorrect inputs')
+  end
+
+
+  %% Algorithm test for UTP 02,03,04,05
+  
+  function atest = algo_test_y(in, out, pli)    
+    atest = true;
+    TOL   = 1e-14;
+    N = pli.find('order');
+    [y, a] = ltpda_polyreg(in.y, N);
+    if  any(abs(y-out.y)>TOL) , atest = false; end
+  end    
+  
+  %% UTP_01
+
+  % <TestDescription>
+  %
+  % Tests that the getInfo call works for this method.
+  %
+  % </TestDescription>
+  function result = utp_01
+
+
+    % <SyntaxDescription>
+    %
+    % Test that the getInfo call works for no sets, all sets, and each set
+    % individually.
+    %
+    % </SyntaxDescription>
+
+    try
+      % <SyntaxCode>
+      % Call for no sets
+      io(1) = eval([class '.getInfo(''' mthd ''', ''None'')']);
+      % Call for all sets
+      io(2) = eval([class '.getInfo(''' mthd ''')']);
+      % Call for each set
+      for kk=1:numel(io(2).sets)
+        io(kk+2) = eval([class '.getInfo(''' mthd ''', ''' io(2).sets{kk} ''')']);
+      end
+      % </SyntaxCode>
+      stest = true;
+    catch err
+      disp(err.message)
+      stest = false;
+    end
+
+    % <AlgoDescription>
+    %
+    % 1) Check that getInfo call returned an minfo object in all cases.
+    % 2) Check that all plists have the correct parameters.
+    %
+    % </AlgoDescription>
+
+    atest = true;
+    if stest
+      % <AlgoCode>
+      % check we have minfo objects
+      if isa(io, 'minfo')
+        %%% SET 'None'
+        if ~isempty(io(1).sets), atest = false; end
+        if ~isempty(io(1).plists), atest = false; end
+        %%% Check all Sets
+        if ~any(strcmpi(io(2).sets, 'Default')), atest = false; end
+        if numel(io(2).plists) ~= numel(io(2).sets), atest = false; end
+        %%%%%%%%%%   SET 'Default'
+        if io(3).plists.nparams ~= 2, atest = false; end
+        % Check key
+        if ~io(3).plists.isparam('order'), atest = false; end
+        % Check default value
+        if ~isequal(io(3).plists.find('order'), 1), atest = false; end
+        % Check options
+        if ~isequal(io(3).plists.getOptionsForParam('order'), {-1 0 1 2 3 4 5 6 7 8 9}), atest = false; end
+        % Check key
+        if ~io(3).plists.isparam('M-FILE ONLY'), atest = false; end
+        % Check default value
+        if ~isequal(io(3).plists.find('M-FILE ONLY'), false), atest = false; end
+        % Check options
+        if ~isequal(io(3).plists.getOptionsForParam('M-FILE ONLY'), {false true}), atest = false; end
+      end
+      % </AlgoCode>
+    else
+      atest = false;
+    end
+
+    % Return a result structure
+    result = utp_prepare_result(atest, stest, dbstack, mfilename);
+  end % END UTP_01
+
+%   %% UTP_02
+% 
+%   % <TestDescription>
+%   %
+%   % Tests that the detrend method works with a vector of AOs as input.
+%   %
+%   % </TestDescription>
+%   function result = utp_02
+% 
+%     % <SyntaxDescription>
+%     %
+%     % Test that the detrend method works for a vector of AOs as input.
+%     %
+%     % </SyntaxDescription>
+% 
+%     try
+%       % <SyntaxCode>
+%       N     = 3;
+%       avec  = [at1 at5 at6];
+%       out   = detrend(avec, plist('N', N));
+%       % </SyntaxCode>
+%       stest = true;
+%     catch err
+%       disp(err.message)
+%       stest = false;
+%     end
+% 
+%     % <AlgoDescription>
+%     %
+%     % 1) Check that the number of elements in 'out' is the square of the
+%     %    number in the input.
+%     % 2) Check that each output AO contains the correct data.
+%     %
+%     % </AlgoDescription>
+% 
+%     atest = true;
+%     TOL   = 1e-14;
+%     if stest
+%       % <AlgoCode>
+%       % Check we have the correct number of outputs
+%       if numel(out) ~= numel(avec), atest = false; end
+%       % Check the correctness of the algorithm
+%       for kk = 1:numel(avec)
+%         [y, a] = ltpda_polyreg(avec(kk).y, N);
+%         if  any(abs(y-out(kk).y)>TOL) , atest = false; end
+%       end
+%       % </AlgoCode>
+%     else
+%       atest = false;
+%     end
+% 
+%     % Return a result structure
+%     result = utp_prepare_result(atest, stest, dbstack, mfilename);
+%   end % END UTP_02
+% 
+%   %% UTP_03
+% 
+%   % <TestDescription>
+%   %
+%   % Tests that the detrend method works with a matrix of AOs as input.
+%   %
+%   % </TestDescription>
+%   function result = utp_03
+% 
+%     % <SyntaxDescription>
+%     %
+%     % Test that the detrend method works for a matrix of AOs as input.
+%     %
+%     % </SyntaxDescription>
+% 
+%     try
+%       % <SyntaxCode>
+%       N     = 3;
+%       amat  = [at1 at5 at6; at5 at6 at1];
+%       out   = detrend(amat, plist('N', N));
+%       % </SyntaxCode>
+%       stest = true;
+%     catch err
+%       disp(err.message)
+%       stest = false;
+%     end
+% 
+%     % <AlgoDescription>
+%     %
+%     % 1) Check that the number of elements in 'out' is the square of the
+%     %    number in the input.
+%     % 2) Check that each output AO contains the correct data.
+%     %
+%     % </AlgoDescription>
+% 
+%     atest = true;
+%     TOL   = 1e-14;
+%     if stest
+%       % <AlgoCode>
+%       % Check we have the correct number of outputs
+%       if numel(out) ~= numel(amat), atest = false; end
+%       % Check the correctness of the algorithm
+%       for kk = 1:numel(amat)
+%         [y, a] = ltpda_polyreg(amat(kk).y, N);
+%         if  any(abs(y-out(kk).y)>TOL) , atest = false; end
+%       end
+%       % </AlgoCode>
+%     else
+%       atest = false;
+%     end
+% 
+%     % Return a result structure
+%     result = utp_prepare_result(atest, stest, dbstack, mfilename);
+%   end % END UTP_03
+% 
+%   %% UTP_04
+% 
+%   % <TestDescription>
+%   %
+%   % Tests that the detrend method works with a list of AOs as input.
+%   %
+%   % </TestDescription>
+%   function result = utp_04
+% 
+%     % <SyntaxDescription>
+%     %
+%     % Test that the detrend method works for a list of AOs as input.
+%     %
+%     % </SyntaxDescription>
+% 
+%     try
+%       % <SyntaxCode>
+%       N     = 3;
+%       out   = detrend(at1,at5,at6, plist('N', N));
+%       % </SyntaxCode>
+%       stest = true;
+%     catch err
+%       disp(err.message)
+%       stest = false;
+%     end
+% 
+%     % <AlgoDescription>
+%     %
+%     % 1) Check that the number of elements in 'out' is the square of the
+%     %    number in the input.
+%     % 2) Check that each output AO contains the correct data.
+%     %
+%     % </AlgoDescription>
+% 
+%     aoin  = [at1, at5, at6];
+%     atest = true;
+%     TOL   = 1e-14;
+%     if stest
+%       % <AlgoCode>
+%       % Check we have the correct number of outputs
+%       if numel(out) ~= 3, atest = false; end
+%       % Check the correctness of the algorithm
+%       for kk = 1:numel(aoin)
+%         [y, a] = ltpda_polyreg(aoin(kk).y, N);
+%         if  any(abs(y-out(kk).y)>TOL) , atest = false; end
+%       end
+%       % </AlgoCode>
+%     else
+%       atest = false;
+%     end
+% 
+%     % Return a result structure
+%     result = utp_prepare_result(atest, stest, dbstack, mfilename);
+%   end % END UTP_04
+% 
+%   %% UTP_05
+% 
+%   % <TestDescription>
+%   %
+%   % Tests that the detrend method works with a mix of different shaped AOs as
+%   % input.
+%   %
+%   % </TestDescription>
+%   function result = utp_05
+% 
+%     % <SyntaxDescription>
+%     %
+%     % Test that the detrend method works with an input of matrices and vectors
+%     % and single AOs.
+%     %
+%     % </SyntaxDescription>
+% 
+%     try
+%       % <SyntaxCode>
+%       N     = 3;
+%       out   = detrend(at1,[at5 at6],at5,[at5 at1; at6 at1],at6, plist('N', N));
+%       % </SyntaxCode>
+%       stest = true;
+%     catch err
+%       disp(err.message)
+%       stest = false;
+%     end
+% 
+%     % <AlgoDescription>
+%     %
+%     % 1) Check that the number of elements in 'out' is the same as in
+%     %    input.
+%     % 2) Check that each output AO contains the correct data.
+%     %
+%     % </AlgoDescription>
+% 
+%     aoin = [at1, reshape([at5 at6], 1, []), at5, reshape([at5 at1; at6 at1], 1, []), at6];
+%     atest = true;
+%     TOL   = 1e-14;
+%     if stest
+%       % <AlgoCode>
+%       % Check we have the correct number of outputs
+%       if numel(out) ~= 9, atest = false; end
+%       % Check the correctness of the algorithm
+%       for kk = 1:numel(aoin)
+%         [y, a] = ltpda_polyreg(aoin(kk).y, N);
+%         if  any(abs(y-out(kk).y)>TOL) , atest = false; end
+%       end
+%       % </AlgoCode>
+%     else
+%       atest = false;
+%     end
+% 
+%     % Return a result structure
+%     result = utp_prepare_result(atest, stest, dbstack, mfilename);
+%   end % END UTP_05
+% 
+%   %% UTP_06
+% 
+%   % <TestDescription>
+%   %
+%   % Tests that the detrend method properly applies history.
+%   %
+%   % </TestDescription>
+%   function result = utp_06
+% 
+%     % <SyntaxDescription>
+%     %
+%     % Test that the result of applying the detrend method can be processed back
+%     % to an m-file.
+%     %
+%     % </SyntaxDescription>
+% 
+%     try
+%       % <SyntaxCode>
+%       out = detrend(at5,plist('N', 3));
+%       mout = rebuild(out);
+%       % </SyntaxCode>
+%       stest = true;
+%     catch err
+%       disp(err.message)
+%       stest = false;
+%     end
+% 
+%     % <AlgoDescription>
+%     %
+%     % 1) Check that the last entry in the history of 'out' corresponds to
+%     %    'detrend'.
+%     % 2) Check that the re-built object is the same object as 'out'.
+%     %
+%     % </AlgoDescription>
+% 
+%     atest = true;
+%     if stest
+%       % <AlgoCode>
+%       % Check the last step in the history of 'out'
+%       if ~strcmp(out.hist.methodInfo.mname, 'detrend'), atest = false; end
+%       % Check the re-built object
+%       if ~eq(mout, out, ple2), atest = false; end
+%       % </AlgoCode>
+%     else
+%       atest = false;
+%     end
+% 
+%     % Return a result structure
+%     result = utp_prepare_result(atest, stest, dbstack, mfilename);
+%   end % END UTP_06
+% 
+%   %% UTP_07
+% 
+%   % <TestDescription>
+%   %
+%   % Tests that the detrend method can modify the input AO.
+%   %
+%   % </TestDescription>
+%   function result = utp_07
+% 
+%     % <SyntaxDescription>
+%     %
+%     % Test that the detrend method can modify the input AO by calling with no
+%     % output and that the method doesn't change the input of the function
+%     % notation (with a equal sign).
+%     %
+%     % </SyntaxDescription>
+% 
+%     try
+%       % <SyntaxCode>
+%       % copy at1 to work with
+%       ain = ao(at1);
+%       % modify ain
+%       N    = 10;
+%       pl   = plist('N', N);
+%       aout = ain.detrend(pl);
+%       ain.detrend(pl);
+%       % </SyntaxCode>
+%       stest = true;
+%     catch err
+%       disp(err.message)
+%       stest = false;
+%     end
+% 
+%     % <AlgoDescription>
+%     %
+%     % 1) Check that 'at1' and 'ain' are now different.
+%     % 2) Check that 'ain' is detrend(at1).
+%     %
+%     % </AlgoDescription>
+% 
+%     atest = true;
+%     TOL   = 1e-14;
+%     if stest
+%       % <AlgoCode>
+%       % Check that detrend modified the input by comparing to the copy
+%       if eq(ao(at1), ain, ple1), atest = false; end
+%       % Check that detrend doesn't modified the input for the function notation
+%       if ~eq(aout, ain, ple1), atest = false; end
+%       % Check that the modified input is the detrend value of the copy
+%       [y, a] = ltpda_polyreg(at1.y, N);
+%       if  any(abs(y-ain.y)>TOL) , atest = false; end
+%       % </AlgoCode>
+%     else
+%       atest = false;
+%     end
+% 
+%     % Return a result structure
+%     result = utp_prepare_result(atest, stest, dbstack, mfilename);
+%   end % END UTP_07
+% 
+%   %% UTP_08
+% 
+%   % <TestDescription>
+%   %
+%   % Control the method with a plist.
+%   %
+%   % </TestDescription>
+%   function result = utp_08
+% 
+%     % <SyntaxDescription>
+%     %
+%     % Test that the detrend method can use the MATLAB methods polyfit and polyval
+%     % to compute the trend.
+%     %
+%     % </SyntaxDescription>
+% 
+%     try
+%       % <SyntaxCode>
+%       N   = 3;
+%       pl  = plist('N', N, 'M-FILE ONLY', 'YES');
+%       out = detrend(at1, pl);
+%       mout = rebuild(out);
+%       % </SyntaxCode>
+%       stest = true;
+%     catch err
+%       disp(err.message)
+%       stest = false;
+%     end
+% 
+%     % <AlgoDescription>
+%     %
+%     % 1) Check that the detrend method uses the MATLAB methods
+%     % 2) Check that the re-built object is the same object as 'out'.
+%     %
+%     % </AlgoDescription>
+% 
+%     atest = true;
+%     if stest
+%       % <AlgoCode>
+%       x     = at1.y;
+%       order = N;
+%       t     = [1:length(x)].';
+%       % fit polynomial
+%       p = polyfit(t, x, order);
+%       % make polynomial series
+%       py = polyval(p, t);
+%       % detrend
+%       y = x - py;
+%       % Check each output against the trend of the input
+%       if ~isequal(y, out.y), atest = false; end
+%       % Check the re-built object
+%       if ~eq(mout, out, ple1), atest = false; end
+%       % </AlgoCode>
+%     else
+%       atest = false;
+%     end
+% 
+%     % Return a result structure
+%     result = utp_prepare_result(atest, stest, dbstack, mfilename);
+%   end % END UTP_08
+% 
+%   %% UTP_09
+% 
+%   % <TestDescription>
+%   %
+%   % Tests that the detrend method keeps the data shape of the input object.
+%   %
+%   % </TestDescription>
+%   function result = utp_09
+% 
+%     % <SyntaxDescription>
+%     %
+%     % Test that the detrend method keeps the data shape of the input object. The
+%     % input AO must be an AO with row data and an AO with column data.
+%     %
+%     % </SyntaxDescription>
+% 
+%     try
+%       % <SyntaxCode>
+%       pl   = plist('N', 3);
+%       out1 = detrend(at5, pl);
+%       out2 = detrend(at6, pl);
+%       % </SyntaxCode>
+%       stest = true;
+%     catch err
+%       disp(err.message)
+%       stest = false;
+%     end
+% 
+%     % <AlgoDescription>
+%     %
+%     % 1) Check that the shpe of the data doesn't change.
+%     %
+%     % </AlgoDescription>
+% 
+%     atest = true;
+%     if stest
+%       % <AlgoCode>
+%       % Check the shape of the output data
+%       if size(out1.data.x) ~= size(at5.data.x), atest = false; end
+%       if size(out1.data.y) ~= size(at5.data.y), atest = false; end
+%       if size(out2.data.x) ~= size(at6.data.x), atest = false; end
+%       if size(out2.data.y) ~= size(at6.data.y), atest = false; end
+%       % </AlgoCode>
+%     else
+%       atest = false;
+%     end
+% 
+%     % Return a result structure
+%     result = utp_prepare_result(atest, stest, dbstack, mfilename);
+%   end % END UTP_09
+% 
+%   %% UTP_10
+% 
+%   % <TestDescription>
+%   %
+%   % Check that the detrend method pass back the output objects to a list of
+%   % output variables or to a single variable.
+%   %
+%   % </TestDescription>
+%   function result = utp_10
+% 
+%     % <SyntaxDescription>
+%     %
+%     % Call the method with a list of output variables and with a single output
+%     % variable. Additionaly check that the rebuild method works on the output.
+%     %
+%     % </SyntaxDescription>
+% 
+%     try
+%       % <SyntaxCode>
+%       pl   = plist('N', 3);
+%       [o1, o2] = detrend(at5, at6, pl);
+%       o3  = detrend(at5, at6, pl);
+%       mout1 = rebuild(o1);
+%       mout2 = rebuild(o2);
+%       mout3 = rebuild(o3);
+%       % </SyntaxCode>
+%       stest = true;
+%     catch err
+%       disp(err.message)
+%       stest = false;
+%     end
+% 
+%     % <AlgoDescription>
+%     %
+%     % 1) Check that the output contains the right number of objects
+%     % 2) Check that the 'rebuild' method produces the same object as 'out'.
+%     %
+%     % </AlgoDescription>
+% 
+%     atest = true;
+%     if stest
+%       % <AlgoCode>
+%       % Check the number of outputs
+%       if numel(o1) ~=1, atest = false; end
+%       if numel(o2) ~=1, atest = false; end
+%       if numel(o3) ~=2, atest = false; end
+%       % Check the rebuilding of the object
+%       if ~eq(o1, mout1, ple2), atest = false; end
+%       if ~eq(o2, mout2, ple2), atest = false; end
+%       if ~eq(o3, mout3, ple2), atest = false; end
+%       % </AlgoCode>
+%     else
+%       atest = false;
+%     end
+% 
+%     % Return a result structure
+%     result = utp_prepare_result(atest, stest, dbstack, mfilename);
+%   end % END UTP_10
+
+end