% UTP_AO_LTFE a set of UTPs for the ao/ltfe method
%
% M Hewitson 06-08-08
%
% $Id: utp_ao_ltfe.m,v 1.25 2011/07/22 12:29:58 mauro Exp $
%

% <MethodDescription>
%
% The ltfe method of the ao class computes the transfer function between two
% time-series AOs on a log-frequency axis.
%
% </MethodDescription>

function results = utp_ao_ltfe(varargin)
  
  % Check the inputs
  if nargin == 0
    
    % Some keywords
    class   = 'ao';
    mthd    = 'ltfe';
    
    results = [];
    disp('******************************************************');
    disp(['****  Running UTPs for ' class '/' mthd]);
    disp('******************************************************');
    
    % Test AOs
    [at1,at2,at3,at4,at5,at6] = eval(['get_test_objects_' class]);
    
    % Exception list for the UTPs:
    [ple1,ple2,ple3,ple4,ple5,ple6] = get_test_ples();
    
    % Get default window from the preferences
    prefs = getappdata(0, 'LTPDApreferences');
    defaultWinType = char(prefs.getMiscPrefs.getDefaultWindow);
    
    % Run the tests
    results = [results utp_01];    % getInfo call
    results = [results utp_02];    % Vector input          (only with two objects)
    results = [results utp_03];    % Matrix input          (not possible)
    results = [results utp_04];    % List input            (only with two objects)
    results = [results utp_05];    % Test with mixed input (not possible)
    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_11(mthd, [at1 at1], ple1)];    % Test plotinfo doesn't disappear
    results = [results utp_17];    % Test units handling: Ltfe
    results = [results utp_30];    % Special cases: same input
    
    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 ~= 9, atest = false; end
        % Check key
        if ~io(3).plists.isparam('kdes'), atest = false; end
        if ~io(3).plists.isparam('jdes'), atest = false; end
        if ~io(3).plists.isparam('lmin'), atest = false; end
        if ~io(3).plists.isparam('win'), atest = false; end
        if ~io(3).plists.isparam('olap'), atest = false; end
        if ~io(3).plists.isparam('order'), atest = false; end
        if ~io(3).plists.isparam('psll'), atest = false; end
        if ~io(3).plists.isparam('times'), atest = false; end
        if ~io(3).plists.isparam('split'), atest = false; end
        % Check default value
        if ~isequal(io(3).plists.find('kdes'), 100), atest = false; end
        if ~isequal(io(3).plists.find('jdes'), 1000), atest = false; end
        if ~isequal(io(3).plists.find('lmin'), 0), atest = false; end
        if ~strcmpi(io(3).plists.find('win'), defaultWinType), atest = false; end
        if ~isequal(io(3).plists.find('olap'), -1), atest = false; end
        if ~isequal(io(3).plists.find('order'), 0), atest = false; end
        if ~isequal(io(3).plists.find('psll'), 200), atest = false; end
        if ~isEmptyDouble(io(3).plists.find('times')), atest = false; end
        if ~isEmptyDouble(io(3).plists.find('split')), atest = false; end
        % Check options
        if ~isequal(io(3).plists.getOptionsForParam('kdes'), {100}), atest = false; end
        if ~isequal(io(3).plists.getOptionsForParam('jdes'), {1000}), atest = false; end
        if ~isequal(io(3).plists.getOptionsForParam('lmin'), {0}), atest = false; end
        if ~isequal(io(3).plists.getOptionsForParam('win'), specwin.getTypes), atest = false; end
        if ~isequal(io(3).plists.getOptionsForParam('olap'), {-1}), atest = false; end
        if ~isequal(io(3).plists.getOptionsForParam('order'), {-1 0 1 2 3 4 5 6 7 8 9}), atest = false; end
        if ~isequal(io(3).plists.getOptionsForParam('psll'), {200}), atest = false; end
        if ~isequal(io(3).plists.getOptionsForParam('times'), {[]}), atest = false; end
        if ~isequal(io(3).plists.getOptionsForParam('split'), {[]}), 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 ltfe method works with a vector of AOs as input. (only
  % with two objects in the vector)
  %
  % </TestDescription>
  function result = utp_02
    
    % <SyntaxDescription>
    %
    % Test that the ltfe method works for a vector of AOs as input.
    %
    % </SyntaxDescription>
    
    try
      % <SyntaxCode>
      avec = [at1 at5];
      out  = ltfe(avec);
      % </SyntaxCode>
      stest = true;
    catch err
      disp(err.message)
      stest = false;
    end
    
    % <AlgoDescription>
    %
    % 1) Check that the number of elements in 'out' is equal to 1.
    %
    % </AlgoDescription>
    
    atest = true;
    if stest
      % <AlgoCode>
      % Check we have the correct number of outputs
      if numel(out) ~= 1, atest = false; 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>
  %
  % Test that the ltfe method doesn't work for a matrix of AOs as input.
  %
  % </TestDescription>
  function result = utp_03
    
    % <SyntaxDescription>
    %
    % Test that the ltfe method doesn't work for a matrix of AOs as input.
    %
    % </SyntaxDescription>
    
    try
      % <SyntaxCode>
      amat = [at1 at5 at6; at5 at6 at1];
      out  = ltfe(amat);
      % </SyntaxCode>
      stest = false;
    catch err
      stest = true;
    end
    
    % <AlgoDescription>
    %
    % 1) Nothing to check.
    %
    % </AlgoDescription>
    
    atest = true;
    if stest
      % <AlgoCode>
      % </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 ltfe method works with a list of AOs as input.
  %
  % </TestDescription>
  function result = utp_04
    
    % <SyntaxDescription>
    %
    % Test that the ltfe method works for a list of AOs as input.
    %
    % </SyntaxDescription>
    
    try
      % <SyntaxCode>
      out = ltfe(at1,at5);
      % </SyntaxCode>
      stest = true;
    catch err
      disp(err.message)
      stest = false;
    end
    
    % <AlgoDescription>
    %
    % 1) Check that the number of elements in 'out' is equal to 1.
    %
    % </AlgoDescription>
    
    atest = true;
    if stest
      % <AlgoCode>
      % Check we have the correct number of outputs
      if numel(out) ~= 1, 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 ltfe method doesn't work with a mix of different shaped
  % AOs as input.
  %
  % </TestDescription>
  function result = utp_05
    
    % <SyntaxDescription>
    %
    % Test that the ltfe method doesn't work with an input of matrices and
    % vectors and single AOs.
    %
    % </SyntaxDescription>
    
    try
      % <SyntaxCode>
      out = ltfe(at1,[at5 at6],at5,[at5 at1; at6 at1],at6);
      stest = false;
      % </SyntaxCode>
    catch err
      stest = true;
    end
    
    % <AlgoDescription>
    %
    % 1) Nothing to check
    %
    % </AlgoDescription>
    
    atest = true;
    if stest
      % <AlgoCode>
      % </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 ltfe method properly applies history.
  %
  % </TestDescription>
  function result = utp_06
    
    % <SyntaxDescription>
    %
    % Test that the result of applying the ltfe method can be processed back
    % to an m-file.
    %
    % </SyntaxDescription>
    
    try
      % <SyntaxCode>
      out = ltfe(at5,at6);
      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
    %    'ltfe'.
    % 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, 'ltfe'), 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 ltfe method can not modify the input AO.
  %
  % </TestDescription>
  function result = utp_07
    
    % <SyntaxDescription>
    %
    % Test that the ltfe method can not modify the input AO.
    % The method must throw an error for the modifier call.
    %
    % </SyntaxDescription>
    
    try
      % <SyntaxCode>
      % copy at1 to work with
      ain = ao(at1);
      % modify ain
      ain.ltfe(at5);
      % </SyntaxCode>
      stest = false;
    catch err
      stest = true;
    end
    
    % <AlgoDescription>
    %
    % 1) Nothing to check.
    %
    % </AlgoDescription>
    
    atest = true;
    if stest
      % <AlgoCode>
      % </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 the shape of the output.
  %
  % </TestDescription>
  function result = utp_08
    
    % <SyntaxDescription>
    %
    % Test that the ltfe 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 = ltfe(at5, at6);
      out2 = ltfe(at6, at5);
      % </SyntaxCode>
      stest = true;
    catch err
      disp(err.message)
      stest = false;
    end
    
    % <AlgoDescription>
    %
    % 1) Check that the shpe of the output 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 ltfe method pass back the output objects to a list of
  % output variables or to a single variable.
  %
  % </TestDescription>
  function result = utp_09
    
    % <SyntaxDescription>
    %
    % This test is not longer necessary because the ltfe method pass back
    % always only one object.
    %
    % </SyntaxDescription>
    
    try
      % <SyntaxCode>
      % </SyntaxCode>
      stest = true;
    catch err
      disp(err.message)
      stest = false;
    end
    
    % <AlgoDescription>
    %
    % 1) Nothing to check
    %
    % </AlgoDescription>
    
    atest = true;
    if stest
      % <AlgoCode>
      % </AlgoCode>
    else
      atest = false;
    end
    
    % Return a result structure
    result = utp_prepare_result(atest, stest, dbstack, mfilename);
  end % END UTP_09
  
  %% UTP_17
  
  % <TestDescription>
  %
  % Tests handling of units:
  % 1) white noise produced from normal pdf, with a given mean value and
  % sigma (distribution's 1st and 2nd orders)
  % 2) white noise produced from normal pdf, with a given mean value and
  % sigma (distribution's 1st and 2nd orders)
  % 3) ltfe of the white noise series
  % 4) compares the units of the input and output
  %
  
  % </TestDescription>
  function result = utp_17
    
    % <SyntaxDescription>
    %
    % 1) Prepare the test tsdata:
    %   white noise from normal distribution + offset
    % 2) Assign a random unit
    % 3) Prepare the test tsdata:
    %   white noise from normal distribution + offset
    % 4) Assign a random unit
    % 5) ltfe of the white noise
    %
    % </SyntaxDescription>
    
    % <SyntaxCode>
    try
      
      % Build time-series test data
      fs = 1;
      nsecs = 86400;
      sigma_distr_1 = 4.69e-12;
      mu_distr_1 = -5.11e-14;
      sigma_distr_2 = 6.04e-9;
      mu_distr_2 = 1.5e-10;
      
      % White noise
      type = 'Normal';
      
      a_n = ao(plist('waveform', 'noise', ...
        'type', type, 'fs', fs, 'nsecs', nsecs, 'sigma', sigma_distr_1));
      a_const = ao(mu_distr_1);
      a_1 = a_n + a_const;
      
      a_n = ao(plist('waveform', 'noise', ...
        'type', type, 'fs', fs, 'nsecs', nsecs, 'sigma', sigma_distr_2));
      a_const = ao(mu_distr_2);
      a_2 = a_n + a_const;
      
      % Set units and prefix from those supported
      unit_list = unit.supportedUnits;
      % remove the first empty unit '' from the list, because then is it
      % possible that we add a prefix to an empty unit
      unit_list = unit_list(2:end);
      prefix_list = unit.supportedPrefixes;
      a_1.setYunits(unit([cell2mat(utils.math.randelement(prefix_list,1)) cell2mat(utils.math.randelement(unit_list,1))]));
      a_2.setYunits(unit([cell2mat(utils.math.randelement(prefix_list,1)) cell2mat(utils.math.randelement(unit_list,1))]));
      
      % Evaluate the ltfe of the time-series data
      win = specwin('BH92');
      olap = win.rov;
      detrend = 0;
      
      T = ltfe(a_1,a_2,plist('Win', win.type, 'olap', olap, 'order', detrend));
      
      stest = true;
      
    catch err
      disp(err.message)
      stest = false;
    end
    % </SyntaxCode>
    
    % <AlgoDescription>
    %
    % 1) Check that (calculated ltfe yunits) equals [1/Hz]
    
    % </AlgoDescription>
    
    % <AlgoCode>
    atest = true;
    
    if stest
      if ne(T.yunits, a_2.yunits ./ a_1.yunits) || ne(T.xunits, unit('Hz'))
        atest = false;
      end
    else
      atest = false;
    end
    % </AlgoCode>
    
    % Return a result structure
    result = utp_prepare_result(atest, stest, dbstack, mfilename);
  end % END UTP_17
  
  %% UTP_30
  
  % <TestDescription>
  %
  % Tests handling of special cases:
  % 1) white noise produced from normal pdf, with a given mean value and
  % sigma (distribution's 1st and 2nd orders)
  % 2) the same noise series
  % 3) ltfe of the white noise series
  % 4) compares the output to unity
  %
  
  % </TestDescription>
  function result = utp_30
    
    % <SyntaxDescription>
    %
    % 1) Prepare the test tsdata:
    %   white noise from normal distribution + offset
    % 2) Assign a random unit
    % 3) Prepare the test tsdata:
    %   the same data as 1) and 2)
    % 4) ltfe of the series
    %
    % </SyntaxDescription>
    
    % <SyntaxCode>
    try
      
      % Build time-series test data
      fs = 1;
      nsecs = 86400;
      sigma_distr_1 = 4.69e-12;
      mu_distr_1 = -5.11e-14;
      
      % White noise
      type = 'Normal';
      
      a_n = ao(plist('waveform', 'noise', ...
        'type', type, 'fs', fs, 'nsecs', nsecs, 'sigma', sigma_distr_1));
      a_const = ao(mu_distr_1);
      a_1 = a_n + a_const;
      
      % Set units and prefix from those supported
      unit_list = unit.supportedUnits;
      % remove the first empty unit '' from the list, because then is it
      % possible that we add a prefix to an empty unit
      unit_list = unit_list(2:end);
      prefix_list = unit.supportedPrefixes;
      a_1.setYunits(unit([cell2mat(utils.math.randelement(prefix_list,1)) cell2mat(utils.math.randelement(unit_list,1))]));
      
      % Build the second object as a copy of the first
      a_2 = a_1;
      
      % Evaluate the ltfe of the time-series data
      win = specwin('BH92');
      olap = win.rov;
      detrend = 0;
      
      T = ltfe(a_1,a_2,plist('Win', win.type, 'olap', olap, 'order', detrend));
      
      stest = true;
      
    catch err
      disp(err.message)
      stest = false;
    end
    % </SyntaxCode>
    
    % <AlgoDescription>
    %
    % 1) Check that calculated ltfe equals 1
    
    % </AlgoDescription>
    
    % <AlgoCode>
    atest = true;
    
    if stest
      if sum(ne(T.y, 1))
        atest = false;
      end
    else
      atest = false;
    end
    % </AlgoCode>
    
    % Return a result structure
    result = utp_prepare_result(atest, stest, dbstack, mfilename);
  end % END UTP_30
  
end
