OpenStructure
Functions
ost.stutil Namespace Reference

Functions

def Mean (xs)
 
def Median (xs)
 
def StdDev (xs)
 
def Min (xs)
 
def Max (xs)
 
def Correl (xs, ys)
 
def Histogram (xs, bounds, num_bins)
 

Function Documentation

◆ Correl()

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 41 of file stutil.py.

◆ Histogram()

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

Definition at line 68 of file stutil.py.

◆ Max()

def ost.stutil.Max (   xs)

Definition at line 38 of file stutil.py.

◆ Mean()

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

Definition at line 3 of file stutil.py.

◆ Median()

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

Definition at line 11 of file stutil.py.

◆ Min()

def ost.stutil.Min (   xs)

Definition at line 35 of file stutil.py.

◆ StdDev()

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

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

Definition at line 24 of file stutil.py.