% UTP_AO_WHITEN2D a set of UTPs for the ao/whiten2D method
%
% L Ferraioli 02-02-09
%
% $Id: utp_ao_whiten2D.m,v 1.10 2010/05/07 16:20:01 ingo Exp $
%

% <MethodDescription>
%
% The whiten1D method of the ao class computes the whiten1Dolute value of the y
% and/or x data.
%
% </MethodDescription>

function results = utp_ao_whiten2D(varargin)

  % Check the inputs
  if nargin == 0

    % Some keywords
    class   = 'ao';
    mthd    = 'whiten2D';

    results = [];
    disp('******************************************************');
    disp(['****  Running UTPs for ' class '/' mthd]);
    disp('******************************************************');

    % Test AOs
    [CSD,a1,a2,a3,a4,a5,a6,av,am,plstd] = get_test_obj_ao_whiten2D();
    
    % --------------------------------------------------------------------
    
    % Exception list for the UTPs:
    [ple1,ple2,ple3,ple4,ple5,ple6] = get_test_ples();
    
    % add useful params to standard exceptions
    ple3 = plist('Exceptions', {'history', 'created', 'UUID', 'param/desc', 'name', 'procinfo'});

    % Run the tests
    results = [results utp_01];    % getInfo call
    results = [results utp_02];    % Vector input
    results = [results utp_03];    % Matrix input
    results = [results utp_04];    % List input
    results = [results utp_05];    % Test with mixed input
    results = [results utp_06];    % Test history is working
    results = [results utp_07];    % Test the modify call works
    results = [results utp_08];    % Test input data shape == output data shape
    results = [results utp_09];    % Test output of the data

    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

  %% 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 ~= 15, atest = false; end        
        % Check key
        if ~io(3).plists.isparam('csd11'), atest = false; end        
        if ~io(3).plists.isparam('csd12'), atest = false; end
        if ~io(3).plists.isparam('csd21'), atest = false; end
        if ~io(3).plists.isparam('csd22'), atest = false; end        
        if ~io(3).plists.isparam('maxiter'), atest = false; end
        if ~io(3).plists.isparam('poletype'), atest = false; end
        if ~io(3).plists.isparam('minorder'), atest = false; end
        if ~io(3).plists.isparam('maxorder'), atest = false; end
        if ~io(3).plists.isparam('weights'), atest = false; end
        if ~io(3).plists.isparam('plot'), atest = false; end
        if ~io(3).plists.isparam('disp'), atest = false; end
        if ~io(3).plists.isparam('msevartol'), atest = false; end
        if ~io(3).plists.isparam('fittol'), atest = false; end
        if ~io(3).plists.isparam('usesym'), atest = false; end
        if ~io(3).plists.isparam('keepvar'), atest = false; end        
        % Check default value
        if ~isEmptyDouble(io(3).plists.find('csd11')), atest = false; end
        if ~isEmptyDouble(io(3).plists.find('csd12')), atest = false; end
        if ~isEmptyDouble(io(3).plists.find('csd21')), atest = false; end
        if ~isEmptyDouble(io(3).plists.find('csd22')), atest = false; end        
        if ~isequal(io(3).plists.find('maxiter'), 30), atest = false; end
        if ~isequal(io(3).plists.find('poletype'), 3), atest = false; end
        if ~isequal(io(3).plists.find('minorder'), 2), atest = false; end
        if ~isequal(io(3).plists.find('maxorder'), 25), atest = false; end
        if ~isequal(io(3).plists.find('weights'), 3), atest = false; end
        if ~isequal(io(3).plists.find('plot'), false), atest = false; end
        if ~isequal(io(3).plists.find('disp'), false), atest = false; end
        if ~isequal(io(3).plists.find('msevartol'), .01), atest = false; end
        if ~isequal(io(3).plists.find('fittol'), .01), atest = false; end
        if ~isequal(io(3).plists.find('usesym'), 0), atest = false; end
        if ~isequal(io(3).plists.find('keepvar'), false), atest = false; end
        % Check options
        if ~isequal(io(3).plists.getOptionsForParam('csd11'), {[]}), atest = false; end
        if ~isequal(io(3).plists.getOptionsForParam('csd12'), {[]}), atest = false; end
        if ~isequal(io(3).plists.getOptionsForParam('csd21'), {[]}), atest = false; end
        if ~isequal(io(3).plists.getOptionsForParam('csd22'), {[]}), atest = false; end        
        if ~isequal(io(3).plists.getOptionsForParam('maxiter'), {30}), atest = false; end
        if ~isequal(io(3).plists.getOptionsForParam('poletype'), {1 2 3}), atest = false; end
        if ~isequal(io(3).plists.getOptionsForParam('minorder'), {2}), atest = false; end
        if ~isequal(io(3).plists.getOptionsForParam('maxorder'), {25}), atest = false; end
        if ~isequal(io(3).plists.getOptionsForParam('weights'), {3}), atest = false; end
        if ~isequal(io(3).plists.getOptionsForParam('plot'), {false, true}), atest = false; end
        if ~isequal(io(3).plists.getOptionsForParam('disp'), {false, true}), atest = false; end
        if ~isequal(io(3).plists.getOptionsForParam('msevartol'), {.01}), atest = false; end
        if ~isequal(io(3).plists.getOptionsForParam('fittol'), {.01}), atest = false; end
        if ~isequal(io(3).plists.getOptionsForParam('usesym'), {0, 1, 2}), atest = false; end
        if ~isequal(io(3).plists.getOptionsForParam('keepvar'), {true, false}), 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 whiten2D method works with a vector of AOs as input.
  %
  % </TestDescription>
  function result = utp_02

    % <SyntaxDescription>
    %
    % Test that the whiten2D method works for a vector of AOs as input.
    %
    % </SyntaxDescription>

    try
      % <SyntaxCode>
      % Building data vector
      
      out = whiten2D(av, plstd);
      % </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 'acv2'
    % 2) Check that each output AO contains the correct data.
    %
    % </AlgoDescription>

    atest = true;
    if stest
      % <AlgoCode>
      % Check we have the correct number of outputs
      if ~isequal(size(out), size(av)), atest = false; end
      
      % check if the number of output is even or odd
      if rem(numel(out),2)
        % check the last object for odd input
        h = numel(out);
        if isa(out(h).data, 'tsdata')
          % Check the last object if nargin is odd (they must be the same)
          if ~eq(out(h), av(h), ple1), atest = false; end
        else
          % Check the other objects (they must be the same)
          if ~eq(out(h), av(h), ple1), atest = false; end
        end
      else
        % Check each output against the absolute value of the input for even
        % input
        for kk=1:2:numel(out)-1
          clear used_filt11 used_filt12 used_filt21 used_filt22
          % Check the noisegen ao(tsdata) objects
          if isa(out(kk).data, 'tsdata')
            used_filt11 = out(kk).procinfo.find('Filt11');
            used_filt12 = out(kk).procinfo.find('Filt12');
            used_filt21 = out(kk+1).procinfo.find('Filt21');
            used_filt22 = out(kk+1).procinfo.find('Filt22');
            obj1 = filter(av(kk),used_filt11)+filter(av(kk+1),used_filt12);
            if ~eq(out(kk), obj1, ple3), atest = false; end
            obj2 = filter(av(kk),used_filt21)+filter(av(kk+1),used_filt22);
            if ~eq(out(kk), obj2, ple3), atest = false; end
          else
            % Check the other objects (they must be the same)
            if ~eq(out(kk), av(kk), ple1), atest = false; end
          end
        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 whiten2D method works with a matrix of AOs as input.
  %
  % </TestDescription>
  function result = utp_03

    % <SyntaxDescription>
    %
    % Test that the whiten2D method works for a matrix of AOs as input.
    %
    % </SyntaxDescription>

    try
      % <SyntaxCode>
      out = whiten2D(am,plstd);
      % </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 'atmat'
    % 2) Check that each output AO contains the correct data.
    %
    % </AlgoDescription>

    atest = true;
    if stest
      % <AlgoCode>
      % Check we have the correct number of outputs
      if ~isequal(size(out), size(am)), atest = false; end
      
      % check if the number of output is even or odd
      if rem(numel(out),2)
        % check the last object for odd input
        h = numel(out);
        if isa(out(h).data, 'tsdata')
          % Check the last object if nargin is odd (they must be the same)
          if ~eq(out(h), am(h), ple1), atest = false; end
        else
          % Check the other objects (they must be the same)
          if ~eq(out(h), am(h), ple1), atest = false; end
        end
      else
        % Check each output against the absolute value of the input for even
        % input
        for kk=1:2:numel(out)-1
          clear used_filt11 used_filt12 used_filt21 used_filt22
          % Check the noisegen ao(tsdata) objects
          if isa(out(kk).data, 'tsdata')
            used_filt11 = out(kk).procinfo.find('Filt11');
            used_filt12 = out(kk).procinfo.find('Filt12');
            used_filt21 = out(kk+1).procinfo.find('Filt21');
            used_filt22 = out(kk+1).procinfo.find('Filt22');
            obj1 = filter(am(kk),used_filt11)+filter(am(kk+1),used_filt12);
            if ~eq(out(kk), obj1, ple3), atest = false; end
            obj2 = filter(am(kk),used_filt21)+filter(am(kk+1),used_filt22);
            if ~eq(out(kk+1), obj2, ple3), atest = false; end
          else
            % Check the other objects (they must be the same)
            if ~eq(out(kk), am(kk), ple1), atest = false; end
          end
        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 whiten2D method works with a list of AOs as input.
  %
  % </TestDescription>
  function result = utp_04

    % <SyntaxDescription>
    %
    % Test that the whiten2D method works for a list of AOs as input.
    %
    % </SyntaxDescription>

    try
      % <SyntaxCode>
      out = whiten2D(a1,a2,a3,a4,a5,plstd);
      % </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>

    atest = true;
    aoin = [a1 a2 a3 a4 a5];
    if stest
      % <AlgoCode>
      % Check we have the correct number of outputs
      if ~isequal(size(out), size(aoin)), atest = false; end
      
      % check if the number of output is even or odd
      if rem(numel(out),2)
        % check the last object for odd input
        h = numel(out);
        if isa(out(h).data, 'tsdata')
          % Check the last object if nargin is odd (they must be the same)
          if ~eq(out(h), aoin(h), ple1), atest = false; end
        else
          % Check the other objects (they must be the same)
          if ~eq(out(h), aoin(h), ple1), atest = false; end
        end
      else
        % Check each output against the absolute value of the input for even
        % input
        for kk=1:2:numel(out)-1
          clear used_filt11 used_filt12 used_filt21 used_filt22
          % Check the noisegen ao(tsdata) objects
          if isa(out(kk).data, 'tsdata')
            used_filt11 = out(kk).procinfo.find('Filt11');
            used_filt12 = out(kk).procinfo.find('Filt12');
            used_filt21 = out(kk+1).procinfo.find('Filt21');
            used_filt22 = out(kk+1).procinfo.find('Filt22');
            obj1 = filter(aoin(kk),used_filt11)+filter(aoin(kk+1),used_filt12);
            if ~eq(out(kk), obj1, ple3), atest = false; end
            obj2 = filter(aoin(kk),used_filt21)+filter(aoin(kk+1),used_filt22);
            if ~eq(out(kk+1), obj2, ple3), atest = false; end
          else
            % Check the other objects (they must be the same)
            if ~eq(out(kk), aoin(kk), ple1), atest = false; end
          end
        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 whiten2D method works with a mix of different shaped AOs as
  % input.
  %
  % </TestDescription>
  function result = utp_05

    % <SyntaxDescription>
    %
    % Test that the whiten1D method works with an input of matrices and vectors
    % and single AOs.
    %
    % </SyntaxDescription>

    try
      % <SyntaxCode>
      % [1,reshape([2 3],1,[]),reshape([4 6; 5 7],1,[])];
      out = whiten2D(a1,[a2 a3],[a4 a2; a1 a3],plstd);
      % </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>

    atest = true;
    % [1,reshape([2 3],1,[]),reshape([4 6; 5 7],1,[])];
    aoin  = [a1,reshape([a2 a3],1,[]),reshape([a4 a2; a1 a3],1,[])];
    if stest
      % <AlgoCode>
      % Check we have the correct number of outputs
      if ~isequal(size(out), size(aoin)), atest = false; end
      
      % check if the number of output is even or odd
      if rem(numel(out),2)
        % check the last object for odd input
        h = numel(out);
        if isa(out(h).data, 'tsdata')
          % Check the last object if nargin is odd (they must be the same)
          if ~eq(out(h), aoin(h), ple1), atest = false; end
        else
          % Check the other objects (they must be the same)
          if ~eq(out(h), aoin(h), ple1), atest = false; end
        end
      else
        % Check each output against the absolute value of the input for even
        % input
        for kk=1:2:numel(out)-1
          clear used_filt11 used_filt12 used_filt21 used_filt22
          % Check the noisegen ao(tsdata) objects
          if isa(out(kk).data, 'tsdata')
            used_filt11 = out(kk).procinfo.find('Filt11');
            used_filt12 = out(kk).procinfo.find('Filt12');
            used_filt21 = out(kk+1).procinfo.find('Filt21');
            used_filt22 = out(kk+1).procinfo.find('Filt22');
            obj1 = filter(aoin(kk),used_filt11)+filter(aoin(kk+1),used_filt12);
            if ~eq(out(kk), obj1, ple3), atest = false; end
            obj2 = filter(aoin(kk),used_filt21)+filter(aoin(kk+1),used_filt22);
            if ~eq(out(kk+1), obj2, ple3), atest = false; end
          else
            % Check the other objects (they must be the same)
            if ~eq(out(kk), aoin(kk), ple1), atest = false; end
          end
        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 whiten2D method properly applies history.
  %
  % </TestDescription>
  function result = utp_06

    % <SyntaxDescription>
    %
    % Test that the result of applying the whiten2D method can be processed back.
    %
    % </SyntaxDescription>

    try
      % <SyntaxCode>
      out  = whiten2D(av,plstd);
      o1 = out.index(1);
      o2 = out.index(2);
      o3 = out(3);       % It is not necessary to index the third element
                         % of 'out' because this is not touched by 'whiten2D'
      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 last entry in the history of 'out' corresponds to
    %    'whiten2D'.
    % 2) Check that the re-built object is the same object as the input.
    %
    % </AlgoDescription>

    atest = true;
    if stest
      % <AlgoCode>
      % Check the last step in the history of 'out'
      if ~strcmp(out(1).hist.methodInfo.mname, 'whiten2D'), atest = false; end
      if ~strcmp(out(2).hist.methodInfo.mname, 'whiten2D'), atest = false; end
      % Check the re-built object
      if ~eq(mout1, o1, ple2), atest = false; end
      if ~eq(mout2, o2, ple2), atest = false; end
      if ~eq(mout3, o3, ple2), atest = false; end
      % Check the unchanged object (the last one)
      if ~eq(av(3), out(3), ple1), 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 whiten2D method can modify the input AO.
  %
  % </TestDescription>
  function result = utp_07

    % <SyntaxDescription>
    %
    % Test that the whiten2D 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>
      amodi = [ao(a1) ao(a2)];
      aeq   = [ao(a1) ao(a2)];
      amodi.whiten2D(plstd);
      out = aeq.whiten2D(plstd);
      stest = false;
      % </SyntaxCode>
    catch
      stest = true;
    end

    % <AlgoDescription>
    %
    % 1) Nothing to do.
    %
    % </AlgoDescription>

    atest = true;
    if stest
      % <AlgoCode>
      % </AlgoCode>
    else
      atest = false;
    end

    % Return a result structure
    result = utp_prepare_result(atest, stest, dbstack, mfilename);
  end % END UTP_07

  %% UTP_08

  % <TestDescription>
  %
  % Test the shape of the output.
  %
  % </TestDescription>
  function result = utp_08

    % <SyntaxDescription>
    %
    % Test that the whiten2D 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>
      out = whiten2D(a3,a4,a5,a6,plstd);
      out1 = out(1);
      out2 = out(2);
      out3 = out(3);
      out4 = out(4);
      % </SyntaxCode>
      stest = true;
    catch err
      disp(err.message)
      stest = false;
    end

    % <AlgoDescription>
    %
    % 1) Check that the shape 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(a3.data.x), atest = false; end
      if size(out1.data.y) ~= size(a3.data.y), atest = false; end
      if size(out2.data.x) ~= size(a4.data.x), atest = false; end
      if size(out2.data.y) ~= size(a4.data.y), atest = false; end
      if size(out3.data.x) ~= size(a5.data.x), atest = false; end
      if size(out3.data.y) ~= size(a5.data.y), atest = false; end
      if size(out4.data.x) ~= size(a6.data.x), atest = false; end
      if size(out4.data.y) ~= size(a6.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_08

  %% UTP_09

  % <TestDescription>
  %
  % Check that the noisegen2D method pass back the output objects to a list of
  % output variables or to a single variable.
  %
  % </TestDescription>
  function result = utp_09

    % <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>
      [o1,o2] = whiten2D(a1,a2,plstd);
      o3  = whiten2D(a1,a2,plstd);
      o31 = o3.index(1);
      o32 = o3.index(2);
      mout1 = rebuild(o1);
      mout2 = rebuild(o2);
      mout31 = rebuild(o31);
      mout32 = rebuild(o32);
      % </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(o31, mout31, ple2), atest = false; end
      if ~eq(o32, mout32, ple2), atest = false; end
      % </AlgoCode>
    else
      atest = false;
    end

    % Return a result structure
    result = utp_prepare_result(atest, stest, dbstack, mfilename);
  end % END UTP_09
  

end