ROOT  6.06/09
Reference Guide
Public Member Functions | Protected Member Functions | Private Attributes | List of all members
RooStats::SamplingDistribution Class Reference

This class simply holds a sampling distribution of some test statistic.

The distribution can either be an empirical distribution (eg. the samples themselves) or a weighted set of points (eg. for the FFT method). The class supports merging.

Definition at line 44 of file SamplingDistribution.h.

Public Member Functions

 SamplingDistribution (const char *name, const char *title, std::vector< Double_t > &samplingDist, const char *varName=0)
 Constructor for SamplingDistribution. More...
 
 SamplingDistribution (const char *name, const char *title, std::vector< Double_t > &samplingDist, std::vector< Double_t > &sampleWeights, const char *varName=0)
 
 SamplingDistribution (const char *name, const char *title, const char *varName=0)
 
 SamplingDistribution (const char *name, const char *title, RooDataSet &dataSet, const char *columnName=0, const char *varName=0)
 
 SamplingDistribution ()
 Default constructor for SamplingDistribution. More...
 
virtual ~SamplingDistribution ()
 Destructor of SamplingDistribution. More...
 
Double_t InverseCDF (Double_t pvalue)
 get the inverse of the Cumulative distribution function More...
 
Double_t InverseCDFInterpolate (Double_t pvalue)
 get the inverse of the Cumulative distribution function More...
 
Double_t InverseCDF (Double_t pvalue, Double_t sigmaVariaton, Double_t &inverseVariation)
 get the inverse of the Cumulative distribution function together with the inverse based on sampling variation More...
 
void Add (const SamplingDistribution *other)
 merge two sampling distributions More...
 
Int_t GetSize () const
 size of samples More...
 
const std::vector< Double_t > & GetSamplingDistribution () const
 Get test statistics values. More...
 
const std::vector< Double_t > & GetSampleWeights () const
 Get the sampling weights. More...
 
const TString GetVarName () const
 
Double_t Integral (Double_t low, Double_t high, Bool_t normalize=kTRUE, Bool_t lowClosed=kTRUE, Bool_t highClosed=kFALSE) const
 numerical integral in these limits More...
 
Double_t IntegralAndError (Double_t &error, Double_t low, Double_t high, Bool_t normalize=kTRUE, Bool_t lowClosed=kTRUE, Bool_t highClosed=kFALSE) const
 numerical integral in these limits including error estimation More...
 
Double_t CDF (Double_t x) const
 calculate CDF as a special case of Integral(...) with lower limit equal to -inf More...
 
- 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)
 
TNamedoperator= (const TNamed &rhs)
 TNamed assignment operator. More...
 
virtual ~TNamed ()
 
virtual void Clear (Option_t *option="")
 Set name and title to empty strings (""). More...
 
