A factory for building PDFs and data for a number counting combination.

The factory produces a PDF for N channels with uncorrelated background uncertainty. Correlations can be added by extending this PDF with additional terms. The factory relates the signal in each channel to a master signal strength times the expected signal in each channel. Thus, the final test is performed on the master signal strength. This yields a more powerful test than letting signal in each channel be independent.

The problem has been studied in these references:

One can incorporate uncertainty on the expected signal by adding additional terms. For the future, perhaps this factory should be extended to include the efficiency terms automatically.

Definition at line 22 of file NumberCountingPdfFactory.h.

Public Member Functions
virtual	~NumberCountingPdfFactory ()=default
	need one for expected and one for observed

void	AddData (double mainMeas, double bkgMeas, double db, Int_t nbins, RooWorkspace ws, const char *dsName="NumberCountingData")
	Arguments are an array of results from a main measurement, a measured background, and relative background uncertainty (eg.

void	AddDataWithSideband (double mainMeas, double sideband, double tau, Int_t nbins, RooWorkspace ws, const char *dsName="ExpectedNumberCountingData")
	Arguments are an array of expected signal, expected background, and relative background uncertainty (eg.

void	AddExpData (double sigExp, double bkgExp, double db, Int_t nbins, RooWorkspace ws, const char *dsName="ExpectedNumberCountingData")
	Arguments are an array of expected signal, expected background, and relative background uncertainty (eg.

void	AddExpDataWithSideband (double sigExp, double bkgExp, double tau, Int_t nbins, RooWorkspace ws, const char *dsName="NumberCountingData")
	Arguments are an array of expected signal, expected background, and relative ratio of background expected in the sideband to that expected in signal region, and the number of channels.

void	AddModel (double sigExp, Int_t nchan, RooWorkspace ws, const char pdfName="CombinedPdf", const char masterSignalName="masterSignal")
	This method produces a PDF for N channels with uncorrelated background uncertainty.

virtual TClass *	IsA () const

virtual void	Streamer (TBuffer &)

void	StreamerNVirtual (TBuffer &ClassDef_StreamerNVirtual_b)

Static Public Member Functions
static TClass *	Class ()

static const char *	Class_Name ()

static constexpr Version_t	Class_Version ()

static const char *	DeclFileName ()

Private Member Functions
RooRealVar *	SafeObservableCreation (RooWorkspace ws, const char varName, double value)
	need to be careful here that the range of observable in the dataset is consistent with the one in the workspace don't rescale unless necessary.

RooRealVar *	SafeObservableCreation (RooWorkspace ws, const char varName, double value, double maximum)
	need to be careful here that the range of observable in the dataset is consistent with the one in the workspace don't rescale unless necessary.

#include <RooStats/NumberCountingPdfFactory.h>

Constructor & Destructor Documentation

◆ ~NumberCountingPdfFactory()

virtual RooStats::NumberCountingPdfFactory::~NumberCountingPdfFactory ( )

virtualdefault

need one for expected and one for observed

Member Function Documentation

◆ AddData()

void RooStats::NumberCountingPdfFactory::AddData	(	double *	mainMeas,
		double *	back,
		double *	back_syst,
		Int_t	nbins,
		RooWorkspace *	ws,
		const char *	dsName = `"NumberCountingData"`
	)

Arguments are an array of results from a main measurement, a measured background, and relative background uncertainty (eg.

0.1 for 10% uncertainty), and the number of channels.

Definition at line 195 of file NumberCountingPdfFactory.cxx.

◆ AddDataWithSideband()

void RooStats::NumberCountingPdfFactory::AddDataWithSideband	(	double *	mainMeas,
		double *	sideband,
		double *	tauForTree,
		Int_t	nbins,
		RooWorkspace *	ws,
		const char *	dsName = `"ExpectedNumberCountingData"`
	)

Arguments are an array of expected signal, expected background, and relative background uncertainty (eg.

0.1 for 10% uncertainty), and the number of channels.

Definition at line 267 of file NumberCountingPdfFactory.cxx.

◆ AddExpData()

void RooStats::NumberCountingPdfFactory::AddExpData	(	double *	sig,
		double *	back,
		double *	back_syst,
		Int_t	nbins,
		RooWorkspace *	ws,
		const char *	dsName = `"ExpectedNumberCountingData"`
	)

Arguments are an array of expected signal, expected background, and relative background uncertainty (eg.

0.1 for 10% uncertainty), and the number of channels.

Definition at line 133 of file NumberCountingPdfFactory.cxx.

◆ AddExpDataWithSideband()

void RooStats::NumberCountingPdfFactory::AddExpDataWithSideband	(	double *	sigExp,
		double *	bkgExp,
		double *	tau,
		Int_t	nbins,
		RooWorkspace *	ws,
		const char *	dsName = `"NumberCountingData"`
	)

Arguments are an array of expected signal, expected background, and relative ratio of background expected in the sideband to that expected in signal region, and the number of channels.

Definition at line 150 of file NumberCountingPdfFactory.cxx.

◆ AddModel()

void RooStats::NumberCountingPdfFactory::AddModel	(	double *	sig,
		Int_t	nbins,
		RooWorkspace *	ws,
		const char *	pdfName = `"CombinedPdf"`,
		const char *	muName = `"masterSignal"`
	)

This method produces a PDF for N channels with uncorrelated background uncertainty.

It relates the signal in each channel to a master signal strength times the expected signal in each channel.

For the future, perhaps this method should be extended to include the efficiency terms automatically.

Definition at line 65 of file NumberCountingPdfFactory.cxx.

◆ Class()

static TClass * RooStats::NumberCountingPdfFactory::Class ( )

static

Returns: TClass describing this class

◆ Class_Name()

static const char * RooStats::NumberCountingPdfFactory::Class_Name ( )

static

Returns: Name of this class

◆ Class_Version()

static constexpr Version_t RooStats::NumberCountingPdfFactory::Class_Version ( )

inlinestaticconstexpr

Returns: Version of this class

Definition at line 46 of file NumberCountingPdfFactory.h.

◆ DeclFileName()

static const char * RooStats::NumberCountingPdfFactory::DeclFileName ( )

inlinestatic

Returns: Name of the file containing the class declaration

Definition at line 46 of file NumberCountingPdfFactory.h.

◆ IsA()

virtual TClass * RooStats::NumberCountingPdfFactory::IsA ( ) const

inlinevirtual

Returns: TClass describing current object

Definition at line 46 of file NumberCountingPdfFactory.h.

◆ SafeObservableCreation() [1/2]

RooRealVar * RooStats::NumberCountingPdfFactory::SafeObservableCreation	(	RooWorkspace *	ws,
		const char *	varName,
		double	value
	)

private

need to be careful here that the range of observable in the dataset is consistent with the one in the workspace don't rescale unless necessary.

If it is necessary, then rescale by x10 or a defined maximum.

Definition at line 168 of file NumberCountingPdfFactory.cxx.

◆ SafeObservableCreation() [2/2]

RooRealVar * RooStats::NumberCountingPdfFactory::SafeObservableCreation	(	RooWorkspace *	ws,
		const char *	varName,
		double	value,
		double	maximum
	)

private

need to be careful here that the range of observable in the dataset is consistent with the one in the workspace don't rescale unless necessary.

If it is necessary, then rescale by x10 or a defined maximum.

Definition at line 177 of file NumberCountingPdfFactory.cxx.

◆ Streamer()

virtual void RooStats::NumberCountingPdfFactory::Streamer ( TBuffer & )

virtual

◆ StreamerNVirtual()

void RooStats::NumberCountingPdfFactory::StreamerNVirtual ( TBuffer & ClassDef_StreamerNVirtual_b )

inline

Definition at line 46 of file NumberCountingPdfFactory.h.

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

roofit/roostats/inc/RooStats/NumberCountingPdfFactory.h
roofit/roostats/src/NumberCountingPdfFactory.cxx

Public Member Functions

Static Public Member Functions

Private Member Functions

Constructor & Destructor Documentation

◆ ~NumberCountingPdfFactory()

Member Function Documentation

◆ AddData()

◆ AddDataWithSideband()

◆ AddExpData()

◆ AddExpDataWithSideband()

◆ AddModel()

◆ Class()

◆ Class_Name()

◆ Class_Version()

◆ DeclFileName()

◆ IsA()

◆ SafeObservableCreation() [1/2]

◆ SafeObservableCreation() [2/2]

◆ Streamer()

◆ StreamerNVirtual()