IMP  2.1.0
The Integrative Modeling Platform
Public Member Functions | Static Public Member Functions | List of all members
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 (::IMP::kernel::Model *m,::IMP::kernel::ParticleIndex id)
 
 Nuisance (const IMP::kernel::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 (kernel::Particle *d)
 
void set_nuisance (Float d)
 
void set_nuisance_is_optimized (bool val)
 
void set_upper (Float d)
 
void set_upper (kernel::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 bool get_is_setup (const IMP::kernel::ParticleAdaptor &p)
 
static bool get_is_setup (kernel::Model *m, kernel::ParticleIndex pi)
 
static FloatKey get_lower_key ()
 
static kernel::ParticleIndexKey get_lower_particle_key ()
 
static FloatKey get_nuisance_key ()
 
static FloatKey get_upper_key ()
 
static kernel::ParticleIndexKey get_upper_particle_key ()
 
static bool particle_is_instance (::IMP::kernel::Particle *p)
 
static bool particle_is_instance (IMP::kernel::Model *m, IMP::kernel::ParticleIndex pi)
 
static Nuisance setup_particle (kernel::Model *m, ParticleIndex pi)
 
static Nuisance setup_particle (IMP::kernel::ParticleAdaptor decorator)
 
static Nuisance setup_particle (IMP::kernel::ParticleAdaptor decorator, double nuisance)
 
static Nuisance setup_particle (kernel::Model *m, ParticleIndex pi, double nuisance)
 
- Static Public Member Functions inherited from IMP::kernel::Decorator
static bool get_is_setup (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 (kernel::Model *m, ParticleIndex pi)
 
 Decorator (ParticleAdaptor 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 26 of file Nuisance.h.

Member Function Documentation

static Nuisance IMP::isd::Nuisance::decorate_particle ( ::IMP::kernel::Particle *  p)
static
Deprecated:
As of IMP release 2.1. See the IMP Deprecation Policy for more information about deprecation in IMP. Check explicitly instead.

Definition at line 32 of file Nuisance.h.

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 bool IMP::isd::Nuisance::particle_is_instance ( ::IMP::kernel::Particle *  p)
static
Deprecated:
As of IMP release 2.1. See the IMP Deprecation Policy for more information about deprecation in IMP. Use get_is_setup() instead.

Definition at line 32 of file Nuisance.h.

static bool IMP::isd::Nuisance::particle_is_instance ( IMP::kernel::Model *  m,
IMP::kernel::ParticleIndex  pi 
)
static
Deprecated:
As of IMP release 2.1. See the IMP Deprecation Policy for more information about deprecation in IMP. Use get_is_setup() instead.

Definition at line 32 of file Nuisance.h.

static Nuisance IMP::isd::Nuisance::setup_particle ( kernel::Model *  m,
ParticleIndex  pi 
)
static

Setup the particle so it can be used with this decorator.

Definition at line 33 of file Nuisance.h.

static Nuisance IMP::isd::Nuisance::setup_particle ( kernel::Model *  m,
ParticleIndex  pi,
double  nuisance 
)
static

Setup the particle so it can be used with this decorator.

Definition at line 34 of file Nuisance.h.

The documentation for this class was generated from the following file: