IMP logo
IMP Reference Guide  2.20.2
The Integrative Modeling Platform
IMP::em::Voxel Class Reference

#include <IMP/em/Voxel.h>

+ Inheritance diagram for IMP::em::Voxel:

Detailed Description

A a decorator for a particle that stores data on a density voxel , such as: position (x,y,z) attributes and density attributes

Definition at line 25 of file Voxel.h.

Public Member Functions

 Voxel (::IMP::Model *m,::IMP::ParticleIndex id)
 
 Voxel (const IMP::ParticleAdaptor &d)
 
Float get_density () const
 
void set_density (Float t)
 
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...
 
Modelget_model () const
 Returns the Model containing the particle. More...
 
Particleget_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
 
Particleoperator-> () const
 

Static Public Member Functions

static const FloatKey get_density_key ()
 
static bool get_is_setup (const IMP::ParticleAdaptor &p)
 
static bool get_is_setup (Model *m, ParticleIndex pi)
 
static const FloatKeys get_keys ()
 
static Voxel setup_particle (IMP::ParticleAdaptor pa, algebra::Vector3D position, Float radius, Float density)
 
static Voxel setup_particle (Model *m, ParticleIndex pi, algebra::Vector3D position, Float radius, Float density)
 

Additional Inherited Members

- Protected Member Functions inherited from IMP::Decorator
 Decorator (Model *m, ParticleIndex pi)
 
 Decorator (ParticleAdaptor p)
 

Member Function Documentation

Float IMP::em::Voxel::get_density ( ) const

returns the value of the density attribute

Definition at line 41 of file Voxel.h.

void IMP::em::Voxel::set_density ( Float  t)

sets the value of the density attribute to t

Definition at line 41 of file Voxel.h.

static Voxel IMP::em::Voxel::setup_particle ( IMP::ParticleAdaptor  pa,
algebra::Vector3D  position,
Float  radius,
Float  density 
)
static
Returns
a Voxel object that decorates the particle specified by pa
See Also
setup_particle(m, pi, position , radius , density )

Definition at line 39 of file Voxel.h.

static Voxel IMP::em::Voxel::setup_particle ( Model m,
ParticleIndex  pi,
algebra::Vector3D  position,
Float  radius,
Float  density 
)
static
Returns
a Voxel object that decorates particle pi

Definition at line 39 of file Voxel.h.


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