Quick Links: ROOT Homepage Class Index Class Hierarchy

Source: header file inheritance tree (.pdf)

Sections: class description function members data members class charts

class TRatioPlot: public TObject


ROOT_TRatioPlot

A collection of histograms

Function Members (Methods)

public:

virtual	~TRatioPlot()
void	TObject::AbstractMethod(const char* method) const
virtual void	TObject::AppendPad(Option_t* option = "")
virtual void	Browse(TBrowser* b)
static TClass*	Class()
virtual const char*	TObject::ClassName() const
virtual void	TObject::Clear(Option_t* = "")
virtual TObject*	TObject::Clone(const char* newname = "") const
virtual Int_t	TObject::Compare(const TObject* obj) const
virtual void	TObject::Copy(TObject& object) const
virtual void	TObject::Delete(Option_t* option = "")MENU
virtual Int_t	TObject::DistancetoPrimitive(Int_t px, Int_t py)
virtual void	Draw(Option_t* chopt = "")
virtual void	TObject::DrawClass() constMENU
virtual TObject*	TObject::DrawClone(Option_t* option = "") constMENU
virtual void	TObject::Dump() constMENU
virtual void	TObject::Error(const char* method, const char* msgfmt) const
virtual void	TObject::Execute(const char* method, const char* params, Int_t* error = 0)
virtual void	TObject::Execute(TMethod* method, TObjArray* params, Int_t* error = 0)
virtual void	TObject::ExecuteEvent(Int_t event, Int_t px, Int_t py)
virtual void	TObject::Fatal(const char* method, const char* msgfmt) const
virtual TObject*	TObject::FindObject(const char* name) const
virtual TObject*	TObject::FindObject(const TObject* obj) const
TGraph*	GetCalculationOutputGraph() const
TGraphErrors*	GetConfidenceInterval1() const
TGraphErrors*	GetConfidenceInterval2() const
virtual Option_t*	TObject::GetDrawOption() const
static Long_t	TObject::GetDtorOnly()
virtual const char*	TObject::GetIconName() const
TPad*	GetLowerPad() const
virtual TGraph*	GetLowerRefGraph() const
TAxis*	GetLowerRefXaxis() const
TAxis*	GetLowerRefYaxis() const
TAxis*	GetLowYaxis() const
virtual const char*	TObject::GetName() const
virtual char*	TObject::GetObjectInfo(Int_t px, Int_t py) const
static Bool_t	TObject::GetObjectStat()
virtual Option_t*	TObject::GetOption() const
Float_t	GetSeparationMargin() const
virtual const char*	TObject::GetTitle() const
virtual UInt_t	TObject::GetUniqueID() const
TPad*	GetUpperPad() const
virtual TObject*	GetUpperRefObject() const
TAxis*	GetUpperRefXaxis() const
TAxis*	GetUpperRefYaxis() const
TAxis*	GetUpYaxis() const
TAxis*	GetXaxis() const
virtual Bool_t	TObject::HandleTimer(TTimer* timer)
virtual ULong_t	TObject::Hash() const
virtual void	TObject::Info(const char* method, const char* msgfmt) const
virtual Bool_t	TObject::InheritsFrom(const char* classname) const
virtual Bool_t	TObject::InheritsFrom(const TClass* cl) const
virtual void	TObject::Inspect() constMENU
void	TObject::InvertBit(UInt_t f)
virtual TClass*	IsA() const
virtual Bool_t	TObject::IsEqual(const TObject* obj) const
virtual Bool_t	TObject::IsFolder() const
Bool_t	TObject::IsOnHeap() const
virtual Bool_t	TObject::IsSortable() const
Bool_t	TObject::IsZombie() const
virtual void	TObject::ls(Option_t* option = "") const
void	TObject::MayNotUse(const char* method) const
virtual Bool_t	TObject::Notify()
void	TObject::Obsolete(const char* method, const char* asOfVers, const char* removedFromVers) const
void	TObject::operator delete(void* ptr)
void	TObject::operator delete(void* ptr, void* vp)
void	TObject::operator delete[](void* ptr)
void	TObject::operator delete[](void* ptr, void* vp)
void*	TObject::operator new(size_t sz)
void*	TObject::operator new(size_t sz, void* vp)
void*	TObject::operator new[](size_t sz)
void*	TObject::operator new[](size_t sz, void* vp)
virtual void	Paint(Option_t* opt = "")
virtual void	TObject::Pop()
virtual void	TObject::Print(Option_t* option = "") const
void	RangeAxisChanged()
virtual Int_t	TObject::Read(const char* name)
virtual void	TObject::RecursiveRemove(TObject* obj)
void	TObject::ResetBit(UInt_t f)
virtual void	TObject::SaveAs(const char* filename = "", Option_t* option = "") constMENU
virtual void	TObject::SavePrimitive(ostream& out, Option_t* option = "")
void	TObject::SetBit(UInt_t f)
void	TObject::SetBit(UInt_t f, Bool_t set)
void	SetC1(Double_t c1)
void	SetC2(Double_t c2)
void	SetConfidenceIntervalColors(Color_t ci1 = kGreen, Color_t ci2 = kYellow)
void	SetConfidenceLevels(Double_t cl1, Double_t cl2)
virtual void	TObject::SetDrawOption(Option_t* option = "")MENU
static void	TObject::SetDtorOnly(void* obj)
void	SetFitDrawOpt(Option_t* opt)
void	SetFitResult(TFitResultPtr fitres)
void	SetGraphDrawOpt(Option_t* opt)
virtual void	SetGridlines(vector<double> gridlines)
virtual void	SetGridlines(Double_t* gridlines, Int_t numGridlines)
void	SetH1DrawOpt(Option_t* opt)
void	SetH2DrawOpt(Option_t* opt)
void	SetInsetWidth(Double_t width)
void	SetLeftMargin(Float_t margin)
void	SetLowBottomMargin(Float_t margin)
void	SetLowTopMargin(Float_t margin)
static void	TObject::SetObjectStat(Bool_t stat)
void	SetRightMargin(Float_t margin)
void	SetSeparationMargin(Float_t)
void	SetSplitFraction(Float_t sf)
virtual void	TObject::SetUniqueID(UInt_t uid)
void	SetUpBottomMargin(Float_t margin)
void	SetUpTopMargin(Float_t margin)
virtual void	ShowMembers(TMemberInspector& insp) const
virtual void	Streamer(TBuffer&)
void	StreamerNVirtual(TBuffer& ClassDef_StreamerNVirtual_b)
void	SubPadResized()
virtual void	TObject::SysError(const char* method, const char* msgfmt) const
Bool_t	TObject::TestBit(UInt_t f) const
Int_t	TObject::TestBits(UInt_t f) const
	TRatioPlot()
	TRatioPlot(TH1* h1, TH1* h2, Option_t* option = "pois")
	TRatioPlot(THStack* st, TH1* h2, Option_t* option = "pois")
	TRatioPlot(TH1* h1, Option_t* option = "", TFitResult* fitres = 0)
