IMP logo
IMP Reference Guide  develop.cb469e0f11,2024/05/28
The Integrative Modeling Platform
IMP.pmi1.restraints.parameters.WeightRestraint Class Reference

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

+ Inheritance diagram for IMP.pmi1.restraints.parameters.WeightRestraint:

Detailed Description

Wrapper for an IMP.isd.WeightRestraint

This class is only available in Python.

Definition at line 11 of file /restraints/

Public Member Functions

def __init__
 Create restraint on weight parameter. 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.parameters.WeightRestraint.__init__ (   self,
  label = None,
  weight = 1.0 

Create restraint on weight parameter.

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/

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