% UTP_AO_SPECTROGRAM a set of UTPs for the ao/spectrogram method
%
% M Hewitson 06-08-08
%
% $Id: utp_ao_spectrogram.m,v 1.10 2010/09/18 06:51:58 mauro Exp $
%

% <MethodDescription>
%
% The spectrogram method of the ao class computes the spectrogram of time-series AOs.
%
% </MethodDescription>

function results = utp_ao_spectrogram(varargin)

  % Check the inputs
  if nargin == 0

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

    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];    % 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_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>

    % <SyntaxCode>
    try
      % 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
      stest = true;
    catch err
      disp(err.message)
      stest = false;
    end
    % </SyntaxCode>

    % <AlgoDescription>
    %
    % 1) Check that getInfo call returned an minfo object in all cases.
    % 2) Check that all plists have the correct parameters.
    %
    % </AlgoDescription>

    % <AlgoCode>
    atest = true;
    if stest
      % check we have minfo objects
      if isa(io, 'minfo')
        prefs = getappdata(0, 'LTPDApreferences');
        defaultWinType = char(prefs.getMiscPrefs.getDefaultWindow);
        
        %%% SET 'None'
        pn = 1;
        if ~isempty(io(pn).sets), atest = false; end
        if ~isempty(io(pn).plists), atest = false; end
        %%% Check all Sets
        pn = 2;
        if ~any(strcmpi(io(pn).sets, 'Default')), atest = false; end
        if numel(io(pn).plists) ~= numel(io(pn).sets), atest = false; end
        %%%%%%%%%%   SET 'Default'
        pn = 3;
        if io(pn).plists.nparams ~= 3, atest = false; end
        % Check key
        if ~io(pn).plists.isparam('win'), atest = false; end
        if ~io(pn).plists.isparam('nolap'), atest = false; end
        if ~io(pn).plists.isparam('nfft'), atest = false; end
        % Check default value
        if ~strcmpi(io(pn).plists.find('win'), defaultWinType), atest = false; end
        if ~isequal(io(pn).plists.find('nolap'), -1), atest = false; end
        if ~isequal(io(pn).plists.find('nfft'), -1), atest = false; end
        % Check options
        if ~isequal(io(pn).plists.getOptionsForParam('win'), specwin.getTypes), atest = false; end
        if ~isequal(io(pn).plists.getOptionsForParam('nolap'), {-1}), atest = false; end
        if ~isequal(io(pn).plists.getOptionsForParam('nfft'), {-1}), atest = false; end
      end
    else
      atest = false;
    end
    % </AlgoCode>

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

  %% UTP_02

  % <TestDescription>
  %
  % Tests that the spectrogram method works with a vector of AOs as input.
  %
  % </TestDescription>
  function result = utp_02

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

    % <SyntaxCode>
    try
      avec = [at1 at5 at6];
      out  = spectrogram(avec);
      stest = true;
    catch err
      disp(err.message)
      stest = false;
    end
    % </SyntaxCode>

    % <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>

    % <AlgoCode>
    atest = true;
    if stest
      % Check we have the correct number of outputs
      if numel(out) ~= numel(avec), atest = false; end
    else
      atest = false;
    end
    % </AlgoCode>

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

  %% UTP_03

  % <TestDescription>
  %
  % Tests that the spectrogram method works with a matrix of AOs as input.
  %
  % </TestDescription>
  function result = utp_03

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

    % <SyntaxCode>
    try
      amat = [at1 at5 at6; at5 at6 at1];
      out  = spectrogram(amat);
      stest = true;
    catch err
      disp(err.message)
      stest = false;
    end
    % </SyntaxCode>

    % <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>

    % <AlgoCode>
    atest = true;
    if stest
      % Check we have the correct number of outputs
      if numel(out) ~= numel(amat), atest = false; end
    else
      atest = false;
    end
    % </AlgoCode>

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

  %% UTP_04

  % <TestDescription>
  %
  % Tests that the spectrogram method works with a list of AOs as input.
  %
  % </TestDescription>
  function result = utp_04

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

    % <SyntaxCode>
    try
      out = spectrogram(at1,at5,at6);
      stest = true;
    catch err
      disp(err.message)
      stest = false;
    end
    % </SyntaxCode>

    % <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>

    % <AlgoCode>
    atest = true;
    if stest
      % Check we have the correct number of outputs
      if numel(out) ~= 3, atest = false; end
    else
      atest = false;
    end
    % </AlgoCode>

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

  %% UTP_05

  % <TestDescription>
  %
  % Tests that the spectrogram method works with a mix of different shaped AOs as
  % input. 
  %
  % </TestDescription>
  function result = utp_05

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

    % <SyntaxCode>
    try
      out = spectrogram(at1,[at5 at6],at5,[at5 at1; at6 at1],at6);
      stest = true;
    catch err
      disp(err.message)
      stest = false;
    end
    % </SyntaxCode>

    % <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>

    % <AlgoCode>
    atest = true;
    if stest
      % Check we have the correct number of outputs
      if numel(out) ~= 9, atest = false; end
    else
      atest = false;
    end
    % </AlgoCode>

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

  % <TestDescription>
  %
  % Tests that the spectrogram method properly applies history.
  %
  % </TestDescription>
  function result = utp_06

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

    % <SyntaxCode>
    try
      out  = spectrogram(at5);
      mout = rebuild(out);
      stest = true;
    catch err
      disp(err.message)
      stest = false;
    end
    % </SyntaxCode>

    % <AlgoDescription>
    %
    % 1) Check that the last entry in the history of 'out' corresponds to
    %    'spectrogram'.
    % 2) Check that the re-built object is the same object as 'out'.
    %
    % </AlgoDescription>

    % <AlgoCode>
    atest = true;
    if stest
      % Check the last step in the history of 'out'
      if ~strcmp(out.hist.methodInfo.mname, 'spectrogram'), atest = false; end
      % Check the re-built object
      if ~eq(mout, out, ple2), atest = false; end
    else
      atest = false;
    end
    % </AlgoCode>

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