IMP::isd::Nuisance Class Reference
Add nuisance parameter to particle. More...
#include <IMP/isd/Nuisance.h>
Inheritance diagram for IMP::isd::Nuisance:Public Member Functions | |
| Nuisance (Model *m, ParticleIndex id) | |
| Nuisance (::IMP::kernel::Particle *p) | |
| void | add_to_nuisance_derivative (Float d, DerivativeAccumulator &accum) |
| Float | get_lower () const |
| Float | get_nuisance () const |
| Float | get_nuisance_derivative () const |
| bool | get_nuisance_is_optimized () const |
| Float | get_upper () const |
| bool | has_lower () const |
| bool | has_upper () const |
| 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::kernel::Decorator | |
| ParticleIndex | get_particle_index () const |
| Particle * | get_particle () const |
| Model * | get_model () const |
| Returns the Model containing the particle. | |
| Decorator (Particle *p) | |
| Decorator () | |
Static Public Member Functions | |
| static Nuisance | decorate_particle (::IMP::kernel::Particle *p) |
| 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 bool | particle_is_instance (Particle *p) |
| static Nuisance | setup_particle (Particle *p, double nuisance=1.0) |
| Static Public Member Functions inherited from IMP::kernel::Decorator | |
| static bool | particle_is_instance (Particle *p) |
| Return true if the particle can be cast to the decorator. More... | |
Additional Inherited Members | |
| Protected Member Functions inherited from IMP::kernel::Decorator | |
| Decorator (Model *m, ParticleIndex pi) | |
| Decorator (Particle *p) | |
Detailed Description
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 28 of file Nuisance.h.
Member Function Documentation
| void IMP::isd::Nuisance::set_lower | ( | Float | d | ) |
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.
The documentation for this class was generated from the following file: