RooHighExpTail Class Reference

Exponential tail above the photopeak, convolved with the resolution. More...

#include <RooFitPhotopeakPdfs.hpp>

Inheritance diagram for RooHighExpTail:

Collaboration diagram for RooHighExpTail:

Public Member Functions
	RooHighExpTail ()
	Default constructor for ROOT I/O; leaves proxies unbound.
	RooHighExpTail (const char *name, const char *title, RooAbsReal &x, RooAbsReal &mu, RooAbsReal &sigma, RooAbsReal &tau_ratio)
	Construct the component and bind its parameters.
	RooHighExpTail (const RooHighExpTail &other, const char *name=nullptr)
	Copy constructor used by RooFit when cloning a model.
TObject *	clone (const char *newname=nullptr) const override
	RooFit clone hook.
Int_t	getAnalyticalIntegral (RooArgSet &allVars, RooArgSet &analVars, const char *rangeName=nullptr) const override
	Advertise the analytic integral over the observable.
Double_t	analyticalIntegral (Int_t code, const char *rangeName=nullptr) const override
	Evaluate the analytic integral advertised above.
void	doEval (RooFit::EvalContext &ctx) const override
	Batched evaluation over every event in one pass.
bool	canComputeBatchWithCuda () const override
	Whether doEval() can consume device-resident buffers.

Protected Member Functions
Double_t	evaluate () const override
	Scalar evaluation for a single observable value.

Protected Attributes
RooRealProxy	x_
RooRealProxy	mu_
RooRealProxy	sigma_
RooRealProxy	tau_ratio_

Detailed Description

Exponential tail above the photopeak, convolved with the resolution.

Models pileup, which moves counts to higher energies. Identical in form to RooLowExpTail but mirrored about the centroid.

Definition at line 308 of file RooFitPhotopeakPdfs.hpp.

Constructor & Destructor Documentation

RooHighExpTail() [1/3]

RooHighExpTail::RooHighExpTail ( )

inline

Default constructor for ROOT I/O; leaves proxies unbound.

Definition at line 311 of file RooFitPhotopeakPdfs.hpp.

Referenced by clone(), and RooHighExpTail().

RooHighExpTail() [2/3]

RooHighExpTail::RooHighExpTail	(	const char *	name,
		const char *	title,
		RooAbsReal &	x,
		RooAbsReal &	mu,
		RooAbsReal &	sigma,
		RooAbsReal &	tau_ratio )

Construct the component and bind its parameters.

Parameters

name	RooFit object name, unique within the workspace.
title	Human-readable title.
x	Observable (energy).
mu	Peak centroid, in the observable's units.
sigma	Gaussian resolution; must be positive.
tau_ratio	Tail decay constant in units of sigma, so tau = tau_ratio * sigma. Dimensionless and positive.

Definition at line 365 of file RooFitPhotopeakPdfs.cpp.

RooHighExpTail() [3/3]

RooHighExpTail::RooHighExpTail	(	const RooHighExpTail &	other,
		const char *	name = nullptr )

Copy constructor used by RooFit when cloning a model.

Parameters

other	Instance to copy.
name	New object name, or null to keep other's.

Definition at line 372 of file RooFitPhotopeakPdfs.cpp.

Member Function Documentation

analyticalIntegral()

Double_t RooHighExpTail::analyticalIntegral ( Int_t code, const char * rangeName = nullptr ) const

override

Evaluate the analytic integral advertised above.

Parameters

code	Code returned by getAnalyticalIntegral(); only 1 is supported.
rangeName	Named range, or null for the full range.

Returns

The integral over the requested range.

Definition at line 425 of file RooFitPhotopeakPdfs.cpp.

canComputeBatchWithCuda()

bool RooHighExpTail::canComputeBatchWithCuda ( ) const

inlineoverride

Whether doEval() can consume device-resident buffers.

Returns

true in a CUDA build, false in a CPU build.

Definition at line 369 of file RooFitPhotopeakPdfs.hpp.

clone()

TObject * RooHighExpTail::clone ( const char * newname = nullptr ) const

inlineoverride

RooFit clone hook.

Parameters

newname

Name for the clone, or null to reuse this one's.

Returns

A heap-allocated copy; ownership passes to the caller.

Definition at line 331 of file RooFitPhotopeakPdfs.hpp.

doEval()

void RooHighExpTail::doEval ( RooFit::EvalContext & ctx ) const

override

Batched evaluation over every event in one pass.

Hoists the parameter-dependent constants out of the loop and writes one density per event. Dispatches to a CUDA kernel when built with CUDA support and handed device-resident buffers; otherwise runs an OpenMP host loop.

Parameters

ctx	RooFit evaluation context supplying inputs and the output span.

Definition at line 387 of file RooFitPhotopeakPdfs.cpp.

evaluate()

Double_t RooHighExpTail::evaluate ( ) const

overrideprotected

Scalar evaluation for a single observable value.

Returns

The unnormalised density, floored at 1e-300; zero if the parameters are non-physical.

Definition at line 377 of file RooFitPhotopeakPdfs.cpp.

getAnalyticalIntegral()

Int_t RooHighExpTail::getAnalyticalIntegral ( RooArgSet & allVars, RooArgSet & analVars, const char * rangeName = nullptr ) const

override

Advertise the analytic integral over the observable.

Parameters

allVars	Variables RooFit offers to integrate over.
analVars	Filled with those handled analytically.
rangeName	Named range, or null for the full range.

Returns

1 if the integral over x is available, 0 otherwise.

Definition at line 417 of file RooFitPhotopeakPdfs.cpp.

Member Data Documentation

mu_

RooRealProxy RooHighExpTail::mu_

protected

Definition at line 374 of file RooFitPhotopeakPdfs.hpp.

Referenced by analyticalIntegral(), doEval(), evaluate(), RooHighExpTail(), and RooHighExpTail().

sigma_

RooRealProxy RooHighExpTail::sigma_

protected

Definition at line 375 of file RooFitPhotopeakPdfs.hpp.

Referenced by analyticalIntegral(), doEval(), evaluate(), RooHighExpTail(), and RooHighExpTail().

tau_ratio_

RooRealProxy RooHighExpTail::tau_ratio_

protected

Definition at line 376 of file RooFitPhotopeakPdfs.hpp.

Referenced by analyticalIntegral(), doEval(), evaluate(), RooHighExpTail(), and RooHighExpTail().

x_

RooRealProxy RooHighExpTail::x_

protected

Definition at line 373 of file RooFitPhotopeakPdfs.hpp.

Referenced by analyticalIntegral(), doEval(), evaluate(), getAnalyticalIntegral(), RooHighExpTail(), and RooHighExpTail().

---

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

• include/RooFitPhotopeakPdfs.hpp
• src/RooFitPhotopeakPdfs.cpp