% UTP_PZMODEL_TOMFIR a set of UTPs for the pzmodel/tomfir method
%
% M Hewitson 06-08-08
%
% $Id: utp_pzmodel_tomfir.m,v 1.3 2009/07/23 18:56:38 ingo Exp $
%

% <MethodDescription>
%
% The tomfir method of the pzmodel class approximates a pole/zero model with an
% FIR filter.
%
% </MethodDescription>

function results = utp_pzmodel_tomfir(varargin)

  % Check the inputs
  if nargin == 0

    % Some keywords
    class   = 'pzmodel';
    mthd    = 'tomfir';

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

    % Test PZMODELs
    [pz1, pz2, pz3, pz4, pz5, pzv, pzm] = get_test_objects_pzmodel;

    % 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 with additional plist with the key 'axis'
    results = [results utp_09];    % Test output of the data

    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 ~= 5, atest = false; end
        % Check key
        if ~io(3).plists.isparam('fs'), atest = false; end
        if ~io(3).plists.isparam('f1'), atest = false; end
        if ~io(3).plists.isparam('f2'), atest = false; end
        if ~io(3).plists.isparam('nf'), atest = false; end
        if ~io(3).plists.isparam('scale'), atest = false; end
        % Check default value
        if ~isequal(io(3).plists.find('fs'), 10), atest = false; end
        if ~isequal(io(3).plists.find('f1'), 0), atest = false; end
        if ~isequal(io(3).plists.find('f2'), 5), atest = false; end
        if ~isequal(io(3).plists.find('nf'), 1000), atest = false; end
        if ~isequal(io(3).plists.find('scale'), 'lin'), atest = false; end
        % Check options
        if ~isequal(io(3).plists.getOptionsForParam('fs'), {10}), atest = false; end
        if ~isequal(io(3).plists.getOptionsForParam('f1'), {0}), atest = false; end
        if ~isequal(io(3).plists.getOptionsForParam('f2'), {5}), atest = false; end
        if ~isequal(io(3).plists.getOptionsForParam('nf'), {1000}), atest = false; end
        if ~isequal(io(3).plists.getOptionsForParam('scale'), {'lin', 'log'}), 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 tomfir method works with a vector of PZMODEL objects as input.
  %
  % </TestDescription>
  function result = utp_02

    % <SyntaxDescription>
    %
    % Test that the tomfir method works for a vector of PZMODEL objects as input.
    %
    % </SyntaxDescription>

    try
      % <SyntaxCode>
      out = tomfir(pzv);
      % </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 'pzv'
    % 2) Check that each output PZMODEL object contains the correct data.
    %
    % </AlgoDescription>

    atest = true;
    if stest
      % <AlgoCode>
      % Check we have the correct number of outputs
      if ~isequal(size(out), size(pzv)), atest = false; end
      % Check each output against the single steps
      for kk=1:numel(out)
        r = resp(pzv(kk), pzmodel.getInfo('tomfir').plists);
        r.setFs(10);
        if ~eq(mfir(r), out(kk), ple3), atest = false; break; 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 tomfir method works with a matrix of PZMODEL objects as input.
  %
  % </TestDescription>
  function result = utp_03

    % <SyntaxDescription>
    %
    % Test that the tomfir method works for a matrix of PZMODEL objects as input.
    %
    % </SyntaxDescription>

    try
      % <SyntaxCode>
      out = tomfir(pzm);
      % </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 'pzm'
    % 2) Check that each output PZMODEL object contains the correct data.
    %
    % </AlgoDescription>

    atest = true;
    if stest
      % <AlgoCode>
      % Check we have the correct number of outputs
      if ~isequal(size(out), size(pzm)), atest = false; end
      % Check each output against the single steps
      for kk=1:numel(out)
        r = resp(pzm(kk), pzmodel.getInfo('tomfir').plists);
        r.setFs(10);
        if ~eq(mfir(r), out(kk), ple3), atest = false; break; 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 tomfir method works with a list of PZMODEL objects as input.
  %
  % </TestDescription>
  function result = utp_04

    % <SyntaxDescription>
    %
    % Test that the tomfir method works for a list of PZMODEL objects as input.
    %
    % </SyntaxDescription>

    try
      % <SyntaxCode>
      out = tomfir(pz1,pz2,pz3);
      % </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 PZMODEL object contains the correct data.
    %
    % </AlgoDescription>

    atest = true;
    pzin  = [pz1,pz2,pz3];
    if stest
      % <AlgoCode>
      % Check we have the correct number of outputs
      if numel(out) ~= 3, atest = false; end
      % Check each output against the single steps
      for kk=1:numel(out)
        r = resp(pzin(kk), pzmodel.getInfo('tomfir').plists);
        r.setFs(10);
        if ~eq(mfir(r), out(kk), ple3), atest = false; break; 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 tomfir method works with a mix of different shaped PZMODEL objects as
  % input.
  %
  % </TestDescription>
  function result = utp_05

    % <SyntaxDescription>
    %
    % Test that the tomfir method works with an input of matrices and vectors
    % and single PZMODEL objects.
    %
    % </SyntaxDescription>

    try
      % <SyntaxCode>
      out = tomfir(pz1,pzv,pz2,pzm,pz3);
      % </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 PZMODEL object contains the correct data.
    %
    % </AlgoDescription>

    atest = true;
    pzin  = [pz1,reshape(pzv,1,[]),pz2,reshape(pzm,1,[]),pz3];
    if stest
      % <AlgoCode>
      % Check we have the correct number of outputs
      if numel(out) ~= (numel(pzin)), atest = false; end
      % Check each output against the single steps
      for kk=1:numel(out)
        r = resp(pzin(kk), pzmodel.getInfo('tomfir').plists);
        r.setFs(10);
        if ~eq(mfir(r), out(kk), ple3), atest = false; break; 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 tomfir method properly applies history.
  %
  % </TestDescription>
  function result = utp_06

    % <SyntaxDescription>
    %
    % Test that the result of applying the tomfir method can be processed back.
    %
    % </SyntaxDescription>

    try
      % <SyntaxCode>
      out  = tomfir(pz5);
      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
    %    'tomfir'.
    % 2) Check that re-built object is the same object as the input.
    %
    % </AlgoDescription>

    atest = true;
    if stest
      % <AlgoCode>
      % Check the last step in the history of 'out'
      if ~strcmp(out.hist.methodInfo.mname, 'tomfir'), atest = false; end
      % Run 'test.m' and check the result
      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 tomfir method can modify the input PZMODEL object.
  %
  % </TestDescription>
  function result = utp_07

    % <SyntaxDescription>
    %
    % Test that the tomfir method can not modify the input PZMODEL object .
    % The method must throw an error for the modifier call.
    %
    % </SyntaxDescription>

    % <SyntaxCode>
    try
      ain.tomfir();
      stest = false;
    catch err
      stest = true;
    end
    % </SyntaxCode>

    % <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>
  %
  % Control the method with a plist.
  %
  % </TestDescription>
  function result = utp_08

    % <SyntaxDescription>
    %
    % Test that the tomfir method use the different values in a plist.
    %
    % </SyntaxDescription>

    try
      % <SyntaxCode>
      fs = 5;
      f2 = fs/2;
      pl = plist('fs', fs, 'f1', 0, 'f2', f2, 'nf', 100);
      out  = tomfir(pz5, pl);
      mout = rebuild(out);
      % </SyntaxCode>
      stest = true;
    catch err
      disp(err.message)
      stest = false;
    end

    % <AlgoDescription>
    %
    % 1) Check the output
    % 2) Check the re-built object
    %
    % </AlgoDescription>

    atest = true;
    if stest
      % <AlgoCode>
      % Check the output
      if ~isa(out, 'mfir'), atest = false; end
      if out.fs ~= fs, atest = false; end
      % Check the rebuilt 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_08

  %% UTP_09

  % <TestDescription>
  %
  % Check that the tomfir 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] = tomfir(pz5, pz4);
      o3  = tomfir(pz5, pz4);
      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

end