Logo ROOT  
Reference Guide
 
Loading...
Searching...
No Matches
RooStats::LikelihoodIntervalPlot Class Reference

This class provides simple and straightforward utilities to plot a LikelihoodInterval object.

Definition at line 30 of file LikelihoodIntervalPlot.h.

Public Member Functions

 LikelihoodIntervalPlot ()
 LikelihoodIntervalPlot default constructor with default parameters.
 
 LikelihoodIntervalPlot (LikelihoodInterval *theInterval)
 LikelihoodIntervalPlot copy constructor.
 
void Draw (const Option_t *options=nullptr) override
 draw the likelihood interval or contour for the 1D case a RooPlot is drawn by default of the profiled Log-Likelihood ratio if option "TF1" is used the objects are drawn using a TF1 scanning the LL function in a grid of the set points (by default the TF1 can be customized by setting maximum and the number of points to scan
 
TObjectGetPlottedObject () const
 returned plotted object (RooPlot or histograms)
 
TClassIsA () const override
 
void SetContourColor (const Color_t color)
 set the fill contour color
 
void SetFillStyle (const Style_t style)
 set the fill contour color
 
void SetLikelihoodInterval (LikelihoodInterval *theInterval)
 
void SetLineColor (const Color_t color)
 set the line color for the 1D interval lines or contours (2D)
 
void SetMaximum (const double theMaximum)
 
void SetNPoints (Int_t np)
 
void SetPlotParameters (const RooArgSet *params)
 
void SetPrecision (double eps)
 set plot precision (when drawing a RooPlot)
 
void SetRange (double x1, double x2)
 set plot range (for 1D plot)
 
void SetRange (double x1, double y1, double x2, double y2)
 set plot range (for 2D plot)
 
void Streamer (TBuffer &) override
 Stream an object of class TObject.
 
void StreamerNVirtual (TBuffer &ClassDef_StreamerNVirtual_b)
 
- Public Member Functions inherited from TNamed
 TNamed ()
 
 TNamed (const char *name, const char *title)
 
 TNamed (const TNamed &named)
 TNamed copy ctor.
 
 TNamed (const TString &name, const TString &title)
 
virtual ~TNamed ()
 TNamed destructor.
 
void Clear (Option_t *option="") override
 Set name and title to empty strings ("").
 
TObjectClone (const char *newname="") const override
 Make a clone of an object using the Streamer facility.
 
Int_t Compare (const TObject *obj) const override
 Compare two TNamed objects.
 
void Copy (TObject &named) const override
 Copy this to obj.
 
virtual void FillBuffer (char *&buffer)
 Encode TNamed into output buffer.
 
const char * GetName () const override
 Returns name of object.
 
const char * GetTitle () const override
 Returns title of object.
 
ULong_t Hash () const override
 Return hash value for this object.
 
TClassIsA () const override
 
Bool_t IsSortable () const override
 
void ls (Option_t *option="") const override
 List TNamed name and title.
 
TNamedoperator= (const TNamed &rhs)
 TNamed assignment operator.
 
void Print (Option_t *option="") const override
 Print TNamed name and title.
 
virtual void SetName (const char *name)
 Set the name of the TNamed.
 
virtual void SetNameTitle (const char *name, const char *title)
 Set all the TNamed parameters (name and title).
 
virtual void SetTitle (const char *title="")
 Set the title of the TNamed.
 
virtual Int_t Sizeof () const
 Return size of the TNamed part of the TObject.
 
void Streamer (TBuffer &) override
 Stream an object of class TObject.
 
void StreamerNVirtual (TBuffer &ClassDef_StreamerNVirtual_b)
 
- Public Member Functions inherited from TObject
 TObject ()
 TObject constructor.
 
 TObject (const TObject &object)
 TObject copy ctor.
 
virtual ~TObject ()
 TObject destructor.
 
void AbstractMethod (const char *method) const
 Use this method to implement an "abstract" method that you don't want to leave purely abstract.
 
virtual void AppendPad (Option_t *option="")
 Append graphics object to current pad.
 
virtual void Browse (TBrowser *b)
 Browse object. May be overridden for another default action.
 
ULong_t CheckedHash ()
 Check and record whether this class has a consistent Hash/RecursiveRemove setup (*) and then return the regular Hash value for this object.
 
virtual const char * ClassName () const
 Returns name of class to which the object belongs.
 
virtual void Delete (Option_t *option="")
 Delete this object.
 
virtual Int_t DistancetoPrimitive (Int_t px, Int_t py)
 Computes distance from point (px,py) to the object.
 
virtual void Draw (Option_t *option="")
 Default Draw method for all objects.
 
virtual void DrawClass () const
 Draw class inheritance tree of the class to which this object belongs.
 
virtual TObjectDrawClone (Option_t *option="") const
 Draw a clone of this object in the current selected pad with: gROOT->SetSelectedPad(c1).
 
virtual void Dump () const
 Dump contents of object on stdout.
 
virtual void Error (const char *method, const char *msgfmt,...) const
 Issue error message.
 
virtual void Execute (const char *method, const char *params, Int_t *error=nullptr)
 Execute method on this object with the given parameter string, e.g.
 
virtual void Execute (TMethod *method, TObjArray *params, Int_t *error=nullptr)
 Execute method on this object with parameters stored in the TObjArray.
 
virtual void ExecuteEvent (Int_t event, Int_t px, Int_t py)
 Execute action corresponding to an event at (px,py).
 
virtual void Fatal (const char *method, const char *msgfmt,...) const
 Issue fatal error message.
 
virtual TObjectFindObject (const char *name) const
 Must be redefined in derived classes.
 
virtual TObjectFindObject (const TObject *obj) const
 Must be redefined in derived classes.
 
virtual Option_tGetDrawOption () const
 Get option used by the graphics system to draw this object.
 
virtual const char * GetIconName () const
 Returns mime type name of object.
 
virtual char * GetObjectInfo (Int_t px, Int_t py) const
 Returns string containing info about the object at position (px,py).
 
virtual Option_tGetOption () const
 
virtual UInt_t GetUniqueID () const
 Return the unique object id.
 
virtual Bool_t HandleTimer (TTimer *timer)
 Execute action in response of a timer timing out.
 
Bool_t HasInconsistentHash () const
 Return true is the type of this object is known to have an inconsistent setup for Hash and RecursiveRemove (i.e.
 
virtual void Info (const char *method, const char *msgfmt,...) const
 Issue info message.
 
virtual Bool_t InheritsFrom (const char *classname) const
 Returns kTRUE if object inherits from class "classname".
 
virtual Bool_t InheritsFrom (const TClass *cl) const
 Returns kTRUE if object inherits from TClass cl.
 
virtual void Inspect () const
 Dump contents of this object in a graphics canvas.
 
void InvertBit (UInt_t f)
 
Bool_t IsDestructed () const
 IsDestructed.
 
virtual Bool_t IsEqual (const TObject *obj) const
 Default equal comparison (objects are equal if they have the same address in memory).
 
virtual Bool_t IsFolder () const
 Returns kTRUE in case object contains browsable objects (like containers or lists of other objects).
 
R__ALWAYS_INLINE Bool_t IsOnHeap () const
 
R__ALWAYS_INLINE 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).
 
virtual Bool_t Notify ()
 This method must be overridden to handle object notification (the base implementation is no-op).
 
void Obsolete (const char *method, const char *asOfVers, const char *removedFromVers) const
 Use this method to declare a method obsolete.
 
void operator delete (void *ptr)
 Operator delete.
 
void operator delete (void *ptr, void *vp)
 Only called by placement new when throwing an exception.
 
void operator delete[] (void *ptr)
 Operator delete [].
 
void operator delete[] (void *ptr, void *vp)
 Only called by placement new[] when throwing an exception.
 
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)
 
