IMP logo
IMP Reference Guide  2.5.0
The Integrative Modeling Platform
IMP.pmi.io.CrossLinkData Class Reference

A class for storing groups of crosslinks. More...

Inherits object.

Detailed Description

A class for storing groups of crosslinks.

Acts like a dictionary where keys are unique IDs and values are CrossLinks Equivalent (using objects instead of dicts) to a data structure like so: data[1030] = [ { 'r1': {'molecule':'A','residue_index':5}, 'r2': {'molecule':'B','residue_index':100}, 'Score': 123 }, { 'r1': {'molecule':'C','residue_index':63}, 'r2': {'molecule':'D','residue_index':94}, 'Score': 600 } ]

Note
This class is only available in Python.

Definition at line 323 of file pmi/io/__init__.py.

Public Member Functions

def __init__
 Setup a CrossLinkData object. More...
 
def add_cross_link
 Add a crosslink. More...
 

Constructor & Destructor Documentation

def IMP.pmi.io.CrossLinkData.__init__ (   self)

Setup a CrossLinkData object.

Definition at line 336 of file pmi/io/__init__.py.

Member Function Documentation

def IMP.pmi.io.CrossLinkData.add_cross_link (   self,
  unique_id,
  kws1,
  kws2,
  score 
)

Add a crosslink.

They are organized by their unique_ids.

Parameters
unique_idThe id is used to group crosslinks that are alternatives
kws1A dictionary of selection keywords for the first residue
kws2A dictionary of selection keywards for the second residue
scoreA score that might be used later for filtering
Note
The dictionaries can contain any Selection argument like molecule or residue_index

Definition at line 345 of file pmi/io/__init__.py.


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