Tomographer::BinningErrorBarConvergenceSummary Struct Reference

Brief summary of convergence of error bars from a binning analysis. More...

#include <tomographer/mhrw_bin_err.h>

Public Member Functions
	BinningErrorBarConvergenceSummary (Eigen::Index n_bins_=0, Eigen::Index n_converged_=0, Eigen::Index n_unknown_=0, Eigen::Index n_unknown_isolated_=0, Eigen::Index n_not_converged_=0)

Static Public Member Functions
static BinningErrorBarConvergenceSummary	fromConvergedStatus (const Eigen::Ref< const Eigen::ArrayXi > &converged_status)
	Construct a summary object from a list of converged status obtained from BinningAnalysis::determineErrorConvergence()

Public Attributes
Eigen::Index	n_bins
Eigen::Index	n_converged
Eigen::Index	n_unknown
Eigen::Index	n_unknown_isolated
Eigen::Index	n_not_converged

Detailed Description

Brief summary of convergence of error bars from a binning analysis.

This brief summary stores the total number of bins (n_bins), the number of bins with converged error bars (n_converged), the number of bins with unknown convergence (n_unknown), how many of the latter are isolated (n_unknown_isolated), and how many bins have error bars which have not converged (n_not_converged).

One always has n_converged + n_unknown + n_not_converged == n_bins and n_unkonwn_isolated <= n_unknown.

The reason for the Eigen::Index type is because we count number of bins in a Histogram, which has Eigen types.

Since

Added in Tomographer 5.0.

Definition at line 107 of file mhrw_bin_err.h.

---

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

• tomographer/mhrw_bin_err.h (v5.2)