IMP  2.0.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 "PeriodicOptimizerState.h"
13 #include "periodic_optimizer_state_macros.h"
14 #include <IMP/Model.h>
15 #include <IMP/OptimizerState.h>
16 #include <IMP/optimizer_state_macros.h>
17 #include <IMP/io.h>
18 
19 IMPCORE_BEGIN_NAMESPACE
20 
21 /** Periodically call write the scores of the passed restraints
22  to a file. The file starts with a line whose first character
23  is a # with the names of the restraints separated by commas
24  and then has one line per periodic update with comma
25  separated scores for each restraint.
26 */
27 class IMPCOREEXPORT WriteRestraintScoresOptimizerState:
28  public PeriodicOptimizerState {
29  Restraints rs_;
30  base::TextOutput out_;
31  public:
32  WriteRestraintScoresOptimizerState(const Restraints &rs,
33  base::TextOutput out);
34  protected:
35  virtual void do_update(unsigned int call_num) IMP_OVERRIDE;
36  IMP_OBJECT_METHODS(WriteRestraintScoresOptimizerState);
37 };
38 
39 IMPCORE_END_NAMESPACE
40 
41 #endif /* IMPCORE_MODEL_STATISTICS_H */