IMP  2.1.1
The Integrative Modeling Platform
model_statistics.h
Go to the documentation of this file.
1 /**
2  * \file IMP/core/model_statistics.h
3  * \brief Log the restraint scores and things.
4  *
5  * Copyright 2007-2013 IMP Inventors. All rights reserved.
6  */
7 
8 #ifndef IMPCORE_MODEL_STATISTICS_H
9 #define IMPCORE_MODEL_STATISTICS_H
10 
11 #include <IMP/core/core_config.h>
12 #include <IMP/kernel/Model.h>
13 #include <IMP/kernel/OptimizerState.h>
14 #include <IMP/io.h>
15 
16 IMPCORE_BEGIN_NAMESPACE
17 
18 /** Periodically call write the scores of the passed restraints
19  to a file. The file starts with a line whose first character
20  is a # with the names of the restraints separated by commas
21  and then has one line per periodic update with comma
22  separated scores for each restraint.
23 */
24 class IMPCOREEXPORT WriteRestraintScoresOptimizerState
25  : public kernel::OptimizerState {
26  kernel::Restraints rs_;
27  base::TextOutput out_;
28 
29  public:
30  WriteRestraintScoresOptimizerState(const kernel::Restraints &rs,
31  base::TextOutput out);
32 
33  protected:
34  virtual void do_update(unsigned int call_num) IMP_OVERRIDE;
35  IMP_OBJECT_METHODS(WriteRestraintScoresOptimizerState);
36 };
37 
38 IMPCORE_END_NAMESPACE
39 
40 #endif /* IMPCORE_MODEL_STATISTICS_H */
IMP::kernel::OptimizerState::do_update
virtual void do_update(unsigned int)
Definition: kernel/OptimizerState.h:123
IMP::kernel::OptimizerState
Shared optimizer state that is invoked upon commitment of new coordinates.
Definition: kernel/OptimizerState.h:43
io.h
Import IMP/kernel/io.h in the namespace.
OptimizerState.h
Shared optimizer state.
IMP_OBJECT_METHODS
#define IMP_OBJECT_METHODS(Name)
Define the basic things needed by any Object.
Definition: base/object_macros.h:25
Model.h
Storage of a model, its restraints, constraints and particles.