TObjectoperator= (const TObject &rhs)
 TObject assignment operator.
 
virtual void Paint (Option_t *option="")
 This method must be overridden if a class wants to paint itself.
 
virtual void Pop ()
 Pop on object drawn in a pad to the top of the display list.
 
virtual Int_t Read (const char *name)
 Read contents of object with specified name from the current directory.
 
virtual void RecursiveRemove (TObject *obj)
 Recursively remove this object from a list.
 
void ResetBit (UInt_t f)
 
virtual void SaveAs (const char *filename="", Option_t *option="") const
 Save this object in the file specified by filename.
 
virtual void SavePrimitive (std::ostream &out, Option_t *option="")
 Save a primitive as a C++ statement(s) on output stream "out".
 
void SetBit (UInt_t f)
 
void SetBit (UInt_t f, Bool_t set)
 Set or unset the user status bits as specified in f.
 
virtual void SetDrawOption (Option_t *option="")
 Set drawing option for object.
 
virtual void SetUniqueID (UInt_t uid)
 Set the unique object id.
 
void StreamerNVirtual (TBuffer &ClassDef_StreamerNVirtual_b)
 
virtual void SysError (const char *method, const char *msgfmt,...) const
 Issue system error message.
 
R__ALWAYS_INLINE 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.
 
