% UTP_AO_DFT a set of UTPs for the ao/dft method
%
% M Hewitson 06-08-08
%
% $Id: utp_ao_dft.m,v 1.13 2009/09/20 16:51:33 hewitson Exp $
%

% <MethodDescription>
%
% The dft method of the ao class computes the discrete fourier transform of
% time-series AOs.
%
% </MethodDescription>

function results = utp_ao_dft(varargin)

  % Check the inputs
  if nargin == 0

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

    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('f', 3, '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, at1, 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;
    % Compute DFT
    f = pli.find('f');
    fs   = in.data.fs;
    N    = length(in.y);
    J    = -2*pi*1i.*[0:N-1]/fs;
    dfts = zeros(size(f));
    for ss = 1:length(f)
      dfts(ss) = exp(f(ss)*J)*in.y;
    end
    if ~isequal(in.fs, out.fs), atest = false; end
    if ~isequal(f,           out.x),  atest = false; end
    if ~isequal(dfts,        out.y),  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 ~= 1, atest = false; end
        % Check key
        if ~io(3).plists.isparam('f'), atest = false; end
        % Check default value
        if ~isequal(io(3).plists.find('f'), -1), atest = false; end
        % Check options
        if ~isequal(io(3).plists.getOptionsForParam('f'), {-1}), 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

end