diff m-toolbox/classes/@ao/phase.m @ 0:f0afece42f48

Import.
author Daniele Nicolodi <nicolodi@science.unitn.it>
date Wed, 23 Nov 2011 19:22:13 +0100
parents
children
line wrap: on
line diff
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/m-toolbox/classes/@ao/phase.m	Wed Nov 23 19:22:13 2011 +0100
@@ -0,0 +1,71 @@
+% PHASE is the phase operator for analysis objects.
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+%
+% DESCRIPTION: PHASE is the phase operator for analysis objects.
+%              Uses utils.math.phase() to compute the phase angle.
+%
+% CALL:        ao_out = phase(ao_in);
+%              ao_out = phase(ao_in, pl);
+%
+% PARAMETERS:  see help for data2D/applymethod for additional parameters
+%
+% <a href="matlab:utils.helper.displayMethodInfo('ao', 'phase')">Parameters Description</a>
+%
+% VERSION:     $Id: phase.m,v 1.34 2011/04/19 18:48:11 ingo Exp $
+%
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+
+function varargout = phase(varargin)
+  
+  % Check if the method was called by another method
+  callerIsMethod = utils.helper.callerIsMethod;
+  
+  % Settings
+  operatorName = 'utils.math.phase';
+  dxFcn = @(x,dx)atan2(abs(dx),abs(x))*180/pi;
+  
+  if callerIsMethod
+    in_names = {};
+  else
+    % Collect input variable names
+    in_names = cell(size(varargin));
+    for ii = 1:nargin,in_names{ii} = inputname(ii);end
+  end
+  
+  copyObjects = nargout>0;
+  [bs, pl] = ao.applymethod(copyObjects, callerIsMethod, in_names, operatorName, dxFcn, @getInfo, @getDefaultPlist, varargin{:});
+  
+  if isa(bs, 'ao')
+    % Set units
+    setUnitsForAxis(bs, pl, 'deg');
+  end
+  
+  % set outputs
+  varargout = utils.helper.setoutputs(nargout, bs);
+  
+end
+
+%--------------------------------------------------------------------------
+% Get Info Object
+%--------------------------------------------------------------------------
+function ii = getInfo(varargin)
+  ii = minfo.getInfoAxis(mfilename, @getDefaultPlist, varargin);
+end
+
+%--------------------------------------------------------------------------
+% Get Default Plist
+%--------------------------------------------------------------------------
+
+function plout = getDefaultPlist(set)
+  persistent pl;
+  persistent lastset;
+  if ~exist('pl', 'var') || isempty(pl) || ~strcmp(lastset, set)
+    pl = buildplist(set);
+    lastset = set;
+  end
+  plout = pl;
+end
+
+function plout = buildplist(varargin)
+  plout = plist.getDefaultAxisPlist(varargin{:});
+end