IMP logo
IMP Reference Guide  2.21.0
The Integrative Modeling Platform
IMP::npctransport::BodyStatisticsOptimizerState Class Reference

#include <IMP/npctransport/BodyStatisticsOptimizerState.h>

+ Inheritance diagram for IMP::npctransport::BodyStatisticsOptimizerState:

Detailed Description

Track the rotational correlation time of a rigid body particle The correlation with at most the last 100 updates is tracked

Definition at line 26 of file BodyStatisticsOptimizerState.h.

Public Member Functions

 BodyStatisticsOptimizerState (Particle *p, IMP::npctransport::Statistics *statistics_manager=nullptr, unsigned int periodicity=1)
 
virtual void do_update (unsigned int call_num) override
 
double get_correlation_time () const
 
double get_diffusion_coefficient () 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 reset () override
 Reset counters, as if at the start of an optimize run. More...
 
void update_particle_type_zr_distribution_map ()
 
- Public Member Functions inherited from IMP::OptimizerState
 OptimizerState (Model *m, std::string name)
 Constructor. More...
 
unsigned int get_number_of_updates () const
 Return the number of times do_update() has been called. More...
 
Optimizerget_optimizer () const
 
unsigned int get_period () const
 Get the periodicity of this state. More...
 
virtual void set_is_optimizing (bool)
 Called by an Optimizer to signal begin/end of an optimize run. More...
 
void set_number_of_updates (unsigned int n)
 Set the counter of number of times do_update() has been called. More...
 
void set_period (unsigned int p)
 Set the periodicity of this state. More...
 
virtual void update ()
 Called when the Optimizer accepts a new conformation. More...
 
void update_always ()
 Force the state to perform its action now, ignoring the periodicity. More...
 
- Public Member Functions inherited from IMP::ModelObject
 ModelObject (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::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::OptimizerState
virtual ModelObjectsTemp do_get_inputs () const override
 
virtual ModelObjectsTemp do_get_outputs () const override
 
virtual void do_set_is_optimizing (bool)
 
- Protected Member Functions inherited from IMP::ModelObject
virtual ModelObjectsTemps do_get_interactions () const
 
virtual void handle_set_has_required_score_states (bool)
 
- 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::npctransport::BodyStatisticsOptimizerState::BodyStatisticsOptimizerState ( Particle p,
IMP::npctransport::Statistics statistics_manager = nullptr,
unsigned int  periodicity = 1 
)
Parameters
pthe particle being wrapped
statistics_manageran optional statistical manager to which statistical updates are sent (of e.g. zr-distribution that are collectively gathered)
periodicityframe interval for statistics, equiv. to set_period(1)

Member Function Documentation

virtual void IMP::npctransport::BodyStatisticsOptimizerState::do_update ( unsigned int  )
overridevirtual

This method is called every get_period() update calls. The number of times this method has been called since the last reset or start of the optimization run is passed.

Reimplemented from IMP::OptimizerState.

virtual ::IMP::VersionInfo IMP::npctransport::BodyStatisticsOptimizerState::get_version_info ( ) const
overridevirtual

Get information about the module and version of the object.

Reimplemented from IMP::Object.

Definition at line 68 of file BodyStatisticsOptimizerState.h.

void IMP::npctransport::BodyStatisticsOptimizerState::reset ( )
overridevirtual

Reset counters, as if at the start of an optimize run.

Reimplemented from IMP::OptimizerState.

void IMP::npctransport::BodyStatisticsOptimizerState::update_particle_type_zr_distribution_map ( )

updates the z-r distriubution table in owner's statistics for this particle type (distribution of z coordinates and r coordinates)


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