void	UnZoomed()
virtual void	TObject::UseCurrentStyle()
virtual void	TObject::Warning(const char* method, const char* msgfmt) const
virtual Int_t	TObject::Write(const char* name = 0, Int_t option = 0, Int_t bufsize = 0)
virtual Int_t	TObject::Write(const char* name = 0, Int_t option = 0, Int_t bufsize = 0) const

protected:

void	BuildLowerPlot()
void	CreateGridline()
virtual void	CreateVisualAxes()
virtual void	TObject::DoError(int level, const char* location, const char* fmt, va_list va) const
void	ImportAxisAttributes(TGaxis* gaxis, TAxis* axis)
virtual void	Init(TH1* h1, TH1* h2, Option_t* option = "")
Bool_t	IsDrawn()
void	TObject::MakeZombie()
void	SetPadMargins()
virtual void	SetupPads()
virtual void	SyncAxesRanges()
virtual Bool_t	SyncPadMargins()

private:

TRatioPlot&	operator=(const TRatioPlot&)
	TRatioPlot(const TRatioPlot& hrp)

Data Members

public:

static TObject::(anonymous)	TObject::kBitMask
static TObject::EStatusBits	TObject::kCanDelete
static TObject::EStatusBits	TObject::kCannotPick
static TObject::EStatusBits	TObject::kHasUUID
static TObject::EStatusBits	TObject::kInvalidObject
static TObject::(anonymous)	TObject::kIsOnHeap
static TObject::EStatusBits	TObject::kIsReferenced
static TObject::EStatusBits	TObject::kMustCleanup
static TObject::EStatusBits	TObject::kNoContextMenu
static TObject::(anonymous)	TObject::kNotDeleted
static TObject::EStatusBits	TObject::kObjInCanvas
static TObject::(anonymous)	TObject::kOverwrite
static TObject::(anonymous)	TObject::kSingleKey
static TObject::(anonymous)	TObject::kWriteDelete
static TObject::(anonymous)	TObject::kZombie

