OpenStructure
Functions
ost.stutil Namespace Reference

Functions

def FloatValueExtract
def Mean
def Median
def StdDev
def Min
def Max
def Correl
def Histogram

Function Documentation

def ost.stutil.Correl (   xs,
  ys 
)
Calculates the correlation coefficient between xs and ys as

  sum[(xi-<x>)*(yi-<y>)]
r=----------------------
        sx*sy
        
where <x>, <y> are the mean of dataset xs and ys, and, sx and sy are the 
standard deviations.

Definition at line 83 of file stutil.py.

def ost.stutil.FloatValueExtract (   func)
Decorator to wrap functions that take a list of float values. In addition to 
passing in a list of float values directly, it is possible to extract the 
values from attributes or generic properties.

Definition at line 4 of file stutil.py.

def ost.stutil.Histogram (   xs,
  bounds,
  num_bins 
)

Definition at line 110 of file stutil.py.

def ost.stutil.Max (   xs)

Definition at line 80 of file stutil.py.

def ost.stutil.Mean (   xs)
Calculate mean of dataset

Definition at line 42 of file stutil.py.

def ost.stutil.Median (   xs)
Calculate median of dataset

Definition at line 51 of file stutil.py.

def ost.stutil.Min (   xs)

Definition at line 76 of file stutil.py.

def ost.stutil.StdDev (   xs)
Calculate standard-deviation of dataset

          | sum[xi-<x>]^2 |
sigma=sqrt|---------------|
          |       n       |

Definition at line 64 of file stutil.py.