IMP logo
IMP Reference Guide  develop.374319d7bb,2024/06/17
The Integrative Modeling Platform
IMP::em2d::GridStates Class Reference

#include <IMP/em2d/domino_particle_states.h>

+ Inheritance diagram for IMP::em2d::GridStates:

Detailed Description

States that a set of Particles can have according to their positions and orientations in a grid. The orientations also determine the orientation of the projections of the particles.

Definition at line 29 of file domino_particle_states.h.

Public Member Functions

 GridStates (const algebra::Vector3Ds &positions, const algebra::Rotation3Ds &orientations, const String &name="GridStates")
 
virtual unsigned int get_number_of_particle_states () const override
 
algebra::Rotation3D get_orientation (unsigned int i) const
 Returns the orientation corresponding to the state i. More...
 
algebra::Vector3D get_position (unsigned int i) const
 Returns the position corresponding to the state i. More...
 
virtual std::string get_type_name () const override
 
virtual ::IMP::VersionInfo get_version_info () const override
 Get information about the module and version of the object. More...
 
virtual void load_particle_state (unsigned int, Particle *) const override
 
- Public Member Functions inherited from IMP::domino::ParticleStates
 ParticleStates (std::string name="ParticleStates %1%")
 
virtual algebra::VectorKD get_embedding (unsigned int i) const
 Return an embedding of the state. More...
 
virtual unsigned int get_nearest_state (const algebra::VectorKD &v) const
 Return the state closest to a given embedding. More...
 
- Public Member Functions inherited from IMP::Object
virtual void clear_caches ()
 
CheckLevel get_check_level () const
 
LogLevel get_log_level () const
 
void set_check_level (CheckLevel l)
 
void set_log_level (LogLevel l)
 Set the logging level used in this object. More...
 
void set_was_used (bool tf) const
 
void show (std::ostream &out=std::cout) const
 
const std::string & get_name () const
 
void set_name (std::string name)
 

Protected Attributes

unsigned int number_of_states_
 
algebra::Rotation3Ds orientations_
 
algebra::Vector3Ds positions_
 

Additional Inherited Members

- Protected Member Functions inherited from IMP::Object
 Object (std::string name)
 Construct an object with the given name. More...
 
virtual void do_destroy ()
 

Constructor & Destructor Documentation

IMP::em2d::GridStates::GridStates ( const algebra::Vector3Ds positions,
const algebra::Rotation3Ds orientations,
const String name = "GridStates" 
)
Parameters
[in]positionsSet of positions that the set of particles can have in the grid (points of the grid).
[in]orientationsOrientations of the particles in in the grid
[in]nameNote: The number of states considered is positions * orientations, as each position can have all orientations. \

Definition at line 46 of file domino_particle_states.h.

Member Function Documentation

algebra::Rotation3D IMP::em2d::GridStates::get_orientation ( unsigned int  i) const

Returns the orientation corresponding to the state i.

algebra::Vector3D IMP::em2d::GridStates::get_position ( unsigned int  i) const

Returns the position corresponding to the state i.

virtual ::IMP::VersionInfo IMP::em2d::GridStates::get_version_info ( ) const
overridevirtual

Get information about the module and version of the object.

Reimplemented from IMP::Object.

Reimplemented in IMP::em2d::ProjectionStates.

Definition at line 65 of file domino_particle_states.h.


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