IMP  2.3.1
The Integrative Modeling Platform
IMP::em2d::RigidBodiesImageFitRestraint Class Reference

Fit rigid bodies to an image. More...

#include <IMP/em2d/RigidBodiesImageFitRestraint.h>

+ Inheritance diagram for IMP::em2d::RigidBodiesImageFitRestraint:

Detailed Description

Fit rigid bodies to an image.

Definition at line 43 of file RigidBodiesImageFitRestraint.h.

Public Member Functions

 RigidBodiesImageFitRestraint (ScoreFunction *scf, const core::RigidBodies &rbs, Image *img)
 Initialize the class. More...
 
unsigned int get_number_of_masks (const core::RigidBody &rb) const
 Return the number of precomputed masks associated with the rigid body. More...
 
virtual std::string get_type_name () const
 
virtual ::IMP::base::VersionInfo get_version_info () const
 Get information about the module and version of the object. More...
 
void set_orientations (const core::RigidBody &rb, const algebra::Rotation3Ds &rots)
 Set the possible rotations that a rigid body can have. More...
 
void set_projecting_parameters (const ProjectingParameters &p)
 
- Public Member Functions inherited from IMP::kernel::Restraint
 Restraint (kernel::Model *m, std::string name)
 
void add_score_and_derivatives (ScoreAccumulator sa) const
 Perform the actual restraint scoring. More...
 
Restraintcreate_current_decomposition () const
 Decompose this restraint into constituent terms for the current conf. More...
 
Restraintcreate_decomposition () const
 Decompose this restraint into constituent terms. More...
 
virtual ScoringFunctioncreate_scoring_function (double weight=1.0, double max=NO_MAX) const
 Create a scoring function with only this restraint. More...
 
virtual double get_last_score () const
 
double get_score () const
 
bool get_was_good () const
 
void set_weight (Float weight)
 
Float get_weight () const
 
double get_maximum_score () const
 
void set_maximum_score (double s)
 
- Public Member Functions inherited from IMP::kernel::ModelObject
 ModelObject (kernel::Model *m, std::string name)
 
bool get_has_dependencies () const
 Return whether this object has dependencies computed. More...
 
bool get_has_required_score_states () const
 Return whether score states are computed. More...
 
ModelObjectsTemp get_inputs () const
 
ModelObjectsTemps get_interactions () const
 Get the interacting sets induced by this ModelObject. More...
 
Modelget_model () const
 
ModelObjectsTemp get_outputs () const
 
const ScoreStatesTempget_required_score_states () const
 Get the score states that are ancestors of this in the dependency graph. More...
 
void set_has_dependencies (bool tf)
 Either invalidate the dependencies or ensure they are correct. More...
 
void set_has_required_score_states (bool tf)
 Compute the required score states. More...
 
- Public Member Functions inherited from IMP::base::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 Member Functions

unsigned int get_rigid_body_index (const core::RigidBody &rb) const
 
- Protected Member Functions inherited from IMP::kernel::Restraint
virtual void do_add_score_and_derivatives (ScoreAccumulator sa) const
 
virtual Restraints do_create_current_decomposition () const
 
virtual Restraints do_create_decomposition () const
 
ModelObjectsTemp do_get_outputs () const
 
- Protected Member Functions inherited from IMP::kernel::ModelObject
virtual ModelObjectsTemps do_get_interactions () const
 
virtual void handle_set_has_required_score_states (bool)
 
- Protected Member Functions inherited from IMP::base::Object
 Object (std::string name)
 Construct an object with the given name. More...
 
virtual void do_destroy ()
 

Protected Attributes

base::Pointer< Imageimage_
 
KeyIndexMaps maps_
 
ProjectingParameters params_
 
bool params_set_
 
base::Pointer< Imageprojection_
 
core::RigidBodies rigid_bodies_
 
std::vector< em2d::Imagesrigid_bodies_masks_
 
base::Pointer< ScoreFunctionscore_function_
 

Constructor & Destructor Documentation

IMP::em2d::RigidBodiesImageFitRestraint::RigidBodiesImageFitRestraint ( ScoreFunction scf,
const core::RigidBodies rbs,
Image img 
)

Initialize the class.

Parameters
[in]scfScore function used to compute the value of the restraint
[in]rbsRigid bodies that are restrained
[in]imgImage used to compute the restraint

Member Function Documentation

unsigned int IMP::em2d::RigidBodiesImageFitRestraint::get_number_of_masks ( const core::RigidBody rb) const

Return the number of precomputed masks associated with the rigid body.

Throws an exception if the rigid body is not in the set used to construct the restraint

virtual ::IMP::base::VersionInfo IMP::em2d::RigidBodiesImageFitRestraint::get_version_info ( ) const
virtual

Get information about the module and version of the object.

Reimplemented from IMP::base::Object.

Definition at line 47 of file RigidBodiesImageFitRestraint.h.

void IMP::em2d::RigidBodiesImageFitRestraint::set_orientations ( const core::RigidBody rb,
const algebra::Rotation3Ds rots 
)

Set the possible rotations that a rigid body can have.

A projection of the rigid body in all possible orientations is stored


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