Class wrapping convolution of two functions.
Class wrapping convolution of two functions: evaluation of \(\int f(x)g(x-t)dx\)
The convolution is performed by default using FFTW if it is available . One can pass optionally the range of the convolution (by default the first function range is used). Note that when using Discrete Fourier Transform (as FFTW), it is a circular transform, so the functions should be approximately zero at the end of the range. If they are significantly different than zero on one side (e.g. the left side) a spill over will occur on the other side (e.g right side). If no function range is given by default the function1 range + 10% is used One should use also a not too small number of points for the DFT (a minimum of 1000). By default 10000 points are used.
Definition at line 20 of file TF1Convolution.h.
Public Member Functions | |
TF1Convolution () | |
constructor without arguments. | |
TF1Convolution (const TF1Convolution &conv) | |
Copy constructor (necessary to hold unique_ptr as member variable). | |
TF1Convolution (TF1 *function1, TF1 *function2, Bool_t useFFT=true) | |
constructor from the two function pointer and a flag is using FFT. | |
TF1Convolution (TF1 *function1, TF1 *function2, Double_t xmin, Double_t xmax, Bool_t useFFT=true) | |
Constructor from the two function pointer and the convolution range. | |
TF1Convolution (TString formula, Double_t xmin=1., Double_t xmax=0., Bool_t useFFT=true) | |
Constructor from a formula expression as f1 * f2 where f1 and f2 are two functions known to ROOT. | |
TF1Convolution (TString formula1, TString formula2, Double_t xmin=1., Double_t xmax=0., Bool_t useFFT=true) | |
Constructor from 2 function names where f1 and f2 are two functions known to ROOT. | |
~TF1Convolution () override | |
void | Copy (TObject &obj) const override |
Copy this to obj. | |
Int_t | GetNpar () const |
const char * | GetParName (Int_t ipar) const |
void | GetRange (Double_t &a, Double_t &b) const |
Get the range used for the convolution. | |
Double_t | GetXmax () const |
Double_t | GetXmin () const |
TClass * | IsA () const override |
Double_t | operator() (const Double_t *x, const Double_t *p) override |
Used in TF1 when doing the fit, will be evaluated at each point. | |
TF1Convolution & | operator= (const TF1Convolution &rhs) |
Operator =. | |
void | SetExtraRange (Double_t percentage) |
Set the fraction of extra range used when doing an FFT convolution. | |
void | SetNofPointsFFT (Int_t n) |
Set the number of points used for the FFT convolution. | |
void | SetNumConv (Bool_t flag=true) |
void | SetParameters (const Double_t *params) override |
Set the vector of parameters p for the convolution function g(x,p) = f1 * f2. | |
void | SetParameters (Double_t p0, Double_t p1, Double_t p2=0., Double_t p3=0., Double_t p4=0., Double_t p5=0., Double_t p6=0., Double_t p7=0.) |
Set the parameter values for the convolution function. | |
void | SetRange (Double_t a, Double_t b) override |
Set the actual range used for the convolution. | |
void | Streamer (TBuffer &) override |
Stream an object of class TObject. | |
void | StreamerNVirtual (TBuffer &ClassDef_StreamerNVirtual_b) |
void | Update () override |
Update the two component functions of the convolution. | |
Public Member Functions inherited from TF1AbsComposition | |
~TF1AbsComposition () override | |
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 | Clear (Option_t *="") |
virtual TObject * | Clone (const char *newname="") const |
Make a clone of an object using the Streamer facility. | |
virtual Int_t | Compare (const TObject *obj) const |
Compare abstract method. | |
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 TObject * | DrawClone (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 TObject * | FindObject (const char *name) const |
Must be redefined in derived classes. | |
virtual TObject * | FindObject (const TObject *obj) const |
Must be redefined in derived classes. | |
virtual Option_t * | GetDrawOption () const |
Get option used by the graphics system to draw this object. | |
virtual const char * | GetIconName () const |
Returns mime type name of object. | |
virtual const char * | GetName () const |
Returns 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_t * | GetOption () const |
virtual const char * | GetTitle () const |
Returns title of object. | |
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. | |
virtual ULong_t | Hash () const |
Return hash value for this object. | |
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 |
virtual Bool_t | IsSortable () const |
R__ALWAYS_INLINE Bool_t | IsZombie () const |
virtual void | ls (Option_t *option="") const |
The ls function lists the contents of a class on stdout. | |
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) |
TObject & | operator= (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 void | Print (Option_t *option="") const |
This method must be overridden when a class wants to print itself. | |
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. | |
Static Public Member Functions | |
static TClass * | Class () |
static const char * | Class_Name () |
static constexpr Version_t | Class_Version () |
static const char * | DeclFileName () |
static Double_t | SetDefaultExtraRange (Double_t percentage) |
Set the default extra range fraction used when doing a FFT convolution. | |
Static Public Member Functions inherited from TF1AbsComposition | |
static TClass * | Class () |
static const char * | Class_Name () |
static constexpr Version_t | Class_Version () |
static const char * | DeclFileName () |
Static Public Member Functions inherited from TObject | |
static TClass * | Class () |
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. | |
Private Member Functions | |
Double_t | EvalFFTConv (Double_t t) |
Perform FFT convolution. | |
Double_t | EvalNumConv (Double_t t) |
Perform numerical convolution. | |
void | InitializeDataMembers (TF1 *function1, TF1 *function2, Bool_t useFFT) |
Internal function to initialize data members. | |
void | MakeFFTConv () |
Perform the FFT of the two functions. | |
Private Attributes | |
Int_t | fCstIndex |
Index of the constant parameter f the first function. | |
Bool_t | fFlagFFT |
Choose FFT or numerical convolution. | |
Bool_t | fFlagGraph = false |
! Tells if the graph is already done or not | |
std::unique_ptr< TF1 > | fFunction1 |
First function to be convolved. | |
std::unique_ptr< TF1 > | fFunction2 |
Second function to be convolved. | |
std::unique_ptr< TGraph > | fGraphConv |
! Graph of the convolution | |
Int_t | fNofParams1 |
Int_t | fNofParams2 |
Int_t | fNofPoints |
Number of point for FFT array. | |
std::vector< Double_t > | fParams1 |
std::vector< Double_t > | fParams2 |
std::vector< TString > | fParNames |
Parameters' names. | |
Double_t | fXmax |
Maximal bound of the range of the convolution. | |
Double_t | fXmin |
Minimal bound of the range of the convolution. | |
Static Private Attributes | |
static Double_t | fgExtraRangeFraction = 0.1 |
! Additional default fraction of the range used for FFT convolution | |
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 )) } |
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 () |
#include <TF1Convolution.h>
TF1Convolution::TF1Convolution | ( | ) |
constructor without arguments.
Definition at line 137 of file TF1Convolution.cxx.
constructor from the two function pointer and a flag is using FFT.
Definition at line 145 of file TF1Convolution.cxx.
TF1Convolution::TF1Convolution | ( | TF1 * | function1, |
TF1 * | function2, | ||
Double_t | xmin, | ||
Double_t | xmax, | ||
Bool_t | useFFT = true |
||
) |
Constructor from the two function pointer and the convolution range.
Definition at line 153 of file TF1Convolution.cxx.
TF1Convolution::TF1Convolution | ( | TString | formula, |
Double_t | xmin = 1. , |
||
Double_t | xmax = 0. , |
||
Bool_t | useFFT = true |
||
) |
Constructor from a formula expression as f1 * f2 where f1 and f2 are two functions known to ROOT.
Definition at line 169 of file TF1Convolution.cxx.
TF1Convolution::TF1Convolution | ( | TString | formula1, |
TString | formula2, | ||
Double_t | xmin = 1. , |
||
Double_t | xmax = 0. , |
||
Bool_t | useFFT = true |
||
) |
Constructor from 2 function names where f1 and f2 are two functions known to ROOT.
If the function names are not known to ROOT, tries to interpret them as TFormula.
Definition at line 209 of file TF1Convolution.cxx.
TF1Convolution::TF1Convolution | ( | const TF1Convolution & | conv | ) |
Copy constructor (necessary to hold unique_ptr as member variable).
Definition at line 241 of file TF1Convolution.cxx.
|
inlineoverride |
Definition at line 56 of file TF1Convolution.h.
|
static |
|
inlinestaticconstexpr |
Definition at line 80 of file TF1Convolution.h.
|
overridevirtual |
|
inlinestatic |
Definition at line 80 of file TF1Convolution.h.
Perform FFT convolution.
Definition at line 330 of file TF1Convolution.cxx.
Perform numerical convolution.
Definition at line 345 of file TF1Convolution.cxx.
|
inline |
Definition at line 68 of file TF1Convolution.h.
|
inline |
Definition at line 71 of file TF1Convolution.h.
Get the range used for the convolution.
Definition at line 487 of file TF1Convolution.cxx.
|
inline |
Definition at line 70 of file TF1Convolution.h.
|
inline |
Definition at line 69 of file TF1Convolution.h.
|
private |
Internal function to initialize data members.
Use TF1::Copy instead of Clone.
Definition at line 73 of file TF1Convolution.cxx.
|
inlineoverridevirtual |
Reimplemented from TF1AbsComposition.
Definition at line 80 of file TF1Convolution.h.
|
private |
Perform the FFT of the two functions.
Definition at line 259 of file TF1Convolution.cxx.
Used in TF1 when doing the fit, will be evaluated at each point.
Implements TF1AbsComposition.
Definition at line 367 of file TF1Convolution.cxx.
TF1Convolution & TF1Convolution::operator= | ( | const TF1Convolution & | rhs | ) |
Operator =.
Definition at line 249 of file TF1Convolution.cxx.
Set the default extra range fraction used when doing a FFT convolution.
By default the value is 0.1 (10%). The function return the previous default defined value.
Definition at line 477 of file TF1Convolution.cxx.
void TF1Convolution::SetExtraRange | ( | Double_t | percentage | ) |
Set the fraction of extra range used when doing an FFT convolution.
The extra range is often needed to avoid mirroring effect of the resulting convolution function at the borders. By default an extra range of 0.1 is used.
Definition at line 438 of file TF1Convolution.cxx.
void TF1Convolution::SetNofPointsFFT | ( | Int_t | n | ) |
Set the number of points used for the FFT convolution.
Definition at line 382 of file TF1Convolution.cxx.
|
inline |
Definition at line 64 of file TF1Convolution.h.
|
overridevirtual |
Set the vector of parameters p for the convolution function g(x,p) = f1 * f2.
Implements TF1AbsComposition.
Definition at line 393 of file TF1Convolution.cxx.
void TF1Convolution::SetParameters | ( | Double_t | p0, |
Double_t | p1, | ||
Double_t | p2 = 0. , |
||
Double_t | p3 = 0. , |
||
Double_t | p4 = 0. , |
||
Double_t | p5 = 0. , |
||
Double_t | p6 = 0. , |
||
Double_t | p7 = 0. |
||
) |
Set the parameter values for the convolution function.
Definition at line 425 of file TF1Convolution.cxx.
Set the actual range used for the convolution.
In case a or b are -inf or +inf and FFT convolution is used, then the range of the first function will be used and extended by the default extra range fraction.
Implements TF1AbsComposition.
Definition at line 452 of file TF1Convolution.cxx.
|
overridevirtual |
Stream an object of class TObject.
Reimplemented from TF1AbsComposition.
|
inline |
Definition at line 80 of file TF1Convolution.h.
|
overridevirtual |
Update the two component functions of the convolution.
Implements TF1AbsComposition.
Definition at line 496 of file TF1Convolution.cxx.
|
private |
Index of the constant parameter f the first function.
Definition at line 34 of file TF1Convolution.h.
|
private |
Choose FFT or numerical convolution.
Definition at line 36 of file TF1Convolution.h.
|
private |
! Tells if the graph is already done or not
Definition at line 37 of file TF1Convolution.h.
|
private |
First function to be convolved.
Definition at line 21 of file TF1Convolution.h.
|
private |
Second function to be convolved.
Definition at line 22 of file TF1Convolution.h.
|
staticprivate |
! Additional default fraction of the range used for FFT convolution
Definition at line 38 of file TF1Convolution.h.
|
private |
! Graph of the convolution
Definition at line 23 of file TF1Convolution.h.
|
private |
Definition at line 32 of file TF1Convolution.h.
|
private |
Definition at line 33 of file TF1Convolution.h.
|
private |
Number of point for FFT array.
Definition at line 35 of file TF1Convolution.h.
|
private |
Definition at line 25 of file TF1Convolution.h.
|
private |
Definition at line 26 of file TF1Convolution.h.
|
private |
Parameters' names.
Definition at line 28 of file TF1Convolution.h.
|
private |
Maximal bound of the range of the convolution.
Definition at line 31 of file TF1Convolution.h.
|
private |
Minimal bound of the range of the convolution.
Definition at line 30 of file TF1Convolution.h.