Detailed Description

This class is used to fit simple gaussian peaks in data

Definition at line 30 of file TGauss.h.

Public Member Functions
	TGauss ()=default

	TGauss (const TGauss &)=default

	TGauss (Double_t centroid, Double_t relativeLimit=-1.)

	TGauss (TGauss &&) noexcept=default

	~TGauss ()=default

Double_t	Area () const

Double_t	AreaErr () const

Double_t	Centroid () const override

void	Centroid (const Double_t &centroid) override

Double_t	CentroidErr () const override

void	Draw (Option_t *opt="") override

virtual void	DrawBackground (Option_t *opt="")

virtual void	DrawComponents (Option_t *opt="")

virtual Double_t	FWHM ()

virtual Double_t	FWHMErr ()

TF1 *	GetBackgroundFunction ()

Double_t	GetChi2 () const

TF1 *	GetFitFunction () const

TF1 *	GetGlobalBackground () const

Color_t	GetLineColor ()

Style_t	GetLineStyle ()

Double_t	GetNDF () const

Int_t	GetNParameters () const

TF1 *	GetPeakFunction () const

Double_t	GetReducedChi2 () const

void	InitializeParameters (TH1 *hist, const double &rangeLow, const double &rangeHigh) override

void	InitParNames () override

bool	IsBackgroundParameter (const Int_t &par) const

bool	IsPeakParameter (const Int_t &par) const

TGauss &	operator= (const TGauss &)=default

TGauss &	operator= (TGauss &&) noexcept=default

bool	ParameterSetByUser (int par)

void	Print (Option_t *="") const override

virtual void	PrintParameters () const

void	SetArea (const Double_t &area)

void	SetAreaErr (const Double_t &area_err)

void	SetGlobalBackground (TF1 *background)

void	SetLineColor (Color_t color)

void	SetLineStyle (Style_t style)

void	SetListOfBGPar (const std::vector< bool > &list_of_bg_par)

Double_t	Sigma () const override

Double_t	SigmaErr () const override

void	UpdateBackgroundParameters ()

void	UpdatePeakParameters ()

Double_t	Width () const override

Protected Member Functions
virtual Double_t	BackgroundFunction (Double_t , Double_t )

Double_t	PeakFunction (Double_t dim, Double_t par) override

virtual Double_t	PeakOnGlobalFunction (Double_t dim, Double_t par)

void	SetChi2 (const Double_t &chi2)

void	SetFitFunction (TF1 *function)

void	SetNDF (const Int_t &ndf)

void	SetPeakFunction (TF1 *function)

Double_t	TotalFunction (Double_t dim, Double_t par)

Private Attributes
Double_t	fArea {-0.1}

Double_t	fAreaErr {0.0}

TF1 *	fBackgroundFunction {nullptr}

Double_t	fChi2 {std::numeric_limits<Double_t>::quiet_NaN()}

TF1 *	fGlobalBackground {nullptr}

std::vector< bool >	fListOfBGPars

Int_t	fNDF {0}

TF1 *	fPeakFunction {nullptr}

TF1 *	fPeakOnGlobal {nullptr}

TF1 *	fTotalFunction {nullptr}

Inheritance diagram for TGauss:

Collaboration diagram for TGauss:

Constructor & Destructor Documentation

◆ TGauss() [1/4]

TGauss::TGauss ( )

default

◆ TGauss() [2/4]

TGauss::TGauss	(	Double_t	centroid,
		Double_t	relativeLimit = -1. )

explicit

Definition at line 3 of file TGauss.cxx.

References Centroid(), and TSinglePeak::GetFitFunction().

◆ TGauss() [3/4]

TGauss::TGauss ( const TGauss & )

default

◆ TGauss() [4/4]

TGauss::TGauss ( TGauss && )

defaultnoexcept

◆ ~TGauss()

TGauss::~TGauss ( )

default

Member Function Documentation

◆ Area()

Double_t TSinglePeak::Area ( ) const

inlineinherited

Definition at line 57 of file TSinglePeak.h.

References TSinglePeak::fArea.

Referenced by TSourceTab::Good(), main(), and TSinglePeak::Print().

◆ AreaErr()

Double_t TSinglePeak::AreaErr ( ) const

inlineinherited

Definition at line 58 of file TSinglePeak.h.

References TSinglePeak::fAreaErr.

Referenced by TSourceTab::Good(), main(), and TSinglePeak::Print().

◆ BackgroundFunction()

virtual Double_t TSinglePeak::BackgroundFunction	(	Double_t *	,
		Double_t *	)

inlineprotectedvirtualinherited

Reimplemented in TAB3Peak, TABPeak, and TRWPeak.

