Mercurial > hg > ltpda
diff m-toolbox/classes/@ao/std.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/std.m Wed Nov 23 19:22:13 2011 +0100 @@ -0,0 +1,91 @@ +% STD computes the standard deviation of the data in the AO. +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +% +% DESCRIPTION: STD computes the standard deviation of the data in the AO. +% +% CALL: ao_out = std(ao_in); +% ao_out = std(ao_in, pl); +% +% <a href="matlab:utils.helper.displayMethodInfo('ao', 'std')">Parameters Description</a> +% +% VERSION: $Id: std.m,v 1.43 2011/04/19 18:48:11 ingo Exp $ +% +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% + +function varargout = std(varargin) + + % Check if the method was called by another method + callerIsMethod = utils.helper.callerIsMethod; + + % Settings + operatorName = 'std'; + dxFcn = []; + + if callerIsMethod + in_names = {}; + else + % Collect input variable names + in_names = cell(size(varargin)); + for ii = 1:nargin,in_names{ii} = inputname(ii);end + + % Check if this is a call for the minfo object + if utils.helper.isinfocall(varargin{:}) + varargout{1} = getInfo(varargin{3}); + return + end + + end + + % Here we are forced to collect objects so that we can check that each ao + % is the correct type and shape for doing det. + [as, dummy, rest] = utils.helper.collect_objects(varargin, 'ao', in_names); + + % Check for the correct data objects: Throw an error for data2D objects. + as.checkDataType('data3D'); + + copyObjects = nargout>0; + + % Apply method to all AOs + [out, pl] = ao.applymethod(copyObjects, callerIsMethod, in_names, operatorName, dxFcn, @getInfo, @getDefaultPlist, varargin{:}); + + % set outputs + if isa(out, 'ao') + out = fixAxisData(out, pl); + % Clear errors + out.clearErrors(pl); + end + + % set outputs + varargout = utils.helper.setoutputs(nargout, out); + +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{:}); + % option + p = param({'option', 'See help std.'}, paramValue.DOUBLE_VALUE(0)); + plout.remove('option'); + plout.append(p); +end +