IMP logo
IMP Reference Guide  develop.62cd6b8d93,2024/10/30
The Integrative Modeling Platform
IMP::statistics::ConfigurationSetXYZEmbedding Class Reference

Embed a configuration using the XYZ coordinates of a set of particles. More...

#include <IMP/statistics/embeddings.h>

+ Inheritance diagram for IMP::statistics::ConfigurationSetXYZEmbedding:

Detailed Description

Embed a configuration using the XYZ coordinates of a set of particles.

The point for each configuration of the model is a concatenation of the Cartesian coordinates of the particles contained in the passed SingletonContainer.

See ConfigurationSet for more information about the input.

Definition at line 28 of file embeddings.h.

Public Member Functions

 ConfigurationSetXYZEmbedding (ConfigurationSet *cs, SingletonContainerAdaptor pi, bool align=false)
 
unsigned int get_number_of_items () const override
 
algebra::VectorKD get_point (unsigned int i) const override
 
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...
 
- Public Member Functions inherited from IMP::statistics::Embedding
virtual algebra::VectorKDs get_points () const
 
double get_weight (unsigned int i) const
 Return a weight for the point. 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)
 

Additional Inherited Members

- Protected Member Functions inherited from IMP::statistics::Embedding
 Embedding (std::string name)
 
virtual double do_get_weight (unsigned int i) const
 By default return 1.0. More...
 
- 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::statistics::ConfigurationSetXYZEmbedding::ConfigurationSetXYZEmbedding ( ConfigurationSet cs,
SingletonContainerAdaptor  pi,
bool  align = false 
)

If align is true, all the configurations are rigidly aligned with the first before generating their coordinates.

Member Function Documentation

virtual ::IMP::VersionInfo IMP::statistics::ConfigurationSetXYZEmbedding::get_version_info ( ) const
overridevirtual

Get information about the module and version of the object.

Reimplemented from IMP::Object.

Definition at line 42 of file embeddings.h.


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