Trees       Indices       Help   
2016-2 Schrodinger Python API
Package schrodinger :: Package analysis :: Module enrichment :: Class StatisticalSummary
[hide private]
[frames] | no frames]

Class StatisticalSummary


Container class to store summary metrics describing an array of
numerical values.

API example:
------------
values = [x/1000 for x in range(1, 1001)]
stat_summary = StatisticalSummary(
    'test',
    numpy.array(values)
)
print stat_summary.mean 
>> 0.50
print stat_summary.std
>> 0.288
Instance Methods [hide private]
 
__init__(self, identifier, values, histogram_range=(0.0, 1.0), histogram_bins=10)
Properties [hide private]
  identifier
  count
Number of items in the original value array.
  mean
Mean of the original value array.
  std
Standard deviation of the original value array.
  median
Second quartile of the original value array.
  min
Minimum value of the original value array.
  min_index
Index of the minimum value of the original value array.
  max
Maximum value of the original value array.
  max_index
Index of the maximum value of the original value array.
  first_quartile
First quartile of the original value array.
  third_quartile
Third quartile of the original value array.
  histogram
Numpy histogram of the original value array.
  bin_edges
Numpy histogram bin edges of the original value array.
Method Details [hide private]

__init__(self, identifier, values, histogram_range=(0.0, 1.0), histogram_bins=10)
(Constructor)

 
Parameters:
  • identifier (string) - Arbitrary string key.
  • values (numpy array) - Array of similary values to summarize.
  • histogram_bins - Number of bins for the histogram. Default is 10.
  • histogram_range (tuple) - Min, max tuple for the histogram range. Default is (0.0, 1.0).

Property Details [hide private]

identifier

Get Method:
unreachable.identifier(self)

count

Number of items in the original value array.

Get Method:
unreachable.count(self) - Number of items in the original value array.

mean

Mean of the original value array.

Get Method:
unreachable.mean(self) - Mean of the original value array.

std

Standard deviation of the original value array.

Get Method:
unreachable.std(self) - Standard deviation of the original value array.

median

Second quartile of the original value array.

Get Method:
unreachable.median(self) - Second quartile of the original value array.

min

Minimum value of the original value array.

Get Method:
unreachable.min(self) - Minimum value of the original value array.

min_index

Index of the minimum value of the original value array.

Get Method:
unreachable.min_index(self) - Index of the minimum value of the original value array.

max

Maximum value of the original value array.

Get Method:
unreachable.max(self) - Maximum value of the original value array.

max_index

Index of the maximum value of the original value array.

Get Method:
unreachable.max_index(self) - Index of the maximum value of the original value array.

first_quartile

First quartile of the original value array.

Get Method:
unreachable.first_quartile(self) - First quartile of the original value array.

third_quartile

Third quartile of the original value array.

Get Method:
unreachable.third_quartile(self) - Third quartile of the original value array.

histogram

Numpy histogram of the original value array.

Get Method:
unreachable.histogram(self) - Numpy histogram of the original value array.

bin_edges

Numpy histogram bin edges of the original value array.

Get Method:
unreachable.bin_edges(self) - Numpy histogram bin edges of the original value array.

   Trees       Indices       Help   
2016-2 Schrodinger Python API
Generated by Epydoc 3.0.1 on Tue Apr 26 05:41:42 2016 http://epydoc.sourceforge.net