IMP
2.4.0
The Integrative Modeling Platform
IMP Mainpage
Modules
Classes
Examples
include
IMP
isd
WeightRestraint.h
Go to the documentation of this file.
1
/**
2
* \file IMP/isd/WeightRestraint.h
3
* \brief Put description here
4
*
5
* Copyright 2007-2015 IMP Inventors. All rights reserved.
6
*
7
*/
8
9
#ifndef IMPISD_WEIGHT_RESTRAINT_H
10
#define IMPISD_WEIGHT_RESTRAINT_H
11
#include <
IMP/isd/Scale.h
>
12
#include "isd_config.h"
13
#include <
IMP/kernel/Restraint.h
>
14
15
IMPISD_BEGIN_NAMESPACE
16
/** A restraint for in-vivo ensemble FRET data
17
*/
18
19
class
IMPISDEXPORT
WeightRestraint
:
public
kernel::Restraint
{
20
kernel::Particle
*w_;
21
Float
wmin_;
22
Float
wmax_;
23
Float
kappa_;
24
25
public
:
26
//! Create the restraint.
27
/** kernel::Restraints should store the particles they are to act on,
28
preferably in a Singleton or PairContainer as appropriate.
29
*/
30
31
WeightRestraint
(
kernel::Particle
*w,
Float
wmin,
Float
wmax,
Float
kappa);
32
33
/** This macro declares the basic needed methods: evaluate and show
34
*/
35
virtual
double
unprotected_evaluate(
IMP::kernel::DerivativeAccumulator
*accum)
36
const
IMP_OVERRIDE
;
37
virtual
IMP::kernel::ModelObjectsTemp
do_get_inputs
()
const
IMP_OVERRIDE
;
38
IMP_OBJECT_METHODS
(
WeightRestraint
);
39
};
40
41
IMPISD_END_NAMESPACE
42
43
#endif
/* IMPISD_WEIGHT_RESTRAINT_H */
IMP::isd::WeightRestraint
Definition:
WeightRestraint.h:19
IMP::kernel::DerivativeAccumulator
Class for adding derivatives from restraints to the model.
Definition:
kernel/DerivativeAccumulator.h:25
IMP_OBJECT_METHODS
#define IMP_OBJECT_METHODS(Name)
Define the basic things needed by any Object.
Definition:
object_macros.h:25
Scale.h
A decorator for scale parameters particles.
IMP::base::Vector
Definition:
Vector.h:37
Restraint.h
Abstract base class for all restraints.
IMP::kernel::Restraint
A restraint is a term in an IMP ScoringFunction.
Definition:
kernel/Restraint.h:52
IMP::kernel::Particle
Class to handle individual model particles.
Definition:
kernel/Particle.h:37
IMP::kernel::ModelObject::do_get_inputs
virtual ModelObjectsTemp do_get_inputs() const =0
IMP::Float
double Float
Basic floating-point value (could be float, double...)
Definition:
types.h:20
IMP_OVERRIDE
#define IMP_OVERRIDE
Cause a compile error if this method does not override a parent method.
Definition:
compiler_macros.h:75