Home > Objects > @iData > std.m



[half_width, center] = std(s, dim) : standard deviation of iData


function [s, f] = std(a, dim)


 [half_width, center] = std(s, dim) : standard deviation of iData

   @iData/std function to compute the standard deviation of objects, that is
     their gaussian half width (second moment). Optionally, the distribution  
     center (first moment) can be returned as well.
   std(a, dim) computes standard deviation along axis of rank 'dim'.
     When omitted, dim is set to 1.
   std(a, -dim)
     Using a negative dimension will subtract minimum signal value to signal
       before computation of std, that is remove background. This may be
       needed to avoid an imaginary result.
   std(a, 0) computes std(Signal) and mean(Signal).

 input:  a: object or array (iData/array of)
         dim: dimension to use. Negative dim subtract background (int/array)
 output: half_width: standard deviation (scalar/array)
         center:     center of distribution (scalar/array)
 ex:     a=iData(peaks); c=std(a);

 Version: Aug. 22, 2017
 See also iData, iData/median, iData/mean


This function calls: This function is called by:
Generated on Tue 22-Aug-2017 11:03:30 by m2html © 2005. iFit (c) E.Farhi/ILL EUPL 1.1