IMP logo
IMP Reference Guide  2.20.0
The Integrative Modeling Platform
IMP.pmi.restraints.basic.DistanceToPointRestraint Class Reference

Anchor a particle to a specific coordinate. More...

Inherits RestraintBase.

Detailed Description

Anchor a particle to a specific coordinate.

Note
This class is only available in Python.

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

Public Member Functions

def __init__
 Setup distance restraint. More...
 

Constructor & Destructor Documentation

def IMP.pmi.restraints.basic.DistanceToPointRestraint.__init__ (   self,
  root_hier,
  tuple_selection,
  anchor_point = IMP.algebra.Vector3D(0, 0,
  radius = 10.0,
  kappa = 10.0,
  resolution = 1.0,
  weight = 1.0,
  label = None 
)

Setup distance restraint.

Parameters
root_hierThe hierarchy to select from
tuple_selection(resnum, resnum, molecule name, copy number (=0))
anchor_pointPoint to which to restrain particle (IMP.algebra.Vector3D object)
radiusMaximum distance the particle can move from the fixed point before it is restrained
kappaStrength of the harmonic restraint for point-particle distance greater than the radius
resolutionFor selecting a particle
weightWeight of restraint
labelA unique label to be used in outputs and particle/restraint names
Note
Pass the same resnum twice to each tuple_selection. Optionally add a copy number

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


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