virtual void Warning (const char *method, const char *msgfmt,...) const
 Issue warning message.
 
virtual Int_t Write (const char *name=nullptr, Int_t option=0, Int_t bufsize=0)
 Write this object to the current directory.
 
virtual Int_t Write (const char *name=nullptr, Int_t option=0, Int_t bufsize=0) const
 Write this object to the current directory.
 
- Public Member Functions inherited from RooPrintable
 RooPrintable ()
 
virtual ~RooPrintable ()
 
virtual Int_t defaultPrintContents (Option_t *opt) const
 Default choice of contents to be printed (name and value)
 
virtual StyleOption defaultPrintStyle (Option_t *opt) const
 
virtual void printAddress (std::ostream &os) const
 Print class name of object.
 
virtual void printArgs (std::ostream &os) const
 Interface for printing of object arguments.
 
virtual void printClassName (std::ostream &os) const
 Print class name of object.
 
virtual void printExtras (std::ostream &os) const
 Interface to print extras of object.
 
virtual void printMultiline (std::ostream &os, Int_t contents, bool verbose=false, TString indent="") const
 Interface for detailed printing of object.
 
virtual void printName (std::ostream &os) const
 Print name of object.
 
virtual void printStream (std::ostream &os, Int_t contents, StyleOption style, TString indent="") const
 Print description of object on ostream, printing contents set by contents integer, which is interpreted as an OR of 'enum ContentsOptions' values and in the style given by 'enum StyleOption'.
 
virtual void printTitle (std::ostream &os) const
 Print title of object.
 
virtual void printTree (std::ostream &os, TString indent="") const
 Interface for tree structure printing of object.
 
virtual void printValue (std::ostream &os) const
 Interface to print value of object.
 
void StreamerNVirtual (TBuffer &ClassDef_StreamerNVirtual_b)
 

Static Public Member Functions

static TClassClass ()
 
static const char * Class_Name ()
 
static constexpr Version_t Class_Version ()
 
static const char * DeclFileName ()
 
- Static Public Member Functions inherited from TNamed
static TClassClass ()
 
static const char * Class_Name ()
 
static constexpr Version_t Class_Version ()
 
static const char * DeclFileName ()
 
- Static Public Member Functions inherited from TObject
static TClassClass ()
 
static const char * Class_Name ()
 
static constexpr Version_t Class_Version ()
 
static const char * DeclFileName ()
 
static Longptr_t GetDtorOnly ()
 Return destructor only flag.
 
static Bool_t GetObjectStat ()
 Get status of object stat flag.
 
static void SetDtorOnly (void *obj)
 Set destructor only flag.
 
static void SetObjectStat (Bool_t stat)
 Turn on/off tracking of objects in the TObjectTable.
 
- Static Public Member Functions inherited from RooPrintable
static TClassClass ()
 
static const char * Class_Name ()
 
static constexpr Version_t Class_Version ()
 
static const char * DeclFileName ()
 
static std::ostream & defaultPrintStream (std::ostream *os=nullptr)
 Return a reference to the current default stream to use in Print().
 
static void nameFieldLength (Int_t newLen)
 Set length of field reserved from printing name of RooAbsArgs in multi-line collection printing to given amount.
 

