IMP logo
IMP Reference Guide  develop.1a86c4215a,2024/04/24
The Integrative Modeling Platform
IMP.pmi.restraints.parameters.WeightRestraint Class Reference

Wrapper for an IMP.isd.WeightRestraint More...

Inherits RestraintBase.

Detailed Description

Wrapper for an IMP.isd.WeightRestraint

Note
This class is only available in Python.

Definition at line 11 of file restraints/parameters.py.

Public Member Functions

def __init__
 Create restraint on weight parameter. More...
 

Constructor & Destructor Documentation

def IMP.pmi.restraints.parameters.WeightRestraint.__init__ (   self,
  w,
  lower,
  upper,
  kappa,
  label = None,
  weight = 1.0 
)

Create restraint on weight parameter.

Parameters
wIMP.isd.Weight particle
lowerLower bound on weight restraint
upperUpper bound on weight restraint
kappaStrength of restraint
labelA unique label to be used in outputs
weightThe weight to apply to all internal restraints

Definition at line 19 of file restraints/parameters.py.


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