IMP Reference Guide
2.20.2
The Integrative Modeling Platform
|
Base class for PMI restraints, which wrap IMP.Restraint
(s).
More...
Base class for PMI restraints, which wrap IMP.Restraint
(s).
Definition at line 15 of file pmi1/restraints/__init__.py.
Public Member Functions | |
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... | |
def IMP.pmi1.restraints.RestraintBase.__init__ | ( | self, | |
m, | |||
name = None , |
|||
label = None , |
|||
weight = 1.0 |
|||
) |
Constructor.
m | The model object |
name | The name of the primary restraint set that is wrapped. This is used for outputs and particle/restraint names and should be set by the child class. |
label | A unique label to be used in outputs and particle/restraint names. |
weight | The weight to apply to all internal restraints. |
Definition at line 24 of file pmi1/restraints/__init__.py.
def IMP.pmi1.restraints.RestraintBase.add_to_model | ( | self | ) |
Add the restraint to the model.
Definition at line 80 of file pmi1/restraints/__init__.py.
def IMP.pmi1.restraints.RestraintBase.evaluate | ( | self | ) |
Evaluate the score of the restraint.
Definition at line 86 of file pmi1/restraints/__init__.py.
def IMP.pmi1.restraints.RestraintBase.get_output | ( | self | ) |
Get outputs to write to stat files.
Definition at line 110 of file pmi1/restraints/__init__.py.
def IMP.pmi1.restraints.RestraintBase.get_particles_to_sample | ( | self | ) |
Get any created particles which should be sampled.
Definition at line 105 of file pmi1/restraints/__init__.py.
def IMP.pmi1.restraints.RestraintBase.get_restraint | ( | self | ) |
Get the primary restraint set.
Identical to get_restraint_set
.
Definition at line 96 of file pmi1/restraints/__init__.py.
def IMP.pmi1.restraints.RestraintBase.get_restraint_for_rmf | ( | self | ) |
Get the restraint for visualization in an RMF file.
Definition at line 100 of file pmi1/restraints/__init__.py.
def IMP.pmi1.restraints.RestraintBase.get_restraint_set | ( | self | ) |
Get the primary restraint set.
Definition at line 91 of file pmi1/restraints/__init__.py.
def IMP.pmi1.restraints.RestraintBase.set_label | ( | self, | |
label | |||
) |
Set the unique label used in outputs and particle/restraint names.
label | Label |
Definition at line 54 of file pmi1/restraints/__init__.py.
def IMP.pmi1.restraints.RestraintBase.set_weight | ( | self, | |
weight | |||
) |
Set the weight to apply to all internal restraints.
weight | Weight |
Definition at line 72 of file pmi1/restraints/__init__.py.