Definition at line 105 of file TSinglePeak.h.

Referenced by TSinglePeak::GetBackgroundFunction(), and TSinglePeak::TotalFunction().

◆ Centroid() [1/2]

Double_t TGauss::Centroid ( ) const

overridevirtual

Implements TSinglePeak.

Definition at line 58 of file TGauss.cxx.

References TSinglePeak::GetFitFunction().

Referenced by TGauss().

◆ Centroid() [2/2]

void TGauss::Centroid ( const Double_t & centroid )

overridevirtual

Implements TSinglePeak.

Definition at line 11 of file TGauss.cxx.

References TSinglePeak::GetFitFunction(), InitParNames(), kSubroutines, PeakFunction(), TSinglePeak::SetFitFunction(), TSinglePeak::SetListOfBGPar(), TSinglePeak::SetPeakFunction(), TSinglePeak::TotalFunction(), and TPeakFitter::VerboseLevel().

Referenced by TSourceTab::Good(), and TSourceTab::Good().

◆ CentroidErr()

Double_t TGauss::CentroidErr ( ) const

overridevirtual

Implements TSinglePeak.

Definition at line 63 of file TGauss.cxx.

References TSinglePeak::GetFitFunction().

Referenced by TSourceTab::Good().

◆ Draw()

void TSinglePeak::Draw ( Option_t * opt = "" )

overrideinherited

Definition at line 106 of file TSinglePeak.cxx.

References TSinglePeak::fGlobalBackground, TSinglePeak::fPeakOnGlobal, TSinglePeak::fTotalFunction, and TSinglePeak::PeakOnGlobalFunction().

Referenced by TBGSubtraction::DrawPeak().

◆ DrawBackground()

virtual void TSinglePeak::DrawBackground ( Option_t * opt = "" )

inlinevirtualinherited

Definition at line 71 of file TSinglePeak.h.

References TSinglePeak::fGlobalBackground.

◆ DrawComponents()

void TSinglePeak::DrawComponents ( Option_t * opt = "" )

virtualinherited

This behaves like the draw function except each daughter class decides how to break the draw into multiple components. This means that we should delegate this task to the daughter class.

Reimplemented in TAB3Peak, and TABPeak.

Definition at line 71 of file TSinglePeak.cxx.

◆ FWHM()

Double_t TSinglePeak::FWHM ( )

virtualinherited

Return the full width at half-maximum.

Definition at line 77 of file TSinglePeak.cxx.

References TSinglePeak::Centroid(), TSinglePeak::fPeakFunction, TSinglePeak::Sigma(), and TSinglePeak::UpdatePeakParameters().

Referenced by TSinglePeak::FWHMErr().

◆ FWHMErr()

Double_t TSinglePeak::FWHMErr ( )

virtualinherited

Return the uncertainty in the full width at half-maximum. Since it is complicated to do this without knowledge of the underlying fit function, we simply assume that the (relative) uncertainty in the FWHM is the same as the uncertainty in sigma.

Definition at line 92 of file TSinglePeak.cxx.

References TSinglePeak::FWHM(), TSinglePeak::Sigma(), and TSinglePeak::SigmaErr().

◆ GetBackgroundFunction()

TF1 * TSinglePeak::GetBackgroundFunction ( )

inherited

Definition at line 28 of file TSinglePeak.cxx.

References TSinglePeak::BackgroundFunction(), TSinglePeak::fBackgroundFunction, and TSinglePeak::fTotalFunction.

◆ GetChi2()

Double_t TSinglePeak::GetChi2 ( ) const

inlineinherited

Definition at line 91 of file TSinglePeak.h.

References TSinglePeak::fChi2.

◆ GetFitFunction()

TF1 * TSinglePeak::GetFitFunction ( ) const

inlineinherited

Definition at line 78 of file TSinglePeak.h.

References TSinglePeak::fTotalFunction.

Referenced by TGauss(), TAB3Peak::Centroid(), TAB3Peak::Centroid(), TABPeak::Centroid(), TABPeak::Centroid(), Centroid(), Centroid(), TRWPeak::Centroid(), TRWPeak::Centroid(), TAB3Peak::CentroidErr(), TABPeak::CentroidErr(), CentroidErr(), TRWPeak::CentroidErr(), TAB3Peak::DrawComponents(), TABPeak::DrawComponents(), TAB3Peak::InitializeParameters(), TABPeak::InitializeParameters(), InitializeParameters(), TRWPeak::InitializeParameters(), TAB3Peak::InitParNames(), TABPeak::InitParNames(), InitParNames(), TRWPeak::InitParNames(), main(), TAB3Peak::OneHitPeakOnGlobalFunction(), TABPeak::OneHitPeakOnGlobalFunction(), TAB3Peak::Sigma(), TABPeak::Sigma(), Sigma(), TRWPeak::Sigma(), TAB3Peak::SigmaErr(), TABPeak::SigmaErr(), SigmaErr(), TRWPeak::SigmaErr(), TAB3Peak::ThreeHitPeakOnGlobalFunction(), TAB3Peak::TwoHitPeakOnGlobalFunction(), TABPeak::TwoHitPeakOnGlobalFunction(), TAB3Peak::Width(), TABPeak::Width(), and TRWPeak::Width().

