% UTP_AO_HETERODYNE a set of UTPs for the ao/heterodyne method
%
% M Nofrarias 19-12-08
%
% $Id: utp_ao_heterodyne.m,v 1.8 2010/07/08 08:49:37 mauro Exp $
%

% <MethodDescription>
%
% The hetrodyne method mixes the input ao at the specified frequency
%
% </MethodDescription>

function results = utp_ao_heterodyne(varargin)
  
  % Check the inputs
  if nargin == 0
    
    % Some keywords
    class   = 'ao';
    mthd    = 'heterodyne';
    
    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_07];    % Test functionality, no downsample
    results = [results utp_08];    % Test functionality, downsampling

    results = [results utp_11(mthd, at1, ple1, plist('f0', 1))];    % 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')
        %%% 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 ~= 7, atest = false; end
        % Check key
        if ~io(3).plists.isparam('f0'),      atest = false; end
        if ~io(3).plists.isparam('t0'),      atest = false; end
        if ~io(3).plists.isparam('quad'),    atest = false; end
        if ~io(3).plists.isparam('bw'),      atest = false; end
        if ~io(3).plists.isparam('lp'),      atest = false; end
        if ~io(3).plists.isparam('filter'),  atest = false; end
        if ~io(3).plists.isparam('ds'),      atest = false; end
        % Check default value
        if ~isEmptyDouble(io(3).plists.find('f0')),       atest = false; end
        if ~isequal(io(3).plists.find('t0'), 0),          atest = false; end
        if ~strcmp(io(3).plists.find('quad'), 'cos'),     atest = false; end
        if ~isEmptyDouble(io(3).plists.find('bw')),       atest = false; end
        if ~isequal(io(3).plists.find('lp'), 'yes'),      atest = false; end
        if ~isEmptyDouble(io(3).plists.find('filter')),   atest = false;  end
        if ~isequal(io(3).plists.find('ds'), 'yes'),      atest = false; end
        % Check options
        if ~isequal(io(3).plists.getOptionsForParam('f0'), {[]}), atest = false; end
        if ~isequal(io(3).plists.getOptionsForParam('t0'), {0}), atest = false; end
        if ~isequal(io(3).plists.getOptionsForParam('quad'), {'sin', 'cos'}), atest = false; end
        if ~isequal(io(3).plists.getOptionsForParam('bw'), {[]}), atest = false; end
        if ~isequal(io(3).plists.getOptionsForParam('lp'), {'yes', 'no'}), atest = false; end
        if ~isequal(io(3).plists.getOptionsForParam('filter'), {[]}), atest = false; end
        if ~isequal(io(3).plists.getOptionsForParam('ds'), {'yes', 'no'}), 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 heterodyne method works with a vector of AOs as input.
  %
  % </TestDescription>
  function result = utp_02
    
    % <SyntaxDescription>
    %
    % Test that the heterodyne method works for a vector of AOs as input.
    %
    % </SyntaxDescription>
    
    % <SyntaxCode>
    try
      avec = [at1 at5 at6];
      pl = plist('f0',1);
      out  = heterodyne(avec,pl);
      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 heterodyne method works with a matrix of AOs as input.
  %
  % </TestDescription>
  function result = utp_03
    
    % <SyntaxDescription>
    %
    % Test that the heterodyne method works for a matrix of AOs as input.
    %
    % </SyntaxDescription>
    
    % <SyntaxCode>
    try
      amat = [at1 at5 at6; at5 at6 at1];
      pl = plist('f0',1);
      out  = heterodyne(amat,pl);
      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 heterodyne method works with a list of AOs as input.
  %
  % </TestDescription>
  function result = utp_04
    
    % <SyntaxDescription>
    %
    % Test that the heterodyne method works for a list of AOs as input.
    %
    % </SyntaxDescription>
    
    % <SyntaxCode>
    try
      pl = plist('f0',1);
      out = heterodyne(at1,at5,at6,pl);
      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 heterodyne method works with a mix of different shaped AOs as
  % input.
  %
  % </TestDescription>
  function result = utp_05
    
    % <SyntaxDescription>
    %
    % Test that the heterodyne method works with an input of matrices and vectors
    % and single AOs.
    %
    % </SyntaxDescription>
    
    % <SyntaxCode>
    try
      pl = plist('f0',1);
      out = heterodyne(at1,[at5 at6],at5,[at5 at1; at6 at1],at6,pl);
      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 heterodyne method properly applies history.
  %
  % </TestDescription>
  function result = utp_06
    
    % <SyntaxDescription>
    %
    % Test that the result of applying the heterodyne method can be processed back
    % to an m-file.
    %
    % </SyntaxDescription>
    
    % <SyntaxCode>
    try
      pl   = plist('f0',1);
      out  = heterodyne(at5,pl);
      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
    %    'heterodyne'.
    % 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, 'heterodyne'), 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
  
  %% UTP_07
  
  % <TestDescription>
  %
  % Tests the heterodyne method functionality.
  %
  % </TestDescription>
  function result = utp_07
    
    % <SyntaxDescription>
    %
    %  Build reference signal, mixed signal and heterodyne the 2nd to obtain the first
    %  Downsample is set to 'no' 
    %
    % </SyntaxDescription>
    
    % <SyntaxCode>
    try
      % generate reference ao
      fs    = 50;
      fhet = 5;
      nsecs = 1000;
      pl = plist(...
        'tsfcn', '(1 + sin(2*pi*0.01*t))', ...
        'fs', fs, ...
        'nsecs', nsecs);
      a1 = ao(pl);
      % generate reference ao at f_heterodyne
      pl = plist('tsfcn', '(1 + sin(2*pi*0.01*t))','fs', fhet, 'nsecs', nsecs);
      a1h = ao(pl);
      % generate same ao mixed and noisy
      pl = plist('tsfcn', ...
        '(1 + sin(2*pi*0.01*t)) .* cos(2*pi*5*t)',...
        'fs', fs, 'nsecs', nsecs);
      a2 = ao(pl);
      % compute heterodyne
      a2h = heterodyne(a2,plist('f0', fhet, 'bw', fhet,'ds','no'));
      stest = true;
    catch err
      disp(err.message)
      stest = false;
    end
    % </SyntaxCode>
    
    % <AlgoDescription>
    %
    %  Test that we can recover the initial signal after heterodyne up to 
    %  a numerical error given by tol  
    %
    % </AlgoDescription>
    atest = false;
    % <AlgoCode>
    if stest
      tol = 1e-5; % numerical tolerance
      trans = 150; % samples out of test at the beginning and end due to transient
      if all(abs(a2h.y(1+trans:end-trans) - a1.y(1+trans:end-trans) ) < tol)
        atest = true;
      else
        atest = false;
      end
    end
    % </AlgoCode>
    
    % Return a result structure
    result = utp_prepare_result(atest, stest, dbstack, mfilename);
  end % END UTP_07

  %% UTP_08
  
  % <TestDescription>
  %
  % Tests the heterodyne method functionality.
  %
  % </TestDescription>
  function result = utp_08
    
    % <SyntaxDescription>
    %
    %  Build reference signal, mixed signal and heterodyne the 2nd to obtain the first
    %  Downsample is set to 'yes' 
    %
    % </SyntaxDescription>
    
    % <SyntaxCode>
    try
      % generate reference ao
      fs    = 50;
      fhet = 5;
      nsecs = 1000;
      pl = plist(...
        'tsfcn', '(1 + sin(2*pi*0.01*t))', ...
        'fs', fs, ...
        'nsecs', nsecs);
      a1 = ao(pl);
      % generate reference ao at f_heterodyne
      pl = plist('tsfcn', ...
        '(1 + sin(2*pi*0.01*t))','fs', fhet, 'nsecs', nsecs);
      a1h = ao(pl);
      % generate same ao mixed and noisy
      pl = plist('tsfcn', ...
        '(1 + sin(2*pi*0.01*t)) .* cos(2*pi*5*t)',...
        'fs', fs, 'nsecs', nsecs);
      a2 = ao(pl);
      % compute heterodyne
      a2h = heterodyne(a2,plist('f0', fhet, 'bw', fhet,'ds','yes'));
      stest = true;
    catch err
      disp(err.message)
      stest = false;
    end
    % </SyntaxCode>
    
    % <AlgoDescription>
    %
    %  Test that we can recover the initial signal after heterodyne up to 
    %  a numerical error given by tol   
    %
    % </AlgoDescription>
    atest = false;
    % <AlgoCode>
    if stest
      tol = 1e-5; % numerical tolerance
      trans = 15; % samples out of test at the beginning and end due to transient
      if all(abs(a2h.y(1+trans:end-trans)-a1h.y(1+trans:end-trans)) < tol)
        atest = true;
      else
        atest = false;
      end
    end
    % </AlgoCode>
    
    % Return a result structure
    result = utp_prepare_result(atest, stest, dbstack, mfilename);
  end % END UTP_08

end