This class calculates sWeights used to create an sPlot.

The code is based on ``SPlot: A statistical tool to unfold data distributions,'' Nucl. Instrum. Meth. A 555, 356 (2005) [arXiv:physics/0402083].

An SPlot gives us the distribution of some variable, x in our data sample for a given species (eg. signal or background). The result is similar to a likelihood projection plot, but no cuts are made, so every event contributes to the distribution.

To use this class, you first must have a pdf that includes yields for (possibly several) different species. Create an instance of the class by supplying a data set, the pdf, and a list of the yield variables. The SPlot Class will calculate SWeights and include these as columns in the RooDataSet.

Definition at line 58 of file SPlot.h.

Public Member Functions
	SPlot ()
	Default constructor. More...

	SPlot (const SPlot &other)
	Copy Constructor from another SPlot. More...

	SPlot (const char name, const char title)

	SPlot (const char name, const char title, const RooDataSet &data)
	Constructor from a RooDataSet No sWeighted variables are present. More...

	SPlot (const char name, const char title, RooDataSet &data, RooAbsPdf pdf, const RooArgList &yieldsList, const RooArgSet &projDeps=RooArgSet(), bool includeWeights=kTRUE, bool copyDataSet=kFALSE, const char newName="")

	~SPlot ()

void	AddSWeight (RooAbsPdf *pdf, const RooArgList &yieldsTmp, const RooArgSet &projDeps=RooArgSet(), bool includeWeights=kTRUE)

Int_t	GetNumSWeightVars () const
	Return the number of SWeights In other words, return the number of species that we are trying to extract. More...

RooDataSet *	GetSDataSet () const

Double_t	GetSumOfEventSWeight (Int_t numEvent) const

Double_t	GetSWeight (Int_t numEvent, const char *sVariable) const

RooArgList	GetSWeightVars () const

Double_t	GetYieldFromSWeight (const char *sVariable) const

RooDataSet *	SetSData (RooDataSet *data)

Public Member Functions inherited from TNamed
	TNamed ()

	TNamed (const char name, const char title)

	TNamed (const TString &name, const TString &title)

	TNamed (const TNamed &named)
	TNamed copy ctor. More...

virtual	~TNamed ()

virtual void	Clear (Option_t *option="")
	Set name and title to empty strings (""). More...

virtual TObject *	Clone (const char *newname="") const
	Make a clone of an object using the Streamer facility. More...

virtual Int_t	Compare (const TObject *obj) const
	Compare two TNamed objects. More...

virtual void	Copy (TObject &named) const
	Copy this to obj. More...

virtual void	FillBuffer (char *&buffer)
	Encode TNamed into output buffer. More...

virtual const char *	GetName () const
	Returns name of object. More...

virtual const char *	GetTitle () const
	Returns title of object. More...

virtual ULong_t	Hash () const
	Return hash value for this object. More...

virtual Bool_t	IsSortable () const

virtual void	ls (Option_t *option="") const
	List TNamed name and title. More...

TNamed &	operator= (const TNamed &rhs)
	TNamed assignment operator. More...

virtual void	Print (Option_t *option="") const
	Print TNamed name and title. More...

virtual void	SetName (const char *name)
	Set the name of the TNamed. More...

virtual void	SetNameTitle (const char name, const char title)
	Set all the TNamed parameters (name and title). More...

virtual void	SetTitle (const char *title="")
	Set the title of the TNamed. More...

virtual Int_t	Sizeof () const
	Return size of the TNamed part of the TObject. More...

Public Member Functions inherited from TObject
	TObject ()
	TObject constructor. More...

	TObject (const TObject &object)
	TObject copy ctor. More...

virtual	~TObject ()
	TObject destructor. More...

void	AbstractMethod (const char *method) const
	Use this method to implement an "abstract" method that you don't want to leave purely abstract. More...

virtual void	AppendPad (Option_t *option="")
	Append graphics object to current pad. More...

virtual void	Browse (TBrowser *b)
	Browse object. May be overridden for another default action. More...

virtual const char *	ClassName () const
	Returns name of class to which the object belongs. More...

virtual void	Delete (Option_t *option="")
	Delete this object. More...

virtual Int_t	DistancetoPrimitive (Int_t px, Int_t py)
	Computes distance from point (px,py) to the object. More...

virtual void	Draw (Option_t *option="")
	Default Draw method for all objects. More...

virtual void	DrawClass () const
	Draw class inheritance tree of the class to which this object belongs. More...

virtual TObject *	DrawClone (Option_t *option="") const
	Draw a clone of this object in the current pad. More...

virtual void	Dump () const
	Dump contents of object on stdout. More...

virtual void	Error (const char method, const char msgfmt,...) const
	Issue error message. More...

virtual void	Execute (const char method, const char params, Int_t *error=0)
	Execute method on this object with the given parameter string, e.g. More...

virtual void	Execute (TMethod method, TObjArray params, Int_t *error=0)
	Execute method on this object with parameters stored in the TObjArray. More...

