IMP logo
Public Member Functions | Static Public Member Functions
IMP::isd::MarginalHBondRestraint Class Reference

Detailed Description

Apply a lognormal distance restraint between two particles.

Marginal of the lognormal model for NOEs where only $\sigma$ was marginalized, and $\gamma$ was set to 1. Since the restraint is complicated, pass individual particles to add_contribution() command.

\[p(D|X,I) = \left(\sum_{i=1}^N \log^2\left(\frac{V_i^{exp}} {d_i^{-6}(X)}\right)\right)^{-\frac{N}{2}} \]

The source code is as follows:

+ Inheritance diagram for IMP::isd::MarginalHBondRestraint:

List of all members.

Public Member Functions

 MarginalHBondRestraint ()
 Create the restraint.
void add_contribution (Particle *p1, Particle *p2, double Iexp)
void add_contribution (PairContainer *pc, double Iexp)
double get_logsquares () const
unsigned get_number_of_contributions () const
double get_probability () const
- Public Member Functions inherited from IMP::isd::ISDRestraint
def __init__
 ISDRestraint (std::string name)
- Public Member Functions inherited from IMP::Restraint
 Restraint (Model *m, std::string name)
Restraintcreate_current_decomposition () const
 Decompose this restraint into constituent terms for the current conf.
Restraintcreate_decomposition () const
 Decompose this restraint into constituent terms.
double evaluate (bool calc_derivs) const
 Return the score for this restraint for the current state of the model.
double evaluate_if_below (bool calc_derivatives, double max) const
 See Model::evaluate_with_maximum()
double evaluate_if_good (bool calc_derivatives) const
 See Model::evaluate_if_good()
double get_last_score () const
bool get_was_good () const
virtual double unprotected_evaluate (DerivativeAccumulator *) const =0
virtual double unprotected_evaluate_if_good (DerivativeAccumulator *da, double max) const
virtual double unprotected_evaluate_if_below (DerivativeAccumulator *da, double max) const
virtual ContainersTemp get_input_containers () const =0
virtual ParticlesTemp get_input_particles () const =0
void set_weight (Float weight)
Float get_weight () const
double get_maximum_score () const
void set_maximum_score (double s)
- Public Member Functions inherited from IMP::ModelObject
 ModelObject (Model *m, std::string name)
ModelObjectsTemp get_inputs () const
Modelget_model () const
ModelObjectsTemp get_outputs () const
- Public Member Functions inherited from IMP::base::Object
std::size_t __hash__ () const
virtual std::string get_type_name () const =0
 Return a string identifying the type of the object.
virtual IMP::base::VersionInfo get_version_info () const =0
 Get information about the module and version of the object.
void set_check_level (CheckLevel l)
void set_log_level (LogLevel l)
 Set the logging level used in this object.
void set_was_used (bool tf) const
void show (std::ostream &out=std::cout) const
const std::string & get_name () const
void set_name (std::string name)

Static Public Member Functions

static MarginalHBondRestraintget_from (IMP::base::Object *o)

Constructor & Destructor Documentation

IMP::isd::MarginalHBondRestraint::MarginalHBondRestraint ( )

Create the restraint.

Restraints should store the particles they are to act on, preferably in a Singleton or PairContainer as appropriate.


Member Function Documentation

static MarginalHBondRestraint* IMP::isd::MarginalHBondRestraint::get_from ( IMP::base::Object o)
static

This macro declares the basic needed methods: evaluate and show


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

Generated on Tue May 22 2012 23:33:35 for IMP by doxygen 1.8.1