virtual TObjectClone (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 SetName (const char *name)
 Change (i.e. More...
 
virtual void SetNameTitle (const char *name, const char *title)
 Change (i.e. set) all the TNamed parameters (name and title). More...
 
virtual void SetTitle (const char *title="")
 Change (i.e. set) the title of the TNamed. More...
 
virtual void ls (Option_t *option="") const
 List TNamed name and title. More...
 
virtual void Print (Option_t *option="") const
 Print TNamed name and title. More...
 
virtual Int_t Sizeof () const
 Return size of the TNamed part of the TObject. More...
 
- Public Member Functions inherited from TObject
 TObject ()
 
 TObject (const TObject &object)
 TObject copy ctor. More...
 
TObjectoperator= (const TObject &rhs)
 TObject assignment operator. More...
 
virtual ~TObject ()
 TObject destructor. 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 TObjectDrawClone (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 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 TObjectFindObject (const char *name) const
 Must be redefined in derived classes. More...
 
virtual TObjectFindObject (const TObject *obj) const
 Must be redefined in derived classes. More...
 
virtual Option_tGetDrawOption () const
 Get option used by the graphics system to draw this object. More...
 
virtual UInt_t GetUniqueID () const
 Return the unique object id. More...
 
virtual const char * GetIconName () const
 Returns mime type name of object. More...
 
virtual Option_tGetOption () const
 
virtual char * GetObjectInfo (Int_t px, Int_t py) const
 Returns string containing info about the object at position (px,py). More...
 
virtual Bool_t HandleTimer (TTimer *timer)
 Execute action in response of a timer timing out. 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...
 
virtual Bool_t IsFolder () const
 Returns kTRUE in case object contains browsable objects (like containers or lists of other objects). More...
 
virtual Bool_t IsEqual (const TObject *obj) const
 Default equal comparison (objects are equal if they have the same address in memory). More...
 
Bool_t IsOnHeap () const
 
Bool_t IsZombie () const
 
virtual Bool_t Notify ()
 This method must be overridden to handle object notification. 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...
 
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...
 
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 UseCurrentStyle ()
 Set current style settings in this object This function is called when either TCanvas::UseCurrentStyle or TROOT::ForceStyle have been invoked. 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...
 
voidoperator new (size_t sz)
 
voidoperator new[] (size_t sz)
 
voidoperator new (size_t sz, void *vp)
 
voidoperator new[] (size_t sz, void *vp)
 
void operator delete (void *ptr)
 Operator delete. More...
 
void operator delete[] (void *ptr)
 Operator delete []. 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)
 
void ResetBit (UInt_t f)
 
Bool_t TestBit (UInt_t f) const
 
Int_t TestBits (UInt_t f) const
 
void InvertBit (UInt_t f)
 
virtual void Info (const char *method, const char *msgfmt,...) const
 Issue info message. More...
 
virtual void Warning (const char *method, const char *msgfmt,...) const
 Issue warning message. More...
 
virtual void Error (const char *method, const char *msgfmt,...) const
 Issue error message. More...
 
virtual void SysError (const char *method, const char *msgfmt,...) const
 Issue system error message. More...
 
virtual void Fatal (const char *method, const char *msgfmt,...) const
 Issue fatal error message. 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...
 
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...
 
void Obsolete (const char *method, const char *asOfVers, const char *removedFromVers) const
 Use this method to declare a method obsolete. More...
 

Protected Member Functions

void SortValues () const
 Chached vector with sum of the weight used to compute integral error. More...
 
- Protected Member Functions inherited from TObject
void MakeZombie ()
 
virtual void DoError (int level, const char *location, const char *fmt, va_list va) const
 Interface to ErrorHandler (protected). More...
 

Private Attributes

std::vector< Double_tfSamplingDist
 
std::vector< Double_tfSampleWeights
 vector of points for the sampling distribution More...
 
TString fVarName
 vector of weights for the samples More...
 
std::vector< Double_tfSumW
 
std::vector< Double_tfSumW2
 Chached vector with sum of the weight used to compute integral. More...
 

Additional Inherited Members

- Public Types inherited from TObject
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)
}
 
enum  { kIsOnHeap = 0x01000000, kNotDeleted = 0x02000000, kZombie = 0x04000000, kBitMask = 0x00ffffff }
 
enum  { kSingleKey = BIT(0), kOverwrite = BIT(1), kWriteDelete = BIT(2) }
 
- Static Public Member Functions inherited from TObject
static Long_t GetDtorOnly ()
 Return destructor only flag. More...
 
static void SetDtorOnly (void *obj)
 Set destructor only flag. More...
 
static Bool_t GetObjectStat ()
 Get status of object stat flag. More...
 
static void SetObjectStat (Bool_t stat)
 Turn on/off tracking of objects in the TObjectTable. More...
 
- Protected Attributes inherited from TNamed
TString fName
 
TString fTitle
 

#include <RooStats/SamplingDistribution.h>

+ Inheritance diagram for RooStats::SamplingDistribution:
+ Collaboration diagram for RooStats::SamplingDistribution:

Constructor & Destructor Documentation

RooStats::SamplingDistribution::SamplingDistribution ( const char *  name,
const char *  title,
std::vector< Double_t > &  samplingDist,
const char *  varName = 0 
)

Constructor for SamplingDistribution.

RooStats::SamplingDistribution::SamplingDistribution ( const char *  name,
const char *  title,
std::vector< Double_t > &  samplingDist,
std::vector< Double_t > &  sampleWeights,
const char *  varName = 0 
)
RooStats::SamplingDistribution::SamplingDistribution ( const char *  name,
const char *  title,
const char *  varName = 0 
)
RooStats::SamplingDistribution::SamplingDistribution ( const char *  name,
const char *  title,
RooDataSet dataSet,
const char *  columnName = 0,
const char *  varName = 0 
)
SamplingDistribution::SamplingDistribution ( )

Default constructor for SamplingDistribution.

SamplingDistribution default constructor.

Definition at line 129 of file SamplingDistribution.cxx.

SamplingDistribution::~SamplingDistribution ( )
virtual

