IMP Reference Guide  develop.cc86c9801d,2022/11/22 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_hier The hierarchy to select from tuple_selection (resnum, resnum, molecule name, copy number (=0)) anchor_point Point to which to restrain particle (IMP.algebra.Vector3D object) radius Maximum distance the particle can move from the fixed point before it is restrained kappa Strength of the harmonic restraint for point-particle distance greater than the radius resolution For selecting a particle weight Weight of restraint label A 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: