% UTP_AO_SELECT a set of UTPs for the ao/select method
%
% M Hewitson 06-08-08
%
% $Id: utp_ao_select.m,v 1.8 2010/08/18 15:45:12 ingo Exp $
%

% <MethodDescription>
%
% The select method of the ao class select particular samples from the
% input AOs and return new AOs with only those samples.
%
% </MethodDescription>

function results = utp_ao_select(varargin)

  % Check the inputs
  if nargin == 0

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

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

    % Test AOs
    [at1,at2,at3,at4,at5,at6,atvec,atmat] = get_test_objects_ao;

    % 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 input data shape == output data shape
    results = [results utp_09];    % Test output of the data
    results = [results utp_10];    % Test plist(sample)
    results = [results utp_11(mthd, at1, ple1, plist('SAMPLES', 1:10))];    % Test plotinfo doesn't disappear
    results = [results utp_12];    % Test that 'dx' and 'dy' are also selected
    results = [results utp_13];    % Test with setted t0

    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 ~= 2, atest = false; end
        % Check key
        if ~io(3).plists.isparam('samples'), atest = false; end
        if ~io(3).plists.isparam('axis'), atest = false; end
        % Check default value
        if ~isEmptyDouble(io(3).plists.find('samples')), atest = false; end
        if ~isequal(io(3).plists.find('axis'), 'x'), atest = false; end
        % Check options
        if ~isequal(io(3).plists.getOptionsForParam('samples'), {[]}), atest = false; end
        if ~isequal(io(3).plists.getOptionsForParam('axis'), {'x', 'y'}), 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 select method works with a vector of AOs as input.
  %
  % </TestDescription>
  function result = utp_02

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

    try
      % <SyntaxCode>
      sel = 1:30;
      out = select(atvec, sel);
      % </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 'atvec'
    % 2) Check that each output AO contains the correct data.
    %
    % </AlgoDescription>

    atest = true;
    TOL   = 1e-14;
    if stest
      % <AlgoCode>
      % Check we have the correct number of outputs
      if ~isequal(size(out), size(atvec)), atest = false; end
      % Check that the output have only the selected data
      for kk=1:numel(out)
        if any(abs(out(kk).x - atvec(kk).x(sel)) > TOL), atest = false; end
        if ~isequal(out(kk).y, atvec(kk).y(sel)), atest = false; 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 select method works with a matrix of AOs as input.
  %
  % </TestDescription>
  function result = utp_03

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

    try
      % <SyntaxCode>
      sel = [1 3 5 7 9];
      out = select(atmat, sel);
      % </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 'atmat'
    % 2) Check that each output AO contains the correct data.
    %
    % </AlgoDescription>

    atest = true;
    TOL   = 1e-14;
    if stest
      % <AlgoCode>
      % Check we have the correct number of outputs
      if ~isequal(size(out), size(atmat)), atest = false; end
      % Check that the output have only the selected data
      for kk=1:numel(out)
        if ~isa(out(kk).data, 'cdata')
          if any(abs(out(kk).x - atmat(kk).x(sel)) > TOL), atest = false; end
          if ~isequal(out(kk).y, atmat(kk).y(sel)), atest = false; end
        else
          if ~isequal(out(kk).y, atmat(kk).y(sel).'), atest = false; end
        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 select method works with a list of AOs as input.
  %
  % </TestDescription>
  function result = utp_04

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

    try
      % <SyntaxCode>
      sel = 30:45;
      out = select(at1,at2,at3,sel);
      % </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 AO contains the correct data.
    %
    % </AlgoDescription>

    atest = true;
    aoin  = [at1,at2,at3];
    TOL   = 1e-14;
    if stest
      % <AlgoCode>
      % Check we have the correct number of outputs
      if numel(out) ~= 3, atest = false; end
      % Check that the output have only the selected data
      for kk=1:numel(out)
        if ~isa(out(kk).data, 'cdata')
          if isa(out(kk).data, 'tsdata')
            % Add first the T0 of the tsdata
            t0off = (out(kk).t0.utc_epoch_milli - aoin(kk).t0.utc_epoch_milli)/1e3;
            if any(abs(out(kk).x + t0off - aoin(kk).x(sel)) > TOL), atest = false; end
          else
            if any(abs(out(kk).x - aoin(kk).x(sel)) > TOL), atest = false; end
          end
          if ~isequal(out(kk).y, aoin(kk).y(sel)), atest = false; end
        else
          if ~isequal(out(kk).y, aoin(kk).y(sel).'), atest = false; end
        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 select method works with a mix of different shaped AOs
  % as input.
  %
  % </TestDescription>
  function result = utp_05

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

    try
      % <SyntaxCode>
      sel = 2:9;
      out = select(at1,sel,atvec,at2,atmat,at3);
      % </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 AO contains the correct data.
    %
    % </AlgoDescription>

    atest = true;
    aoin  = [at1,reshape(atvec,1,[]),at2,reshape(atmat,1,[]),at3];
    TOL   = 1e-14;
    if stest
      % <AlgoCode>
      % Check we have the correct number of outputs
      if numel(out) ~= numel(aoin), atest = false; end
      % Check that the output have only the selected data
      for kk=1:numel(out)
        if ~isa(out(kk).data, 'cdata')
          if isa(out(kk).data, 'tsdata')
            % Add first the T0 of the tsdata
            t0off = (out(kk).t0.utc_epoch_milli - aoin(kk).t0.utc_epoch_milli)/1e3;
            if any(abs(out(kk).x + t0off - aoin(kk).x(sel)) > TOL), atest = false; end
          else
            if any(abs(out(kk).x - aoin(kk).x(sel)) > TOL), atest = false; end
          end
          if ~isequal(out(kk).y, aoin(kk).y(sel)), atest = false; end
        else
          if ~isequal(out(kk).y, aoin(kk).y(sel).'), atest = false; end
        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 select method properly applies history.
  %
  % </TestDescription>
  function result = utp_06

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

    try
      % <SyntaxCode>
      out  = select(at1, [30:70, 80:120]);
      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
    %    'select'.
    % 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, 'select'), 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>
  %
  % Tests that the select method can modify the input AO.
  %
  % </TestDescription>
  function result = utp_07

    % <SyntaxDescription>
    %
    % Test that the select method can modify the input AO by calling with
    % no output and that the method doesn't change the input of the
    % function notation (with a equal sign).
    %
    % </SyntaxDescription>

    try
      % <SyntaxCode>
      % copy at1 to work with
      sel   = 30:80;
      amodi = ao(at1);
      aeq   = ao(at1);
      out = aeq.select(sel);
      amodi.select(sel);
      % </SyntaxCode>
      stest = true;
    catch err
      disp(err.message)
      stest = false;
    end

    % <AlgoDescription>
    %
    % 1) Check that 'out' and 'aeq' are now different.
    % 2) Check that 'aeq' is not changed
    % 3) Check that the modified input is the selected value of the copy
    % 4) Check that out and amodi are the same
    %
    % </AlgoDescription>

    atest = true;
    TOL   = 1e-14;
    if stest
      % <AlgoCode>
      % Check that 'out' and 'aeq' are now different.
      if eq(out, aeq, ple2), atest = false; end
      % Check that 'aeq' is not changed
      if ~eq(aeq, ao(at1), ple1), atest = false; end
      % Check that the modified input is the selected value of the copy
      if ~isequal(at1.y(sel), amodi.y), atest = false; end
      t0off = (amodi.t0.utc_epoch_milli - at1.t0.utc_epoch_milli)/1e3;
      if any(abs(at1.x(sel) - (amodi.x+t0off))>TOL), atest = false; end
      % Check that out and amodi are the same
      if ~eq(out, amodi, ple1), atest = false; end
      % </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 select 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>
      sel  = [1, 4, 7, 1:30, 33, 6:70];
      out1 = select(at5, sel);
      out2 = select(at6, sel);
      % </SyntaxCode>
      stest = true;
    catch err
      disp(err.message)
      stest = false;
    end

    % <AlgoDescription>
    %
    % 1) Check that the shape of the data doesn't change.
    %
    % </AlgoDescription>

    atest = true;
    if stest
      % <AlgoCode>
      % Check the shape of the output data
      if size(out1.data.y,1) == 1, atest = false; end
      if size(out2.data.y,2) == 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 select 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>
      sel = 1:150;
      [o1, o2] = select(at5, at6, sel);
      o3  = select(at5, at6, sel);
      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

  %% UTP_10

  % <TestDescription>
  %
  % Test that the select method uses the plist to select the samples.
  %
  % </TestDescription>
  function result = utp_10

    % <SyntaxDescription>
    %
    % Test that the select method uses the plist to select the samples.
    %
    % </SyntaxDescription>

    try
      % <SyntaxCode>
      pl = plist('samples', 30:100);
      
      out1 = select(at1, pl);
      out2 = select(at1, pl, 110:150);
      out3 = select(at1, pl, 110:150, 200:220);

      mout1 = rebuild(out1);
      mout2 = rebuild(out2);
      mout3 = rebuild(out3);
      % </SyntaxCode>
      stest = true;
    catch err
      disp(err.message)
      stest = false;
    end

    % <AlgoDescription>
    %
    % 1) Check that the select method uses the samples in the plist
    % 2) Check that the select method uses the samples in the plist and input
    % 3) Check that the select method uses the samples in the plist and input
    % 4) Check that the re-built object is the same as in 'out[1..3]'.
    %
    % </AlgoDescription>

    atest = true;
    TOL   = 1e-14;
    if stest
      % <AlgoCode>
      % Check each output against the selected data samples of the input
      sl1 = 30:100;
      sl2 = 110:150;
      sl3 = 200:220;
      if ~isequal(at1.y(sl1), out1.y), atest = false; end
      t0off = (out1.t0.utc_epoch_milli - at1.t0.utc_epoch_milli)/1e3;
      if any(abs(at1.x(sl1) - (out1.x+t0off))>TOL), atest = false; end
      if ~isequal(at1.y([sl1 sl2]), out2.y), atest = false; end
      t0off = (out2.t0.utc_epoch_milli - at1.t0.utc_epoch_milli)/1e3;
      if any(abs(at1.x([sl1 sl2]) - (out2.x+t0off))>TOL), atest = false; end
      if ~isequal(at1.y([sl1 sl2 sl3]), out3.y), atest = false; end
      t0off = (out3.t0.utc_epoch_milli - at1.t0.utc_epoch_milli)/1e3;
      if any(abs(at1.x([sl1 sl2 sl3]) - (out3.x+t0off))>TOL), atest = false; end
      % Check the re-built objects
      if ~eq(mout1, out1, ple2), atest = false; end
      if ~eq(mout2, out2, ple2), atest = false; end
      if ~eq(mout3, out3, ple2), atest = false; end
      % </AlgoCode>
    else
      atest = false;
    end

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


  %% UTP_12

  % <TestDescription>
  %
  % Test that the select method also select the 'dx' and 'dy' values.
  %
  % </TestDescription>
  function result = utp_12

    % <SyntaxDescription>
    %
    % Test that the select method also select the 'dx' and 'dy' values.
    %
    % </SyntaxDescription>

    try
      % <SyntaxCode>
      % Create default values for 'dx' and 'dy'
      dx = randn(1000,1);
      dy = randn(1000,1);
      % tsdata
      a1 = at1.setDx(dx(1:at1.len));
      a1.setDy(dy(1:at1.len));
      % fsdata
      a2 = at2.setDx(dx(1:at2.len));
      a2.setDy(dy(1:at2.len));
      % xydata
      a3 = at3.setDx(dx(1:at3.len));
      a3.setDy(dy(1:a3.len));
      % cdata
      a4 = at4.setDy(dy(1:at4.len));
      
      % Test with only one value for 'dx' and 'dy'
      % tsdata
      a5 = at1.setDx(123);
      a5.setDy(123);

      sl = [20:40 70:90];
      out1 = select(a1, sl);
      out2 = select(a2, sl);
      out3 = select(a3, sl);
      out4 = select(a4, 3:7);
      out5 = select(a5, sl);

      mout1 = rebuild(out1);
      mout2 = rebuild(out2);
      mout3 = rebuild(out3);
      mout4 = rebuild(out4);
      mout5 = rebuild(out5);
      % </SyntaxCode>
      stest = true;
    catch err
      disp(err.message)
      stest = false;
    end

    % <AlgoDescription>
    %
    % 1) Check the output
    % 2) Check that the re-built object is the same as in 'out'.
    %
    % </AlgoDescription>

    atest = true;
    if stest
      % <AlgoCode>
      % Check the output
      ddx = dx(1:at1.len);
      ddy = dy(1:at1.len);
      if ~isequal(out1.dx, ddx(sl)); atest = false; end
      if ~isequal(out1.dy, ddy(sl)); atest = false; end
      ddx = dx(1:at1.len);
      ddy = dy(1:at2.len);
      if ~isequal(out2.dx, ddx(sl)); atest = false; end
      if ~isequal(out2.dy, ddy(sl)); atest = false; end
      ddx = dx(1:at3.len);
      ddy = dy(1:at3.len);
      if ~isequal(out3.dx, ddx(sl)); atest = false; end
      if ~isequal(out3.dy, ddy(sl)); atest = false; end
      ddy = dy(1:at4.len);
      if ~isequal(out4.dy, ddy(3:7)); atest = false; end
      if ~isequal(out5.dx, a5.dx); atest = false; end
      if ~isequal(out5.dy, a5.dy); atest = false; end
      % Check the re-built objects
      if ~eq(mout1, out1, ple2), atest = false; end
      if ~eq(mout2, out2, ple2), atest = false; end
      if ~eq(mout3, out3, ple2), atest = false; end
      if ~eq(mout4, out4, ple2), atest = false; end
      if ~eq(mout5, out5, ple2), atest = false; end
      % </AlgoCode>
    else
      atest = false;
    end

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

  %% UTP_13

  % <TestDescription>
  %
  % Test that the select method updates the t0.
  %
  % </TestDescription>
  function result = utp_13

    % <SyntaxDescription>
    %
    % Test that the select method updates the t0.
    %
    % </SyntaxDescription>

    try
      % <SyntaxCode>
      sl = 30:300;
      aa = at1.setT0('14:00:00');
      
      out = select(aa, sl);

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

    % <AlgoDescription>
    %
    % 1) Check the output
    % 2) Check that the re-built object is the same as in 'out'.
    %
    % </AlgoDescription>

    atest = true;
    TOL   = 1e-14;
    if stest
      % <AlgoCode>
      % Check each output against the selected data samples of the input
      toff = (out.t0.utc_epoch_milli - aa.t0.utc_epoch_milli)/1000;
      if ~isequal(aa.y(sl), out.y), atest = false; end
      if any(abs(aa.x(sl) - (out.x + toff))>TOL), atest = false; end
      % Check the re-built objects
      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_13
  
end