Home > classes > @xyzdata > display.m

display

PURPOSE ^

DISPLAY overloads display functionality for xyzdata objects.

SYNOPSIS ^

function varargout = display(varargin)

DESCRIPTION ^

 DISPLAY overloads display functionality for xyzdata objects.
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

 DESCRIPTION: DISPLAY overloads display functionality for xyzdata objects.

 CALL:        txt    = display(xyzdata)

 INPUT:       xyzdata - an xyz data object

 OUTPUT:      txt    - cell array with strings to display the xyzdata object

 M-FILE INFO: Get information about this methods by calling
              >> xyzdata.getInfo('display')

              Get information about a specified set-plist by calling:
              >> xyzdata.getInfo('display', 'None')

 VERSION:     $Id: display.m,v 1.7 2008/09/04 15:29:32 ingo Exp $

 HISTORY:     24-12-2007 M Hewitson
                 Creation

%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

CROSS-REFERENCE INFORMATION ^

This function calls: This function is called by:

SUBFUNCTIONS ^

SOURCE CODE ^

0001 % DISPLAY overloads display functionality for xyzdata objects.
0002 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
0003 %
0004 % DESCRIPTION: DISPLAY overloads display functionality for xyzdata objects.
0005 %
0006 % CALL:        txt    = display(xyzdata)
0007 %
0008 % INPUT:       xyzdata - an xyz data object
0009 %
0010 % OUTPUT:      txt    - cell array with strings to display the xyzdata object
0011 %
0012 % M-FILE INFO: Get information about this methods by calling
0013 %              >> xyzdata.getInfo('display')
0014 %
0015 %              Get information about a specified set-plist by calling:
0016 %              >> xyzdata.getInfo('display', 'None')
0017 %
0018 % VERSION:     $Id: display.m,v 1.7 2008/09/04 15:29:32 ingo Exp $
0019 %
0020 % HISTORY:     24-12-2007 M Hewitson
0021 %                 Creation
0022 %
0023 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
0024 
0025 function varargout = display(varargin)
0026 
0027   %%% Check if this is a call for parameters
0028   if utils.helper.isinfocall(varargin{:})
0029     varargout{1} = getInfo(varargin{3});
0030     return
0031   end
0032 
0033   xyzdatas = utils.helper.collect_objects(varargin(:), 'xyzdata');
0034 
0035   txt = {};
0036 
0037   for i=1:numel(xyzdatas)
0038     xyz = xyzdatas(i);
0039     banner = sprintf('-------- xyzdata %02d ------------', i);
0040     txt{end+1} = banner;
0041 
0042     txt{end+1} = ' ';
0043 
0044     xdata = xyz.x;
0045     ydata = xyz.y;
0046     zdata = xyz.z;
0047     xinfo = whos('xdata');
0048     yinfo = whos('ydata');
0049     zinfo = whos('zdata');
0050 
0051     txt{end+1} = sprintf('     x:  [%d %d], %s', xinfo.size(1), xinfo.size(2), xinfo.class);
0052     txt{end+1} = sprintf('     y:  [%d %d], %s', yinfo.size(1), yinfo.size(2), yinfo.class);
0053     txt{end+1} = sprintf('     z:  [%d %d], %s', zinfo.size(1), zinfo.size(2), zinfo.class);
0054     txt{end+1} = sprintf('xunits:  %s', char(xyz.xunits));
0055     txt{end+1} = sprintf('yunits:  %s', char(xyz.yunits));
0056     txt{end+1} = sprintf('zunits:  %s', char(xyz.zunits));
0057 
0058     banner_end(1:length(banner)) = '-';
0059     txt{end+1} = banner_end;
0060 
0061     txt{end+1} = ' ';
0062   end
0063 
0064   if nargout == 0
0065     for ii=1:length(txt)
0066       disp(txt{ii});
0067     end
0068   elseif nargout == 1
0069     varargout{1} = txt;
0070   end
0071 
0072 end
0073 
0074 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
0075 %                               Local Functions                               %
0076 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
0077 
0078 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
0079 %
0080 % FUNCTION:    getInfo
0081 %
0082 % DESCRIPTION: Get Info Object
0083 %
0084 % HISTORY:     11-07-07 M Hewitson
0085 %                Creation.
0086 %
0087 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
0088 
0089 function ii = getInfo(varargin)
0090   if nargin == 1 && strcmpi(varargin{1}, 'None')
0091     sets = {};
0092     pl   = [];
0093   else
0094     sets = {'Default'};
0095     pl   = getDefaultPlist;
0096   end
0097   % Build info object
0098   ii = minfo(mfilename, 'xyzdata', '', utils.const.categories.output, '$Id: display.m,v 1.7 2008/09/04 15:29:32 ingo Exp $', sets, pl);
0099 end
0100 
0101 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
0102 %
0103 % FUNCTION:    getDefaultPlist
0104 %
0105 % DESCRIPTION: Get Default Plist
0106 %
0107 % HISTORY:     11-07-07 M Hewitson
0108 %                Creation.
0109 %
0110 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
0111 
0112 function plo = getDefaultPlist()
0113   plo = plist();
0114 end
0115

Generated on Mon 08-Sep-2008 13:18:47 by m2html © 2003