protected:

Double_t	fC1	Stores the scale factor for h1 (or THStack sum)
Double_t	fC2	Stores the scale factor for h2
Color_t	fCi1Color	Stores the color for the 1 sigma band
Color_t	fCi2Color	Stores the color for the 2 sigma band
Double_t	fCl1	Stores the confidence level for the inner confidence interval band
Double_t	fCl2	Stores the confidence level for the outer confidence interval band
TGraphErrors*	fConfidenceInterval1	Stores the graph for the 1 sigma band
TGraphErrors*	fConfidenceInterval2	Stores the graph for the 2 sigma band
Int_t	fErrorMode	Stores the error mode, sym, asym or func
TString	fFitDrawOpt	Stores draw option for the fit function in the fit residual case
TFitResult*	fFitResult	Stores the explicit fit result given in the fit residual case. Can be 0
TString	fGraphDrawOpt	Stores draw option for the lower plot graph given in constructor
vector<double>	fGridlinePositions	Stores the y positions for the gridlines
vector<TLine*>	fGridlines	Keeps TLine objects for the gridlines
TH1*	fH1	Stores the primary histogram
TString	fH1DrawOpt	Stores draw option for h1 given in constructor
TH1*	fH2	Stores the secondary histogram, if there is one
TString	fH2DrawOpt	Stores draw option for h2 given in constructor
Int_t	fHideLabelMode	Stores which label to hide if the margin is to narrow, if at all
TObject*	fHistDrawProxy	The object which is actually drawn, this might be TH1 or THStack
Float_t	fInsetWidth
Bool_t	fIsPadUpdating	Keeps track whether pads are updating during resizing
Bool_t	fIsUpdating	Keeps track of whether its currently updating to reject other calls until done
Float_t	fLeftMargin	Stores the common left margin of both pads
Float_t	fLowBottomMargin	Stores the bottom margin of the lower pad
Float_t	fLowTopMargin	Stores the top margin of the lower pad
TAxis*	fLowYaxis	Clone of the lower y axis
TGaxis*	fLowerGXaxis	Lower graphical x axis
TGaxis*	fLowerGXaxisMirror	Lower mirror of the x axis
TGaxis*	fLowerGYaxis	Lower graphical y axis
TGaxis*	fLowerGYaxisMirror	Lower mirror of the y axis
TPad*	fLowerPad	The pad which contains the calculated lower plot part
Int_t	fMode	Stores which calculation is supposed to be performed as specified by user option
TString	fOption	Stores the option which is given in the constructor as a string
TVirtualPad*	fParentPad	Stores the pad the ratio plot was created in
TGraph*	fRatioGraph	Stores the lower plot's graph
Float_t	fRightMargin	Stores the common right margin of both pads
TAxis*	fSharedXAxis	X axis that stores the range for both plots
Bool_t	fShowConfidenceIntervals	Stores whether to show the confidence interval bands. From Draw option
Bool_t	fShowGridlines	Stores whether to show the gridlines at all
Float_t	fSplitFraction	Stores the fraction at which the upper and lower pads meet
TPad*	fTopPad	The Pad that drawn on top on the others to have consistent coordinates
Float_t	fUpBottomMargin	Stores the bottom margin of the upper pad
Float_t	fUpTopMargin	Stores the top margin of the upper pad
TAxis*	fUpYaxis	Clone of the upper y axis
TGaxis*	fUpperGXaxis	Upper graphical x axis
TGaxis*	fUpperGXaxisMirror	Upper mirror of the x axis
TGaxis*	fUpperGYaxis	Upper graphical y axis
TGaxis*	fUpperGYaxisMirror	Upper mirror of the y axis
TPad*	fUpperPad	The pad which contains the upper plot part

