IMP logo
IMP Reference Guide  2.20.1
The Integrative Modeling Platform
IMP.pmi1.restraints.saxs.SAXSISDRestraint Class Reference

Basic SAXS restraint using ISD. More...

+ Inheritance diagram for IMP.pmi1.restraints.saxs.SAXSISDRestraint:

Detailed Description

Basic SAXS restraint using ISD.

Note
This class is only available in Python.

Definition at line 93 of file /restraints/saxs.py.

Public Member Functions

def draw_gamma
 Draw gamma from lognormal distribution. More...
 
def draw_sigma
 Draw 1/sigma2 from gamma distribution. More...
 
def get_gamma_value
 Get value of gamma. More...
 
def optimize_gamma
 Set gamma to the value that maximizes its conditional likelihood. More...
 
def optimize_sigma
 Set sigma to the value that maximizes its conditional likelihood. 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...
 

Member Function Documentation

def IMP.pmi1.restraints.saxs.SAXSISDRestraint.draw_gamma (   self)

Draw gamma from lognormal distribution.

Definition at line 218 of file /restraints/saxs.py.

def IMP.pmi1.restraints.saxs.SAXSISDRestraint.draw_sigma (   self)

Draw 1/sigma2 from gamma distribution.

Definition at line 213 of file /restraints/saxs.py.

def IMP.pmi1.restraints.saxs.SAXSISDRestraint.get_gamma_value (   self)

Get value of gamma.

Definition at line 206 of file /restraints/saxs.py.

def IMP.pmi1.restraints.saxs.SAXSISDRestraint.optimize_gamma (   self)

Set gamma to the value that maximizes its conditional likelihood.

Definition at line 174 of file /restraints/saxs.py.

def IMP.pmi1.restraints.saxs.SAXSISDRestraint.optimize_sigma (   self)

Set sigma to the value that maximizes its conditional likelihood.

Definition at line 167 of file /restraints/saxs.py.


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