Tomographer::ValueHistogramWithBinningMHRWStatsCollectorResult< HistogramType_, BinningAnalysisParamsType_ > Struct Template Reference

Result type of a ValueHistogramWithBinningMHRWStatsCollector. More...

#include <tomographer/mhrwstatscollectors.h>

Inheritance diagram for Tomographer::ValueHistogramWithBinningMHRWStatsCollectorResult< HistogramType_, BinningAnalysisParamsType_ >:

Collaboration diagram for Tomographer::ValueHistogramWithBinningMHRWStatsCollectorResult< HistogramType_, BinningAnalysisParamsType_ >:

Public Types
typedef HistogramType_	HistogramType
typedef HistogramType::Params	HistogramParams
typedef BinningAnalysisParamsType_	BinningAnalysisParamsType

Public Member Functions
	ValueHistogramWithBinningMHRWStatsCollectorResult ()
	Simple default constructor (e.g. to use as std::vector<Result>).
	ValueHistogramWithBinningMHRWStatsCollectorResult (ValueHistogramWithBinningMHRWStatsCollectorResult &&)=default
	ValueHistogramWithBinningMHRWStatsCollectorResult (const ValueHistogramWithBinningMHRWStatsCollectorResult &copy)
template<typename EigenDerived1 , typename EigenDerived2 >
	ValueHistogramWithBinningMHRWStatsCollectorResult (const HistogramType &histogram_, const Eigen::DenseBase< EigenDerived1 > &error_levels_, const Eigen::DenseBase< EigenDerived2 > &converged_status_)
	Simple constructor with direct initialization of fields.
template<typename BinningAnalysisType >
	ValueHistogramWithBinningMHRWStatsCollectorResult (HistogramParams p, const BinningAnalysisType &b)
	Constructor which initializes the fields from the histogram and binning analysis type.
BinningErrorBarConvergenceSummary	errorBarConvergenceSummary () const
	A summary of the convergence status of the binning error bars.
void	dumpConvergenceAnalysis (std::ostream &stream) const
	Dump values, error bars and convergence status in verbose, debug-human-readable form into ostream.
std::string	dumpConvergenceAnalysis () const
	Dump values, error bars and convergence status in verbose, debug-human-readable form as string.

Public Attributes
HistogramType	histogram
	Histogram, already with error bars. More...
BinningAnalysisParamsType::BinSumSqArray	error_levels
	Detailed error bars for all binning levels.
Eigen::ArrayXi	converged_status
	Information of convergence status of the error bars (see e.g. BINNING_CONVERGED)

Detailed Description

template<typename HistogramType_, typename BinningAnalysisParamsType_>
struct Tomographer::ValueHistogramWithBinningMHRWStatsCollectorResult< HistogramType_, BinningAnalysisParamsType_ >

Result type of a ValueHistogramWithBinningMHRWStatsCollector.

Stores a histogram with error bars, detailed information about error bars at different binning levels, and information about the convergence of these error bars.

Since

Since Tomographer 5.3, this class can be serialized with Boost.Serialization (HistogramType needs to be serializable)

Definition at line 595 of file mhrwstatscollectors.h.

Member Data Documentation

histogram

template<typename HistogramType_ , typename BinningAnalysisParamsType_ >

HistogramType Tomographer::ValueHistogramWithBinningMHRWStatsCollectorResult< HistogramType_, BinningAnalysisParamsType_ >::histogram

Histogram, already with error bars.

The scaling of the histogram is chosen such that each bin value represents the fraction of sample data points whose value were inside this bin.

Note

This histogram is not normalized to unit area. You should call HistogramWithErrorBars::normalized() to obtain a proper normalized histogram, i.e. to which one can fit a proper, normalized probability density.

Definition at line 655 of file mhrwstatscollectors.h.

---

The documentation for this struct was generated from the following file:

• tomographer/mhrwstatscollectors.h (v5.3)