IMP Reference Guide
2.20.2
The Integrative Modeling Platform
|
Add nuisance parameter to particle. More...
#include <IMP/isd/Nuisance.h>
Add nuisance parameter to particle.
The value of the nuisance parameter may express data or theory uncertainty. It can be initialized with or without specifying its value. Default is 1. On construction, the Nuisance is unbounded. It can be bounded with set_upper and set_lower. Setting it to values outside of bounds results in setting it to the bound value.
Definition at line 27 of file Nuisance.h.
Public Member Functions | |
Nuisance (::IMP::Model *m,::IMP::ParticleIndex id) | |
Nuisance (const IMP::ParticleAdaptor &d) | |
void | add_to_nuisance_derivative (Float d, DerivativeAccumulator &accum) |
bool | get_has_lower () const |
bool | get_has_upper () const |
Float | get_lower () const |
Float | get_nuisance () const |
Float | get_nuisance_derivative () const |
bool | get_nuisance_is_optimized () const |
Float | get_upper () const |
void | remove_lower () |
void | remove_upper () |
void | set_lower (Float d) |
void | set_lower (Particle *d) |
void | set_nuisance (Float d) |
void | set_nuisance_is_optimized (bool val) |
void | set_upper (Float d) |
void | set_upper (Particle *d) |
void | show (std::ostream &out=std::cout) const |
Public Member Functions inherited from IMP::Decorator | |
bool | get_is_valid () const |
Returns true if constructed with a non-default constructor. More... | |
Model * | get_model () const |
Returns the Model containing the particle. More... | |
Particle * | get_particle () const |
Returns the particle decorated by this decorator. More... | |
ParticleIndex | get_particle_index () const |
Returns the particle index decorated by this decorator. More... | |
operator Particle * () const | |
operator ParticleIndex () const | |
Particle * | operator-> () const |
Static Public Member Functions | |
static bool | get_is_setup (const IMP::ParticleAdaptor &p) |
static bool | get_is_setup (Model *m, ParticleIndex pi) |
static FloatKey | get_lower_key () |
static ParticleIndexKey | get_lower_particle_key () |
static FloatKey | get_nuisance_key () |
static FloatKey | get_upper_key () |
static ParticleIndexKey | get_upper_particle_key () |
static Nuisance | setup_particle (Model *m, ParticleIndex pi) |
static Nuisance | setup_particle (IMP::ParticleAdaptor pa) |
static Nuisance | setup_particle (Model *m, ParticleIndex pi, double nuisance) |
static Nuisance | setup_particle (IMP::ParticleAdaptor pa, double nuisance) |
Additional Inherited Members | |
Protected Member Functions inherited from IMP::Decorator | |
Decorator (Model *m, ParticleIndex pi) | |
Decorator (ParticleAdaptor p) | |
bool IMP::isd::Nuisance::get_has_lower | ( | ) | const |
set upper and lower bound of nuisance by specifying either a float or another nuisance. Both can be set at the same time in which case the upper bound is the minimum of the two values. This constraint is enforced with the help of a ScoreState that will be created on-the-fly.
|
static |
Definition at line 33 of file Nuisance.h.
|
static |
Definition at line 33 of file Nuisance.h.
|
static |
Definition at line 34 of file Nuisance.h.
|
static |
Definition at line 34 of file Nuisance.h.