IMP logo
IMP Reference Guide  2.6.2
The Integrative Modeling Platform
IMP::em::EnvelopeScore Class Reference

class for envelope based scoring using MapDistanceTransform More...

#include <IMP/em/EnvelopeScore.h>

+ Inheritance diagram for IMP::em::EnvelopeScore:

Detailed Description

class for envelope based scoring using MapDistanceTransform

Definition at line 21 of file EnvelopeScore.h.

Public Member Functions

 EnvelopeScore (const MapDistanceTransform *mdt)
 
IMP::VersionInfo get_version_info () const
 Get information about the module and version of the object. More...
 
bool is_penetrating (const std::vector< IMP::algebra::Vector3D > &points, float penetration_thr) const
 
bool is_penetrating (const std::vector< IMP::algebra::Vector3D > &points, const IMP::algebra::Transformation3D &trans, float penetration_thr) const
 
double score (const std::vector< IMP::algebra::Vector3D > &points) const
 
double score (const std::vector< IMP::algebra::Vector3D > &points, const IMP::algebra::Transformation3D &trans) const
 
- 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)
 
virtual std::string get_type_name () const
 

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 ()
 

Member Function Documentation

IMP::VersionInfo IMP::em::EnvelopeScore::get_version_info ( ) const
virtual

Get information about the module and version of the object.

Reimplemented from IMP::Object.

Definition at line 63 of file EnvelopeScore.h.

bool IMP::em::EnvelopeScore::is_penetrating ( const std::vector< IMP::algebra::Vector3D > &  points,
float  penetration_thr 
) const

check for penetration with respect to the envelope as defined by the distance transform

Parameters
[in]pointscheck this set of points for penetration
[in]penetration_thrthreshold that defines penetration. Use penetration_thr=0 to require for all points inside the envelope to allow some penetration set the threshold to the -distance of the allowed penetration distance. Recommended value is map resolution.
bool IMP::em::EnvelopeScore::is_penetrating ( const std::vector< IMP::algebra::Vector3D > &  points,
const IMP::algebra::Transformation3D trans,
float  penetration_thr 
) const

same as above

Parameters
[in]points
[in]transapply this transformation on points before checking for penetrations
[in]penetration_thr
double IMP::em::EnvelopeScore::score ( const std::vector< IMP::algebra::Vector3D > &  points) const

score points with respect to the distance transform the score awards points that fall into the envelope and penalizes for points outside the envelope

double IMP::em::EnvelopeScore::score ( const std::vector< IMP::algebra::Vector3D > &  points,
const IMP::algebra::Transformation3D trans 
) const

same as above

Parameters
[in]points
[in]transapply this transformation on points before scoring

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