Destructor of SamplingDistribution.

SamplingDistribution destructor.

Definition at line 137 of file SamplingDistribution.cxx.

Member Function Documentation

void SamplingDistribution::Add ( const SamplingDistribution other)

merge two sampling distributions

Merge SamplingDistributions (does nothing if NULL is given).

If variable name was not set before, it is copied from the added SamplingDistribution.

Definition at line 149 of file SamplingDistribution.cxx.

Referenced by RooStats::HypoTestResult::Append().

Double_t SamplingDistribution::CDF ( Double_t  x) const

calculate CDF as a special case of Integral(...) with lower limit equal to -inf

returns the closed integral [-inf,x]

Definition at line 309 of file SamplingDistribution.cxx.

const std::vector<Double_t>& RooStats::SamplingDistribution::GetSampleWeights ( ) const
inline

Get the sampling weights.

Definition at line 83 of file SamplingDistribution.h.

Referenced by RooStats::SamplingDistPlot::SetSampleWeights().

const std::vector<Double_t>& RooStats::SamplingDistribution::GetSamplingDistribution ( ) const
inline
Int_t RooStats::SamplingDistribution::GetSize ( ) const
inline
const TString RooStats::SamplingDistribution::GetVarName ( ) const
inline
Double_t SamplingDistribution::Integral ( Double_t  low,
Double_t  high,
Bool_t  normalize = kTRUE,
Bool_t  lowClosed = kTRUE,
Bool_t  highClosed = kFALSE 
) const

numerical integral in these limits

Returns the integral in the open/closed/mixed interval.

Default is [low,high) interval. Normalization can be turned off.

Definition at line 185 of file SamplingDistribution.cxx.

Referenced by CDF().

Double_t SamplingDistribution::IntegralAndError ( Double_t error,
Double_t  low,
Double_t  high,
Bool_t  normalize = kTRUE,
Bool_t  lowClosed = kTRUE,
Bool_t  highClosed = kFALSE 
) const

numerical integral in these limits including error estimation

Returns the integral in the open/closed/mixed interval.

Default is [low,high) interval. Normalization can be turned off. compute also the error on the integral

Definition at line 235 of file SamplingDistribution.cxx.

Referenced by Integral(), and RooStats::HypoTestResult::UpdatePValue().

Double_t SamplingDistribution::InverseCDF ( Double_t  pvalue)

get the inverse of the Cumulative distribution function

returns the inverse of the cumulative distribution function

Definition at line 318 of file SamplingDistribution.cxx.

Referenced by RooStats::NeymanConstruction::GetInterval().

Double_t RooStats::SamplingDistribution::InverseCDF ( Double_t  pvalue,
Double_t  sigmaVariaton,
Double_t inverseVariation 
)

get the inverse of the Cumulative distribution function together with the inverse based on sampling variation

Double_t SamplingDistribution::InverseCDFInterpolate ( Double_t  pvalue)

get the inverse of the Cumulative distribution function

returns the inverse of the cumulative distribution function

Definition at line 406 of file SamplingDistribution.cxx.

void SamplingDistribution::SortValues ( ) const
protected

Chached vector with sum of the weight used to compute integral error.

internal function to sort values

Definition at line 194 of file SamplingDistribution.cxx.

Referenced by IntegralAndError(), and InverseCDFInterpolate().

Member Data Documentation

std::vector<Double_t> RooStats::SamplingDistribution::fSampleWeights
mutableprivate

vector of points for the sampling distribution

Definition at line 100 of file SamplingDistribution.h.

Referenced by Add(), GetSampleWeights(), SortValues(), and ~SamplingDistribution().

std::vector<Double_t> RooStats::SamplingDistribution::fSamplingDist
mutableprivate
std::vector<Double_t> RooStats::SamplingDistribution::fSumW
mutableprivate

Definition at line 105 of file SamplingDistribution.h.

Referenced by IntegralAndError(), InverseCDFInterpolate(), and SortValues().

std::vector<Double_t> RooStats::SamplingDistribution::fSumW2
mutableprivate

Chached vector with sum of the weight used to compute integral.

Definition at line 106 of file SamplingDistribution.h.

Referenced by IntegralAndError(), InverseCDFInterpolate(), and SortValues().

TString RooStats::SamplingDistribution::fVarName
private

vector of weights for the samples

Definition at line 103 of file SamplingDistribution.h.

Referenced by Add(), and GetVarName().


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