MuonCalib::VariableBinwidthHistogram Class Reference

#include <VariableBinwidthHistogram.h>

Collaboration diagram for MuonCalib::VariableBinwidthHistogram:

Public Member Functions
	VariableBinwidthHistogram ()
	Default constructor. More...
	~VariableBinwidthHistogram ()
	destructor More...
bool	Initialize (TH1F *hist, double binc_r, double max_bin_width, double min_x=-9e9, double max_x=9e9)
	Initialize with new input histogram Returns on error false. More...
bool	Smooth (double width)
	Removes steps that origin in a binning effekt. More...
const VariableBinwidthHistogramBin &	GetBin (unsigned int bin) const
	Get a bin. More...
const VariableBinwidthHistogramBin &	GetSortedBin (unsigned int bin)
	Get a bin sorted by content. More...
unsigned int	GetNumberOfBins () const
	Get the number of bins More...
TGraph *	DenistyGraph () const
	create density graph - density vs bin center More...
TGraph *	BinWidthGraph () const
	Plot binwidth graph - binwidth versus bin center. More...
TGraph *	BinContentGraph () const
	Plot bin content graph - bin content vs bin center. More...
TGraph *	DiffDensityGraph () const
	Plot graph with differential density. More...
TGraph *	DiffBinwidthGraph () const
	Plot graph with differential binwidth. More...

Private Member Functions
double	sign (double val) const

Private Attributes
std::vector< VariableBinwidthHistogramBin * >	m_bins
	vector containing histogram bins More...
std::vector< VBHBinPtrSrt >	m_sort_bins
	bins sorted by content More...
unsigned int	m_binc
	number of entries per bin More...
double	m_max_bin_width
	maximum bin width More...
bool	m_error
	error flag More...
bool	m_sorted

Detailed Description

A histogram where every bin has the same number of entries. The density is represented by the bin width.

Author

Felix.nosp@m..Rau.nosp@m.scher.nosp@m.@Phy.nosp@m.sik.U.nosp@m.ni-M.nosp@m.uench.nosp@m.en.D.nosp@m.e

Date

February 2006

Definition at line 40 of file VariableBinwidthHistogram.h.

Constructor & Destructor Documentation

VariableBinwidthHistogram()

MuonCalib::VariableBinwidthHistogram::VariableBinwidthHistogram ( )

inline

Default constructor.

Definition at line 44 of file VariableBinwidthHistogram.h.

: m_binc(0), m_max_bin_width(0), m_error(false), m_sorted(false) {}

~VariableBinwidthHistogram()

MuonCalib::VariableBinwidthHistogram::~VariableBinwidthHistogram ( )

inline

destructor

Definition at line 47 of file VariableBinwidthHistogram.h.

                                            {
            for (unsigned int i = 0; i < m_bins.size(); i++) { delete m_bins[i]; }
        }

Member Function Documentation

BinContentGraph()

TGraph * MuonCalib::VariableBinwidthHistogram::BinContentGraph

(

)

const

Plot bin content graph - bin content vs bin center.

Definition at line 141 of file VariableBinwidthHistogram.cxx.

                                                             {
        Double_t *x = new Double_t[m_bins.size()], *y = new Double_t[m_bins.size()];
        for (unsigned int i = 0; i < m_bins.size(); i++) {
            x[i] = m_bins[i]->Center();
            y[i] = m_bins[i]->Entries();
        }
        TGraph *gr = new TGraph(m_bins.size(), x, y);
        return gr;
    }

BinWidthGraph()

TGraph * MuonCalib::VariableBinwidthHistogram::BinWidthGraph

(

)

const

Plot binwidth graph - binwidth versus bin center.

Definition at line 127 of file VariableBinwidthHistogram.cxx.

                                                           {
        Double_t *x = new Double_t[m_bins.size()], *y = new Double_t[m_bins.size()];
        for (unsigned int i = 0; i < m_bins.size(); i++) {
            x[i] = m_bins[i]->Center();
            y[i] = m_bins[i]->Width();
        }
        TGraph *gr = new TGraph(m_bins.size(), x, y);
        return gr;
    }

DenistyGraph()

TGraph * MuonCalib::VariableBinwidthHistogram::DenistyGraph

(

)

const

create density graph - density vs bin center

Definition at line 113 of file VariableBinwidthHistogram.cxx.

                                                          {
        Double_t *x = new Double_t[m_bins.size()], *y = new Double_t[m_bins.size()];
        for (unsigned int i = 0; i < m_bins.size(); i++) {
            x[i] = m_bins[i]->Center();
            y[i] = m_bins[i]->Density();
        }
        TGraph *gr = new TGraph(m_bins.size(), x, y);
        return gr;
    }

DiffBinwidthGraph()

