% UTP_AO_PHASE a set of UTPs for the ao/phase method
%
% M Hewitson 06-08-08
%
% $Id: utp_ao_phase.m,v 1.14 2011/04/17 10:47:12 hewitson Exp $
%

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

function results = utp_ao_phase(varargin)

  % Check the inputs
  if nargin == 0

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

    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
    results = [results utp_01];    % getInfo call
    results = [results utp_02(mthd, atvec, @algo_test_y, [], ple3)];    % Vector input
    results = [results utp_03(mthd, atmat, @algo_test_y, [], ple3)];    % Matrix input
    results = [results utp_04(mthd, at1, at2, at3, @algo_test_y, [], ple3)];    % List input
    results = [results utp_05(mthd, at1, atvec, atmat, @algo_test_y, [], ple3)];    % Test with mixed input
    results = [results utp_06(mthd, at1, [], ple2)];    % Test history is working
    results = [results utp_07(mthd, at1, plist('neval', true), 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, at2, ple2)];    % Test output of the data
    results = [results utp_11(mthd, at1, ple1)];    % Test plotinfo doesn't disappear

    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;
    if ~isequal(utils.math.phase(in.data.getY), out.data.getY)
      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')
        atest = check_axis_sets(io);
      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 phase method works with a vector of AOs as input.