◆ GetGlobalBackground()

TF1 * TSinglePeak::GetGlobalBackground ( ) const

inlineinherited

Definition at line 80 of file TSinglePeak.h.

References TSinglePeak::fGlobalBackground.

Referenced by TAB3Peak::DrawComponents(), TABPeak::DrawComponents(), TAB3Peak::OneHitPeakOnGlobalFunction(), TABPeak::OneHitPeakOnGlobalFunction(), TAB3Peak::ThreeHitPeakOnGlobalFunction(), TAB3Peak::TwoHitPeakOnGlobalFunction(), and TABPeak::TwoHitPeakOnGlobalFunction().

◆ GetLineColor()

Color_t TSinglePeak::GetLineColor ( )

inlineinherited

Definition at line 100 of file TSinglePeak.h.

References TSinglePeak::fTotalFunction.

Referenced by TAB3Peak::DrawComponents(), and TABPeak::DrawComponents().

◆ GetLineStyle()

Style_t TSinglePeak::GetLineStyle ( )

inlineinherited

Definition at line 101 of file TSinglePeak.h.

References TSinglePeak::fTotalFunction.

◆ GetNDF()

Double_t TSinglePeak::GetNDF ( ) const

inlineinherited

Definition at line 92 of file TSinglePeak.h.

References TSinglePeak::fNDF.

◆ GetNParameters()

Int_t TSinglePeak::GetNParameters ( ) const

inherited

Definition at line 20 of file TSinglePeak.cxx.

References TSinglePeak::fTotalFunction.

◆ GetPeakFunction()

TF1 * TSinglePeak::GetPeakFunction ( ) const

inlineinherited

Definition at line 79 of file TSinglePeak.h.

References TSinglePeak::fPeakFunction.

◆ GetReducedChi2()

Double_t TSinglePeak::GetReducedChi2 ( ) const

inlineinherited

Definition at line 93 of file TSinglePeak.h.

References TSinglePeak::fChi2, and TSinglePeak::fNDF.

Referenced by main().

◆ InitializeParameters()

void TGauss::InitializeParameters	(	TH1 *	hist,
		const double &	rangeLow,
		const double &	rangeHigh )

overridevirtual

Makes initial guesses at parameters for the fit base on the histogram.

Reimplemented from TSinglePeak.

Definition at line 34 of file TGauss.cxx.

References TSinglePeak::GetFitFunction(), and TSinglePeak::ParameterSetByUser().

◆ InitParNames()

void TGauss::InitParNames ( )

overridevirtual

Reimplemented from TSinglePeak.

Definition at line 25 of file TGauss.cxx.

References TSinglePeak::GetFitFunction(), kSubroutines, and TPeakFitter::VerboseLevel().

Referenced by Centroid().

◆ IsBackgroundParameter()

bool TSinglePeak::IsBackgroundParameter ( const Int_t & par ) const

inherited

Definition at line 4 of file TSinglePeak.cxx.

References TSinglePeak::fListOfBGPars.

Referenced by TSinglePeak::IsPeakParameter().

◆ IsPeakParameter()

bool TSinglePeak::IsPeakParameter ( const Int_t & par ) const

inherited

Definition at line 15 of file TSinglePeak.cxx.

References TSinglePeak::IsBackgroundParameter().

◆ operator=() [1/2]

TGauss & TGauss::operator= ( const TGauss & )

default

◆ operator=() [2/2]

TGauss & TGauss::operator= ( TGauss && )

defaultnoexcept

◆ ParameterSetByUser()

bool TSinglePeak::ParameterSetByUser ( int par )

inherited

This function checks if a parameter or its limits have been set to a non-zero value. In case that the user fixed a parameter to be zero, the limits are non-zero, so this case is covered as well.

Definition at line 129 of file TSinglePeak.cxx.

References TSinglePeak::fTotalFunction.

Referenced by TAB3Peak::InitializeParameters(), TABPeak::InitializeParameters(), InitializeParameters(), and TRWPeak::InitializeParameters().