


STD overloads the std operator for Analysis objects. Compute the standard deviation.
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
DESCRIPTION: STD overloads the std operator for Analysis objects.
Compute the standard deviation.
STD(ao) is the standard deviation value of the elements in ao.data.
CALL: ao_out = std(ao_in);
ao_out = std(ao_in, dim);
ao_out = std(ao_in, FLAG, DIM); --> use the parameterlist
ao_out = std(ao_in, pl);
ao_out = std(ao1, pl1, ao_vector, ao_matrix, pl2);
POSSIBLE VALUES: ao_in = [ao2 ao3]
ao_in = ao_vector
ao_in = ao_matrix
PARAMETER LIST: <key> <value> <description>
'W' 0 of 1 represent the FLAG
'dim' 1 or 2 or 3 ... takes the std along the
dimension dim
tsdata fsdata xydata
'xdata' 't' 'f' 'x' compute the std of the x-axis
'ydata' 'x' 'xx' 'y' compute the std of the y-axis
The following call returns a parameter list object that contains the
default parameter values:
>> pl = std(ao, 'Params')
HISTORY: 23-05-2007 Diepholz
Creation
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%


0001 function ao_out = std (varargin) 0002 % STD overloads the std operator for Analysis objects. Compute the standard deviation. 0003 % 0004 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% 0005 % 0006 % DESCRIPTION: STD overloads the std operator for Analysis objects. 0007 % Compute the standard deviation. 0008 % STD(ao) is the standard deviation value of the elements in ao.data. 0009 % 0010 % CALL: ao_out = std(ao_in); 0011 % ao_out = std(ao_in, dim); 0012 % ao_out = std(ao_in, FLAG, DIM); --> use the parameterlist 0013 % ao_out = std(ao_in, pl); 0014 % ao_out = std(ao1, pl1, ao_vector, ao_matrix, pl2); 0015 % 0016 % POSSIBLE VALUES: ao_in = [ao2 ao3] 0017 % ao_in = ao_vector 0018 % ao_in = ao_matrix 0019 % 0020 % PARAMETER LIST: <key> <value> <description> 0021 % 'W' 0 of 1 represent the FLAG 0022 % 'dim' 1 or 2 or 3 ... takes the std along the 0023 % dimension dim 0024 % tsdata fsdata xydata 0025 % 'xdata' 't' 'f' 'x' compute the std of the x-axis 0026 % 'ydata' 'x' 'xx' 'y' compute the std of the y-axis 0027 % 0028 % The following call returns a parameter list object that contains the 0029 % default parameter values: 0030 % 0031 % >> pl = std(ao, 'Params') 0032 % 0033 % HISTORY: 23-05-2007 Diepholz 0034 % Creation 0035 % 0036 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% 0037 0038 VERSION = '$Id: std.m,v 1.9 2007/11/26 14:48:13 ingo Exp $'; 0039 ao_out = []; 0040 0041 %% Check if this is a call for parameters 0042 if nargin == 2 0043 if isa(varargin{1}, 'ao') && ischar(varargin{2}) 0044 in = char(varargin{2}); 0045 if strcmp(in, 'Params') 0046 ao_out = getDefaultPL(); 0047 return 0048 elseif strcmp(in, 'Version') 0049 ao_out = VERSION; 0050 return 0051 end 0052 end 0053 end 0054 0055 %% Collect input ao's, plist's and ao variable names 0056 in_names = {}; 0057 ps = plist(); 0058 for ii = 1:nargin 0059 in_names{end+1} = inputname(ii); 0060 0061 if isnumeric(varargin{ii}) 0062 ps = [ps plist(param('dim', varargin{ii}))]; 0063 end 0064 end 0065 0066 [ao_set, pl, invars] = collect_inputs(varargin, in_names); 0067 0068 pl = combine(pl, ps); 0069 0070 %% go through analysis objects 0071 for j=1:numel(ao_set) 0072 a = ao_set(j); 0073 0074 [h, std_data] = single_operation(a.data, 'std', pl); 0075 0076 %% Add the history from the ao object to the history 0077 h = set(h, 'inhists', [a.hist]); 0078 0079 %% Set the var_name to the history 0080 h = set(h, 'invars', cellstr(invars{j})); 0081 0082 % convert to cdata type 0083 std_x = []; 0084 std_y = []; 0085 0086 do_xdata = find(pl, 'xdata'); 0087 do_ydata = find(pl, 'ydata'); 0088 0089 %% Is no axis entry in the parameter list 0090 %% then set the default axis = xdata 0091 if isempty(do_xdata) && isempty(do_ydata) 0092 do_ydata = 'yes'; 0093 end 0094 0095 %% Get the operation result. It is stored in the individual axis 0096 pl_get_axis = plist([param('xdata', do_xdata) param('ydata', do_ydata)]); 0097 [std_x, std_y] = get_xy_values(std_data, pl_get_axis); 0098 0099 std_cdata = cdata([std_x std_y]); 0100 std_cdata = set (std_cdata, 'name', std_data.name); 0101 std_cdata = set (std_cdata, 'xunits', std_data.xunits); 0102 std_cdata = set (std_cdata, 'yunits', std_data.yunits); 0103 0104 %% create a new analysis objects 0105 new_ao = ao (std_cdata, h); 0106 new_ao = setnh(new_ao, 'name', sprintf('std(%s)',invars{j}) ); 0107 0108 ao_out = [ao_out new_ao]; 0109 0110 end 0111 0112 % Reshape the ouput to the same size of the input 0113 ao_out = reshape(ao_out, size(ao_set)); 0114 0115 %% Get default params 0116 function pl_default = getDefaultPL() 0117 0118 pl_default = plist([param('dim', '') 0119 param('W', []) 0120 param('xdata', '') 0121 param('ydata', '')]); 0122 0123 % END