Private Attributes

Color_t fColor = 0
 color for the contour (for 2D) or function (in 1D)
 
Style_t fFillStyle = 4050
 fill style for contours, half transparent by default
 
LikelihoodIntervalfInterval = nullptr
 
Color_t fLineColor = 0
 line color for the interval (1D) or for other contours (2D)
 
double fMaximum = -1
 function maximum
 
Int_t fNdimPlot = 0
 
Int_t fNPoints = 0
 number of points used to scan the PL, default depends if 1D or 2D
 
RooArgSetfParamsPlot = nullptr
 
TObjectfPlotObject = nullptr
 plotted object
 
double fPrecision = -1
 RooCurve precision, use default in case of -1.
 
double fXmax = -1
 
double fXmin = 0
 
double fYmax = -1
 
double fYmin = 0
 

Additional Inherited Members

- Public Types inherited from TObject
enum  {
  kIsOnHeap = 0x01000000 , kNotDeleted = 0x02000000 , kZombie = 0x04000000 , kInconsistent = 0x08000000 ,
  kBitMask = 0x00ffffff
}
 
enum  { kSingleKey = (1ULL << ( 0 )) , kOverwrite = (1ULL << ( 1 )) , kWriteDelete = (1ULL << ( 2 )) }
 
enum  EDeprecatedStatusBits { kObjInCanvas = (1ULL << ( 3 )) }
 
enum  EStatusBits {
  kCanDelete = (1ULL << ( 0 )) , kMustCleanup = (1ULL << ( 3 )) , kIsReferenced = (1ULL << ( 4 )) , kHasUUID = (1ULL << ( 5 )) ,
  kCannotPick = (1ULL << ( 6 )) , kNoContextMenu = (1ULL << ( 8 )) , kInvalidObject = (1ULL << ( 13 ))
}
 
- Public Types inherited from RooPrintable
enum  ContentsOption {
  kName =1 , kClassName =2 , kValue =4 , kArgs =8 ,
  kExtras =16 , kAddress =32 , kTitle =64 , kCollectionHeader =128
}
 
enum  StyleOption {
  kInline =1 , kSingleLine =2 , kStandard =3 , kVerbose =4 ,
  kTreeStructure =5
}
 
- Protected Types inherited from TObject
enum  { kOnlyPrepStep = (1ULL << ( 3 )) }
 
- 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).
 
void MakeZombie ()
 
- Protected Attributes inherited from TNamed
TString fName
 
TString fTitle
 
- Static Protected Attributes inherited from RooPrintable
static Int_t _nameLength
 

#include <RooStats/LikelihoodIntervalPlot.h>

Inheritance diagram for RooStats::LikelihoodIntervalPlot:
[legend]

Constructor & Destructor Documentation

◆ LikelihoodIntervalPlot() [1/2]

LikelihoodIntervalPlot::LikelihoodIntervalPlot ( )

LikelihoodIntervalPlot default constructor with default parameters.

Definition at line 58 of file LikelihoodIntervalPlot.cxx.

◆ LikelihoodIntervalPlot() [2/2]

LikelihoodIntervalPlot::LikelihoodIntervalPlot ( LikelihoodInterval theInterval)

LikelihoodIntervalPlot copy constructor.

Definition at line 63 of file LikelihoodIntervalPlot.cxx.

Member Function Documentation

◆ Class()

static TClass * RooStats::LikelihoodIntervalPlot::Class ( )
static
Returns
TClass describing this class

◆ Class_Name()

static const char * RooStats::LikelihoodIntervalPlot::Class_Name ( )
static
Returns
Name of this class

◆ Class_Version()

static constexpr Version_t RooStats::LikelihoodIntervalPlot::Class_Version ( )
inlinestaticconstexpr
Returns
Version of this class

Definition at line 93 of file LikelihoodIntervalPlot.h.

◆ DeclFileName()

static const char * RooStats::LikelihoodIntervalPlot::DeclFileName ( )
inlinestatic
Returns
Name of the file containing the class declaration

Definition at line 93 of file LikelihoodIntervalPlot.h.

