Tomographer::MHRWTasks::ValueHistogramTools Namespace Reference

Tools for running random walk tasks while collecting a histogram of values More...

Classes
struct	CDataBase
	Constant data structure for MH random walk tasks with a value histogram stats collector. More...
struct	MHRWStatsResultsBaseSimple
	Stores the result of the value histogram stats collector (version without binning analysis) More...

Functions
template<typename CDataBaseType , typename TaskResultType , typename AggregatedHistogramType >
void	printFinalReport (std::ostream &stream, const CDataBaseType &cdata, const std::vector< TaskResultType *> &task_results, const AggregatedHistogramType &aggregated_histogram, int max_width=0, bool print_histogram=true)
	Produce a final, human-readable report of the whole procedure. More...

Detailed Description

Tools for running random walk tasks while collecting a histogram of values

These tools build on top of Tomographer::MHRWTasks to add specific support for collecting a histogram of values during the random walk, including a binning analysis for error bars, and then aggregating the results of each task together to form an averaged histogram.

The CData class Tomographer::MHRWTasks::ValueHistogramTools::CDataBase should be used as CData class to define your random walk task, as it provides additional typedefs as well as automatic construction of the value stats collector.

Since

Namespace added in Tomographer 5.0 to replace Tomographer::MHRWTasks::ValueHistogramTasks.

Function Documentation

printFinalReport()

template<typename CDataBaseType , typename TaskResultType , typename AggregatedHistogramType >

void Tomographer::MHRWTasks::ValueHistogramTools::printFinalReport ( std::ostream &  stream, const CDataBaseType &  cdata, const std::vector< TaskResultType *> &  task_results, const AggregatedHistogramType &  aggregated_histogram, int  max_width = 0, bool  print_histogram = true  )

inline

Produce a final, human-readable report of the whole procedure.

The report is written in the C++ stream str. You should provide the shared constant data structure cdata used for the random walk, so that the random walk parameters can be displayed.

You may specify the maximum width of your terminal in max_width, in which case we try very hard not make lines longer than that, and to fill all available horizontal space.

If print_histogram is true, then the histogram is also printed in a human readable form, using HistogramWithErrorBars::prettyPrint().

Definition at line 512 of file mhrw_valuehist_tools.h.