IMP logo
IMP Reference Guide  develop.cc86c9801d,2022/11/22
The Integrative Modeling Platform
IMP.pmi.restraints.basic.ResidueProteinProximityRestraint Class Reference

Restrain residue/residues to bind to unknown location in a target. More...

Inherits RestraintBase.

Detailed Description

Restrain residue/residues to bind to unknown location in a target.

Note
This class is only available in Python.

Definition at line 449 of file restraints/basic.py.

Public Member Functions

def __init__
 Constructor. More...
 
def get_container_pairs
 Get particles in the close pair container. More...
 

Constructor & Destructor Documentation

def IMP.pmi.restraints.basic.ResidueProteinProximityRestraint.__init__ (   self,
  hier,
  selection,
  cutoff = 6.0,
  sigma = 3.0,
  xi = 0.01,
  resolution = 1.0,
  weight = 1.0,
  label = None 
)

Constructor.

Parameters
hierHierarchy of the system
sectionSelection of residues and target; syntax is (prot, r1, r2, target_prot) or (prot1, r1, r2, target_prot, target_r1, target_r2)
cutoffDistance cutoff between selected segment and target protein
sigmaDistance variance between selected fragments
xiSlope of a distance-linear scoring function that funnels the score when the particles are too far away
resolutionResolution at which to apply restraint
weightWeight of the restraint
labelExtra text to label the restraint so that it is searchable in the output

Definition at line 465 of file restraints/basic.py.

Member Function Documentation

def IMP.pmi.restraints.basic.ResidueProteinProximityRestraint.get_container_pairs (   self)

Get particles in the close pair container.

Definition at line 572 of file restraints/basic.py.


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