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

Restraint for anchoring a particle to a specific coordinate. More...

+ Inheritance diagram for IMP.pmi1.restraints.basic.DistanceToPointRestraint:

Detailed Description

Restraint for anchoring a particle to a specific coordinate.

Note
This class is only available in Python.

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

Public Member Functions

def __init__
 Setup distance restraint. More...
 
- Public Member Functions inherited from IMP.pmi1.restraints.RestraintBase
def __init__
 Constructor. More...
 
def add_to_model
 Add the restraint to the model. More...
 
def evaluate
 Evaluate the score of the restraint. More...
 
def get_output
 Get outputs to write to stat files. More...
 
def get_particles_to_sample
 Get any created particles which should be sampled. More...
 
def get_restraint
 Get the primary restraint set. More...
 
def get_restraint_for_rmf
 Get the restraint for visualization in an RMF file. More...
 
def get_restraint_set
 Get the primary restraint set. More...
 
def set_label
 Set the unique label used in outputs and particle/restraint names. More...
 
def set_weight
 Set the weight to apply to all internal restraints. More...
 

Constructor & Destructor Documentation

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

Setup distance restraint.

Parameters
representationDEPRECATED
tuple_selection(resnum, resnum, molecule name, copy number (=0))
anchor_pointPoint to which to restrain particle (IMP.algebra.Vector3D object)
radiusSize of the tolerance length
kappaThe harmonic parameter
resolutionFor selecting a particle
weightWeight of restraint
root_hierThe hierarchy to select from (use this instead of representation)
labelA unique label to be used in outputs and particle/restraint names

ote Pass the same resnum twice to each tuple_selection. Optionally add a copy number (PMI2 only)

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


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