Home > classes > @ao > asin.m

asin

PURPOSE ^

ASIN overloads the asin method for Analysis objects.

SYNOPSIS ^

function varargout = asin (varargin)

DESCRIPTION ^

 ASIN overloads the asin method for Analysis objects.
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

 DESCRIPTION: ASIN overloads the asin operator for Analysis objects.
              Inverse sine result in radians.
              ASIN(ao) is the sine of the elements of ao.data.

 CALL:        ao_out = asin(ao_in);
              ao_out = asin(ao_in, pl);
              ao_out = asin(ao1, pl1, ao_vector, ao_matrix, pl2);

 PARAMETERS:  see help for data2D/applymethod for additional parameters

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

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

 VERSION:     $Id: asin.m,v 1.16 2008/09/05 11:05:28 ingo Exp $

 HISTORY:     07-05-2007 Diepholz
                 Creation

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

CROSS-REFERENCE INFORMATION ^

This function calls: This function is called by:

SUBFUNCTIONS ^

SOURCE CODE ^

0001 % ASIN overloads the asin method for Analysis objects.
0002 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
0003 %
0004 % DESCRIPTION: ASIN overloads the asin operator for Analysis objects.
0005 %              Inverse sine result in radians.
0006 %              ASIN(ao) is the sine of the elements of ao.data.
0007 %
0008 % CALL:        ao_out = asin(ao_in);
0009 %              ao_out = asin(ao_in, pl);
0010 %              ao_out = asin(ao1, pl1, ao_vector, ao_matrix, pl2);
0011 %
0012 % PARAMETERS:  see help for data2D/applymethod for additional parameters
0013 %
0014 % M-FILE INFO: Get information about this methods by calling
0015 %              >> ao.getInfo('asin')
0016 %
0017 %              Get information about a specified set-plist by calling:
0018 %              >> ao.getInfo('asin', 'None')
0019 %
0020 % VERSION:     $Id: asin.m,v 1.16 2008/09/05 11:05:28 ingo Exp $
0021 %
0022 % HISTORY:     07-05-2007 Diepholz
0023 %                 Creation
0024 %
0025 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
0026 
0027 function varargout = asin (varargin)
0028 
0029   % Check if this is a call for parameters
0030   if utils.helper.isinfocall(varargin{:})
0031     varargout{1} = getInfo(varargin{3});
0032     return
0033   end
0034 
0035   % Collect input variable names
0036   in_names = cell(size(varargin));
0037   for ii = 1:nargin,in_names{ii} = inputname(ii);end
0038 
0039   % Collect all AOs
0040   [as, ao_invars] = utils.helper.collect_objects(varargin(:), 'ao', in_names);
0041   pl              = utils.helper.collect_objects(varargin(:), 'plist', in_names);
0042 
0043   % Decide on a deep copy or a modify
0044   bs = copy(as, nargout);
0045 
0046   % Apply method to all AOs
0047   applymethod(bs, ao_invars, 'asin', pl, getDefaultPlist, getInfo);
0048 
0049   % Set output
0050   if nargout == 1
0051     varargout{1} = bs;
0052   end
0053 end
0054 
0055 %--------------------------------------------------------------------------
0056 % Get Info Object
0057 %--------------------------------------------------------------------------
0058 function ii = getInfo(varargin)
0059   if nargin == 1 && strcmpi(varargin{1}, 'None')
0060     sets = {};
0061     pl   = [];
0062   else
0063     sets = {'Default'};
0064     pl   = getDefaultPlist;
0065   end
0066   % Build info object
0067   ii = minfo(mfilename, 'ao', '', utils.const.categories.trig, '$Id: asin.m,v 1.16 2008/09/05 11:05:28 ingo Exp $', sets, pl);
0068 end
0069 
0070 %--------------------------------------------------------------------------
0071 % Get Default Plist
0072 %--------------------------------------------------------------------------
0073 function pl_default = getDefaultPlist()
0074   pl_default = plist('axis',  'y');
0075 end
0076

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