IMP logo
IMP Reference Guide  develop.04681809d8,2020/01/27
The Integrative Modeling Platform
IMP.pmi.restraints.parameters.JeffreysPrior Class Reference

Wrapper for IMP.isd.JeffreysRestraint More...

+ Inheritance diagram for IMP.pmi.restraints.parameters.JeffreysPrior:

Detailed Description

Wrapper for IMP.isd.JeffreysRestraint

Note
This class is only available in Python.

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

Public Member Functions

def __init__
 Create Jeffreys prior. More...
 
- Public Member Functions inherited from IMP.pmi.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.pmi.restraints.parameters.JeffreysPrior.__init__ (   self,
  nuisance,
  label = None,
  weight = 1.0 
)

Create Jeffreys prior.

Parameters
nuisanceNuisance parameter
labelA unique label to be used in outputs
weightThe weight to apply to all internal restraints

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


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