% UTP_AO_UNWRAP a set of UTPs for the ao/unwrap method
%
% M Hewitson 06-08-08
%
% $Id: utp_ao_unwrap.m,v 1.8 2011/04/17 11:12:03 hewitson Exp $
%

% <MethodDescription>
%
% The unwrap method of the ao class unwraps radian phases P by changing
% absolute jumps greater than or equal to pi to their 2*pi complement.
%
% </MethodDescription>

function results = utp_ao_unwrap(varargin)

  % Check the inputs
  if nargin == 0

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

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

    % Create an test AO with a phase jump
    w = [0:.2:3,3.5:1:10];
    p = [ 0
         -1.5728
         -1.5747
         -1.5772
         -1.5790
         -1.5816
         -1.5852
         -1.5877
         -1.5922
         -1.5976
         -1.6044
         -1.6129
         -1.6269
         -1.6512
         -1.6998
         -1.8621
         1.7252
         1.6124
         1.5930
         1.5916
         1.5708
         1.5708
         1.5708 ];
    a1 = ao(w,p, plist('type', 'tsdata'));
    a2 = ao(w,p, plist('type', 'fsdata'));
    a3 = ao(w,p, plist('type', 'xydata'));
    a4 = ao(p);
    avec = [a1, a2, a3];
    amat = [a1, a2, a3; a4, a3, a1];

    % 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];    % 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 with additional plist with the key 'axis'
    results = [results utp_09];    % Test input data shape == output data shape
    results = [results utp_10];    % Test output of the data
    results = [results utp_11(mthd, a1, 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

  %% 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 unwrap method works with a vector of AOs as input.
  %
  % </TestDescription>
  function result = utp_02

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

    try
      % <SyntaxCode>
      out = unwrap(avec);
      % </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 'avec'
    % 2) Check that each ouput corrects the phase angles
    %
    % </AlgoDescription>

    atest = true;
    if stest
      % <AlgoCode>
      % Check we have the correct number of outputs
      if ~isequal(size(out), size(avec)), atest = false; end
      % Check that each ouput corrects the phase angles
      for kk=1:numel(out)
        if ~isequal(unwrap(avec(kk).y), out(kk).y), 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 unwrap method works with a matrix of AOs as input.
  %
  % </TestDescription>
  function result = utp_03

    % <SyntaxDescription>
    %
    % Tests that the unwrap method works with a matrix of AOs as input.
    %
    % </SyntaxDescription>

    try
      % <SyntaxCode>
      out = unwrap(amat);
      % </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 'amat'
    % 2) Check that each ouput corrects the phase angles
    %
    % </AlgoDescription>

    atest = true;
    if stest
      % <AlgoCode>
      % Check we have the correct number of outputs
      if ~isequal(size(out), size(amat)), atest = false; end
      % Check that each ouput corrects the phase angles
      for kk=1:numel(out)
        if ~isequal(unwrap(amat(kk).y), out(kk).y), 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 unwrap method works with a list of AOs as input.
  %
  % </TestDescription>
  function result = utp_04

    % <SyntaxDescription>
    %
    % Tests that the unwrap method works with a list of AOs as input.
    %
    % </SyntaxDescription>

    try
      % <SyntaxCode>
      out = unwrap(a1, a2, a3, a4);
      % </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 the
    %    input
    % 2) Check that each ouput corrects the phase angles
    %
    % </AlgoDescription>

    atest = true;
    aoin  = [a1, a2, a3, a4];
    if stest
      % <AlgoCode>
      % Check we have the correct number of outputs
      if ~isequal(size(out), size(aoin)), atest = false; end
      % Check that each ouput corrects the phase angles
      for kk=1:numel(out)
        if ~isequal(unwrap(aoin(kk).y), out(kk).y), 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 unwrap method works with a mix of different shaped AOs
  % as input.
  %
  % </TestDescription>
  function result = utp_05

    % <SyntaxDescription>
    %
    % Tests that the unwrap method works with a mix of different shaped AOs
    % as input.
    %
    % </SyntaxDescription>

    try
      % <SyntaxCode>
      out = unwrap(a1, avec, amat, a4);
      % </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 the
    %    input
    % 2) Check that each ouput corrects the phase angles
    %
    % </AlgoDescription>

    atest = true;
    aoin  = [a1, reshape(avec, 1, []), reshape(amat, 1, []), a4];
    if stest
      % <AlgoCode>
      % Check we have the correct number of outputs
      if ~isequal(size(out), size(aoin)), atest = false; end
      % Check that each ouput corrects the phase angles
      for kk=1:numel(out)
        if ~isequal(unwrap(aoin(kk).y), out(kk).y), 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 unwrap method properly applies history.
  %
  % </TestDescription>
  function result = utp_06

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

    try
      % <SyntaxCode>
      out  = unwrap(a1);
      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
    %    'unwrap'.
    % 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.hist.methodInfo.mname, 'unwrap'), atest = false; end
      % The rebuilt object must be the same as 'out'
      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 unwrap method can modify the input AO.
  %
  % </TestDescription>
  function result = utp_07

    % <SyntaxDescription>
    %
    % Test that the unwrap 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(a3);
      aeq   = ao(a3);
      out = aeq.unwrap();
      amodi.unwrap();
      % </SyntaxCode>
      stest = true;
    catch err
      disp(err.message)
      stest = false;
    end

    % <AlgoDescription>
    %
    % 1) Check that 'out' and 'aeq' are now different.
    % 2) Check that 'aeq' is not changed
    % 3) Check that the modified input is the unwraped value of the copy
    % 4) Check that out and amodi are the same
    %
    % </AlgoDescription>

    atest = true;
    if stest
      % <AlgoCode>
      % Check that 'out' and 'aeq' are now different.
      if eq(out, aeq, ple2), atest = false; end
      % Check that 'aeq' is not changed
      if ~eq(aeq, ao(a3), ple1), atest = false; end
      % Check that the modified input is the unwraped value of the copy
      if ~isequal(unwrap(a3.y), amodi.y), atest = false; end
      % Check that out and amodi are the same
      if ~eq(out, amodi, ple2), 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>
  %
  % Test that the unwrap method uses the plist to get the axis.
  %
  % </TestDescription>
  function result = utp_08

    % <SyntaxDescription>
    %
    % Test that the unwrap method uses the plist to get the axis.
    %
    % </SyntaxDescription>

    try
      % <SyntaxCode>
      plx  = plist('axis', 'X');
      ply  = plist('axis', 'Y');
      plxy = plist('axis', 'XY');
      out1 = unwrap(a3, plx);
      out2 = unwrap(a3, ply);
      out3 = unwrap(a3, 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 unwrap method applies to the x-axis
    % 2) Check that the unwrap method applies to the y-axis
    % 3) Check that the unwrap method applies to both axes
    % 4) Check that the re-built object is the same as in 'out[1..3]'.
    %
    % </AlgoDescription>

    atest = true;
    if stest
      % <AlgoCode>
      % Check each output against the unwrapped value of the input
      if ~isequal(unwrap(a3.data.getX), out1.data.getX), atest = false; end
      if ~isequal(a3.data.getY, out1.data.getY), atest = false; end
      if ~isequal(a3.data.getX, out2.data.getX), atest = false; end
      if ~isequal(unwrap(a3.data.getY), out2.data.getY), atest = false; end
      if ~isequal(unwrap(a3.data.getX), out3.data.getX), atest = false; end
      if ~isequal(unwrap(a3.data.getY), out3.data.getY), atest = false; end
      % Check the re-built objects
      if ~eq(mout1, out1, ple2), atest = false; end
      if ~eq(mout2, out2, ple2), atest = false; end
      if ~eq(mout3, out3, ple2), 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>
  %
  % Test the shape of the output.
  %
  % </TestDescription>
  function result = utp_09

    % <SyntaxDescription>
    %
    % Test that the unwrap 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>
      a_col = ao(a3);
      a_row = a_col.';
      out1 = unwrap(a_col);
      out2 = unwrap(a_row);
      % </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.y,1) == 1, atest = false; end
      if size(out2.data.y,2) == 1, 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 unwrap 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] = unwrap(a1, a3);
      o3  = unwrap(a1, a3);
      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