IMP  2.0.1
The Integrative Modeling Platform
IMP::isd::Scale Class Reference

Add scale parameter to particle. More...

#include <IMP/isd/Scale.h>

+ Inheritance diagram for IMP::isd::Scale:

Public Member Functions

 Scale (Model *m, ParticleIndex id)
 
 Scale (::IMP::kernel::Particle *p)
 
void add_to_scale_derivative (Float d, DerivativeAccumulator &accum)
 
Float get_scale () const
 
Float get_scale_derivative () const
 
bool get_scale_is_optimized () const
 
void set_scale (Float d)
 
void set_scale_is_optimized (bool val)
 
void show (std::ostream &out=std::cout) const
 
- Public Member Functions inherited from IMP::isd::Nuisance
 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
 
Particleget_particle () const
 
Modelget_model () const
 Returns the Model containing the particle.
 
 Decorator (Particle *p)
 
 Decorator ()
 

Static Public Member Functions

static Scale decorate_particle (::IMP::kernel::Particle *p)
 
static FloatKey get_scale_key ()
 
static bool particle_is_instance (Particle *p)
 
static Scale setup_particle (Particle *p, double scale=1.0)
 
- Static Public Member Functions inherited from IMP::isd::Nuisance
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

This is just syntactic sugar for a Nuisance bounded to be positive.

Definition at line 24 of file Scale.h.


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