IMP::statistics::ParticleEmbedding Class Reference

#include <IMP/statistics/embeddings.h>

Inheritance diagram for IMP::statistics::ParticleEmbedding:

Detailed Description

Embed particles using the values of some of their attributes. By default, the Cartesian coordinates are used, but another set of attributes can be chosen. When using attributes that are not equivalent (for example, angular degrees of freedom), it is probably useful to rescale the attributes according to their ranges (see IMP::Model::get_range()). This is done by passing rescale=true to the constructor.

Definition at line 53 of file embeddings.h.

Public Member Functions
	ParticleEmbedding (const ParticlesTemp &ps, const FloatKeys &ks=core::XYZ::get_xyz_keys(), bool rescale=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 ()

Member Function Documentation

virtual ::IMP::VersionInfo IMP::statistics::ParticleEmbedding::get_version_info ( ) const

overridevirtual

Get information about the module and version of the object.

Reimplemented from IMP::Object.

Definition at line 75 of file embeddings.h.

---

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

• embeddings.h