statf.mBack to Contents<< Prev |  Next >> 

statf
Statistics of a vector/scalar field

Description
STAT = statf(F) returns a structure that contains statistics of the 
vector/scalar field F.  F is a structure (or structure array) of fields 
as obtained by loadvec (vector field) or vec2scal (scalar field). 
If F is a scalar field, STAT contains the following fields: 
  n:         number of nonzero elements (used in the computation) 
  mean, std, rms:  mean, standard deviation and rms. 
  zeros:     number of zero elements. 
  mom:       non-centered moments, <s^n> 
  momabs:    non-centered absolute moments, <|s^n|> 
  cmom:      centered moments, <(s-<s>)^n> 
  cmomabs:   centered absolute moments, <|s-<s>|^n> 
  skewness:  normalized 3rd order non-centered moment. 
  flatness:  normalized 4th order non-centered moment. 
  skewnessc: normalized 3rd order centered moment. 
  skewnessc: normalized 4th order centered moment. 
  history:   remind for which field statf has been called. 
 
For the "centered" quantities, the brackets <> means spatial and 
ensemble average over the whole fields. 
 
STAT = statf(F,MAXORDER) specifies the maximum order for the moments. 
MAXORDER=6 is used by default. 
 
If F is a vector field, use [STATX,STATY] = statf(F), where STATX and 
STATY are the statistics for each component of the vector field. 
 
If the scalar fields contain 0 (zero) values, they are considered as 
erroneous and are not included into the computations. 
 
Examples:    statrot=statf(vec2scal(filterf(loadset,1),'rot')); 
 
F. Moisy & C. Morize 
Revision: 1.20,  Date: 2005/10/13 
 
See Also
loadvec, vec2scal. 

 Previous: spaverfNext: statvec_disp 

Help file generated by m2html 1.06