IMP logo
IMP Reference Guide  develop.ba5ef9f91e,2024/02/26
The Integrative Modeling Platform
IMP::kinematics::PathLocalPlanner Class Reference

Local planner that samples conformations on a path between two nodes. More...

#include <IMP/kinematics/local_planners.h>

+ Inheritance diagram for IMP::kinematics::PathLocalPlanner:

Detailed Description

Local planner that samples conformations on a path between two nodes.

Note
the default path planning is over a linear interpolation between the nodes

Definition at line 54 of file local_planners.h.

Public Member Functions

 PathLocalPlanner (Model *model, DOFsSampler *dofs_sampler, DirectionalDOF *directional_dof, int save_step_interval=1)
 Construct a path planner (default planning is linear) More...
 
- Public Member Functions inherited from IMP::kinematics::LocalPlanner
 LocalPlanner (Model *model, DOFsSampler *dofs_sampler)
 
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...
 
bool is_valid (const DOFValues &values, ScoringFunction *sf)
 
- 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 std::vector< DOFValuesplan (DOFValues q_from, DOFValues q_rand, ScoringFunction *sf) override
 
- Protected Member Functions inherited from IMP::Object
 Object (std::string name)
 Construct an object with the given name. More...
 
virtual void do_destroy ()
 

Additional Inherited Members

- Protected Attributes inherited from IMP::kinematics::LocalPlanner
PointerMember< DOFsSamplerdofs_sampler_
 
PointerMember< Modelmodel_
 

Constructor & Destructor Documentation

IMP::kinematics::PathLocalPlanner::PathLocalPlanner ( Model model,
DOFsSampler dofs_sampler,
DirectionalDOF directional_dof,
int  save_step_interval = 1 
)

Construct a path planner (default planning is linear)

Parameters
modelthe working model
dofs_sampleran object for sampling node configurations
directional_dofXX TODO XX
save_step_intervalthe interval for recording nodes in the path. For instance, 2 would mean save every node in the local plan.

Member Function Documentation

virtual std::vector<DOFValues> IMP::kinematics::PathLocalPlanner::plan ( DOFValues  q_from,
DOFValues  q_rand,
ScoringFunction sf 
)
overrideprotectedvirtual

plan a linear path of intermediate nodes with a properly calculated step size from existing node q_from until the valid node that is found closest to q_rand (inclusive)

Implements IMP::kinematics::LocalPlanner.


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