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

Keeps all structures inside a sphere. More...

Inherits RestraintBase.

Detailed Description

Keeps all structures inside a sphere.

Note
This class is only available in Python.

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

Public Member Functions

def __init__
 Setup external barrier restraint. More...
 

Constructor & Destructor Documentation

def IMP.pmi.restraints.basic.ExternalBarrier.__init__ (   self,
  hierarchies,
  radius = 10.0,
  resolution = 10,
  weight = 1.0,
  center = None,
  label = None 
)

Setup external barrier restraint.

Parameters
hierarchiesCan be one of the following inputs: IMP Hierarchy, PMI System/State/Molecule/TempResidue, or a list/set of them
radiusSize of external barrier
resolutionSelect which resolutions to act upon
weightWeight of restraint
centerCenter of the external barrier (IMP.algebra.Vector3D object)
labelA unique label to be used in outputs and particle/restraint names.

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


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