%   %
%   % </TestDescription>
%   function result = utp_02
% 
%     % <SyntaxDescription>
%     %
%     % Test that the phase method works for a vector of AOs as input.
%     %
%     % </SyntaxDescription>
% 
%     try
%       % <SyntaxCode>
%       out = phase(atvec);
%       % </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 'atvec'
%     % 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(atvec)), atest = false; end
%       % Check each output against the phase of the input
%       for kk=1:numel(out)
%         if ~isequal(utils.math.phase(atvec(kk).data.getY), out(kk).data.getY)
%           atest = false;
%           break;
%         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 phase method works with a matrix of AOs as input.
%   %
%   % </TestDescription>
%   function result = utp_03
% 
%     % <SyntaxDescription>
%     %
%     % Test that the phase method works for a matrix of AOs as input.
%     %
%     % </SyntaxDescription>
% 
%     try
%       % <SyntaxCode>
%       out = phase(atmat);
%       % </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(atmat)), atest = false; end
%       % Check each output against the phase of the input
%       for kk=1:numel(out)
%         if ~isequal(utils.math.phase(atmat(kk).data.getY), out(kk).data.getY)
%           atest = false;
%           break;
%         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 phase method works with a list of AOs as input.
%   %
%   % </TestDescription>
%   function result = utp_04
% 
%     % <SyntaxDescription>
%     %
%     % Test that the phase method works for a list of AOs as input.
%     %
%     % </SyntaxDescription>
% 
%     try
%       % <SyntaxCode>
%       out = phase(at1,at2,at3);
%       % </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;
%     if stest
%       % <AlgoCode>
%       % Check we have the correct number of outputs
%       if numel(out) ~= 3, atest = false; end
%       % Check each output against the phase of the input
%       if ~isequal(utils.math.phase(at1.data.getY), out(1).data.getY), atest = false; end
%       if ~isequal(utils.math.phase(at2.data.getY), out(2).data.getY), atest = false; end
%       if ~isequal(utils.math.phase(at3.data.getY), out(3).data.getY), atest = false; 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 phase method works with a mix of different shaped AOs as
%   % input.
%   %
%   % </TestDescription>
%   function result = utp_05
% 
%     % <SyntaxDescription>
%     %
%     % Test that the phase method works with an input of matrices and vectors
%     % and single AOs.
%     %
%     % </SyntaxDescription>
% 
%     try
%       % <SyntaxCode>
%       out = phase(at1,atvec,at2,atmat,at3);
%       % </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;
%     if stest
%       % <AlgoCode>
%       % Check we have the correct number of outputs
%       if numel(out) ~= (3+numel(atmat)+numel(atvec)), atest = false; end
%       % Check the first input
%       nout = 1;
%       if ~isequal(utils.math.phase(at1.data.getY), out(nout).data.getY), atest = false; end
%       nout = nout+1;
%       % Check the elements of the input vector
%       for jj=1:numel(atvec)
%         if ~isequal(utils.math.phase(atvec(jj).data.getY), out(nout).data.getY), atest = false; end
%         nout = nout+1;
%       end
%       % Check the 3rd input
%       if ~isequal(utils.math.phase(at2.data.getY), out(nout).data.getY), atest = false; end
%       nout = nout+1;
%       % Check the elements of the input matrix
%       for jj=1:numel(atmat)
%         if ~isequal(utils.math.phase(atmat(jj).data.getY), out(nout).data.getY), atest = false; end
%         nout = nout+1;
%       end
%       % Check the last input
%       if ~isequal(utils.math.phase(at3.data.getY), out(nout).data.getY), atest = false; 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 phase method properly applies history.
%   %
%   % </TestDescription>
%   function result = utp_06
% 
%     % <SyntaxDescription>
%     %
%     % Test that the result of applying the phase method can be processed back
%     % to an m-file.
%     %
%     % </SyntaxDescription>
% 
%     try
%       % <SyntaxCode>
%       out  = phase(at1);
%       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
%     %    'phase'.
%     % 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, 'phase'), 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 phase method can modify the input AO.
%   %
%   % </TestDescription>
%   function result = utp_07
% 
%     % <SyntaxDescription>
%     %
%     % Test that the phase 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
%       aout = ain.phase();
%       ain.phase();
%       % </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 phase(at1).
%     %
%     % </AlgoDescription>
% 
%     atest = true;
%     if stest
%       % <AlgoCode>
%       % Check that phase modified the input by comparing to the copy
%       if eq(ao(at1), ain, ple1), atest = false; end
%       % Check that phase doesn't modified the input for the function notation
%       if ~eq(aout, ain, ple1), atest = false; end
%       % Check that the modified input is the phase value of the copy
%       if ~isequal(utils.math.phase(at1.data.getY), ain.data.getY), 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 phase method can modify the single axis controlled by the
%     % plist and the resuld can be processed back to an m-file.
%     %
%     % </SyntaxDescription>
% 
%     try
%       % <SyntaxCode>
%       plx  = plist('axis', 'X');
%       ply  = plist('axis', 'Y');
%       plxy = plist('axis', 'XY');
%       out1 = phase(at1, plx);
%       out2 = phase(at1, ply);
%       out3 = phase(at1, plxy);
%       mout1 = rebuild(out1);
%       mout2 = rebuild(out2);
%       mout3 = rebuild(out3);
%       % </SyntaxCode>
%       stest = true;
%     catch err
%       disp(err.message)
%       stest = false;
%     end
% 
%     % <AlgoDescription>
%     %
%     % 1) Check that the phase method applies to the x-axis
%     % 2) Check that the phase method applies to the y-axis
%     % 3) Check that the phase method applies to both axes
%     % 4) Check that the re-built objects are the same object as 'out[1..3]'.
%     %
%     % </AlgoDescription>
% 
%     atest = true;
%     if stest
%       % <AlgoCode>
%       % Check each output against the phase of the input
%       if ~isequal(utils.math.phase(at1.data.getX), out1.data.getX), atest = false; end
%       if ~isequal(at1.data.getY, out1.data.getY), atest = false; end
%       if ~isequal(at1.data.getX, out2.data.getX), atest = false; end
%       if ~isequal(utils.math.phase(at1.data.getY), out2.data.getY), atest = false; end
%       if ~isequal(utils.math.phase(at1.data.getX), out3.data.getX), atest = false; end
%       if ~isequal(utils.math.phase(at1.data.getY), out3.data.getY), atest = false; end
%       % Check the re-built object
%       if ~eq(mout1, out1, ple1), atest = false; end
%       if ~eq(mout2, out2, ple1), atest = false; end
%       if ~eq(mout3, out3, 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>
%   %
%   % Control the method with a plist.
%   %
%   % </TestDescription>
%   function result = utp_09
% 
%     % <SyntaxDescription>
%     %
%     % Test that the phase 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>
%       out1 = phase(at5);
%       out2 = phase(at6);
%       % </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 phase 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>
%       [o1, o2] = phase(at5, at6);
%       o3  = phase(at5, at6);
%       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