IMP logo
IMP Reference Guide  develop.031dafb4d2,2024/05/21
The Integrative Modeling Platform
IMP.pmi.output.ProcessOutput Class Reference

A class for reading stat files (either rmf or ascii v1 and v2) More...

Inherits object.

Detailed Description

A class for reading stat files (either rmf or ascii v1 and v2)

Note
This class is only available in Python.

Definition at line 935 of file output.py.

Public Member Functions

def get_fields
 Get the desired field names, and return a dictionary. More...
 

Member Function Documentation

def IMP.pmi.output.ProcessOutput.get_fields (   self,
  fields,
  filtertuple = None,
  filterout = None,
  get_every = 1,
  statistics = None 
)

Get the desired field names, and return a dictionary.

Namely, "fields" are the queried keys in the stat file (eg. ["Total_Score",...]) The returned data structure is a dictionary, where each key is a field and the value is the time series (ie, frame ordered series) of that field (ie, {"Total_Score":[Score_0,Score_1,Score_2,,...],....})

Parameters
fields(list of strings) queried keys in the stat file (eg. "Total_Score"....)
filteroutspecify if you want to "grep" out something from the file, so that it is faster
filtertuplea tuple that contains ("TheKeyToBeFiltered",relationship,value) where relationship = "<", "==", or ">"
get_everyonly read every Nth line from the file
statisticsif provided, accumulate statistics in an OutputStatistics object

Definition at line 1000 of file output.py.


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