virtual void	ExecuteEvent (Int_t event, Int_t px, Int_t py)
	Execute action corresponding to an event at (px,py). More...

virtual void	Fatal (const char method, const char msgfmt,...) const
	Issue fatal error message. More...

virtual TObject *	FindObject (const char *name) const
	Must be redefined in derived classes. More...

virtual TObject *	FindObject (const TObject *obj) const
	Must be redefined in derived classes. More...

virtual Option_t *	GetDrawOption () const
	Get option used by the graphics system to draw this object. More...

virtual const char *	GetIconName () const
	Returns mime type name of object. More...

virtual char *	GetObjectInfo (Int_t px, Int_t py) const
	Returns string containing info about the object at position (px,py). More...

virtual Option_t *	GetOption () const

virtual UInt_t	GetUniqueID () const
	Return the unique object id. More...

virtual Bool_t	HandleTimer (TTimer *timer)
	Execute action in response of a timer timing out. More...

virtual void	Info (const char method, const char msgfmt,...) const
	Issue info message. More...

virtual Bool_t	InheritsFrom (const char *classname) const
	Returns kTRUE if object inherits from class "classname". More...

virtual Bool_t	InheritsFrom (const TClass *cl) const
	Returns kTRUE if object inherits from TClass cl. More...

virtual void	Inspect () const
	Dump contents of this object in a graphics canvas. More...

void	InvertBit (UInt_t f)

virtual Bool_t	IsEqual (const TObject *obj) const
	Default equal comparison (objects are equal if they have the same address in memory). More...

virtual Bool_t	IsFolder () const
	Returns kTRUE in case object contains browsable objects (like containers or lists of other objects). More...

Bool_t	IsOnHeap () const

Bool_t	IsZombie () const

void	MayNotUse (const char *method) const
	Use this method to signal that a method (defined in a base class) may not be called in a derived class (in principle against good design since a child class should not provide less functionality than its parent, however, sometimes it is necessary). More...

virtual Bool_t	Notify ()
	This method must be overridden to handle object notification. More...

void	Obsolete (const char method, const char asOfVers, const char *removedFromVers) const
	Use this method to declare a method obsolete. More...

void	operator delete (void *ptr)
	Operator delete. More...

void	operator delete[] (void *ptr)
	Operator delete []. More...

void *	operator new (size_t sz)

void *	operator new (size_t sz, void *vp)

void *	operator new[] (size_t sz)

void *	operator new[] (size_t sz, void *vp)

TObject &	operator= (const TObject &rhs)
	TObject assignment operator. More...

virtual void	Paint (Option_t *option="")
	This method must be overridden if a class wants to paint itself. More...

virtual void	Pop ()
	Pop on object drawn in a pad to the top of the display list. More...

virtual Int_t	Read (const char *name)
	Read contents of object with specified name from the current directory. More...

virtual void	RecursiveRemove (TObject *obj)
	Recursively remove this object from a list. More...

void	ResetBit (UInt_t f)

virtual void	SaveAs (const char filename="", Option_t option="") const
	Save this object in the file specified by filename. More...

virtual void	SavePrimitive (std::ostream &out, Option_t *option="")
	Save a primitive as a C++ statement(s) on output stream "out". More...

void	SetBit (UInt_t f, Bool_t set)
	Set or unset the user status bits as specified in f. More...

void	SetBit (UInt_t f)

virtual void	SetDrawOption (Option_t *option="")
	Set drawing option for object. More...

virtual void	SetUniqueID (UInt_t uid)
	Set the unique object id. More...

virtual void	SysError (const char method, const char msgfmt,...) const
	Issue system error message. More...

Bool_t	TestBit (UInt_t f) const

Int_t	TestBits (UInt_t f) const

virtual void	UseCurrentStyle ()
	Set current style settings in this object This function is called when either TCanvas::UseCurrentStyle or TROOT::ForceStyle have been invoked. More...

virtual void	Warning (const char method, const char msgfmt,...) const
	Issue warning message. More...

virtual Int_t	Write (const char *name=0, Int_t option=0, Int_t bufsize=0)
	Write this object to the current directory. More...

virtual Int_t	Write (const char *name=0, Int_t option=0, Int_t bufsize=0) const
	Write this object to the current directory. More...

Protected Types
enum	{ kOwnData = BIT(20) }

Protected Attributes
RooDataSet *	fSData

RooArgList	fSWeightVars

Protected Attributes inherited from TNamed
TString	fName

TString	fTitle

Additional Inherited Members
Public Types inherited from TObject
enum	{ kIsOnHeap = 0x01000000, kNotDeleted = 0x02000000, kZombie = 0x04000000, kBitMask = 0x00ffffff }

enum	{ kSingleKey = BIT(0), kOverwrite = BIT(1), kWriteDelete = BIT(2) }

