IMP logo
IMP Reference Guide  2.20.2
The Integrative Modeling Platform
IMP::kinematics::UniformBackboneSampler Class Reference

Sample uniformly over a set of backbone dihedral joints. More...

#include <IMP/kinematics/UniformBackboneSampler.h>

+ Inheritance diagram for IMP::kinematics::UniformBackboneSampler:

Detailed Description

Sample uniformly over a set of backbone dihedral joints.

Definition at line 22 of file UniformBackboneSampler.h.

Public Member Functions

 UniformBackboneSampler (DihedralAngleRevoluteJoints joints, DOFs dofs)
 
virtual void apply (const DOFValues &values) override
 
virtual void apply_floats (const Floats &values)
 
DihedralAngleRevoluteJoints get_joints ()
 
- Public Member Functions inherited from IMP::kinematics::DOFsSampler
 DOFsSampler (DOFs dofs)
 Constructs the dofs sampler over specified dofs. More...
 
void apply_last_sample ()
 
DOF const * get_dof (unsigned int i) const
 Returns the i'th dof over which this sampler works. More...
 
DOFs const & get_dofs () const
 Returns the dofs over which this sampler works. More...
 
unsigned int get_number_of_dofs () const
 
DOFValues get_sample () const
 
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...
 
void sample_and_apply ()
 
- 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 Member Functions

virtual DOFValues do_get_sample () const override
 
- 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::kinematics::UniformBackboneSampler::UniformBackboneSampler ( DihedralAngleRevoluteJoints  joints,
DOFs  dofs 
)

Construct a uniform backbone sampler over joints, with corresponding dof properties specified in dofs

Parameters
jointsthe dihedral joints over which to sample uniformly
dofscorresponding list of dofs for each joint in joints respectively, with information about minimal / maximal dof values, etc.

Member Function Documentation

virtual void IMP::kinematics::UniformBackboneSampler::apply ( const DOFValues values)
overridevirtual

apply set of dof values in values over objects associated with this DOFsSampler (e.g., joints)

Implements IMP::kinematics::DOFsSampler.


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