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

A class to store the selection commands for a single crosslink. More...

Inherits object.

Detailed Description

A class to store the selection commands for a single crosslink.

Note
This class is only available in Python.

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

Public Member Functions

def __init__
 Add a crosslink. More...
 
def get_selection
 Return a list of atom pairs (particles) for this crosslink. More...
 

Constructor & Destructor Documentation

def IMP.pmi.io.CrossLink.__init__ (   self,
  unique_id,
  r1,
  r2,
  score 
)

Add a crosslink.

Parameters
unique_idThe id is used to group crosslinks that are alternatives
r1A dictionary of selection keywords for the first residue
r2A 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 273 of file pmi/io/__init__.py.

Member Function Documentation

def IMP.pmi.io.CrossLink.get_selection (   self,
  mh,
  kwargs 
)

Return a list of atom pairs (particles) for this crosslink.

Found by selecting everything with r1 and r2 then returning the cartesian product.

Note
you may want to provide some atom specifiers like atom_type=IMP.atom.AtomType("CA")
Parameters
mhThe hierarchy to select from
kwargsAny additional selection arguments

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


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