IMP logo
IMP Reference Guide  2.15.0
The Integrative Modeling Platform
IMP.pmi.restraints.basic.DistanceRestraint Class Reference

A simple distance restraint. More...

Inherits RestraintBase.

Detailed Description

A simple distance restraint.

Note
This class is only available in Python.

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

Public Member Functions

def __init__
 Setup distance restraint. More...
 

Constructor & Destructor Documentation

def IMP.pmi.restraints.basic.DistanceRestraint.__init__ (   self,
  root_hier,
  tuple_selection1,
  tuple_selection2,
  distancemin = 0,
  distancemax = 100,
  resolution = 1.0,
  kappa = 1.0,
  label = None,
  weight = 1.0 
)

Setup distance restraint.

Parameters
root_hierThe hierarchy to select from
tuple_selection1(resnum, resnum, molecule name, copy number (=0))
tuple_selection2(resnum, resnum, molecule name, copy number (=0))
distanceminThe minimum dist
distancemaxThe maximum dist
resolutionFor selecting particles
kappaThe harmonic parameter
labelA unique label to be used in outputs and particle/restraint names
weightWeight of restraint
Note
Pass the same resnum twice to each tuple_selection. Optionally add a copy number (PMI2 only)

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


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