TGraph * MuonCalib::VariableBinwidthHistogram::DiffBinwidthGraph

(

)

const

Plot graph with differential binwidth.

Definition at line 166 of file VariableBinwidthHistogram.cxx.

                                                               {
        if (m_bins.size() < 2) {
            MsgStream log(Athena::getMessageSvc(), "VariableBinwidthHistogram");
            log << MSG::WARNING << "DiffBinwidthGraph() - Need at alst 2 bins for differential density!" << endmsg;
            return new TGraph();
        }
        Double_t *x = new Double_t[m_bins.size() - 1], *y = new Double_t[m_bins.size() - 1];
        for (unsigned int i = 0; i < m_bins.size() - 1; i++) {
            x[i] = m_bins[i]->Center();
            y[i] = m_bins[i + 1]->Width() - m_bins[i]->Width();
        }
        TGraph *gr = new TGraph(m_bins.size() - 1, x, y);
        return gr;
    }

DiffDensityGraph()

TGraph * MuonCalib::VariableBinwidthHistogram::DiffDensityGraph

(

)

const

Plot graph with differential density.

Definition at line 151 of file VariableBinwidthHistogram.cxx.

                                                              {
        if (m_bins.size() < 2) {
            MsgStream log(Athena::getMessageSvc(), "VariableBinwidthHistogram");
            log << MSG::WARNING << "DiffDensityGraph() - Need at alst 2 bins for differential density!" << endmsg;
            return new TGraph();
        }
        Double_t *x = new Double_t[m_bins.size() - 1], *y = new Double_t[m_bins.size() - 1];
        for (unsigned int i = 0; i < m_bins.size() - 1; i++) {
            x[i] = m_bins[i]->Center();
            y[i] = m_bins[i + 1]->Density() - m_bins[i]->Density();
        }
        TGraph *gr = new TGraph(m_bins.size() - 1, x, y);
        return gr;
    }

GetBin()

const VariableBinwidthHistogramBin& MuonCalib::VariableBinwidthHistogram::GetBin ( unsigned int  bin ) const

inline

Get a bin.

Parameters

bin	The bin index of the bin. bin < VariableBinwidthHistogram :: GetNumberOfBins()

Definition at line 71 of file VariableBinwidthHistogram.h.

{ return *(m_bins[bin]); }

GetNumberOfBins()

unsigned int MuonCalib::VariableBinwidthHistogram::GetNumberOfBins ( ) const

inline

Get the number of bins

Definition at line 85 of file VariableBinwidthHistogram.h.

{ return m_bins.size(); }

GetSortedBin()

const VariableBinwidthHistogramBin& MuonCalib::VariableBinwidthHistogram::GetSortedBin ( unsigned int  bin )

inline

Get a bin sorted by content.

Parameters

bin	The bin index of the bin. bin < VariableBinwidthHistogram :: GetNumberOfBins()

Definition at line 76 of file VariableBinwidthHistogram.h.

                                                                                  {
            if (!m_sorted) {
                sort(m_sort_bins.begin(), m_sort_bins.end());
                m_sorted = true;
            }
            return m_sort_bins[bin].Bin();
        }

Initialize()

bool MuonCalib::VariableBinwidthHistogram::Initialize	(	TH1F *	hist,
		double	binc_r,
		double	max_bin_width,
		double	min_x = -9e9,
		double	max_x = 9e9
	)

Initialize with new input histogram Returns on error false.

Parameters

hist	the input histogram
binc_r	number of entries per bin / max number of entries in hist
max_bin_width	The binwidth will not exceed the maximum_bin_width
min_x	only the range between min_x and max_x will be used
max_x	only the range between min_x and max_x will be used