private:

static TRatioPlot::CalculationMode	kDifference
static TRatioPlot::CalculationMode	kDifferenceSign
static TRatioPlot::CalculationMode	kDivideGraph
static TRatioPlot::CalculationMode	kDivideHist
static TRatioPlot::ErrorMode	kErrorAsymmetric
static TRatioPlot::ErrorMode	kErrorFunc
static TRatioPlot::ErrorMode	kErrorSymmetric
static TRatioPlot::CalculationMode	kFitResidual
static TRatioPlot::HideLabelMode	kForceHideLow
static TRatioPlot::HideLabelMode	kForceHideUp
static TRatioPlot::HideLabelMode	kHideLow
static TRatioPlot::HideLabelMode	kHideUp
static TRatioPlot::HideLabelMode	kNoHide

Class Charts

Inheritance Chart:

TObject

←

TRatioPlot

Function documentation

TRatioPlot& operator=(const TRatioPlot& )

TRatioPlot(const TRatioPlot& hrp)

void SyncAxesRanges()

void SetupPads()

void CreateVisualAxes()

Bool_t SyncPadMargins()

void SetPadMargins()

void CreateGridline()

void BuildLowerPlot()

void ImportAxisAttributes(TGaxis* gaxis, TAxis* axis)

Bool_t IsDrawn()

void Init(TH1* h1, TH1* h2, Option_t* option = "")

TRatioPlot()

virtual ~TRatioPlot()

TRatioPlot(TH1* h1, TH1* h2, Option_t* option = "pois")

TRatioPlot(THStack* st, TH1* h2, Option_t* option = "pois")

TRatioPlot(TH1* h1, Option_t* option = "", TFitResult* fitres = 0)

void SetH1DrawOpt(Option_t* opt)

void SetH2DrawOpt(Option_t* opt)

void SetGraphDrawOpt(Option_t* opt)

void SetFitDrawOpt(Option_t* opt)

void SetInsetWidth(Double_t width)

void Draw(Option_t* chopt = "")

void Browse(TBrowser* b)

void Paint(Option_t* opt = "")

void UnZoomed()

 Slots for signal receiving

void RangeAxisChanged()

void SubPadResized()

TAxis * GetXaxis() const

 Getters

{ return fSharedXAxis; }

TAxis * GetUpYaxis() const

{ return fUpYaxis; }

TAxis * GetLowYaxis() const

{ return fLowYaxis; }

TGraph * GetLowerRefGraph() const

TAxis * GetLowerRefXaxis() const

 Shortcut for:

 ~~~{.cpp}
 rp->GetLowerRefGraph()->GetXaxis();
 ~~~

{ return GetLowerRefGraph()->GetXaxis(); }

TAxis * GetLowerRefYaxis() const

 Shortcut for:

 ~~~{.cpp}
 rp->GetLowerRefGraph()->GetYaxis();
 ~~~

{ return GetLowerRefGraph()->GetYaxis(); }

TObject * GetUpperRefObject() const

TAxis * GetUpperRefXaxis() const

TAxis * GetUpperRefYaxis() const

TGraph * GetCalculationOutputGraph() const

 Get the output of the calculation in the form of a graph. The type of
 the return value depends on the input option that was given in the constructor.

{ return fRatioGraph; }

TGraphErrors * GetConfidenceInterval1() const

 Returns the graph for the 1 sigma confidence interval in the fit residual case

{ return fConfidenceInterval1; }

TGraphErrors * GetConfidenceInterval2() const

 Returns the graph for the 2 sigma confidence interval in the fit residual case

{ return fConfidenceInterval2; }

TPad * GetUpperPad() const

{ return fUpperPad; }

TPad * GetLowerPad() const

{ return fLowerPad; }

void SetFitResult(TFitResultPtr fitres)

 Setters

 Explicitly specify the fit result that is to be used for fit residual calculation.
 If it is not provided, the last fit registered in the global fitter is used.
 The fit result can also be specified in the constructor.

 \param fitres The fit result coming from the fit function call

{ fFitResult = fitres.Get(); }

void SetUpTopMargin(Float_t margin)