BCSummaryTool Class Reference

A class for summarizing the results of an analysis. More...

#include <BCSummaryTool.h>

Public Member Functions
Constructors and destructors
	BCSummaryTool ()
	BCSummaryTool (BCModel *model)
	~BCSummaryTool ()
Member functions (get)
BCSummaryPriorModel *	GetPriorModel ()
Member functions (set)
void	SetModel (BCModel *model)
Member functions (misc)
int	CalculatePriorModel ()
int	CopySummaryData ()
int	PrintParameterPlot (const char *filename="parameters.pdf")
int	PrintCorrelationMatrix (const char *filename="matrix.pdf")
int	PrintCorrelationPlot (const char *filename="correlation.pdf")
int	DrawKnowledgeUpdatePlot1D (int index, std::string options_post="", std::string options_prior="")
int	PrintKnowledgeUpdatePlot1D (int index, const char *filename, std::string options_post="", std::string options_prior="")
int	PrintKnowledgeUpdatePlots (const char *filename="update.pdf", std::string options="")
int	PrintParameterLatex (const char *filename)

Detailed Description

A class for summarizing the results of an analysis.

This class can be used to summarize the results of an analysis. The prior and posterior probabilities are compared.

Author

Daniel Kollar

Kevin Kröninger

Version

1.0.0

Date

15.02.2010

Definition at line 34 of file BCSummaryTool.h.

Constructor & Destructor Documentation

BCSummaryTool::BCSummaryTool

(

)

The default constructor.

Definition at line 42 of file BCSummaryTool.cxx.

BCSummaryTool::BCSummaryTool

(

BCModel *

model

)

A constructor.

Definition at line 62 of file BCSummaryTool.cxx.

BCSummaryTool::~BCSummaryTool

(

)

The default destructor.

Definition at line 82 of file BCSummaryTool.cxx.

Member Function Documentation

int BCSummaryTool::CalculatePriorModel

(

)

Calculate the marginalized distributions using the prior knowledge alone.

Returns

An error flag.

Definition at line 931 of file BCSummaryTool.cxx.

int BCSummaryTool::CopySummaryData

(

)

Copy the summary information from the model.

Returns

An error flag.

Definition at line 88 of file BCSummaryTool.cxx.

int BCSummaryTool::DrawKnowledgeUpdatePlot1D	(	int	index,
		std::string	options_post = "",
		std::string	options_prior = ""
	)

Draw a comparison of the prior knowledge to the posterior knowledge for each parameter.

Returns

An error flag.

Definition at line 583 of file BCSummaryTool.cxx.

BCSummaryPriorModel* BCSummaryTool::GetPriorModel ( )

inline

Retrieve pointer to the Prior model to allow for its detailed setup

Definition at line 59 of file BCSummaryTool.h.

int BCSummaryTool::PrintCorrelationMatrix

(

const char *

filename = "matrix.pdf"

)

Print a correlation matrix for the parameters.

Returns

An error flag.

Definition at line 317 of file BCSummaryTool.cxx.

int BCSummaryTool::PrintCorrelationPlot

(

const char *

filename = "correlation.pdf"

)

Print a correlation plot for the parameters.

Returns

An error flag.

Definition at line 414 of file BCSummaryTool.cxx.

int BCSummaryTool::PrintKnowledgeUpdatePlot1D	(	int	index,
		const char *	filename,
		std::string	options_post = "",
		std::string	options_prior = ""
	)

Print a comparison of the prior knowledge to the posterior knowledge for each parameter.

Returns

An error flag.

Definition at line 563 of file BCSummaryTool.cxx.

int BCSummaryTool::PrintKnowledgeUpdatePlots	(	const char *	filename = "update.pdf",
		std::string	options = ""
	)

Print a comparison of the prior knowledge to the posterior knowledge for each parameter.

Returns

An error flag.

Definition at line 709 of file BCSummaryTool.cxx.

int BCSummaryTool::PrintParameterLatex

(

const char *

filename

)

Print a Latex table of the parameters.

Returns

An error flag.

Definition at line 873 of file BCSummaryTool.cxx.

int BCSummaryTool::PrintParameterPlot

(

const char *

filename = "parameters.pdf"

)

Print a summary plot for the parameters.

Returns

An error flag.

Definition at line 166 of file BCSummaryTool.cxx.

void BCSummaryTool::SetModel ( BCModel *  model )

inline

Set the model to be summarized.

Parameters

model

The BCModel to be summarized.

Definition at line 69 of file BCSummaryTool.h.

---

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

• /home/beaujean/workspace/bat/BAT/BCSummaryTool.h
• /home/beaujean/workspace/bat/src/BCSummaryTool.cxx