Definition at line 22 of file VariableBinwidthHistogram.cxx.

                                                                                                                             {
        if (binc_rate < 1.0)
            throw std::runtime_error(
                Form("File: %s, Line: %d\nVariableBinwidthHistogram::Initialize - binc_rate must be greater than 1!", __FILE__, __LINE__));
 
        // get maximum, firest bin and last bin
        double max;
        int first_bin(hist->FindBin(min_x)), last_bin(hist->FindBin(max_x));
        bool max_valid(true);
        if (first_bin == 0)
            first_bin = 1;
        else
            max_valid = false;
        if (last_bin > hist->GetNbinsX())
            last_bin = hist->GetNbinsX();
        else
            max_valid = false;
        if (max_valid)
            max = hist->GetMaximum();
        else {
            max = -9e9;
            for (int i = first_bin; i <= last_bin; i++) {
                if (max < hist->GetBinContent(i)) max = hist->GetBinContent(i);
            }
        }
        // get number of entries per bin
        m_binc = static_cast<unsigned int>(ceil(max * binc_rate));
        m_max_bin_width = max_bin_width;
        // create first bin
        m_bins.clear();
        m_bins.push_back(new VariableBinwidthHistogramBin(hist->GetBinLowEdge(first_bin) + 0.5 * max_bin_width, max_bin_width, 0));
        VariableBinwidthHistogramBin *current_bin(m_bins[0]);
        // loop on histogram bins
        for (int i = first_bin; i <= last_bin; i++) {
            // maximum binwidth reached
            if (hist->GetBinCenter(i) > current_bin->Right()) {
                m_bins.push_back(new VariableBinwidthHistogramBin(current_bin->Right() + 0.5 * m_max_bin_width, max_bin_width, 0));
                current_bin = m_bins[m_bins.size() - 1];
            }
            // will the bin be full
            if (current_bin->Entries() + static_cast<unsigned int>(hist->GetBinContent(i)) > m_binc) {
                // this will be filled in the next bin
                unsigned int overflow = current_bin->Entries() + static_cast<unsigned int>(hist->GetBinContent(i)) - m_binc;
                // the current bin ends here.
                current_bin->MoveRight(hist->GetBinLowEdge(i));
                current_bin->SetContent(m_binc);
                // create new bin
                m_bins.push_back(new VariableBinwidthHistogramBin(current_bin->Right() + 0.5 * m_max_bin_width, m_max_bin_width, overflow));
                current_bin = m_bins[m_bins.size() - 1];
                continue;
            }
            // add to content of current bin
            (*current_bin) += static_cast<unsigned int>(hist->GetBinContent(i));
        }
        // sort bins by content
        for (auto & bin : m_bins) { m_sort_bins.push_back(VBHBinPtrSrt(bin)); }
        m_sorted = false;
        m_error = false;
        return true;
    }

sign()

double MuonCalib::VariableBinwidthHistogram::sign ( double  val ) const

inlineprivate

Definition at line 122 of file VariableBinwidthHistogram.h.

                                             {
            if (val > 0.0) return 1.0;
            if (val < 0.0) return -1.0;
            if (val == 0.0) return 0;
            return 0;
        }

Smooth()

bool MuonCalib::VariableBinwidthHistogram::Smooth

(

double

width

)

Removes steps that origin in a binning effekt.

Parameters

width

smoothin parameter (typically the binwidth of the input-hisatogram)

Definition at line 87 of file VariableBinwidthHistogram.cxx.

                                                       {
        // needs at last 3 bins to smooth
        if (m_bins.size() < 3) {
            MsgStream log(Athena::getMessageSvc(), "VariableBinwidthHistogram");
            log << MSG::WARNING << "Smooth() - VBH has less than 3 bins" << endmsg;
            return false;
        }
        for (unsigned int i = 0; i < m_bins.size() - 3; i++) {
            Double_t sl1 = m_bins[i + 1]->Width() - m_bins[i]->Width();
            Double_t sl2 = m_bins[i + 2]->Width() - m_bins[i + 1]->Width();
            // slopes must be oposit sign
            if (sign(sl1) == sign(sl2)) continue;
            // prevents numerical effects
            if (std::abs(sl1) < width / 2 || std::abs(sl2) < width / 2) continue;
            // move bin boarder
            m_bins[i]->MoveRight(m_bins[i]->Right() - width / 2 * sign(sl2));
            m_bins[i + 1]->MoveLeft(m_bins[i]->Right() - width / 2 * sign(sl2));
        }
        m_sorted = false;
        return true;
    }

Member Data Documentation

m_binc

unsigned int MuonCalib::VariableBinwidthHistogram::m_binc

private

number of entries per bin

Definition at line 111 of file VariableBinwidthHistogram.h.

m_bins

std::vector<VariableBinwidthHistogramBin *> MuonCalib::VariableBinwidthHistogram::m_bins

private

vector containing histogram bins

Definition at line 105 of file VariableBinwidthHistogram.h.

m_error

bool MuonCalib::VariableBinwidthHistogram::m_error

private

error flag

Definition at line 117 of file VariableBinwidthHistogram.h.

m_max_bin_width

double MuonCalib::VariableBinwidthHistogram::m_max_bin_width

private

maximum bin width

Definition at line 114 of file VariableBinwidthHistogram.h.

m_sort_bins

std::vector<VBHBinPtrSrt> MuonCalib::VariableBinwidthHistogram::m_sort_bins

private

bins sorted by content

Definition at line 108 of file VariableBinwidthHistogram.h.

m_sorted

bool MuonCalib::VariableBinwidthHistogram::m_sorted

private

Definition at line 119 of file VariableBinwidthHistogram.h.

---

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

• VariableBinwidthHistogram.h
• VariableBinwidthHistogram.cxx