BAT  0.9.4
The Bayesian analysis toolkit
 All Classes Namespaces Functions Variables Enumerations
BCSummaryTool.h
1 #ifndef __BCSUMMARYTOOL__H
2 #define __BCSUMMARYTOOL__H
3 
16 /*
17  * Copyright (C) 2007-2014, the BAT core developer team
18  * All rights reserved.
19  *
20  * For the licensing terms see doc/COPYING.
21  * For documentation see http://mpp.mpg.de/bat
22  */
23 
24 // ---------------------------------------------------------
25 
26 #include <string>
27 #include <vector>
28 
29 class BCModel;
31 
32 // ---------------------------------------------------------
33 
35 {
36  public:
37 
43  BCSummaryTool();
44 
47  BCSummaryTool(BCModel * model);
48 
52 
60  { return fPriorModel; }
61 
69  void SetModel(BCModel * model)
70  { fModel = model; };
71 
81  int CalculatePriorModel();
82 
86  int CopySummaryData();
87 
91  int PrintParameterPlot(const char * filename = "parameters.pdf");
92 
96  int PrintCorrelationMatrix(const char * filename = "matrix.pdf");
97 
101  int PrintCorrelationPlot(const char * filename = "correlation.pdf");
102 
107  int DrawKnowledgeUpdatePlot1D(int index, std::string options_post="", std::string options_prior="");
108 
113  int PrintKnowledgeUpdatePlot1D(int index, const char * filename, std::string options_post="", std::string options_prior="");
114 
119  int PrintKnowledgeUpdatePlots(const char * filename = "update.pdf", std::string options="");
120 
124  int PrintParameterLatex(const char * filename);
125 
128  private:
129 
131  static unsigned int getNextIndex()
132  { return ++fHCounter; }
133 
135  static unsigned int fHCounter;
136 
139  BCModel * fModel;
140 
143  std::vector<std::string> fParName;
144 
147  std::vector<double> fParMin;
148 
151  std::vector<double> fParMax;
152 
156  std::vector<double> fCorrCoeff;
157 
161  std::vector<double> fMargMode;
162 
166  std::vector<double> fMean;
167 
171  std::vector<double> fGlobalMode;
172 
177  std::vector<double> fQuantiles;
178 
184  std::vector<double> fSmallInt;
185 
189  std::vector<double> fRMS;
190 
193  std::vector<double> fSumProb;
194 
198  BCSummaryPriorModel * fPriorModel;
199 
202  bool fFlagInfoMarg;
203 
206  bool fFlagInfoOpt;
207 
208 };
209 // ---------------------------------------------------------
210 
211 #endif
212 
A helper class for the BCSummaryTool.
int PrintCorrelationMatrix(const char *filename="matrix.pdf")
int DrawKnowledgeUpdatePlot1D(int index, std::string options_post="", std::string options_prior="")
A class for summarizing the results of an analysis.
Definition: BCSummaryTool.h:34
The base class for all user-defined models.
Definition: BCModel.h:50
int PrintKnowledgeUpdatePlots(const char *filename="update.pdf", std::string options="")
int CalculatePriorModel()
void SetModel(BCModel *model)
Definition: BCSummaryTool.h:69
int PrintParameterPlot(const char *filename="parameters.pdf")
int PrintCorrelationPlot(const char *filename="correlation.pdf")
int PrintParameterLatex(const char *filename)
BCSummaryPriorModel * GetPriorModel()
Definition: BCSummaryTool.h:59
int PrintKnowledgeUpdatePlot1D(int index, const char *filename, std::string options_post="", std::string options_prior="")