◆ Draw()

void LikelihoodIntervalPlot::Draw ( const Option_t options = nullptr)
override

draw the likelihood interval or contour for the 1D case a RooPlot is drawn by default of the profiled Log-Likelihood ratio if option "TF1" is used the objects are drawn using a TF1 scanning the LL function in a grid of the set points (by default the TF1 can be customized by setting maximum and the number of points to scan

draw the log of the profiled likelihood function in 1D with the interval or as a 2D plot with the contours.

Higher dimensional intervals cannot be drawn. One needs to call SetPlotParameters to project interval in 1 or 2dim

Options for drawing 1D intervals

For 1D problem the log of the profiled likelihood function is drawn by default in a RooPlot as a RooCurve The plotting range (default is the full parameter range) and the precision of the RooCurve can be specified by using SetRange(x1,x2) and SetPrecision(eps). SetNPoints(npoints) can also be used (default is npoints=100) Optionally the function can be drawn as a TF1 (option="tf1") obtained by sampling the given npoints in the given range

Options for drawing 2D intervals

For 2D case, a contour and optionally the profiled likelihood function is drawn by sampling npoints in the given range. A 2d histogram of nbinsX=nbinsY = sqrt(npoints) is used for sampling the profiled likelihood. The contour can be obtained by using Minuit or by the sampled histogram, If using Minuit, the number of points specifies the number of contour points. If using an histogram the number of points is approximately the total number of bins of the histogram. Possible options:

  • minuit/nominuit: use minuit for computing the contour
  • hist/nohist : sample in an histogram the profiled likelihood

Note that one can have both a drawing of the sampled likelihood and of the contour using minuit. The default options is "minuit nohist" The sampled histogram is drawn first by default using the option "colz" and then 8 probability contours at these CL are drawn: { 0.1,0.3,0.5,0.683,0.95,0.9973,0.9999366575,0.9999994267} re-drawing the histogram with the option "cont3"

The drawn object (RooPlot or sampled histogram) is saved in the class and can be retrieved using GetPlottedObject() In this way the user can eventually customize further the plot. Note that the class does not delete the plotted object. It needs, if needed, to be deleted by the user

Definition at line 128 of file LikelihoodIntervalPlot.cxx.

◆ GetPlottedObject()

TObject * RooStats::LikelihoodIntervalPlot::GetPlottedObject ( ) const
inline

returned plotted object (RooPlot or histograms)

Definition at line 38 of file LikelihoodIntervalPlot.h.

◆ IsA()

TClass * RooStats::LikelihoodIntervalPlot::IsA ( ) const
inlineoverridevirtual
Returns
TClass describing current object

Reimplemented from TObject.

Definition at line 93 of file LikelihoodIntervalPlot.h.

◆ SetContourColor()

void RooStats::LikelihoodIntervalPlot::SetContourColor ( const Color_t  color)
inline

set the fill contour color

Definition at line 59 of file LikelihoodIntervalPlot.h.

◆ SetFillStyle()

void RooStats::LikelihoodIntervalPlot::SetFillStyle ( const Style_t  style)
inline

set the fill contour color

Definition at line 57 of file LikelihoodIntervalPlot.h.

◆ SetLikelihoodInterval()

void LikelihoodIntervalPlot::SetLikelihoodInterval ( LikelihoodInterval theInterval)

Definition at line 71 of file LikelihoodIntervalPlot.cxx.

◆ SetLineColor()

void RooStats::LikelihoodIntervalPlot::SetLineColor ( const Color_t  color)
inline

set the line color for the 1D interval lines or contours (2D)

Definition at line 55 of file LikelihoodIntervalPlot.h.

◆ SetMaximum()

void RooStats::LikelihoodIntervalPlot::SetMaximum ( const double  theMaximum)
inline

Definition at line 60 of file LikelihoodIntervalPlot.h.

◆ SetNPoints()

void RooStats::LikelihoodIntervalPlot::SetNPoints ( Int_t  np)
inline

Definition at line 61 of file LikelihoodIntervalPlot.h.

◆ SetPlotParameters()

void LikelihoodIntervalPlot::SetPlotParameters ( const RooArgSet params)

Definition at line 82 of file LikelihoodIntervalPlot.cxx.

◆ SetPrecision()

void RooStats::LikelihoodIntervalPlot::SetPrecision ( double  eps)
inline

set plot precision (when drawing a RooPlot)

Definition at line 53 of file LikelihoodIntervalPlot.h.

◆ SetRange() [1/2]

void RooStats::LikelihoodIntervalPlot::SetRange ( double  x1,
double  x2 
)
inline

set plot range (for 1D plot)

Definition at line 45 of file LikelihoodIntervalPlot.h.

◆ SetRange() [2/2]

void RooStats::LikelihoodIntervalPlot::SetRange ( double  x1,
double  y1,
double  x2,
double  y2 
)
inline

set plot range (for 2D plot)

Definition at line 47 of file LikelihoodIntervalPlot.h.

◆ Streamer()

void RooStats::LikelihoodIntervalPlot::Streamer ( TBuffer R__b)
overridevirtual

Stream an object of class TObject.

Reimplemented from TObject.

◆ StreamerNVirtual()

void RooStats::LikelihoodIntervalPlot::StreamerNVirtual ( TBuffer ClassDef_StreamerNVirtual_b)
inline

Definition at line 93 of file LikelihoodIntervalPlot.h.

Member Data Documentation

◆ fColor

Color_t RooStats::LikelihoodIntervalPlot::fColor = 0
private

color for the contour (for 2D) or function (in 1D)

Definition at line 72 of file LikelihoodIntervalPlot.h.

◆ fFillStyle

Style_t RooStats::LikelihoodIntervalPlot::fFillStyle = 4050
private

fill style for contours, half transparent by default

Definition at line 73 of file LikelihoodIntervalPlot.h.

◆ fInterval

LikelihoodInterval* RooStats::LikelihoodIntervalPlot::fInterval = nullptr
private

Definition at line 86 of file LikelihoodIntervalPlot.h.

◆ fLineColor

Color_t RooStats::LikelihoodIntervalPlot::fLineColor = 0
private

line color for the interval (1D) or for other contours (2D)

Definition at line 74 of file LikelihoodIntervalPlot.h.

◆ fMaximum

double RooStats::LikelihoodIntervalPlot::fMaximum = -1
private

function maximum

Definition at line 78 of file LikelihoodIntervalPlot.h.

◆ fNdimPlot

Int_t RooStats::LikelihoodIntervalPlot::fNdimPlot = 0
private

Definition at line 75 of file LikelihoodIntervalPlot.h.

◆ fNPoints

Int_t RooStats::LikelihoodIntervalPlot::fNPoints = 0
private

number of points used to scan the PL, default depends if 1D or 2D

Definition at line 76 of file LikelihoodIntervalPlot.h.

◆ fParamsPlot

RooArgSet* RooStats::LikelihoodIntervalPlot::fParamsPlot = nullptr
private

Definition at line 88 of file LikelihoodIntervalPlot.h.

◆ fPlotObject

TObject* RooStats::LikelihoodIntervalPlot::fPlotObject = nullptr
private

plotted object

Definition at line 89 of file LikelihoodIntervalPlot.h.

◆ fPrecision

double RooStats::LikelihoodIntervalPlot::fPrecision = -1
private

RooCurve precision, use default in case of -1.

Definition at line 84 of file LikelihoodIntervalPlot.h.

◆ fXmax

double RooStats::LikelihoodIntervalPlot::fXmax = -1
private

Definition at line 81 of file LikelihoodIntervalPlot.h.

◆ fXmin

double RooStats::LikelihoodIntervalPlot::fXmin = 0
private

Definition at line 80 of file LikelihoodIntervalPlot.h.

◆ fYmax

double RooStats::LikelihoodIntervalPlot::fYmax = -1
private

Definition at line 83 of file LikelihoodIntervalPlot.h.

◆ fYmin

double RooStats::LikelihoodIntervalPlot::fYmin = 0
private

Definition at line 82 of file LikelihoodIntervalPlot.h.

Libraries for RooStats::LikelihoodIntervalPlot:

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