IMP logo
IMP Reference Guide  2.21.0
The Integrative Modeling Platform
IMP.mmcif.util.Writer Class Reference

Convert one or more IMP Models and/or RMF frames to mmCIF or BinaryCIF. More...

Inherits object.

Detailed Description

Convert one or more IMP Models and/or RMF frames to mmCIF or BinaryCIF.

Models can be added by calling add_model. The final output is collected in a python-ihm ihm.System object, as the system attribute, and can be written out using the python-ihm API or with the convenience write method.

This class is still in development and does not yet convert all IMP data to IHM mmCIF/BinaryCIF.

Note
This class is only available in Python.

Definition at line 44 of file mmcif/util.py.

Public Member Functions

def add_model
 Add information to the system from an IMP Model. More...
 
def add_rmf
 Add information to the system from a single frame in an RMF file. More...
 
def report
 Use python-ihm to print a summary report of the IHM system. More...
 
def write
 Write out the IHM system to a named mmCIF or BinaryCIF file. More...
 

Member Function Documentation

def IMP.mmcif.util.Writer.add_model (   self,
  hiers,
  restraints,
  name = None,
  states = None,
  ensembles = None 
)

Add information to the system from an IMP Model.

Multiple IHM Models (coordinate sets) may be created (one per state per hierarchy). All IHM models in a state are given the same name and are added to the given IHM Ensemble for that state (or placed in a new Ensemble if not given). Only coordinates for the given state names (or all states, if not given) are added. The IHM Ensembles containing the new models are returned.

Definition at line 71 of file mmcif/util.py.

def IMP.mmcif.util.Writer.add_rmf (   self,
  filename,
  name = None,
  frame = 0,
  states = None,
  ensembles = None 
)

Add information to the system from a single frame in an RMF file.

Definition at line 276 of file mmcif/util.py.

def IMP.mmcif.util.Writer.report (   self,
  fh = sys.stdout 
)

Use python-ihm to print a summary report of the IHM system.

Definition at line 297 of file mmcif/util.py.

def IMP.mmcif.util.Writer.write (   self,
  filename 
)

Write out the IHM system to a named mmCIF or BinaryCIF file.

Definition at line 288 of file mmcif/util.py.


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