IMP logo
IMP Reference Guide  2.12.0
The Integrative Modeling Platform
version 2.12.0
SigmoidRestraintSphere.h
Go to the documentation of this file.
1 /**
2  * \file IMP/pmi/SigmoidRestraintSphere.h
3  * \brief Simple sigmoidal score calculated between sphere surfaces.
4  *
5  * Copyright 2007-2019 IMP Inventors. All rights reserved.
6  *
7  */
8 
9 #ifndef IMPPMI_SIGMOID_RESTRAINT_SPHERE_H
10 #define IMPPMI_SIGMOID_RESTRAINT_SPHERE_H
11 #include "pmi_config.h"
12 #include <IMP/Restraint.h>
13 #include <IMP/particle_index.h>
14 
15 
16 IMPPMI_BEGIN_NAMESPACE
17 
18 //! Simple sigmoidal score calculated between sphere surfaces.
19 class IMPPMIEXPORT SigmoidRestraintSphere : public Restraint
20 {
21  IMP::ParticleIndex p1_;
22  IMP::ParticleIndex p2_;
23  double inflection_;
24  double slope_;
25  double amplitude_;
26  double line_slope_;
27 
28 
29 
30 public:
31 
32 
33  //! Create the restraint.
34  IMPPMI_DEPRECATED_OBJECT_DECL(2.11)
35  SigmoidRestraintSphere(IMP::Model *m,
36  IMP::ParticleIndexAdaptor p1,
37  IMP::ParticleIndexAdaptor p2,
38  double inflection, double slope,
39  double amplitude, double line_slope_=0,
40  std::string name="SigmoidRestraintSphere%1%");
41 
42  void set_amplitude(double amplitude){amplitude_=amplitude;}
43  void increment_amplitude(double amplitude){amplitude_=amplitude_+amplitude;}
44  double get_amplitude(){return amplitude_;}
45 
46  virtual double
47  unprotected_evaluate(IMP::DerivativeAccumulator *accum)
48  const IMP_OVERRIDE;
49  virtual IMP::ModelObjectsTemp do_get_inputs() const IMP_OVERRIDE;
50  IMP_OBJECT_METHODS(SigmoidRestraintSphere);
51 
52 
53 };
54 
55 IMPPMI_END_NAMESPACE
56 
57 #endif /* IMPPMI_SIGMOID_RESTRAINT_SPHERE_H */
particle_index.h
Various general useful functions for IMP.
IMP_OBJECT_METHODS
#define IMP_OBJECT_METHODS(Name)
Define the basic things needed by any Object.
Definition: object_macros.h:25
IMP::Vector
A more IMP-like version of the std::vector.
Definition: Vector.h:39
IMP::Model
Class for storing model, its restraints, constraints, and particles.
Definition: Model.h:72
IMP::pmi::SigmoidRestraintSphere
Simple sigmoidal score calculated between sphere surfaces.
Definition: SigmoidRestraintSphere.h:19
Restraint.h
Abstract base class for all restraints.
IMP::ModelObject::do_get_inputs
virtual ModelObjectsTemp do_get_inputs() const =0
IMP_OVERRIDE
#define IMP_OVERRIDE
Cause a compile error if this method does not override a parent method.
Definition: compiler_macros.h:78
IMP::DerivativeAccumulator
Class for adding derivatives from restraints to the model.
Definition: DerivativeAccumulator.h:25
IMP::Restraint
A restraint is a term in an IMP ScoringFunction.
Definition: Restraint.h:54