% UTP_AO_INTERPMISSING a set of UTPs for the ao/interpmissing method
%
% M Hewitson 06-08-08
%
% $Id: utp_ao_interpmissing.m,v 1.13 2010/06/07 16:43:06 ingo Exp $
%

% <MethodDescription>
%
% The interpmissing method of the ao class interpolates over any missing
% samples in a time-series AO.
% For this UTP contain the test objects different gaps. These gaps are created
% with the AO method select. Thus at1, at5 and at5 get gaps at the positions
% idx = 30 and idx = 51
%
% </MethodDescription>

function results = utp_ao_interpmissing(varargin)

  % Check the inputs
  if nargin == 0

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

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

    % Test AOs
    [at1,at2,at3,at4,at5,at6,atvec,atmat] = eval(['get_test_objects_' class]);

    % Create gaps
    samples = [1:30, 70:90, 150:300];
    at1 = at1.select(plist('samples', samples));
    at5 = at5.select(plist('samples', samples));
    at6 = at6.select(plist('samples', samples));

    % 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 input data shape == output data shape
    results = [results utp_09];    % Test output of the data
    results = [results utp_10];    % Test with different tolerances
    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

  %% 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('d'), atest = false; end
        if ~io(3).plists.isparam('method'), atest = false; end
        % Check default value
        if ~isequal(io(3).plists.find('d'), 1.5), atest = false; end
        if ~isequal(io(3).plists.find('method'), 'spline'), atest = false; end
        % Check options
        if ~isequal(io(3).plists.getOptionsForParam('d'), {1.5}), atest = false; end
        if ~isequal(io(3).plists.getOptionsForParam('method'), {'nearest', 'linear', 'spline', 'cubic'}), 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 interpmissing method works with a vector of AOs as input.
  %
  % </TestDescription>
  function result = utp_02

    % <SyntaxDescription>
    %
    % Test that the interpmissing method works for a vector of AOs as input.
    % Known gaps at the position idx = 30 and 51
    %
    % </SyntaxDescription>

    try
      % <SyntaxCode>
      avec = [at1 at5 at6];
      out  = interpmissing(avec);
      % </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;
    if stest
      % <AlgoCode>
      % Check we have the correct number of outputs
      if numel(out) ~= numel(avec), atest = false; end
      % Check each output data
      for kk = 1:numel(avec)
        x = avec(kk).data.getX;
        % Gap at index position 30
        gap1   = x(30+1) - x(30) - 1/avec(kk).fs;
        gap1_t = ((1/avec(kk).fs : 1/avec(kk).fs : gap1) + x(30)).';
        % Gap at index position 51
        gap2   = x(51+1) - x(51) - 1/avec(kk).fs;
        gap2_t = ((1/avec(kk).fs : 1/avec(kk).fs : gap2) + x(51)).';
        % Create t
        t = [x(1:30); gap1_t; x(31:51); gap2_t; x(52:end)];
        % Interpolate the missing samples
        res = interp(avec(kk), plist('vertices', t));
        if ~isequal(out(kk).x, res.x), atest = false; end
        if ~isequal(out(kk).y, res.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 interpmissing method works with a matrix of AOs as input.
  %
  % </TestDescription>
  function result = utp_03

    % <SyntaxDescription>
    %
    % Test that the interpmissing method works for a matrix of AOs as input.
    % Known gaps at the position idx = 30 and 51
    %
    % </SyntaxDescription>

    try
      % <SyntaxCode>
      amat = [at1 at5 at6; at6 at5 at1];
      out  = interpmissing(amat);
      % </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;
    if stest
      % <AlgoCode>
      % Check we have the correct number of outputs
      if numel(out) ~= numel(amat), atest = false; end
      % Check each output data
      for kk = 1:numel(amat)
        x = amat(kk).data.getX;
        % Gap at index position 30
        gap1   = x(30+1) - x(30) - 1/amat(kk).fs;
        gap1_t = ((1/amat(kk).fs : 1/amat(kk).fs : gap1) + x(30)).';
        % Gap at index position 51
        gap2   = x(51+1) - x(51) - 1/amat(kk).fs;
        gap2_t = ((1/amat(kk).fs : 1/amat(kk).fs : gap2) + x(51)).';
        % Create t
        t = [x(1:30); gap1_t; x(31:51); gap2_t; x(52:end)];
        % Interpolate the missing samples
        res = interp(amat(kk), plist('vertices', t));
        if ~isequal(out(kk).x, res.x), atest = false; end
        if ~isequal(out(kk).y, res.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 interpmissing method works with a list of AOs as input.
  %
  % </TestDescription>
  function result = utp_04

    % <SyntaxDescription>
    %
    % Test that the interpmissing method works for a list of AOs as input.
    % Known gaps at the position idx = 30 and 51
    %
    % </SyntaxDescription>

    try
      % <SyntaxCode>
      out = interpmissing(at1,at5,at6);
      % </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;
    aoin  = [at1, at5, at6];
    if stest
      % <AlgoCode>
      % Check we have the correct number of outputs
      if numel(out) ~= 3, atest = false; end
      % Check each output data
      for kk = 1:numel(aoin)
        x = aoin(kk).data.getX;
        % Gap at index position 30
        gap1   = x(30+1) - x(30) - 1/aoin(kk).fs;
        gap1_t = ((1/aoin(kk).fs : 1/aoin(kk).fs : gap1) + x(30)).';
        % Gap at index position 51
        gap2   = x(51+1) - x(51) - 1/aoin(kk).fs;
        gap2_t = ((1/aoin(kk).fs : 1/aoin(kk).fs : gap2) + x(51)).';
        % Create t
        t = [x(1:30); gap1_t; x(31:51); gap2_t; x(52:end)];
        % Interpolate the missing samples
        res = interp(aoin(kk), plist('vertices', t));
        if ~isequal(out(kk).x, res.x), atest = false; end
        if ~isequal(out(kk).y, res.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 interpmissing method works with a mix of different shaped AOs as
  % input.
  %
  % </TestDescription>
  function result = utp_05

    % <SyntaxDescription>
    %
    % Test that the interpmissing method works with an input of matrices and vectors
    % and single AOs. Known gaps at the position idx = 30 and 51
    %
    % </SyntaxDescription>

    try
      % <SyntaxCode>
      out = interpmissing(at1,[at5 at6],at5,[at5 at1; at6 at1],at6);
      % </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  = [at1, reshape([at5 at6], 1, []), at5, reshape([at5 at1; at6 at1], 1, []), at6];
    if stest
      % <AlgoCode>
      % Check we have the correct number of outputs
      if numel(out) ~= 9, atest = false; end
      % Check each output data
      for kk = 1:numel(aoin)
        x = aoin(kk).data.getX;
        % Gap at index position 30
        gap1   = x(30+1) - x(30) - 1/aoin(kk).fs;
        gap1_t = ((1/aoin(kk).fs : 1/aoin(kk).fs : gap1) + x(30)).';
        % Gap at index position 51
        gap2   = x(51+1) - x(51) - 1/aoin(kk).fs;
        gap2_t = ((1/aoin(kk).fs : 1/aoin(kk).fs : gap2) + x(51)).';
        % Create t
        t = [x(1:30); gap1_t; x(31:51); gap2_t; x(52:end)];
        % Interpolate the missing samples
        res = interp(aoin(kk), plist('vertices', t));
        if ~isequal(out(kk).x, res.x), atest = false; end
        if ~isequal(out(kk).y, res.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 interpmissing method properly applies history.
  %
  % </TestDescription>
  function result = utp_06

    % <SyntaxDescription>
    %
    % Test that the result of applying the interpmissing method can be processed back
    % to an m-file.
    %
    % </SyntaxDescription>

    try
      % <SyntaxCode>
      % remove some samples
      ac   = ao(at5);
      out  = interpmissing(ac);
      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
    %    'interpmissing'.
    % 2) Check that the re-built object is the same as 'out'.
    %
    % </AlgoDescription>

    atest = true;
    if stest
      % <AlgoCode>
      % Check the last step in the history of 'out'
      if ~strcmp(out.hist.methodInfo.mname, 'interpmissing'), 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 interpmissing method can modify the input AO.
  %
  % </TestDescription>
  function result = utp_07

    % <SyntaxDescription>
    %
    % Test that the interpmissing 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).
    % Known gaps at the position idx = 30 and 51
    %
    % </SyntaxDescription>

    try
      % <SyntaxCode>
      % copy at1 to work with
      ain = ao(at1);
      % modify ain
      aout = ain.interpmissing();
      ain.interpmissing();
      % </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 interpmissing(at1).
    %
    % </AlgoDescription>

    atest = true;
    if stest
      % <AlgoCode>
      % Check that interpmissing modified the input by comparing to the copy
      if eq(ao(at1), ain, ple1), atest = false; end
      % Check that interpmissing doesn't modified the input for the function notation
      if ~eq(aout, ain, ple1), atest = false; end
      % Check that the modified input is the interpmissing value of the copy
      x = at1.data.getX;
      % Gap at index position 30
      gap1   = x(30+1) - x(30) - 1/at1.fs;
      gap1_t = ((1/at1.fs : 1/at1.fs : gap1) + x(30)).';
      % Gap at index position 51
      gap2   = x(51+1) - x(51) - 1/at1.fs;
      gap2_t = ((1/at1.fs : 1/at1.fs : gap2) + x(51)).';
      % Create t
      t = [x(1:30); gap1_t; x(31:51); gap2_t; x(52:end)];
      % Interpolate the missing samples
      res = interp(at1, plist('vertices', t));
      if ~isequal(ain.x, res.x), atest = false; end
      if ~isequal(ain.y, res.y), 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 interpmissing 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 = interpmissing(at5);
      out2 = interpmissing(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.y,2) ~= 1, atest = false; end
      if size(out2.data.y,1) ~= 1, 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 interpmissing 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] = interpmissing(at5, at6);
      o3  = interpmissing(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_09

  %% UTP_10

  % <TestDescription>
  %
  % Tests that the interpmissing method can change the tolerance for finding
  % missing samples.
  %
  % </TestDescription>
  function result = utp_10

    % <SyntaxDescription>
    %
    % Test that the interpmissing method works with a plist which changes the
    % tolerance. Known gaps at the position idx = 30 and 51 with the width of 40
    % and 60
    %
    % </SyntaxDescription>

    try
      % <SyntaxCode>
      pl1  = plist('d', 41); % This tolerance supress the first gap
      pl2  = plist('d', 61); % This tolerance supress all gaps
      out1 = interpmissing(at1, pl1);
      out2 = interpmissing(at1, pl2);
      mout1 = rebuild(out1);
      mout2 = rebuild(out2);
      % </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.
    % 3) Check that the re-built object is the same as 'out'.
    %
    % </AlgoDescription>

    atest = true;
    if stest
      % <AlgoCode>
      % Check each output data
      x = at1.data.getX;
      % Gap at index position 51
      gap2   = x(51+1) - x(51) - 1/at1.fs;
      gap2_t = ((1/at1.fs : 1/at1.fs : gap2) + x(51)).';
      % Create t
      t = [x(1:51); gap2_t; x(52:end)];
      % Interpolate the missing samples
      res = interp(at1, plist('vertices', t));
      % Depending to the tolerance have at1 only one gap
      if ~isequal(out1.x, res.x), atest = false; end
      if ~isequal(out1.y, res.y), atest = false; end
      % Depending to the tolerance have no gaps
      if ~isequal(out2.x, at1.x), atest = false; end
      if ~isequal(out2.y, at1.y), atest = false; end
      % Check the re-built object
      if ~eq(mout1, out1, ple2), atest = false; end
      if ~eq(mout2, out2, 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