Logo ROOT  
Reference Guide
 
Loading...
Searching...
No Matches
RooPoisson.h
Go to the documentation of this file.
1 /*****************************************************************************
2 * Project: RooFit *
3 * *
4 * Simple Poisson PDF
5 * author: Kyle Cranmer <cranmer@cern.ch>
6 * *
7 *****************************************************************************/
8
9#ifndef ROOPOISSON
10#define ROOPOISSON
11
12#include "RooAbsPdf.h"
13#include "RooRealProxy.h"
14#include "RooCategoryProxy.h"
15#include "RooAbsReal.h"
16#include "RooAbsCategory.h"
17#include "RooTrace.h"
18
19class RooPoisson : public RooAbsPdf {
20public:
21 RooPoisson() { _noRounding = false ; } ;
22 // Original constructor without RooAbsReal::Ref for backwards compatibility.
23 inline RooPoisson(const char *name, const char *title, RooAbsReal& _x, RooAbsReal& _mean, bool noRounding=false)
24 : RooPoisson{name, title, RooAbsReal::Ref{_x}, RooAbsReal::Ref{_mean}, noRounding} {}
25 RooPoisson(const char *name, const char *title, RooAbsReal::Ref _x, RooAbsReal::Ref _mean, bool noRounding=false);
26 RooPoisson(const RooPoisson& other, const char* name=nullptr) ;
27 TObject* clone(const char* newname) const override { return new RooPoisson(*this,newname); }
28 inline ~RooPoisson() override { }
29
30 Int_t getAnalyticalIntegral(RooArgSet& allVars, RooArgSet& analVars, const char* rangeName=nullptr) const override;
31 double analyticalIntegral(Int_t code, const char* rangeName=nullptr) const override;
32
33 Int_t getGenerator(const RooArgSet& directVars, RooArgSet &generateVars, bool staticInitOK=true) const override;
34 void generateEvent(Int_t code) override;
35
36 /// Switch off/on rounding of `x` to the nearest integer.
37 void setNoRounding(bool flag = true) {_noRounding = flag;}
38 /// Switch on or off protection against negative means.
39 void protectNegativeMean(bool flag = true) {_protectNegative = flag;}
40
41 /// Get the x variable.
42 RooAbsReal const& getX() const { return x.arg(); }
43
44 /// Get the mean parameter.
45 RooAbsReal const& getMean() const { return mean.arg(); }
46
47protected:
48
52 bool _protectNegative{true};
53
54 double evaluate() const override;
55 void computeBatch(cudaStream_t*, double* output, size_t nEvents, RooFit::Detail::DataMap const&) const override;
56 inline bool canComputeBatchWithCuda() const override { return true; }
57
58 ClassDefOverride(RooPoisson,3) // A Poisson PDF
59};
60
61#endif
#define ClassDefOverride(name, id)
Definition Rtypes.h:339
char name[80]
Definition TGX11.cxx:110
A RooAbsReal::Ref can be constructed from a RooAbsReal& or a double that will be implicitly converted...
Definition RooAbsReal.h:70
RooAbsReal is the common abstract base class for objects that represent a real value and implements f...
Definition RooAbsReal.h:61
RooArgSet is a container object that can hold multiple RooAbsArg objects.
Definition RooArgSet.h:55
Poisson pdf.
Definition RooPoisson.h:19
RooRealProxy x
Definition RooPoisson.h:49
void computeBatch(cudaStream_t *, double *output, size_t nEvents, RooFit::Detail::DataMap const &) const override
Compute multiple values of the Poisson distribution.
bool _noRounding
Definition RooPoisson.h:51
bool canComputeBatchWithCuda() const override
Definition RooPoisson.h:56
RooAbsReal const & getX() const
Get the x variable.
Definition RooPoisson.h:42
~RooPoisson() override
Definition RooPoisson.h:28
double analyticalIntegral(Int_t code, const char *rangeName=nullptr) const override
Implements the actual analytical integral(s) advertised by getAnalyticalIntegral.
RooPoisson(const char *name, const char *title, RooAbsReal &_x, RooAbsReal &_mean, bool noRounding=false)
Definition RooPoisson.h:23
bool _protectNegative
Definition RooPoisson.h:52
void setNoRounding(bool flag=true)
Switch off/on rounding of x to the nearest integer.
Definition RooPoisson.h:37
void generateEvent(Int_t code) override
Implement internal generator using TRandom::Poisson.
void protectNegativeMean(bool flag=true)
Switch on or off protection against negative means.
Definition RooPoisson.h:39
Int_t getGenerator(const RooArgSet &directVars, RooArgSet &generateVars, bool staticInitOK=true) const override
Advertise internal generator in x.
TObject * clone(const char *newname) const override
Definition RooPoisson.h:27
double evaluate() const override
Implementation in terms of the TMath::Poisson() function.
RooRealProxy mean
Definition RooPoisson.h:50
RooAbsReal const & getMean() const
Get the mean parameter.
Definition RooPoisson.h:45
Int_t getAnalyticalIntegral(RooArgSet &allVars, RooArgSet &analVars, const char *rangeName=nullptr) const override
Interface function getAnalyticalIntergral advertises the analytical integrals that are supported.
const T & arg() const
Return reference to object held in proxy.
Mother of all ROOT objects.
Definition TObject.h:41
static void output()