home
about
news
download
doc
source
systems
tests
bugs
contact
IMP Reference Guide
2.20.2
The Integrative Modeling Platform
IMP Manual
Reference Guide
Tutorial Index
Modules
Classes
Examples
include
IMP
pmi1
version 2.20.2
SigmoidRestraintSphere.h
Go to the documentation of this file.
1
/**
2
* \file IMP/pmi1/SigmoidRestraintSphere.h
3
* \brief Simple sigmoidal score calculated between sphere surfaces.
4
*
5
* Copyright 2007-2018 IMP Inventors. All rights reserved.
6
*
7
*/
8
9
#ifndef IMPPMI1_SIGMOID_RESTRAINT_SPHERE_H
10
#define IMPPMI1_SIGMOID_RESTRAINT_SPHERE_H
11
#include "pmi1_config.h"
12
#include <
IMP/Restraint.h
>
13
#include <
IMP/particle_index.h
>
14
15
16
IMPPMI1_BEGIN_NAMESPACE
17
18
//! Simple sigmoidal score calculated between sphere surfaces.
19
class
IMPPMI1EXPORT
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
SigmoidRestraintSphere
(
IMP::Model
*m,
35
IMP::ParticleIndexAdaptor
p1,
36
IMP::ParticleIndexAdaptor
p2,
37
double
inflection,
double
slope,
38
double
amplitude,
double
line_slope_=0,
39
std::string name=
"SigmoidRestraintSphere%1%"
);
40
41
void
set_amplitude(
double
amplitude){amplitude_=amplitude;}
42
void
increment_amplitude(
double
amplitude){amplitude_=amplitude_+amplitude;}
43
double
get_amplitude(){
return
amplitude_;}
44
45
virtual
double
46
unprotected_evaluate
(
IMP::DerivativeAccumulator
*accum)
const override
;
47
virtual
IMP::ModelObjectsTemp
do_get_inputs
()
const override
;
48
IMP_OBJECT_METHODS
(
SigmoidRestraintSphere
);
49
50
51
};
52
53
IMPPMI1_END_NAMESPACE
54
55
#endif
/* IMPPMI1_SIGMOID_RESTRAINT_SPHERE_H */
particle_index.h
Functions and adaptors for dealing with particle indexes.
IMP_OBJECT_METHODS
#define IMP_OBJECT_METHODS(Name)
Define the basic things needed by any Object.
Definition:
object_macros.h:25
IMP::ParticleIndexAdaptor
Take Decorator, Particle or ParticleIndex.
Definition:
particle_index.h:32
IMP::Index< ParticleIndexTag >
IMP::Restraint::unprotected_evaluate
virtual double unprotected_evaluate(DerivativeAccumulator *da) const
Return the unweighted score for the restraint.
IMP::Vector
A more IMP-like version of the std::vector.
Definition:
Vector.h:42
IMP::Model
Class for storing model, its restraints, constraints, and particles.
Definition:
Model.h:86
IMP::pmi1::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::DerivativeAccumulator
Class for adding derivatives from restraints to the model.
Definition:
DerivativeAccumulator.h:24
IMP::Restraint
A restraint is a term in an IMP ScoringFunction.
Definition:
Restraint.h:56