enum	EStatusBits { kCanDelete = BIT(0), kMustCleanup = BIT(3), kObjInCanvas = BIT(3), kIsReferenced = BIT(4), kHasUUID = BIT(5), kCannotPick = BIT(6), kNoContextMenu = BIT(8), kInvalidObject = BIT(13) }

Static Public Member Functions inherited from TObject
static Long_t	GetDtorOnly ()
	Return destructor only flag. More...

static Bool_t	GetObjectStat ()
	Get status of object stat flag. More...

static void	SetDtorOnly (void *obj)
	Set destructor only flag. More...

static void	SetObjectStat (Bool_t stat)
	Turn on/off tracking of objects in the TObjectTable. More...

Protected Member Functions inherited from TObject
virtual void	DoError (int level, const char location, const char fmt, va_list va) const
	Interface to ErrorHandler (protected). More...

void	MakeZombie ()

#include <RooStats/SPlot.h>

Inheritance diagram for RooStats::SPlot:

[legend]

Member Enumeration Documentation

◆ anonymous enum

anonymous enum

protected

Enumerator
kOwnData

Definition at line 92 of file SPlot.h.

Constructor & Destructor Documentation

◆ ~SPlot()

SPlot::~SPlot ( )

Definition at line 52 of file SPlot.cxx.

◆ SPlot() [1/5]

SPlot::SPlot ( )

Default constructor.

Definition at line 62 of file SPlot.cxx.

◆ SPlot() [2/5]

SPlot::SPlot ( const SPlot & other )

Copy Constructor from another SPlot.

Definition at line 104 of file SPlot.cxx.

◆ SPlot() [3/5]

SPlot::SPlot	(	const char *	name,
		const char *	title
	)

Definition at line 75 of file SPlot.cxx.

◆ SPlot() [4/5]

SPlot::SPlot	(	const char *	name,
		const char *	title,
		const RooDataSet &	data
	)

Constructor from a RooDataSet No sWeighted variables are present.

Definition at line 90 of file SPlot.cxx.

◆ SPlot() [5/5]

SPlot::SPlot	(	const char *	name,
		const char *	title,
		RooDataSet &	data,
		RooAbsPdf *	pdf,
		const RooArgList &	yieldsList,
		const RooArgSet &	projDeps = `RooArgSet()`,
		bool	includeWeights = `kTRUE`,
		bool	copyDataSet = `kFALSE`,
		const char *	newName = `""`
	)

Definition at line 118 of file SPlot.cxx.

Member Function Documentation

◆ AddSWeight()

void SPlot::AddSWeight	(	RooAbsPdf *	pdf,
		const RooArgList &	yieldsTmp,
		const RooArgSet &	projDeps = `RooArgSet()`,
		bool	includeWeights = `kTRUE`
	)

Definition at line 319 of file SPlot.cxx.

◆ GetNumSWeightVars()

Int_t SPlot::GetNumSWeightVars ( ) const

Return the number of SWeights In other words, return the number of species that we are trying to extract.

Definition at line 309 of file SPlot.cxx.

◆ GetSDataSet()

RooDataSet * SPlot::GetSDataSet ( ) const

Definition at line 163 of file SPlot.cxx.

◆ GetSumOfEventSWeight()

Double_t SPlot::GetSumOfEventSWeight ( Int_t numEvent ) const

Definition at line 216 of file SPlot.cxx.

◆ GetSWeight()

Double_t SPlot::GetSWeight	(	Int_t	numEvent,
		const char *	sVariable
	)		const

Definition at line 170 of file SPlot.cxx.

◆ GetSWeightVars()

RooArgList SPlot::GetSWeightVars ( ) const

Definition at line 294 of file SPlot.cxx.

◆ GetYieldFromSWeight()

Double_t SPlot::GetYieldFromSWeight ( const char * sVariable ) const

Definition at line 250 of file SPlot.cxx.

◆ SetSData()

RooDataSet * SPlot::SetSData ( RooDataSet * data )

Definition at line 152 of file SPlot.cxx.

Member Data Documentation

◆ fSData

RooDataSet* RooStats::SPlot::fSData

protected

Definition at line 100 of file SPlot.h.

◆ fSWeightVars

RooArgList RooStats::SPlot::fSWeightVars

protected

Definition at line 96 of file SPlot.h.

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

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

Public Member Functions

Protected Types

Protected Attributes

Additional Inherited Members

Member Enumeration Documentation

◆ anonymous enum

Constructor & Destructor Documentation

◆ ~SPlot()

◆ SPlot() [1/5]

◆ SPlot() [2/5]

◆ SPlot() [3/5]

◆ SPlot() [4/5]

◆ SPlot() [5/5]

Member Function Documentation

◆ AddSWeight()

◆ GetNumSWeightVars()

◆ GetSDataSet()

◆ GetSumOfEventSWeight()

◆ GetSWeight()

◆ GetSWeightVars()

◆ GetYieldFromSWeight()

◆ SetSData()

Member Data Documentation

◆ fSData

◆ fSWeightVars