diff testing/utp_1.1/utps/ao/utp_ao_cov.m @ 44:409a22968d5e default

Add unit tests
author Daniele Nicolodi <nicolodi@science.unitn.it>
date Tue, 06 Dec 2011 18:42:11 +0100
parents
children
line wrap: on
line diff
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/testing/utp_1.1/utps/ao/utp_ao_cov.m	Tue Dec 06 18:42:11 2011 +0100
@@ -0,0 +1,460 @@
+% UTP_AO_COV a set of UTPs for the ao/cov method
+%
+% M Hewitson 06-08-08
+%
+% $Id: utp_ao_cov.m,v 1.4 2009/08/07 10:05:39 hewitson Exp $
+%
+
+% <MethodDescription>
+%
+% The cov method of the ao class computes estimate covariance of data
+% streams.
+%
+% </MethodDescription>
+
+function results = utp_ao_cov(varargin)
+
+  % Check the inputs
+  if nargin == 0
+
+    % Some keywords
+    class   = 'ao';
+    mthd    = 'cov';
+
+    results = [];
+    disp('******************************************************');
+    disp(['****  Running UTPs for ' class '/' mthd]);
+    disp('******************************************************');
+
+    plts = plist('fs', '1', 'nsecs', 30, 'tsfcn', 'randn(size(t))');
+    plfs = plist('f', '1:30', 'fsfcn', 'randn(size(f))');
+    plxy = plist('x', '1:30', 'xyfcn', 'randn(size(x))');
+    at1 = ao(plts);
+    at1.setYunits('Hz^2');
+    at2 = ao(plfs);
+    at2.setYunits('Hz^-1');
+    at3 = ao(plxy);
+    at3.setYunits('km');
+    atvec = [at1, at2, at3];
+    atmat = [at1, at2, at3; at3, at2, at1];
+
+    % 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_11(mthd, [at1 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>
+
+    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 ~= 0, atest = false; end
+        % Check key
+        % Check default value
+        % Check options
+      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 cov method works with a vector of AOs as input.
+  %
+  % </TestDescription>
+  function result = utp_02
+
+    % <SyntaxDescription>
+    %
+    % Test that the cov method works for a vector of AOs as input.
+    %
+    % </SyntaxDescription>
+
+    try
+      % <SyntaxCode>
+      out = cov(atvec);
+      % </SyntaxCode>
+      stest = true;
+    catch err
+      disp(err.message)
+      stest = false;
+    end
+
+    % <AlgoDescription>
+    %
+    % 1) Check that the output is exact one Ao with cdata.
+    % 2) Check that each output AO contains the correct data.
+    %
+    % </AlgoDescription>
+
+    atest = true;
+    if stest
+      % <AlgoCode>
+      % Check we have the correct number of outputs
+      if numel(out) ~= 1, atest = false; end
+      if ~isa(out.data, 'cdata'), atest = false; end
+      % Check output data / units
+      res = [];
+      u   = unit();
+      for kk=1:numel(atvec)
+        res = [res atvec(kk).y];
+        u   = u * atvec(kk).yunits;
+      end
+      if ~eq(u, out.yunits), atest = false; end
+      if ~isequal(cov(res), out.y), 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>
+  %
+  % Tests that the cov method works with a matrix of AOs as input.
+  %
+  % </TestDescription>
+  function result = utp_03
+
+    % <SyntaxDescription>
+    %
+    % Test that the cov method works for a matrix of AOs as input.
+    %
+    % </SyntaxDescription>
+
+    try
+      % <SyntaxCode>
+      out = cov(atmat);
+      % </SyntaxCode>
+      stest = true;
+    catch err
+      disp(err.message)
+      stest = false;
+    end
+
+    % <AlgoDescription>
+    %
+    % 1) Check that the output is exact one Ao with cdata.
+    % 2) Check that each output AO contains the correct data.
+    %
+    % </AlgoDescription>
+
+    atest = true;
+    if stest
+      % <AlgoCode>
+      % Check we have the correct number of outputs
+      if numel(out) ~= 1, atest = false; end
+      if ~isa(out.data, 'cdata'), atest = false; end
+      % Check output data / units
+      res = [];
+      u   = unit();
+      for kk=1:numel(atmat)
+        res = [res atmat(kk).y];
+        u   = u * atmat(kk).yunits;
+      end
+      if ~eq(u, out.yunits), atest = false; end
+      if ~isequal(cov(res), out.y), atest = false; 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 cov method works with a list of AOs as input.
+  %
+  % </TestDescription>
+  function result = utp_04
+
+    % <SyntaxDescription>
+    %
+    % Tests that the cov method works with a list of AOs as input.
+    %
+    % </SyntaxDescription>
+
+    try
+      % <SyntaxCode>
+      out = cov(at1, at2, at3);
+      % </SyntaxCode>
+      stest = true;
+    catch err
+      disp(err.message)
+      stest = false;
+    end
+
+    % <AlgoDescription>
+    %
+    % 1) Check that the output is exact one Ao with cdata.
+    % 2) Check that each output AO contains the correct data.
+    %
+    % </AlgoDescription>
+
+    atest = true;
+    aoin  = [at1, at2, at3];
+    if stest
+      % <AlgoCode>
+      % Check we have the correct number of outputs
+      if numel(out) ~= 1, atest = false; end
+      if ~isa(out.data, 'cdata'), atest = false; end
+      % Check output data / units
+      res = [];
+      u   = unit();
+      for kk=1:numel(aoin)
+        res = [res aoin(kk).y];
+        u   = u * aoin(kk).yunits;
+      end
+      if ~eq(u, out.yunits), atest = false; end
+      if ~isequal(cov(res), out.y), 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 cov method works with a mix of different shaped AOs as
+  % input.
+  %
+  % </TestDescription>
+  function result = utp_05
+
+    % <SyntaxDescription>
+    %
+    % Tests that the cov method works with a mix of different shaped AOs as
+    % input.
+    %
+    % </SyntaxDescription>
+
+    try
+      % <SyntaxCode>
+      out = cov(at1, atmat, at2, atvec, at3);
+      % </SyntaxCode>
+      stest = true;
+    catch err
+      disp(err.message)
+      stest = false;
+    end
+
+    % <AlgoDescription>
+    %
+    % 1) Check that the output is exact one Ao with cdata.
+    % 2) Check that each output AO contains the correct data.
+    %
+    % </AlgoDescription>
+
+    atest = true;
+    aoin  = [at1, reshape(atmat, 1, []), at2, reshape(atvec, 1, []), at3];
+    if stest
+      % <AlgoCode>
+      % Check we have the correct number of outputs
+      if numel(out) ~= 1, atest = false; end
+      if ~isa(out.data, 'cdata'), atest = false; end
+      % Check output data / units
+      res = [];
+      u   = unit();
+      for kk=1:numel(aoin)
+        res = [res aoin(kk).y];
+        u   = u * aoin(kk).yunits;
+      end
+      if ~eq(u, out.yunits), atest = false; end
+      if ~isequal(cov(res), out.y), atest = false; 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 cov method properly applies history.
+  %
+  % </TestDescription>
+  function result = utp_06
+
+    % <SyntaxDescription>
+    %
+    % Test that the result of applying the cov method can be processed back.
+    %
+    % </SyntaxDescription>
+
+    try
+      % <SyntaxCode>
+      out  = cov(at1, at2, at3);
+      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
+    %    'cov'.
+    % 2) Check that the 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, 'cov'), atest = false; end
+      % The rebuilt object must be the same as 'out'
+      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>
+  %
+  % The cov method can not modify the input AO.
+  %
+  % </TestDescription>
+  function result = utp_07
+
+    % <SyntaxDescription>
+    %
+    % The cov method can not modify the input AO.
+    %
+    % </SyntaxDescription>
+
+    try
+      % <SyntaxCode>
+      % copy at1 to work with
+      amodi = ao(at1);
+      aeq   = ao(at1);
+      out = aeq.cov();
+      amodi.abs();
+      stest = false;
+      % </SyntaxCode>
+    catch err
+      stest = true;
+    end
+
+    % <AlgoDescription>
+    %
+    % 1) Nothing to test.
+    %
+    % </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
+
+end