IMP  2.0.0
The Integrative Modeling Platform
MarginalHBondRestraint.h
Go to the documentation of this file.
1 /**
2  * \file IMP/isd/MarginalHBondRestraint.h
3  * \brief A lognormal restraint that uses the ISPA model to model HBond-derived
4  * distance fit.
5  *
6  * Copyright 2007-2013 IMP Inventors. All rights reserved.
7  *
8  */
9 
10 #ifndef IMPISD_MARGINAL_HBOND_RESTRAINT_H
11 #define IMPISD_MARGINAL_HBOND_RESTRAINT_H
12 
13 #include <IMP/restraint_macros.h>
14 #include <IMP/isd/isd_config.h>
15 #include <IMP/isd/ISDRestraint.h>
16 #include <IMP/PairContainer.h>
17 
18 IMPISD_BEGIN_NAMESPACE
19 
20 //! Apply a lognormal distance restraint between two particles.
21 /** Marginal of the lognormal model for NOEs where only \f$\sigma\f$ was
22  marginalized, and \f$\gamma\f$ was set to 1.
23  Since the restraint is complicated, pass individual particles to
24  add_contribution() command.
25 
26  \f[p(D|X,I) =
27  \left(\sum_{i=1}^N \log^2\left(\frac{V_i^{exp}}
28  {d_i^{-6}(X)}\right)\right)^{-\frac{N}{2}}
29  \f]
30  */
31 class IMPISDEXPORT MarginalHBondRestraint : public ISDRestraint
32 {
33  PairContainers contribs_;
34  std::vector<double> volumes_;
35  double logsquares_;
36  void set_logsquares(double logsquares) {logsquares_=logsquares;}
37 
38 public:
39  //! Create the restraint.
40  /** Restraints should store the particles they are to act on,
41  preferably in a Singleton or PairContainer as appropriate.
42  */
44 
45 
46  // add a contribution: simple case
47  void add_contribution(Particle *p1, Particle *p2, double Iexp);
48 
49  //add a contribution: general case
50  void add_contribution(PairContainer *pc, double Iexp);
51 
52  //return the sum inside the parentheses
53  double get_logsquares() const {return logsquares_;}
54 
55  unsigned get_number_of_contributions() const {return volumes_.size();}
56 
57  /* call for probability */
58  double get_probability() const
59  {
60  return exp(-unprotected_evaluate(nullptr));
61  }
62 
63 
64  /** This macro declares the basic needed methods: evaluate and show
65  */
66  IMP_RESTRAINT_2(MarginalHBondRestraint);
67 
68 
69 };
70 
71 IMPISD_END_NAMESPACE
72 
73 #endif /* IMPISD_MARGINAL_HBOND_RESTRAINT_H */