ana::Ratio Class Reference

Represent the ratio between two spectra. More...

#include <Ratio.h>

Public Member Functions
	Ratio (const Spectrum &num, const Spectrum &denom, bool purOrEffErrs=false)
	Ratio (TH1 *h, std::string varName="")
	Don't use this constructor unless you REALLY KNOW what you're doing. More...
virtual	~Ratio ()
	Ratio (const Ratio &rhs)
Ratio &	operator= (const Ratio &rhs)
Ratio &	operator*= (const Ratio &rhs)
Ratio	operator* (const Ratio &rhs) const
Ratio &	operator/= (const Ratio &rhs)
Ratio	operator/ (const Ratio &rhs) const
TH1D *	ToTH1 (Color_t col=kBlack, Style_t style=kSolid) const

Protected Attributes
TH1D *	fHist

Friends
class	Spectrum

Detailed Description

Represent the ratio between two spectra.

Definition at line 8 of file Ratio.h.

Constructor & Destructor Documentation

ana::Ratio::Ratio	(	const Spectrum &	num,
		const Spectrum &	denom,
		bool	purOrEffErrs = false
	)

Parameters

num	Numerator of the ratio
denom	Denominator of the ratio
purOrEffErrs	Does this ratio represent a purity or efficiency plot? If so, error bars are calculated differently.

Definition at line 13 of file Ratio.cxx.

  {
    // Scale to same arbitrary POT
    fHist = num.ToTH1(1e20);
    TH1D* temp = denom.ToTH1(1e20);
    if(purOrEffErrs){
      fHist->Divide(fHist, temp, 1, 1, "B");
    }
    else{
      fHist->Divide(temp);
    }
    HistCache::Delete(temp);

    fHist->GetYaxis()->SetTitle("Ratio");

    // TODO: set error bars smartly
  }

ana::Ratio::Ratio	(	TH1 *	h,
		std::string	varName = ""
	)

Don't use this constructor unless you REALLY KNOW what you're doing.

Definition at line 33 of file Ratio.cxx.

  {
    if(!h){
      fHist = 0;
      return;
    }

    DontAddDirectory guard;

    const TString className = h->ClassName();

    if(className == "TH1D"){
      // Shortcut if types match
      fHist = HistCache::Copy((TH1D*)h);
    }
    else{
      fHist = HistCache::New(UniqueName(), h->GetXaxis());
      fHist->GetXaxis()->SetTitle(h->GetXaxis()->GetTitle());
      fHist->Add(h);
    }

    if(!varName.empty()) fHist->GetXaxis()->SetTitle(varName.c_str());
  }

ana::Ratio::~Ratio ( )

virtual

Definition at line 58 of file Ratio.cxx.

  {
    HistCache::Delete(fHist);
  }

ana::Ratio::Ratio

(

const Ratio &

rhs

)

Definition at line 64 of file Ratio.cxx.

  {
    DontAddDirectory guard;

    assert(rhs.fHist);
    fHist = HistCache::Copy(rhs.fHist);
  }

Member Function Documentation

Ratio ana::Ratio::operator*

(

const Ratio &

rhs

)

const

Definition at line 93 of file Ratio.cxx.

  {
    Ratio ret = *this;
    ret *= rhs;
    return ret;
  }

Ratio & ana::Ratio::operator*=

(

const Ratio &

rhs

)

Definition at line 86 of file Ratio.cxx.

  {
    fHist->Multiply(rhs.fHist);
    return *this;
  }

Ratio ana::Ratio::operator/

(

const Ratio &

rhs

)

const

Definition at line 108 of file Ratio.cxx.

  {
    Ratio ret = *this;
    ret /= rhs;
    return ret;
  }

Ratio & ana::Ratio::operator/=

(

const Ratio &

rhs

)

Definition at line 101 of file Ratio.cxx.

  {
    fHist->Divide(rhs.fHist);
    return *this;
  }

Ratio & ana::Ratio::operator=

(

const Ratio &

rhs

)

Definition at line 73 of file Ratio.cxx.

  {
    if(this == &rhs) return *this;

    DontAddDirectory guard;

    HistCache::Delete(fHist);
    assert(rhs.fHist);
    fHist = HistCache::Copy(rhs.fHist);
    return *this;
  }

TH1D * ana::Ratio::ToTH1	(	Color_t	col = kBlack,
		Style_t	style = kSolid
	)		const

Definition at line 116 of file Ratio.cxx.

  {
    // Could have a file temporarily open
    DontAddDirectory guard;

    TH1D* ret = HistCache::Copy(fHist);
    ret->SetLineColor(col);
    ret->SetLineStyle(style);
    return ret;
  }

Friends And Related Function Documentation

friend class Spectrum

friend

Definition at line 11 of file Ratio.h.

Member Data Documentation

TH1D* ana::Ratio::fHist

protected

Definition at line 36 of file Ratio.h.

---

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

• Ratio.h
• Ratio.cxx