IMP logo
IMP Reference Guide  develop.45c11de31d,2024/03/27
The Integrative Modeling Platform
IMP.isd.Analysis.Analysis Class Reference

Class that produces analysis-related output, and is able to parse the output of a file produced by the Statistics class. More...

Detailed Description

Class that produces analysis-related output, and is able to parse the output of a file produced by the Statistics class.

Note
This class is only available in Python.

Definition at line 9 of file isd/Analysis.py.

Public Member Functions

def add_data
 adds data point to hierarchy More...
 
def create_entry
 adds a new entry to the hierarchy by parsing a title entry More...
 
def dump
 "dump float data from history h to file dest. More...
 
def histogram
 plots histogram of datum (cat,name) from hierarchy h, optionally specifying a range. More...
 
def plot
 plots datum (cat,name) from hierarchy h, optionally specifying a range. More...
 
def read_AMBER_stats
 reads an AMBER mden file and returns a History instance More...
 
def read_AMBER_variables
 reads an AMBER mden file and returns variables present in it More...
 
def read_stats
 reads a *_stats.txt file and returns a History instance More...
 
def read_variables
 reads a *_stats.txt file and returns variables present in it More...
 

Member Function Documentation

def IMP.isd.Analysis.Analysis.add_data (   self,
  h,
  lineno,
  colno,
  data 
)

adds data point to hierarchy

Definition at line 27 of file isd/Analysis.py.

def IMP.isd.Analysis.Analysis.create_entry (   self,
  h,
  lineno,
  el 
)

adds a new entry to the hierarchy by parsing a title entry

Definition at line 15 of file isd/Analysis.py.

def IMP.isd.Analysis.Analysis.dump (   self,
  h,
  dest,
  args 
)

"dump float data from history h to file dest.

args can be either strings corresponding to categories, or tuples corresponding to entries of a certain category. Only one counter will be output for the whole dump, it corresponds to the counter of the first entry's category. You can always specify additional counters if needed.

Definition at line 151 of file isd/Analysis.py.

def IMP.isd.Analysis.Analysis.histogram (   self,
  h,
  datums,
  kwargs 
)

plots histogram of datum (cat,name) from hierarchy h, optionally specifying a range.

To plot multiple data at the same time, add them sequentially.

Definition at line 139 of file isd/Analysis.py.

def IMP.isd.Analysis.Analysis.plot (   self,
  h,
  datums,
  kwargs 
)

plots datum (cat,name) from hierarchy h, optionally specifying a range.

To plot multiple data at the same time, add them sequentially. Takes x axis from the 'step' entry of the first datum. TODO.

Definition at line 123 of file isd/Analysis.py.

def IMP.isd.Analysis.Analysis.read_AMBER_stats (   self,
  statfile 
)

reads an AMBER mden file and returns a History instance

Definition at line 74 of file isd/Analysis.py.

def IMP.isd.Analysis.Analysis.read_AMBER_variables (   self,
  statfile 
)

reads an AMBER mden file and returns variables present in it

Definition at line 58 of file isd/Analysis.py.

def IMP.isd.Analysis.Analysis.read_stats (   self,
  statfile 
)

reads a *_stats.txt file and returns a History instance

Definition at line 97 of file isd/Analysis.py.

def IMP.isd.Analysis.Analysis.read_variables (   self,
  statfile 
)

reads a *_stats.txt file and returns variables present in it

Definition at line 39 of file isd/Analysis.py.


The documentation for this class was generated from the following file: