Home > Objects > @iData > mean.m

iFit/mean

PURPOSE ^

b = mean(s, dim) : mean value of iData object

SYNOPSIS ^

function b = mean(a, dim)

DESCRIPTION ^

 b = mean(s, dim) : mean value of iData object

   @iData/mean function to compute the mean value of objects
     mean(a,dim) averages along axis of rank dim. The axis is then removed.
       If dim=0, mean is done on all axes and the total is returned as a scalar value. 
       mean(a,1) accumulates on first dimension (columns)
     mean(a,-dim) averages on all axes except the dimension specified, i.e.
       the result is the mean projection of a along dimension dim.
       All other axes are removed.

 input:  a: object or array (iData/array of)
         dim: dimension to average (int)
 output: s: mean of elements (iData/scalar)
 ex:     c=mean(a);

 Version: Nov. 27, 2018
 See also iData, iData/std, iData/combine, iData/median

CROSS-REFERENCE INFORMATION ^

This function calls: This function is called by:
Generated on Tue 27-Nov-2018 10:56:24 by m2html © 2005. iFit (c) E.Farhi/ILL EUPL 1.1