Logo ROOT  
Reference Guide
 
Loading...
Searching...
No Matches
TF12 Class Reference

A projection of a TF2 along X or Y.

It has the same behaviour as a TF1

Example of a function

{
auto f2 = new TF2("f2","sin(x)*sin(y)/(x*y)",0,5,0,5);
auto f12 = new TF12("f12",f2,0.1,"y");
f12->Draw();
}
A projection of a TF2 along X or Y.
Definition TF12.h:25
A 2-Dim function with parameters.
Definition TF2.h:29

Definition at line 25 of file TF12.h.

Public Types

enum  {
  kIsOnHeap = 0x01000000 , kNotDeleted = 0x02000000 , kZombie = 0x04000000 , kInconsistent = 0x08000000 ,
  kBitMask = 0x00ffffff
}
 
enum  { kSingleKey = (1ULL << ( 0 )) , kOverwrite = (1ULL << ( 1 )) , kWriteDelete = (1ULL << ( 2 )) }
 
enum class  EAddToList { kDefault , kAdd , kNo }
 Add to list behavior. More...
 
enum  EDeprecatedStatusBits { kObjInCanvas = (1ULL << ( 3 )) }
 
enum  EStatusBits { kNotGlobal = (1ULL << ( 10 )) , kNotDraw = (1ULL << ( 9 )) }
 

Public Member Functions

 TF12 ()
 TF12 default constructor.
 
 TF12 (const char *name, TF2 *f2, Double_t xy, Option_t *option="x", EAddToList addToGlobList=EAddToList::kDefault)
 TF12 normal constructor.
 
 TF12 (const TF12 &f12)
 Copy constructor.
 
 ~TF12 () override
 F2 default destructor.
 
void AbstractMethod (const char *method) const
 Call this function within a function that you don't want to define as purely virtual, in order not to force all users deriving from that class to implement that maybe (on their side) unused function; but at the same time, emit a run-time warning if they try to call it, telling that it is not implemented in the derived class: action must thus be taken on the user side to override it.
 
virtual void AddParameter (const TString &name, Double_t value)
 
virtual Bool_t AddToGlobalList (Bool_t on=kTRUE)
 Add to global list of functions (gROOT->GetListOfFunctions() ) return previous status (true if the function was already in the list false if not)
 
virtual void AppendPad (Option_t *option="")
 Append graphics object to current pad.
 
void Browse (TBrowser *b) override
 Browse.
 
virtual Double_t CentralMoment (Double_t n, Double_t a, Double_t b, const Double_t *params=nullptr, Double_t epsilon=0.000001)
 Return nth central moment of function between a and b (i.e the n-th moment around the mean value)
 
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.
 
void Clear (Option_t *option="") override
 Set name and title to empty strings ("").
 
TObjectClone (const char *newname=nullptr) const override
 Make a complete copy of the underlying object.
 
Int_t Compare (const TObject *obj) const override
 Compare two TNamed objects.
 
void Copy (TAttFill &attfill) const
 Copy this fill attributes to a new TAttFill.
 
void Copy (TAttLine &attline) const
 Copy this line attributes to a new TAttLine.
 
void Copy (TAttMarker &attmarker) const
 Copy this marker attributes to a new TAttMarker.
 
void Copy (TObject &f12) const override
 Copy this F2 to a new F2.
 
virtual TH1CreateHistogram ()
 
virtual void Delete (Option_t *option="")
 Delete this object.
 
virtual Double_t Derivative (Double_t x, Double_t *params=nullptr, Double_t epsilon=0.001) const
 Returns the first derivative of the function at point x, computed by Richardson's extrapolation method (use 2 derivative estimates to compute a third, more accurate estimation) first, derivatives with steps h and h/2 are computed by central difference formulas.
 
virtual Double_t Derivative2 (Double_t x, Double_t *params=nullptr, Double_t epsilon=0.001) const
 Returns the second derivative of the function at point x, computed by Richardson's extrapolation method (use 2 derivative estimates to compute a third, more accurate estimation) first, derivatives with steps h and h/2 are computed by central difference formulas.
 
virtual Double_t Derivative3 (Double_t x, Double_t *params=nullptr, Double_t epsilon=0.001) const
 Returns the third derivative of the function at point x, computed by Richardson's extrapolation method (use 2 derivative estimates to compute a third, more accurate estimation) first, derivatives with steps h and h/2 are computed by central difference formulas.
 
Int_t DistancetoLine (Int_t px, Int_t py, Double_t xp1, Double_t yp1, Double_t xp2, Double_t yp2)
 Compute distance from point px,py to a line.
 
Int_t DistancetoPrimitive (Int_t px, Int_t py) override
 Compute distance from point px,py to a function.
 
void Draw (Option_t *option="") override
 Draw this function with its current attributes.
 
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).
 
TF1DrawCopy (Option_t *option="") const override
 Draw a copy of this function with its current attributes.
 
virtual TObjectDrawDerivative (Option_t *option="al")
 Draw derivative of this function.
 
virtual void DrawF1 (Double_t xmin, Double_t xmax, Option_t *option="")
 Draw function between xmin and xmax.
 
virtual TObjectDrawIntegral (Option_t *option="al")
 Draw integral of this function.
 
virtual void Dump () const
 Dump contents of object on stdout.
 
virtual void Error (const char *method, const char *msgfmt,...) const
 Issue error message.
 
Double_t Eval (Double_t x, Double_t y=0, Double_t z=0, Double_t t=0) const override
 Evaluate this formula.
 
Double_t EvalPar (const Double_t *x, const Double_t *params=nullptr) override
 Evaluate this function at point x[0].
 
template<class T >
EvalPar (const T *x, const Double_t *params=nullptr)
 EvalPar for vectorized.
 
Double_t EvalUncertainty (Double_t x, const TMatrixDSym *covMatrix=nullptr) const
 Evaluate the uncertainty of the function at location x due to the parameter uncertainties.
 
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.
 
void ExecuteEvent (Int_t event, Int_t px, Int_t py) override
 Execute action corresponding to one event.
 
virtual void Fatal (const char *method, const char *msgfmt,...) const
 Issue fatal error message.
 
virtual void FillBuffer (char *&buffer)
 Encode TNamed into output buffer.
 
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 void FixParameter (Int_t ipar, Double_t value)
 Fix the value of a parameter for a fit operation The specified value will be used in the fit and the parameter will be constant (nor varying) during fitting Note that when using pre-defined functions (e.g gaus), one needs to use the fit option 'B' to have the fix of the paramter effective.
 
Double_t GetChisquare () const
 Return the Chisquare after fitting. See ROOT::Fit::FitResult::Chi2()
 
virtual Option_tGetDrawOption () const
 Get option used by the graphics system to draw this object.
 
virtual TString GetExpFormula (Option_t *option="") const
 
virtual Color_t GetFillColor () const
 Return the fill area color.
 
virtual Style_t GetFillStyle () const
 Return the fill area style.
 
virtual TFormulaGetFormula ()
 
virtual const TFormulaGetFormula () const
 
virtual TH1GetHistogram () const
 Return a pointer to the histogram used to visualise the function Note that this histogram is managed by the function and in same case it is automatically deleted when some TF1 functions are called such as TF1::SetParameters, TF1::SetNpx, TF1::SetRange It is then reccomended either to clone the return object or calling again teh GetHistogram function whenever is needed.
 
virtual const char * GetIconName () const
 Returns mime type name of object.
 
virtual const TObjectGetLinearPart (Int_t i) const
 
virtual Color_t GetLineColor () const
 Return the line color.
 
virtual Style_t GetLineStyle () const
 Return the line style.
 
virtual Width_t GetLineWidth () const
 Return the line width.
 
virtual Color_t GetMarkerColor () const
 Return the marker color.
 
virtual Size_t GetMarkerSize () const
 Return the marker size.
 
virtual Style_t GetMarkerStyle () const
 Return the marker style.
 
virtual Double_t GetMaximum (Double_t xmin=0, Double_t xmax=0, Double_t epsilon=1.E-10, Int_t maxiter=100, Bool_t logx=false) const
 Returns the maximum value of the function.
 
virtual Double_t GetMaximumStored () const
 
virtual Double_t GetMaximumX (Double_t xmin=0, Double_t xmax=0, Double_t epsilon=1.E-10, Int_t maxiter=100, Bool_t logx=false) const
 Returns the X value corresponding to the maximum value of the function.
 
TMethodCallGetMethodCall () const
 
virtual Double_t GetMinimum (Double_t xmin=0, Double_t xmax=0, Double_t epsilon=1.E-10, Int_t maxiter=100, Bool_t logx=false) const
 Returns the minimum value of the function on the (xmin, xmax) interval.
 
virtual Double_t GetMinimumStored () const
 
virtual Double_t GetMinimumX (Double_t xmin=0, Double_t xmax=0, Double_t epsilon=1.E-10, Int_t maxiter=100, Bool_t logx=false) const
 Returns the X value corresponding to the minimum value of the function on the (xmin, xmax) interval.
 
const char * GetName () const override
 Returns name of object.
 
virtual Int_t GetNDF () const
 Return the number of degrees of freedom in the fit the fNDF parameter has been previously computed during a fit.
 
virtual Int_t GetNdim () const
 
virtual Int_t GetNpar () const
 
virtual Int_t GetNpx () const
 
virtual Int_t GetNumber () const
 
virtual Int_t GetNumberFitPoints () const
 
virtual Int_t GetNumberFreeParameters () const
 Return the number of free parameters.
 
char * GetObjectInfo (Int_t px, Int_t py) const override
 Redefines TObject::GetObjectInfo.
 
virtual Option_tGetOption () const
 
virtual Double_t GetParameter (const TString &name) const
 
virtual Double_t GetParameter (Int_t ipar) const
 
virtual Double_tGetParameters () const
 
virtual void GetParameters (Double_t *params)
 
TObjectGetParent () const
 
virtual Double_t GetParError (const char *name) const
 
virtual Double_t GetParError (Int_t ipar) const
 Return value of parameter number ipar.
 
virtual const Double_tGetParErrors () const
 
virtual void GetParLimits (Int_t ipar, Double_t &parmin, Double_t &parmax) const
 Return limits for parameter ipar.
 
virtual const char * GetParName (Int_t ipar) const
 
virtual Int_t GetParNumber (const char *name) const
 
virtual Double_t GetProb () const
 Return the fit probability.
 
virtual Int_t GetQuantiles (Int_t n, Double_t *xp, const Double_t *p)
 Compute Quantiles for density distribution of this function.
 
virtual Double_t GetRandom (Double_t xmin, Double_t xmax, TRandom *rng=nullptr, Option_t *opt=nullptr)
 Return a random number following this function shape in [xmin,xmax].
 
virtual Double_t GetRandom (TRandom *rng=nullptr, Option_t *opt=nullptr)
 Return a random number following this function shape.
 
virtual void GetRange (Double_t &xmin, Double_t &xmax) const
 Return range of a 1-D function.
 
virtual void GetRange (Double_t &xmin, Double_t &ymin, Double_t &xmax, Double_t &ymax) const
 Return range of a 2-D function.
 
virtual void GetRange (Double_t &xmin, Double_t &ymin, Double_t &zmin, Double_t &xmax, Double_t &ymax, Double_t &zmax) const
 Return range of function.
 
virtual Double_t GetSave (const Double_t *x)
 Get value corresponding to X in array of fSave values.
 
const char * GetTitle () const override
 Returns title of object.
 
virtual UInt_t GetUniqueID () const
 Return the unique object id.
 
virtual Double_t GetVariable (const TString &name)
 
virtual Double_t GetX (Double_t y, Double_t xmin=0, Double_t xmax=0, Double_t epsilon=1.E-10, Int_t maxiter=100, Bool_t logx=false) const
 Returns the X value corresponding to the function value fy for (xmin<x<xmax).
 
TAxisGetXaxis () const
 Get x axis of the function.
 
virtual Double_t GetXmax () const
 
virtual Double_t GetXmin () const
 
virtual Double_t GetXY () const
 
TAxisGetYaxis () const
 Get y axis of the function.
 
TAxisGetZaxis () const
 Get z axis of the function. (In case this object is a TF2 or TF3)
 
virtual void GradientPar (const Double_t *x, Double_t *grad, Double_t eps=0.01) const
 Compute the gradient wrt parameters If the TF1 object is based on a formula expression (TFormula) and TFormula::GenerateGradientPar() has been successfully called automatic differentiation using CLAD is used instead of the default numerical differentiation.
 
template<class T >
void GradientPar (const T *x, T *grad, Double_t eps=0.01) const
 
virtual Double_t GradientPar (Int_t ipar, const Double_t *x, Double_t eps=0.01) const
 Compute the gradient (derivative) wrt a parameter ipar.
 
template<class T >
GradientPar (Int_t ipar, const T *x, Double_t eps=0.01) const
 
template<class T >
void GradientParTempl (const T *x, T *grad, Double_t eps=0.01) const
 
template<class T >
GradientParTempl (Int_t ipar, const T *x, Double_t eps=0.01) const
 
virtual Bool_t HandleTimer (TTimer *timer)
 Execute action in response of a timer timing out.
 
ULong_t Hash () const override
 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.
 
Bool_t HasSave () const
 Return true if function has data in fSave buffer.
 
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 InitArgs (const Double_t *x, const Double_t *params)
 Initialize parameters addresses.
 
virtual void Inspect () const
 Dump contents of this object in a graphics canvas.
 
virtual Double_t Integral (Double_t a, Double_t b, Double_t epsrel=1.e-12)
 IntegralOneDim or analytical integral.
 
virtual Double_t IntegralError (Double_t a, Double_t b, const Double_t *params=nullptr, const Double_t *covmat=nullptr, Double_t epsilon=1.E-2)
 Return Error on Integral of a parametric function between a and b due to the parameter uncertainties and their covariance matrix from the fit.
 
virtual Double_t IntegralError (Int_t n, const Double_t *a, const Double_t *b, const Double_t *params=nullptr, const Double_t *covmat=nullptr, Double_t epsilon=1.E-2)
 Return Error on Integral of a parametric function with dimension larger than one between a[] and b[] due to the parameters uncertainties.
 
virtual Double_t IntegralFast (Int_t num, Double_t *x, Double_t *w, Double_t a, Double_t b, Double_t *params=nullptr, Double_t epsilon=1e-12)
 Gauss-Legendre integral, see CalcGaussLegendreSamplingPoints.
 
virtual Double_t IntegralMultiple (Int_t n, const Double_t *a, const Double_t *b, Double_t epsrel, Double_t &relerr)
 See more general prototype below.
 
virtual Double_t IntegralMultiple (Int_t n, const Double_t *a, const Double_t *b, Int_t maxpts, Double_t epsrel, Double_t epsabs, Double_t &relerr, Int_t &nfnevl, Int_t &ifail)
 This function computes, to an attempted specified accuracy, the value of the integral.
 
virtual Double_t IntegralMultiple (Int_t n, const Double_t *a, const Double_t *b, Int_t, Int_t maxpts, Double_t epsrel, Double_t &relerr, Int_t &nfnevl, Int_t &ifail)
 
virtual Double_t IntegralOneDim (Double_t a, Double_t b, Double_t epsrel, Double_t epsabs, Double_t &err)
 Return Integral of function between a and b using the given parameter values and relative and absolute tolerance.
 
void InvertBit (UInt_t f)
 
TClassIsA () const override
 
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 IsEvalNormalized () const
 
virtual Bool_t IsFolder () const
 Returns kTRUE in case object contains browsable objects (like containers or lists of other objects).
 
virtual Bool_t IsInside (const Double_t *x) const
 return kTRUE if the point is inside the function range
 
virtual Bool_t IsLinear () const
 
R__ALWAYS_INLINE Bool_t IsOnHeap () const
 
Bool_t IsSortable () const override
 
virtual Bool_t IsTransparent () const
 
virtual Bool_t IsValid () const
 Return kTRUE if the function is valid.
 
bool IsVectorized ()
 
R__ALWAYS_INLINE Bool_t IsZombie () const
 
void ls (Option_t *option="") const override
 List TNamed name and title.
 
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 Double_t Mean (Double_t a, Double_t b, const Double_t *params=nullptr, Double_t epsilon=0.000001)
 
virtual void Modify ()
 Change current fill area attributes if necessary.
 
virtual void Modify ()
 Change current line attributes if necessary.
 
virtual void Modify ()
 Change current marker attributes if necessary.
 
virtual void ModifyOn (TVirtualPad &pad)
 Change current fill area attributes on speicifed pad.
 
virtual void ModifyOn (TVirtualPad &pad)
 Change current line attributes on specified pad.
 
virtual void ModifyOn (TVirtualPad &pad)
 Change current marker attributes if necessary on specified pad.
 
virtual Double_t Moment (Double_t n, Double_t a, Double_t b, const Double_t *params=nullptr, Double_t epsilon=0.000001)
 Return nth moment of function between a and b.
 
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 *, size_t)
 Operator delete for sized deallocation.
 
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 *, size_t)
 Operator delete [] for sized deallocation.
 
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)
 
template<class T >
operator() (const T *x, const Double_t *params=nullptr)
 
virtual Double_t operator() (Double_t x, Double_t y=0, Double_t z=0, Double_t t=0) const
 
void Paint (Option_t *option="") override
 Paint this function with its current attributes.
 
virtual void Pop ()
 Pop on object drawn in a pad to the top of the display list.
 
void Print (Option_t *option="") const override
 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.
 
virtual void ReleaseParameter (Int_t ipar)
 Release parameter number ipar during a fit operation.
 
virtual void ResetAttFill (Option_t *option="")
 Reset this fill attributes to default values.
 
virtual void ResetAttLine (Option_t *option="")
 Reset this line attributes to default values.
 
virtual void ResetAttMarker (Option_t *toption="")
 Reset this marker attributes to the default values.
 
void ResetBit (UInt_t f)
 
virtual void Save (Double_t xmin, Double_t xmax, Double_t ymin, Double_t ymax, Double_t zmin, Double_t zmax)
 Save values of function in array fSave.
 
virtual void SaveAs (const char *filename="", Option_t *option="") const
 Save this object in the file specified by filename.
 
virtual void SaveFillAttributes (std::ostream &out, const char *name, Int_t coldef=1, Int_t stydef=1001)
 Save fill attributes as C++ statement(s) on output stream out.
 
virtual void SaveLineAttributes (std::ostream &out, const char *name, Int_t coldef=1, Int_t stydef=1, Int_t widdef=1)
 Save line attributes as C++ statement(s) on output stream out.
 
virtual void SaveMarkerAttributes (std::ostream &out, const char *name, Int_t coldef=1, Int_t stydef=1, Int_t sizdef=1)
 Save line attributes as C++ statement(s) on output stream out.
 
void SavePrimitive (std::ostream &out, Option_t *option="") override
 Save 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 SetChisquare (Double_t chi2)
 
virtual void SetDrawOption (Option_t *option="")
 Set drawing option for object.
 
virtual void SetFillAttributes ()
 Invoke the DialogCanvas Fill attributes.
 
virtual void SetFillColor (Color_t fcolor)
 Set the fill area color.
 
void SetFillColor (TColorNumber)
 Set a fill color.
 
virtual void SetFillColorAlpha (Color_t fcolor, Float_t falpha)
 Set a transparent fill color.
 
virtual void SetFillStyle (Style_t fstyle)
 Set the fill area style.
 
virtual void SetFitResult (const ROOT::Fit::FitResult &result, const Int_t *indpar=nullptr)
 Set the result from the fit parameter values, errors, chi2, etc... Optionally a pointer to a vector (with size fNpar) of the parameter indices in the FitResult can be passed This is useful in the case of a combined fit with different functions, and the FitResult contains the global result By default it is assume that indpar = {0,1,2,....,fNpar-1}.
 
template<typename Func >
void SetFunction (Func f)
 
template<class PtrObj , typename MemFn >
void SetFunction (PtrObj &p, MemFn memFn)
 
virtual void SetLineAttributes ()
 Invoke the DialogCanvas Line attributes.
 
virtual void SetLineColor (Color_t lcolor)
 Set the line color.
 
void SetLineColor (TColorNumber lcolor)
 
virtual void SetLineColorAlpha (Color_t lcolor, Float_t lalpha)
 Set a transparent line color.
 
virtual void SetLineStyle (Style_t lstyle)
 Set the line style.
 
virtual void SetLineWidth (Width_t lwidth)
 Set the line width.
 
virtual void SetMarkerAttributes ()
 Invoke the DialogCanvas Marker attributes.
 
virtual void SetMarkerColor (Color_t mcolor=1)
 Set the marker color.
 
void SetMarkerColor (TColorNumber lcolor)
 
virtual void SetMarkerColorAlpha (Color_t mcolor, Float_t malpha)
 Set a transparent marker color.
 
virtual void SetMarkerSize (Size_t msize=1)
 Set the marker size.
 
virtual void SetMarkerStyle (Style_t mstyle=1)
 Set the marker style.
 
virtual void SetMaximum (Double_t maximum=-1111)
 Set the maximum value along Y for this function In case the function is already drawn, set also the maximum in the helper histogram.
 
virtual void SetMinimum (Double_t minimum=-1111)
 Set the minimum value along Y for this function In case the function is already drawn, set also the minimum in the helper histogram.
 
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 SetNDF (Int_t ndf)
 Set the number of degrees of freedom ndf should be the number of points used in a fit - the number of free parameters.
 
void SetNdim (Int_t ndim)
 
virtual void SetNormalized (Bool_t flag)
 
virtual void SetNpx (Int_t npx=100)
 Set the number of points used to draw the function.
 
virtual void SetNumberFitPoints (Int_t npfits)
 
virtual void SetParameter (const TString &name, Double_t value)
 
virtual void SetParameter (Int_t param, Double_t value)
 
virtual void SetParameters (const Double_t *params)
 
virtual void SetParameters (double p0, double p1=TMath::QuietNaN(), double p2=TMath::QuietNaN(), double p3=TMath::QuietNaN(), double p4=TMath::QuietNaN(), double p5=TMath::QuietNaN(), double p6=TMath::QuietNaN(), double p7=TMath::QuietNaN(), double p8=TMath::QuietNaN(), double p9=TMath::QuietNaN(), double p10=TMath::QuietNaN())
 Set parameter values.
 
virtual void SetParent (TObject *p=nullptr)
 
virtual void SetParError (Int_t ipar, Double_t error)
 Set error for parameter number ipar.
 
virtual void SetParErrors (const Double_t *errors)
 Set errors for all active parameters when calling this function, the array errors must have at least fNpar values.
 
virtual void SetParLimits (Int_t ipar, Double_t parmin, Double_t parmax)
 Set lower and upper limits for parameter ipar.
 
virtual void SetParName (Int_t ipar, const char *name)
 Set name of parameter number ipar.
 
virtual void SetParNames (const char *name0="", const char *name1="", const char *name2="", const char *name3="", const char *name4="", const char *name5="", const char *name6="", const char *name7="", const char *name8="", const char *name9="", const char *name10="")
 Set up to 10 parameter names.
 
virtual void SetRange (Double_t xmin, Double_t xmax)
 Initialize the upper and lower bounds to draw the function.
 
virtual void SetRange (Double_t xmin, Double_t ymin, Double_t xmax, Double_t ymax)
 
virtual void SetRange (Double_t xmin, Double_t ymin, Double_t zmin, Double_t xmax, Double_t ymax, Double_t zmax)
 
virtual void SetSavedPoint (Int_t point, Double_t value)
 Restore value of function saved at point.
 
void SetTitle (const char *title="") override
 Set function title if title has the form "fffffff;xxxx;yyyy", it is assumed that the function title is "fffffff" and "xxxx" and "yyyy" are the titles for the X and Y axis respectively.
 
virtual void SetUniqueID (UInt_t uid)
 Set the unique object id.
 
virtual void SetVectorized (Bool_t vectorized)
 
virtual void SetXY (Double_t xy)
 Set the value of the constant for the TF2.
 
virtual Int_t Sizeof () const
 Return size of the TNamed part of the TObject.
 
void Streamer (TBuffer &) override
 Stream a class object.
 
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 Update ()
 Called by functions such as SetRange, SetNpx, SetParameters to force the deletion of the associated histogram or Integral.
 
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 Double_t Variance (Double_t a, Double_t b, const Double_t *params=nullptr, Double_t epsilon=0.000001)
 
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 void AbsValue (Bool_t reject=kTRUE)
 Static function: set the fgAbsValue flag.
 
static void CalcGaussLegendreSamplingPoints (Int_t num, Double_t *x, Double_t *w, Double_t eps=3.0e-11)
 Type safe interface (static method) The number of sampling points are taken from the TGraph.
 
static TClassClass ()
 
static const char * Class_Name ()
 
static constexpr Version_t Class_Version ()
 
static const char * DeclFileName ()
 
static Bool_t DefaultAddToGlobalList (Bool_t on=kTRUE)
 Static method to add/avoid to add automatically functions to the global list (gROOT->GetListOfFunctions() ) After having called this static method, all the functions created afterwards will follow the desired behaviour.
 
static Double_t DerivativeError ()
 Static function returning the error of the last call to the of Derivative's functions.
 
static TF1GetCurrent ()
 Static function returning the current function being processed.
 
static Longptr_t GetDtorOnly ()
 Return destructor only flag.
 
static Width_t GetMarkerLineWidth (Style_t style)
 Internal helper function that returns the line width of the given marker style (0 = filled marker)
 
static Style_t GetMarkerStyleBase (Style_t style)
 Internal helper function that returns the corresponding marker style with line width 1 for the given style.
 
static Bool_t GetObjectStat ()
 Get status of object stat flag.
 
static void InitStandardFunctions ()
 Create the basic function objects.
 
static Bool_t RejectedPoint ()
 See TF1::RejectPoint above.
 
static void RejectPoint (Bool_t reject=kTRUE)
 Static function to set the global flag to reject points the fgRejectPoint global flag is tested by all fit functions if TRUE the point is not included in the fit.
 
static void SetCurrent (TF1 *f1)
 Static function setting the current function.
 
static void SetDtorOnly (void *obj)
 Set destructor only flag.
 
static void SetObjectStat (Bool_t stat)
 Turn on/off tracking of objects in the TObjectTable.
 

Protected Types

enum  { kOnlyPrepStep = (1ULL << ( 3 )) }
 
enum  EFType {
  kFormula = 0 , kPtrScalarFreeFcn , kInterpreted , kTemplVec ,
  kTemplScalar , kCompositionFcn
}
 

Protected Member Functions

Bool_t ComputeCdfTable (Option_t *opt)
 Compute the cumulative function at fNpx points between fXmin and fXmax.
 
virtual TH1DoCreateHistogram (Double_t xmin, Double_t xmax, Bool_t recreate=kFALSE)
 Create histogram with bin content equal to function value computed at the bin center This histogram will be used to paint the function A re-creation is forced and a new histogram is done if recreate=true.
 
virtual void DoError (int level, const char *location, const char *fmt, va_list va) const
 Interface to ErrorHandler (protected).
 
void DoInitialize (EAddToList addToGlobList)
 Common initialization of the TF1.
 
virtual Double_t GetMinMaxNDim (Double_t *x, Bool_t findmax, Double_t epsilon=0, Int_t maxiter=0) const
 Find the minimum of a function of whatever dimension.
 
virtual void GetRange (Double_t *xmin, Double_t *xmax) const
 Return range of a generic N-D function.
 
void IntegrateForNormalization ()
 
void MakeZombie ()
 
TString ProvideSaveName (Option_t *option)
 Provide variable name for function for saving as primitive When TH1 or TGraph stores list of functions, it applies special coding of created variable names.
 
void SavePrimitiveNameTitle (std::ostream &out, const char *variable_name)
 Save object name and title into the output stream "out".
 

Static Protected Member Functions

static void SavePrimitiveConstructor (std::ostream &out, TClass *cl, const char *variable_name, const char *constructor_agrs="", Bool_t empty_line=kTRUE)
 Save object constructor in the output stream "out".
 
static void SavePrimitiveDraw (std::ostream &out, const char *variable_name, Option_t *option=nullptr)
 Save invocation of primitive Draw() method Skipped if option contains "nodraw" string.
 
static TString SavePrimitiveVector (std::ostream &out, const char *prefix, Int_t len, Double_t *arr, Int_t flag=0)
 Save array in the output stream "out" as vector.
 

Protected Attributes

std::vector< Double_tfAlpha
 ! Array alpha. for each bin in x the deconvolution r of fIntegral
 
std::vector< Double_tfBeta
 ! Array beta. is approximated by x = alpha +beta*r *gamma*r**2
 
Int_t fCase
 Projection along X(0), or Y(1)
 
Double_t fChisquare {}
 Function fit chisquare.
 
std::unique_ptr< TF1AbsCompositionfComposition
 Pointer to composition (NSUM or CONV)
 
TF2fF2
 Pointer to the mother TF2.
 
Color_t fFillColor
 Fill area color.
 
Style_t fFillStyle
 Fill area style.
 
std::unique_ptr< TFormulafFormula
 Pointer to TFormula in case when user define formula.
 
std::unique_ptr< TF1FunctorPointerfFunctor
 ! Functor object to wrap any C++ callable object
 
std::vector< Double_tfGamma
 ! Array gamma.
 
TH1fHistogram {nullptr}
 ! Pointer to histogram used for visualisation
 
std::vector< Double_tfIntegral
 ! Integral of function binned on fNpx bins
 
Color_t fLineColor
 Line color.
 
Style_t fLineStyle
 Line style.
 
Width_t fLineWidth
 Line width.
 
Color_t fMarkerColor
 Marker color.
 
Size_t fMarkerSize
 Marker size.
 
Style_t fMarkerStyle
 Marker style.
 
Double_t fMaximum {-1111}
 Maximum value for plotting.
 
std::unique_ptr< TMethodCallfMethodCall
 ! Pointer to MethodCall in case of interpreted function
 
Double_t fMinimum {-1111}
 Minimum value for plotting.
 
TString fName
 
Int_t fNDF {}
 Number of degrees of freedom in the fit.
 
Int_t fNdim {}
 Function dimension.
 
Bool_t fNormalized {false}
 Normalization option (false by default)
 
Double_t fNormIntegral {}
 Integral of the function before being normalized.
 
Int_t fNpar {}
 Number of parameters.
 
Int_t fNpfits {}
 Number of points used in the fit.
 
Int_t fNpx {100}
 Number of points used for the graphical representation.
 
std::unique_ptr< TF1ParametersfParams
 Pointer to Function parameters object (exists only for not-formula functions)
 
TObjectfParent {nullptr}
 ! Parent object hooking this function (if one)
 
std::vector< Double_tfParErrors
 Array of errors of the fNpar parameters.
 
std::vector< Double_tfParMax
 Array of upper limits of the fNpar parameters.
 
std::vector< Double_tfParMin
 Array of lower limits of the fNpar parameters.
 
std::vector< Double_tfSave
 Array of fNsave function values.
 
TString fTitle
 
EFType fType {EFType::kTemplScalar}
 
Double_t fXmax {-1111}
 Upper bounds for the range.
 
Double_t fXmin {-1111}
 Lower bounds for the range.
 
Double_t fXY
 Value along Y (if projection X) or X (if projection Y)
 

Static Protected Attributes

static std::atomic< Bool_tfgAbsValue
 
static std::atomic< Bool_tfgAddToGlobList
 
static TF1fgCurrent = nullptr
 
static Bool_t fgRejectPoint = kFALSE
 

Private Member Functions

void DefineNSUMTerm (TObjArray *newFuncs, TObjArray *coeffNames, TString &fullFormula, TString &formula, int termStart, int termEnd, Double_t xmin, Double_t xmax)
 Helper functions for NSUM parsing.
 
template<class T >
EvalParTempl (const T *data, const Double_t *params=nullptr)
 Eval for vectorized functions.
 
double EvalParVec (const Double_t *data, const Double_t *params)
 
int TermCoeffLength (TString &term)
 

Static Private Member Functions

static void AddToTObjectTable (TObject *)
 Private helper function which will dispatch to TObjectTable::AddObj.
 

Private Attributes

UInt_t fBits
 bit field status word
 
UInt_t fUniqueID
 object unique identifier
 

Static Private Attributes

static Longptr_t fgDtorOnly = 0
 object for which to call dtor only (i.e. no delete)
 
static Bool_t fgObjectStat = kTRUE
 if true keep track of objects in TObjectTable
 

#include <TF12.h>

Inheritance diagram for TF12:
TF1 TNamed TAttLine TAttFill TAttMarker TObject

Member Enumeration Documentation

◆ anonymous enum

anonymous enum
inherited
Enumerator
kIsOnHeap 

object is on heap

kNotDeleted 

object has not been deleted

kZombie 

object ctor failed

kInconsistent 

class overload Hash but does call RecursiveRemove in destructor

kBitMask 

Definition at line 89 of file TObject.h.

◆ anonymous enum

anonymous enum
inherited
Enumerator
kSingleKey 

write collection with single key

kOverwrite 

overwrite existing object with same name

kWriteDelete 

write object, then delete previous key with same name

Definition at line 99 of file TObject.h.

◆ anonymous enum

anonymous enum
protectedinherited
Enumerator
kOnlyPrepStep 

Used to request that the class specific implementation of TObject::Write just prepare the objects to be ready to be written but do not actually write them into the TBuffer.

This is just for example by TBufferMerger to request that the TTree inside the file calls TTree::FlushBaskets (outside of the merging lock) and TBufferMerger will later ask for the write (inside the merging lock). To take advantage of this feature the class needs to overload TObject::Write and use this enum value accordingly. (See TTree::Write and TObject::Write) Do not use, this feature will be migrate to the Merge function (See TClass and TTree::Merge)

Definition at line 106 of file TObject.h.

◆ EAddToList

enum class TF1::EAddToList
stronginherited

Add to list behavior.

Enumerator
kDefault 
kAdd 
kNo 

Definition at line 189 of file TF1.h.

◆ EDeprecatedStatusBits

Enumerator
kObjInCanvas 

for backward compatibility only, use kMustCleanup

Definition at line 84 of file TObject.h.

◆ EFType

enum TF1::EFType
protectedinherited
Enumerator
kFormula 

Formula functions which can be stored,.

kPtrScalarFreeFcn 

Pointer to scalar free function,.

kInterpreted 

Interpreted functions constructed by name,.

kTemplVec 

Vectorized free functions or TemplScalar functors evaluating on vectorized parameters,.

kTemplScalar 

TemplScalar functors evaluating on scalar parameters.

kCompositionFcn 

Definition at line 203 of file TF1.h.

◆ EStatusBits

Enumerator
kNotGlobal 
kNotDraw 

Definition at line 295 of file TF1.h.

Constructor & Destructor Documentation

◆ TF12() [1/3]

TF12::TF12 ( )

TF12 default constructor.

Definition at line 38 of file TF12.cxx.

◆ TF12() [2/3]

TF12::TF12 ( const char * name,
TF2 * f2,
Double_t xy,
Option_t * option = "x",
EAddToList addToGlobList = EAddToList::kDefault )

TF12 normal constructor.

Create a TF12 (special TF1) from a projection of a TF2 for a fix value of Y if option="X" or X if option="Y" This value may be changed at any time via TF12::SetXY(xy)

Definition at line 53 of file TF12.cxx.

◆ TF12() [3/3]

TF12::TF12 ( const TF12 & f12)

Copy constructor.

Definition at line 88 of file TF12.cxx.

◆ ~TF12()

TF12::~TF12 ( )
override

F2 default destructor.

Definition at line 80 of file TF12.cxx.

Member Function Documentation

◆ AbstractMethod()

void TObject::AbstractMethod ( const char * method) const
inherited

Call this function within a function that you don't want to define as purely virtual, in order not to force all users deriving from that class to implement that maybe (on their side) unused function; but at the same time, emit a run-time warning if they try to call it, telling that it is not implemented in the derived class: action must thus be taken on the user side to override it.

In other word, this method acts as a "runtime purely virtual" warning instead of a "compiler purely virtual" error.

Warning
This interface is a legacy function that is no longer recommended to be used by new development code.
Note
The name "AbstractMethod" does not imply that it's an abstract method in the strict C++ sense.

Definition at line 1149 of file TObject.cxx.

◆ AbsValue()

void TF1::AbsValue ( Bool_t flag = kTRUE)
staticinherited

Static function: set the fgAbsValue flag.

By default TF1::Integral uses the original function value to compute the integral However, TF1::Moment, CentralMoment require to compute the integral using the absolute value of the function.

Definition at line 985 of file TF1.cxx.

◆ AddParameter()

virtual void TF1::AddParameter ( const TString & name,
Double_t value )
inlinevirtualinherited

Definition at line 371 of file TF1.h.

◆ AddToGlobalList()

Bool_t TF1::AddToGlobalList ( Bool_t on = kTRUE)
virtualinherited

Add to global list of functions (gROOT->GetListOfFunctions() ) return previous status (true if the function was already in the list false if not)

Definition at line 848 of file TF1.cxx.

◆ AddToTObjectTable()

void TObject::AddToTObjectTable ( TObject * op)
staticprivateinherited

Private helper function which will dispatch to TObjectTable::AddObj.

Included here to avoid circular dependency between header files.

Definition at line 195 of file TObject.cxx.

◆ AppendPad()

void TObject::AppendPad ( Option_t * option = "")
virtualinherited

Append graphics object to current pad.

In case no current pad is set yet, create a default canvas with the name "c1".

Definition at line 204 of file TObject.cxx.

◆ Browse()

void TF1::Browse ( TBrowser * b)
overridevirtualinherited

Browse.

Reimplemented from TObject.

Definition at line 994 of file TF1.cxx.

◆ CalcGaussLegendreSamplingPoints()

void TF1::CalcGaussLegendreSamplingPoints ( Int_t num,
Double_t * x,
Double_t * w,
Double_t eps = 3.0e-11 )
staticinherited

Type safe interface (static method) The number of sampling points are taken from the TGraph.

Type: unsafe but fast interface filling the arrays x and w (static method)

Given the number of sampling points this routine fills the arrays x and w of length num, containing the abscissa and weight of the Gauss-Legendre n-point quadrature formula.

Gauss-Legendre:

\[ W(x)=1 -1<x<1 \\ (j+1)P_{j+1} = (2j+1)xP_j-jP_{j-1} \]

num is the number of sampling points (>0) x and w are arrays of size num eps is the relative precision

If num<=0 or eps<=0 no action is done.

Reference: Numerical Recipes in C, Second Edition

Definition at line 3866 of file TF1.cxx.

◆ CentralMoment()

Double_t TF1::CentralMoment ( Double_t n,
Double_t a,
Double_t b,
const Double_t * params = nullptr,
Double_t epsilon = 0.000001 )
virtualinherited

Return nth central moment of function between a and b (i.e the n-th moment around the mean value)

See TF1::Integral() for parameter definitions

Author
Gene Van Buren gene@.nosp@m.bnl..nosp@m.gov

Definition at line 3779 of file TF1.cxx.

◆ CheckedHash()

ULong_t TObject::CheckedHash ( )
inlineinherited

Check and record whether this class has a consistent Hash/RecursiveRemove setup (*) and then return the regular Hash value for this object.

The intent is for this routine to be called instead of directly calling the function Hash during "insert" operations. See TObject::HasInconsistenTObjectHash();

(*) The setup is consistent when all classes in the class hierarchy that overload TObject::Hash do call ROOT::CallRecursiveRemoveIfNeeded in their destructor. i.e. it is safe to call the Hash virtual function during the RecursiveRemove operation.

Definition at line 332 of file TObject.h.

◆ Class()

static TClass * TF12::Class ( )
static
Returns
TClass describing this class

◆ Class_Name()

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

◆ Class_Version()

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

Definition at line 51 of file TF12.h.

◆ ClassName()

const char * TObject::ClassName ( ) const
virtualinherited

Returns name of class to which the object belongs.

Definition at line 227 of file TObject.cxx.

◆ Clear()

void TNamed::Clear ( Option_t * option = "")
overridevirtualinherited

Set name and title to empty strings ("").

Reimplemented from TObject.

Reimplemented in TStreamerInfo, TVirtualStreamerInfo, TProcessID, TTask, TPrincipal, and TVirtualFitter.

Definition at line 63 of file TNamed.cxx.

◆ Clone()

TObject * TF1::Clone ( const char * newname = nullptr) const
overridevirtualinherited

Make a complete copy of the underlying object.

If 'newname' is set, the copy's name will be set to that name.

Reimplemented from TObject.

Definition at line 1071 of file TF1.cxx.

◆ Compare()

Int_t TNamed::Compare ( const TObject * obj) const
overridevirtualinherited

Compare two TNamed objects.

Returns 0 when equal, -1 when this is smaller and +1 when bigger (like strcmp).

Reimplemented from TObject.

Reimplemented in TStructNodeProperty.

Definition at line 84 of file TNamed.cxx.

◆ ComputeCdfTable()

Bool_t TF1::ComputeCdfTable ( Option_t * option)
protectedinherited

Compute the cumulative function at fNpx points between fXmin and fXmax.

Option can be used to force a log scale (option = "log"), linear (option = "lin") or automatic if empty.

Definition at line 2129 of file TF1.cxx.

◆ Copy() [1/4]

void TAttFill::Copy ( TAttFill & attfill) const
inherited

Copy this fill attributes to a new TAttFill.

Definition at line 203 of file TAttFill.cxx.

◆ Copy() [2/4]

void TAttLine::Copy ( TAttLine & attline) const
inherited

Copy this line attributes to a new TAttLine.

Definition at line 176 of file TAttLine.cxx.

◆ Copy() [3/4]

void TAttMarker::Copy ( TAttMarker & attmarker) const
inherited

Copy this marker attributes to a new TAttMarker.

Definition at line 243 of file TAttMarker.cxx.

◆ Copy() [4/4]

void TF12::Copy ( TObject & f12) const
overridevirtual

Copy this F2 to a new F2.

Reimplemented from TF1.

Definition at line 97 of file TF12.cxx.

◆ CreateHistogram()

virtual TH1 * TF1::CreateHistogram ( )
inlinevirtualinherited

Reimplemented in TF2, and TF3.

Definition at line 414 of file TF1.h.

◆ DeclFileName()

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

Definition at line 51 of file TF12.h.

◆ DefaultAddToGlobalList()

Bool_t TF1::DefaultAddToGlobalList ( Bool_t on = kTRUE)
staticinherited

Static method to add/avoid to add automatically functions to the global list (gROOT->GetListOfFunctions() ) After having called this static method, all the functions created afterwards will follow the desired behaviour.

By default the functions are added automatically It returns the previous status (true if the functions are added automatically)

Definition at line 839 of file TF1.cxx.

◆ DefineNSUMTerm()

void TF1::DefineNSUMTerm ( TObjArray * newFuncs,
TObjArray * coeffNames,
TString & fullFormula,
TString & formula,
int termStart,
int termEnd,
Double_t xmin,
Double_t xmax )
privateinherited

Helper functions for NSUM parsing.

Definition at line 884 of file TF1.cxx.

◆ Delete()

void TObject::Delete ( Option_t * option = "")
virtualinherited

◆ Derivative()

Double_t TF1::Derivative ( Double_t x,
Double_t * params = nullptr,
Double_t eps = 0.001 ) const
virtualinherited

Returns the first derivative of the function at point x, computed by Richardson's extrapolation method (use 2 derivative estimates to compute a third, more accurate estimation) first, derivatives with steps h and h/2 are computed by central difference formulas.

\[ D(h) = \frac{f(x+h) - f(x-h)}{2h} \]

the final estimate

\[ D = \frac{4D(h/2) - D(h)}{3} \]

"Numerical Methods for Scientists and Engineers", H.M.Antia, 2nd edition"

if the argument params is null, the current function parameters are used, otherwise the parameters in params are used.

the argument eps may be specified to control the step size (precision). the step size is taken as eps*(xmax-xmin). the default value (0.001) should be good enough for the vast majority of functions. Give a smaller value if your function has many changes of the second derivative in the function range.

Getting the error via TF1::DerivativeError: (total error = roundoff error + interpolation error) the estimate of the roundoff error is taken as follows:

\[ err = k\sqrt{f(x)^{2} + x^{2}deriv^{2}}\sqrt{\sum ai^{2}}, \]

where k is the double precision, ai are coefficients used in central difference formulas interpolation error is decreased by making the step size h smaller.

Author
Anna Kreshuk

Definition at line 1120 of file TF1.cxx.

◆ Derivative2()

Double_t TF1::Derivative2 ( Double_t x,
Double_t * params = nullptr,
Double_t eps = 0.001 ) const
virtualinherited

Returns the second derivative of the function at point x, computed by Richardson's extrapolation method (use 2 derivative estimates to compute a third, more accurate estimation) first, derivatives with steps h and h/2 are computed by central difference formulas.

\[ D(h) = \frac{f(x+h) - 2f(x) + f(x-h)}{h^{2}} \]

the final estimate

\[ D = \frac{4D(h/2) - D(h)}{3} \]

"Numerical Methods for Scientists and Engineers", H.M.Antia, 2nd edition"

if the argument params is null, the current function parameters are used, otherwise the parameters in params are used.

the argument eps may be specified to control the step size (precision). the step size is taken as eps*(xmax-xmin). the default value (0.001) should be good enough for the vast majority of functions. Give a smaller value if your function has many changes of the second derivative in the function range.

Getting the error via TF1::DerivativeError: (total error = roundoff error + interpolation error) the estimate of the roundoff error is taken as follows:

\[ err = k\sqrt{f(x)^{2} + x^{2}deriv^{2}}\sqrt{\sum ai^{2}}, \]

where k is the double precision, ai are coefficients used in central difference formulas interpolation error is decreased by making the step size h smaller.

Author
Anna Kreshuk

Definition at line 1185 of file TF1.cxx.

◆ Derivative3()

Double_t TF1::Derivative3 ( Double_t x,
Double_t * params = nullptr,
Double_t eps = 0.001 ) const
virtualinherited

Returns the third derivative of the function at point x, computed by Richardson's extrapolation method (use 2 derivative estimates to compute a third, more accurate estimation) first, derivatives with steps h and h/2 are computed by central difference formulas.

\[ D(h) = \frac{f(x+2h) - 2f(x+h) + 2f(x-h) - f(x-2h)}{2h^{3}} \]

the final estimate

\[ D = \frac{4D(h/2) - D(h)}{3} \]

"Numerical Methods for Scientists and Engineers", H.M.Antia, 2nd edition"

if the argument params is null, the current function parameters are used, otherwise the parameters in params are used.

the argument eps may be specified to control the step size (precision). the step size is taken as eps*(xmax-xmin). the default value (0.001) should be good enough for the vast majority of functions. Give a smaller value if your function has many changes of the second derivative in the function range.

Getting the error via TF1::DerivativeError: (total error = roundoff error + interpolation error) the estimate of the roundoff error is taken as follows:

\[ err = k\sqrt{f(x)^{2} + x^{2}deriv^{2}}\sqrt{\sum ai^{2}}, \]

where k is the double precision, ai are coefficients used in central difference formulas interpolation error is decreased by making the step size h smaller.

Author
Anna Kreshuk

Definition at line 1250 of file TF1.cxx.

◆ DerivativeError()

Double_t TF1::DerivativeError ( )
staticinherited

Static function returning the error of the last call to the of Derivative's functions.

Definition at line 1284 of file TF1.cxx.

◆ DistancetoLine()

Int_t TAttLine::DistancetoLine ( Int_t px,
Int_t py,
Double_t xp1,
Double_t yp1,
Double_t xp2,
Double_t yp2 )
inherited

Compute distance from point px,py to a line.

Compute the closest distance of approach from point px,py to this line. The distance is computed in pixels units.

Algorithm:

A(x1,y1) P B(x2,y2)
-----------------+------------------------------
|
|
|
|
M(x,y)
Let us call a = distance AM A=a**2
b = distance BM B=b**2
c = distance AB C=c**2
d = distance PM D=d**2
u = distance AP U=u**2
v = distance BP V=v**2 c = u + v
D = A - U
D = B - V = B -(c-u)**2
==> u = (A -B +C)/2c
#define d(i)
Definition RSha256.hxx:102
#define b(i)
Definition RSha256.hxx:100
#define c(i)
Definition RSha256.hxx:101
#define a(i)
Definition RSha256.hxx:99
ROOT::Detail::TRangeCast< T, true > TRangeDynCast
TRangeDynCast is an adapter class that allows the typed iteration through a TCollection.
Option_t Option_t TPoint TPoint const char x2
Option_t Option_t TPoint TPoint const char x1
Option_t Option_t TPoint TPoint const char y2
Option_t Option_t TPoint TPoint const char y1
Double_t y[n]
Definition legend1.C:17
Double_t x[n]
Definition legend1.C:17

Definition at line 210 of file TAttLine.cxx.

◆ DistancetoPrimitive()

Int_t TF1::DistancetoPrimitive ( Int_t px,
Int_t py )
overridevirtualinherited

Compute distance from point px,py to a function.

Compute the closest distance of approach from point px,py to this function. The distance is computed in pixels units.

Note that px is called with a negative value when the TF1 is in TGraph or TH1 list of functions. In this case there is no point looking at the histogram axis.

Reimplemented from TObject.

Reimplemented in TF2, and TF3.

Definition at line 1300 of file TF1.cxx.

◆ DoCreateHistogram()

TH1 * TF1::DoCreateHistogram ( Double_t xmin,
Double_t xmax,
Bool_t recreate = kFALSE )
protectedvirtualinherited

Create histogram with bin content equal to function value computed at the bin center This histogram will be used to paint the function A re-creation is forced and a new histogram is done if recreate=true.

Definition at line 3097 of file TF1.cxx.

◆ DoError()

void TObject::DoError ( int level,
const char * location,
const char * fmt,
va_list va ) const
protectedvirtualinherited

Interface to ErrorHandler (protected).

Reimplemented in TTreeViewer, and TThread.

Definition at line 1059 of file TObject.cxx.

◆ DoInitialize()

void TF1::DoInitialize ( EAddToList addToGlobalList)
protectedinherited

Common initialization of the TF1.

Add to the global list and set the default style

Definition at line 803 of file TF1.cxx.

◆ Draw()

void TF1::Draw ( Option_t * option = "")
overridevirtualinherited

Draw this function with its current attributes.

Possible option values are:

option description
"SAME" superimpose on top of existing picture
"L" connect all computed points with a straight line
"C" connect all computed points with a smooth curve
"FC" draw a fill area below a smooth curve

Note that the default value is "L". Therefore to draw on top of an existing picture, specify option "LSAME"

NB. You must use DrawCopy if you want to draw several times the same function in the current canvas.

Reimplemented from TObject.

Reimplemented in TF2, and TF3.

Definition at line 1340 of file TF1.cxx.

◆ DrawClass()

void TObject::DrawClass ( ) const
virtualinherited

Draw class inheritance tree of the class to which this object belongs.

If a class B inherits from a class A, description of B is drawn on the right side of description of A. Member functions overridden by B are shown in class A with a blue line crossing-out the corresponding member function. The following picture is the class inheritance tree of class TPaveLabel:

Reimplemented in TSystemDirectory, TSystemFile, and TGFrame.

Definition at line 308 of file TObject.cxx.

◆ DrawClone()

TObject * TObject::DrawClone ( Option_t * option = "") const
virtualinherited

Draw a clone of this object in the current selected pad with: gROOT->SetSelectedPad(c1).

If pad was not selected - gPad will be used.

Note
For histograms, use the more specialised TH1::DrawCopy().

Reimplemented in TSystemDirectory, TSystemFile, TGFrame, TAxis, and TCanvas.

Definition at line 319 of file TObject.cxx.

◆ DrawCopy()

TF1 * TF12::DrawCopy ( Option_t * option = "") const
overridevirtual

Draw a copy of this function with its current attributes.

This function MUST be used instead of Draw when you want to draw the same function with different parameters settings in the same canvas.

Possible option values are:

option description
"SAME" superimpose on top of existing picture
"L" connect all computed points with a straight line
"C" connect all computed points with a smooth curve

Note that the default value is "F". Therefore to draw on top of an existing picture, specify option "SL"

Reimplemented from TF1.

Definition at line 123 of file TF12.cxx.

◆ DrawDerivative()

TObject * TF1::DrawDerivative ( Option_t * option = "al")
virtualinherited

Draw derivative of this function.

An intermediate TGraph object is built and drawn with option. The function returns a pointer to the TGraph object. Do:

TGraph *g = (TGraph*)myfunc.DrawDerivative(option);

The resulting graph will be drawn into the current pad. If this function is used via the context menu, it recommended to create a new canvas/pad before invoking this function.

Reimplemented in TF2, and TF3.

Definition at line 1392 of file TF1.cxx.

◆ DrawF1()

void TF1::DrawF1 ( Double_t xmin,
Double_t xmax,
Option_t * option = "" )
virtualinherited

Draw function between xmin and xmax.

Definition at line 1427 of file TF1.cxx.

◆ DrawIntegral()

TObject * TF1::DrawIntegral ( Option_t * option = "al")
virtualinherited

Draw integral of this function.

An intermediate TGraph object is built and drawn with option. The function returns a pointer to the TGraph object. Do:

TGraph *g = (TGraph*)myfunc.DrawIntegral(option);

The resulting graph will be drawn into the current pad. If this function is used via the context menu, it recommended to create a new canvas/pad before invoking this function.

Reimplemented in TF2, and TF3.

Definition at line 1414 of file TF1.cxx.

◆ Dump()

void TObject::Dump ( ) const
virtualinherited

Dump contents of object on stdout.

Using the information in the object dictionary (class TClass) each data member is interpreted. If a data member is a pointer, the pointer value is printed

The following output is the Dump of a TArrow object:

fAngle 0 Arrow opening angle (degrees)
fArrowSize 0.2 Arrow Size
fOption.*fData
fX1 0.1 X of 1st point
fY1 0.15 Y of 1st point
fX2 0.67 X of 2nd point
fY2 0.83 Y of 2nd point
fBits 50331648 bit field status word
fFillColor 19 fill area color
#define X(type, name)
Option_t Option_t TPoint TPoint angle
Option_t Option_t width
Option_t Option_t style
Style_t fFillStyle
Fill area style.
Definition TAttFill.h:25
Color_t fFillColor
Fill area color.
Definition TAttFill.h:24
Width_t fLineWidth
Line width.
Definition TAttLine.h:26
Style_t fLineStyle
Line style.
Definition TAttLine.h:25
Color_t fLineColor
Line color.
Definition TAttLine.h:24
UInt_t fUniqueID
object unique identifier
Definition TObject.h:46
UInt_t fBits
bit field status word
Definition TObject.h:47
TLine * line

Reimplemented in TSystemFile, TCollection, TClass, TGFrame, and TGPack.

Definition at line 367 of file TObject.cxx.

◆ Error()

void TObject::Error ( const char * location,
const char * fmt,
... ) const
virtualinherited

Issue error message.

Use "location" to specify the method where the error occurred. Accepts standard printf formatting arguments.

Reimplemented in TFitResult.

Definition at line 1098 of file TObject.cxx.

◆ Eval()

Double_t TF12::Eval ( Double_t x,
Double_t y = 0,
Double_t z = 0,
Double_t t = 0 ) const
overridevirtual

Evaluate this formula.

Computes the value of the referenced TF2 for a fix value of X or Y

Reimplemented from TF1.

Definition at line 138 of file TF12.cxx.

◆ EvalPar() [1/2]

Double_t TF12::EvalPar ( const Double_t * x,
const Double_t * params = nullptr )
overridevirtual

Evaluate this function at point x[0].

x[0] is the value along X if fCase =0, the value along Y if fCase=1 if params is non null, the array will be used instead of the internal TF2 parameters

Reimplemented from TF1.

Definition at line 156 of file TF12.cxx.

◆ EvalPar() [2/2]

template<class T >
T TF1::EvalPar ( const T * x,
const Double_t * params = nullptr )
inherited

EvalPar for vectorized.

Definition at line 776 of file TF1.h.

◆ EvalParTempl()

template<class T >
T TF1::EvalParTempl ( const T * data,
const Double_t * params = nullptr )
inlineprivateinherited

Eval for vectorized functions.

Definition at line 801 of file TF1.h.

◆ EvalParVec()

double TF1::EvalParVec ( const Double_t * data,
const Double_t * params )
privateinherited

◆ EvalUncertainty()

Double_t TF1::EvalUncertainty ( Double_t x,
const TMatrixDSym * covMatrix = nullptr ) const
inherited

Evaluate the uncertainty of the function at location x due to the parameter uncertainties.

If covMatrix is nullptr, assumes uncorrelated uncertainties, otherwise the input covariance matrix (e.g. from a fit performed with option "S") is used. Implemented for 1-d only.

Note
to obtain confidence intervals of a fit result for drawing purposes, see instead ROOT::Fit::FitResult::GetConfidenceInterval()

Definition at line 1567 of file TF1.cxx.

◆ Execute() [1/2]

void TObject::Execute ( const char * method,
const char * params,
Int_t * error = nullptr )
virtualinherited

Execute method on this object with the given parameter string, e.g.

"3.14,1,\"text\"".

Reimplemented in TMethodCall, TCling, TInterpreter, ROOT::R::TRInterface, and TContextMenu.

Definition at line 378 of file TObject.cxx.

◆ Execute() [2/2]

void TObject::Execute ( TMethod * method,
TObjArray * params,
Int_t * error = nullptr )
virtualinherited

Execute method on this object with parameters stored in the TObjArray.

The TObjArray should contain an argv vector like:

argv[0] ... argv[n] = the list of TObjString parameters
Collectable string class.
Definition TObjString.h:28
const Int_t n
Definition legend1.C:16

Reimplemented in TCling, TMethodCall, TInterpreter, ROOT::R::TRInterface, and TContextMenu.

Definition at line 398 of file TObject.cxx.

◆ ExecuteEvent()

void TF1::ExecuteEvent ( Int_t event,
Int_t px,
Int_t py )
overridevirtualinherited

Execute action corresponding to one event.

This member function is called when a F1 is clicked with the locator

Reimplemented from TObject.

Reimplemented in TF2, and TF3.

Definition at line 1586 of file TF1.cxx.

◆ Fatal()

void TObject::Fatal ( const char * location,
const char * fmt,
... ) const
virtualinherited

Issue fatal error message.

Use "location" to specify the method where the fatal error occurred. Accepts standard printf formatting arguments.

Definition at line 1126 of file TObject.cxx.

◆ FillBuffer()

void TNamed::FillBuffer ( char *& buffer)
virtualinherited

Encode TNamed into output buffer.

Reimplemented in TKeySQL, TSQLFile, TKeyXML, TXMLFile, TDirectoryFile, TFile, and TKey.

Definition at line 103 of file TNamed.cxx.

◆ FindObject() [1/2]

TObject * TObject::FindObject ( const char * name) const
virtualinherited

Must be redefined in derived classes.

This function is typically used with TCollections, but can also be used to find an object by name inside this object.

Reimplemented in TListOfEnums, TMap, TDirectory, TFolder, TROOT, TListOfTypes, TListOfTypes, TBtree, TCollection, THashList, THashTable, TList, TObjArray, TListOfDataMembers, TListOfDataMembers, TListOfEnums, TListOfEnumsWithLock, TListOfFunctions, TListOfFunctionTemplates, TListOfFunctionTemplates, TViewPubDataMembers, TViewPubFunctions, TPad, TGeometry, THbookFile, TGraph, TGraph2D, TH1, RooAbsCollection, and RooLinkedList.

Definition at line 425 of file TObject.cxx.

◆ FindObject() [2/2]

TObject * TObject::FindObject ( const TObject * obj) const
virtualinherited

Must be redefined in derived classes.

This function is typically used with TCollections, but can also be used to find an object inside this object.

Reimplemented in TMap, TDirectory, TFolder, TROOT, TListOfTypes, TBtree, TCollection, THashList, THashTable, TList, TObjArray, TListOfDataMembers, TListOfEnums, TListOfEnumsWithLock, TListOfFunctions, TListOfFunctionTemplates, TViewPubDataMembers, TViewPubFunctions, TPad, TGeometry, THbookFile, TGraph, TGraph2D, TH1, RooAbsCollection, and RooLinkedList.

Definition at line 435 of file TObject.cxx.

◆ FixParameter()

void TF1::FixParameter ( Int_t ipar,
Double_t value )
virtualinherited

Fix the value of a parameter for a fit operation The specified value will be used in the fit and the parameter will be constant (nor varying) during fitting Note that when using pre-defined functions (e.g gaus), one needs to use the fit option 'B' to have the fix of the paramter effective.

See TH1::Fit(TF1*, Option_t *, Option_t *, Double_t, Double_t) for the fitting documentation and the fitting options.

Definition at line 1607 of file TF1.cxx.

◆ GetChisquare()

Double_t TF1::GetChisquare ( ) const
inlineinherited

Return the Chisquare after fitting. See ROOT::Fit::FitResult::Chi2()

Definition at line 409 of file TF1.h.

◆ GetCurrent()

TF1 * TF1::GetCurrent ( )
staticinherited

Static function returning the current function being processed.

Definition at line 1619 of file TF1.cxx.

◆ GetDrawOption()

Option_t * TObject::GetDrawOption ( ) const
virtualinherited

Get option used by the graphics system to draw this object.

Note that before calling object.GetDrawOption(), you must have called object.Draw(..) before in the current pad.

Reimplemented in TBrowser, TFitEditor, TGedFrame, TGFileBrowser, TRootBrowser, and TRootBrowserLite.

Definition at line 445 of file TObject.cxx.

◆ GetDtorOnly()

Longptr_t TObject::GetDtorOnly ( )
staticinherited

Return destructor only flag.

Definition at line 1196 of file TObject.cxx.

◆ GetExpFormula()

virtual TString TF1::GetExpFormula ( Option_t * option = "") const
inlinevirtualinherited

Definition at line 426 of file TF1.h.

◆ GetFillColor()

virtual Color_t TAttFill::GetFillColor ( ) const
inlinevirtualinherited

Return the fill area color.

Reimplemented in TGraphMultiErrors, TGWin32, TGWin32VirtualXProxy, and TGX11.

Definition at line 32 of file TAttFill.h.

◆ GetFillStyle()

virtual Style_t TAttFill::GetFillStyle ( ) const
inlinevirtualinherited

Return the fill area style.

Reimplemented in TGraphMultiErrors, TGWin32, TGWin32VirtualXProxy, and TGX11.

Definition at line 33 of file TAttFill.h.

◆ GetFormula() [1/2]

virtual TFormula * TF1::GetFormula ( )
inlinevirtualinherited

Definition at line 418 of file TF1.h.

◆ GetFormula() [2/2]

virtual const TFormula * TF1::GetFormula ( ) const
inlinevirtualinherited

Definition at line 422 of file TF1.h.

◆ GetHistogram()

TH1 * TF1::GetHistogram ( ) const
virtualinherited

Return a pointer to the histogram used to visualise the function Note that this histogram is managed by the function and in same case it is automatically deleted when some TF1 functions are called such as TF1::SetParameters, TF1::SetNpx, TF1::SetRange It is then reccomended either to clone the return object or calling again teh GetHistogram function whenever is needed.

Definition at line 1634 of file TF1.cxx.

◆ GetIconName()

const char * TObject::GetIconName ( ) const
virtualinherited

Returns mime type name of object.

Used by the TBrowser (via TGMimeTypes class). Override for class of which you would like to have different icons for objects of the same class.

Reimplemented in TSystemFile, TGeoVolume, TASImage, TGMainFrame, TKey, ROOT::Experimental::XRooFit::xRooNode, TBranch, TVirtualBranchBrowsable, TMethodBrowsable, and TBranchElement.

Definition at line 472 of file TObject.cxx.

◆ GetLinearPart()

virtual const TObject * TF1::GetLinearPart ( Int_t i) const
inlinevirtualinherited

Definition at line 430 of file TF1.h.

◆ GetLineColor()

virtual Color_t TAttLine::GetLineColor ( ) const
inlinevirtualinherited

Return the line color.

Reimplemented in TGraphMultiErrors, and TGWin32VirtualXProxy.

Definition at line 36 of file TAttLine.h.

◆ GetLineStyle()

virtual Style_t TAttLine::GetLineStyle ( ) const
inlinevirtualinherited

Return the line style.

Reimplemented in TGraphMultiErrors, TGWin32, TGWin32VirtualXProxy, and TGX11.

Definition at line 37 of file TAttLine.h.

◆ GetLineWidth()

virtual Width_t TAttLine::GetLineWidth ( ) const
inlinevirtualinherited

Return the line width.

Reimplemented in TGraphMultiErrors, TGWin32, TGWin32VirtualXProxy, and TGX11.

Definition at line 38 of file TAttLine.h.

◆ GetMarkerColor()

virtual Color_t TAttMarker::GetMarkerColor ( ) const
inlinevirtualinherited

Return the marker color.

Reimplemented in TGWin32VirtualXProxy.

Definition at line 33 of file TAttMarker.h.

◆ GetMarkerLineWidth()

Width_t TAttMarker::GetMarkerLineWidth ( Style_t style)
staticinherited

Internal helper function that returns the line width of the given marker style (0 = filled marker)

Definition at line 305 of file TAttMarker.cxx.

◆ GetMarkerSize()

virtual Size_t TAttMarker::GetMarkerSize ( ) const
inlinevirtualinherited

Return the marker size.

Reimplemented in TGWin32VirtualXProxy.

Definition at line 35 of file TAttMarker.h.

◆ GetMarkerStyle()

virtual Style_t TAttMarker::GetMarkerStyle ( ) const
inlinevirtualinherited

Return the marker style.

Reimplemented in TGWin32VirtualXProxy.

Definition at line 34 of file TAttMarker.h.

◆ GetMarkerStyleBase()

Style_t TAttMarker::GetMarkerStyleBase ( Style_t style)
staticinherited

Internal helper function that returns the corresponding marker style with line width 1 for the given style.

Definition at line 254 of file TAttMarker.cxx.

◆ GetMaximum()

Double_t TF1::GetMaximum ( Double_t xmin = 0,
Double_t xmax = 0,
Double_t epsilon = 1.E-10,
Int_t maxiter = 100,
Bool_t logx = false ) const
virtualinherited

Returns the maximum value of the function.

Method: First, the grid search is used to bracket the maximum with the step size = (xmax-xmin)/fNpx. This way, the step size can be controlled via the SetNpx() function. If the function is unimodal or if its extrema are far apart, setting the fNpx to a small value speeds the algorithm up many times. Then, Brent's method is applied on the bracketed interval epsilon (default = 1.E-10) controls the relative accuracy (if |x| > 1 ) and absolute (if |x| < 1) and maxiter (default = 100) controls the maximum number of iteration of the Brent algorithm If the flag logx is set the grid search is done in log step size This is done automatically if the log scale is set in the current Pad

NOTE: see also TF1::GetMaximumX and TF1::GetX

Reimplemented in TF2.

Definition at line 1664 of file TF1.cxx.

◆ GetMaximumStored()

virtual Double_t TF1::GetMaximumStored ( ) const
inlinevirtualinherited

Definition at line 438 of file TF1.h.

◆ GetMaximumX()

Double_t TF1::GetMaximumX ( Double_t xmin = 0,
Double_t xmax = 0,
Double_t epsilon = 1.E-10,
Int_t maxiter = 100,
Bool_t logx = false ) const
virtualinherited

Returns the X value corresponding to the maximum value of the function.

Method: First, the grid search is used to bracket the maximum with the step size = (xmax-xmin)/fNpx. This way, the step size can be controlled via the SetNpx() function. If the function is unimodal or if its extrema are far apart, setting the fNpx to a small value speeds the algorithm up many times. Then, Brent's method is applied on the bracketed interval epsilon (default = 1.E-10) controls the relative accuracy (if |x| > 1 ) and absolute (if |x| < 1) and maxiter (default = 100) controls the maximum number of iteration of the Brent algorithm If the flag logx is set the grid search is done in log step size This is done automatically if the log scale is set in the current Pad

NOTE: see also TF1::GetX

Definition at line 1705 of file TF1.cxx.

◆ GetMethodCall()

TMethodCall * TF1::GetMethodCall ( ) const
inlineinherited

Definition at line 459 of file TF1.h.

◆ GetMinimum()

Double_t TF1::GetMinimum ( Double_t xmin = 0,
Double_t xmax = 0,
Double_t epsilon = 1.E-10,
Int_t maxiter = 100,
Bool_t logx = false ) const
virtualinherited

Returns the minimum value of the function on the (xmin, xmax) interval.

Method: First, the grid search is used to bracket the maximum with the step size = (xmax-xmin)/fNpx. This way, the step size can be controlled via the SetNpx() function. If the function is unimodal or if its extrema are far apart, setting the fNpx to a small value speeds the algorithm up many times. Then, Brent's method is applied on the bracketed interval epsilon (default = 1.E-10) controls the relative accuracy (if |x| > 1 ) and absolute (if |x| < 1) and maxiter (default = 100) controls the maximum number of iteration of the Brent algorithm If the flag logx is set the grid search is done in log step size This is done automatically if the log scale is set in the current Pad

NOTE: see also TF1::GetMaximumX and TF1::GetX

Reimplemented in TF2.

Definition at line 1746 of file TF1.cxx.

◆ GetMinimumStored()

virtual Double_t TF1::GetMinimumStored ( ) const
inlinevirtualinherited

Definition at line 442 of file TF1.h.

◆ GetMinimumX()

Double_t TF1::GetMinimumX ( Double_t xmin = 0,
Double_t xmax = 0,
Double_t epsilon = 1.E-10,
Int_t maxiter = 100,
Bool_t logx = false ) const
virtualinherited

Returns the X value corresponding to the minimum value of the function on the (xmin, xmax) interval.

Method: First, the grid search is used to bracket the maximum with the step size = (xmax-xmin)/fNpx. This way, the step size can be controlled via the SetNpx() function. If the function is unimodal or if its extrema are far apart, setting the fNpx to a small value speeds the algorithm up many times. Then, Brent's method is applied on the bracketed interval epsilon (default = 1.E-10) controls the relative accuracy (if |x| > 1 ) and absolute (if |x| < 1) and maxiter (default = 100) controls the maximum number of iteration of the Brent algorithm If the flag logx is set the grid search is done in log step size This is done automatically if the log scale is set in the current Pad

NOTE: see also TF1::GetX

Definition at line 1873 of file TF1.cxx.

◆ GetMinMaxNDim()

Double_t TF1::GetMinMaxNDim ( Double_t * x,
Bool_t findmax,
Double_t epsilon = 0,
Int_t maxiter = 0 ) const
protectedvirtualinherited

Find the minimum of a function of whatever dimension.

While GetMinimum works only for 1D function , GetMinimumNDim works for all dimensions since it uses the minimizer interface vector x at beginning will contained the initial point, on exit will contain the result

Definition at line 1773 of file TF1.cxx.

◆ GetName()

const char * TNamed::GetName ( ) const
inlineoverridevirtualinherited

Returns name of object.

This default method returns the class name. Classes that give objects a name should override this method.

Reimplemented from TObject.

Definition at line 49 of file TNamed.h.

◆ GetNDF()

Int_t TF1::GetNDF ( ) const
virtualinherited

Return the number of degrees of freedom in the fit the fNDF parameter has been previously computed during a fit.

The number of degrees of freedom corresponds to the number of points used in the fit minus the number of free parameters.

Definition at line 1939 of file TF1.cxx.

◆ GetNdim()

virtual Int_t TF1::GetNdim ( ) const
inlinevirtualinherited

Definition at line 450 of file TF1.h.

◆ GetNpar()

virtual Int_t TF1::GetNpar ( ) const
inlinevirtualinherited

Definition at line 446 of file TF1.h.

◆ GetNpx()

virtual Int_t TF1::GetNpx ( ) const
inlinevirtualinherited

Definition at line 455 of file TF1.h.

◆ GetNumber()

virtual Int_t TF1::GetNumber ( ) const
inlinevirtualinherited

Definition at line 463 of file TF1.h.

◆ GetNumberFitPoints()

virtual Int_t TF1::GetNumberFitPoints ( ) const
inlinevirtualinherited

Definition at line 468 of file TF1.h.

◆ GetNumberFreeParameters()

Int_t TF1::GetNumberFreeParameters ( ) const
virtualinherited

Return the number of free parameters.

Definition at line 1950 of file TF1.cxx.

◆ GetObjectInfo()

char * TF1::GetObjectInfo ( Int_t px,
Int_t py ) const
overridevirtualinherited

Redefines TObject::GetObjectInfo.

Displays the function info (x, function value) corresponding to cursor position px,py

Reimplemented from TObject.

Reimplemented in TF2.

Definition at line 1968 of file TF1.cxx.

◆ GetObjectStat()

Bool_t TObject::GetObjectStat ( )
staticinherited

Get status of object stat flag.

Definition at line 1181 of file TObject.cxx.

◆ GetOption()

virtual Option_t * TObject::GetOption ( ) const
inlinevirtualinherited

◆ GetParameter() [1/2]

virtual Double_t TF1::GetParameter ( const TString & name) const
inlinevirtualinherited

Definition at line 481 of file TF1.h.

◆ GetParameter() [2/2]

virtual Double_t TF1::GetParameter ( Int_t ipar) const
inlinevirtualinherited

Definition at line 477 of file TF1.h.

◆ GetParameters() [1/2]

virtual Double_t * TF1::GetParameters ( ) const
inlinevirtualinherited

Definition at line 485 of file TF1.h.

◆ GetParameters() [2/2]

virtual void TF1::GetParameters ( Double_t * params)
inlinevirtualinherited

Definition at line 489 of file TF1.h.

◆ GetParent()

TObject * TF1::GetParent ( ) const
inlineinherited

Definition at line 473 of file TF1.h.

◆ GetParError() [1/2]

virtual Double_t TF1::GetParError ( const char * name) const
inlinevirtualinherited

Definition at line 503 of file TF1.h.

◆ GetParError() [2/2]

Double_t TF1::GetParError ( Int_t ipar) const
virtualinherited

Return value of parameter number ipar.

Definition at line 1980 of file TF1.cxx.

◆ GetParErrors()

virtual const Double_t * TF1::GetParErrors ( ) const
inlinevirtualinherited

Definition at line 507 of file TF1.h.

◆ GetParLimits()

void TF1::GetParLimits ( Int_t ipar,
Double_t & parmin,
Double_t & parmax ) const
virtualinherited

Return limits for parameter ipar.

Definition at line 1990 of file TF1.cxx.

◆ GetParName()

virtual const char * TF1::GetParName ( Int_t ipar) const
inlinevirtualinherited

Definition at line 494 of file TF1.h.

◆ GetParNumber()

virtual Int_t TF1::GetParNumber ( const char * name) const
inlinevirtualinherited

Definition at line 498 of file TF1.h.

◆ GetProb()

Double_t TF1::GetProb ( ) const
virtualinherited

Return the fit probability.

Definition at line 2005 of file TF1.cxx.

◆ GetQuantiles()

Int_t TF1::GetQuantiles ( Int_t n,
Double_t * xp,
const Double_t * p )
virtualinherited

Compute Quantiles for density distribution of this function.

Quantile x_p of a probability distribution Function F is defined as

\[ F(x_{p}) = \int_{xmin}^{x_{p}} f dx = p \text{with} 0 <= p <= 1. \]

For instance the median \( x_{\frac{1}{2}} \) of a distribution is defined as that value of the random variable for which the distribution function equals 0.5:

\[ F(x_{\frac{1}{2}}) = \prod(x < x_{\frac{1}{2}}) = \frac{1}{2} \]

Parameters
[in]nmaximum size of array xp and size of array p
[out]xparray filled with n quantiles evaluated at p. Memory has to be preallocated by caller.
[in]parray of cumulative probabilities where quantiles should be evaluated. It is assumed to contain at least n values.
Returns
n, the number of quantiles computed (same as input argument n)

Getting quantiles from two histograms and storing results in a TGraph, a so-called QQ-plot

TGraph *gr = new TGraph(nprob);
f1->GetQuantiles(nprob,gr->GetX(),p);
f2->GetQuantiles(nprob,gr->GetY(),p);
gr->Draw("alp");
Author
Eddy Offermann
Warning
Function leads to undefined behavior if xp or p are null or their size does not match with n

Definition at line 2042 of file TF1.cxx.

◆ GetRandom() [1/2]

Double_t TF1::GetRandom ( Double_t xmin,
Double_t xmax,
TRandom * rng = nullptr,
Option_t * option = nullptr )
virtualinherited

Return a random number following this function shape in [xmin,xmax].

The distribution contained in the function fname (TF1) is integrated over the channel contents. It is normalized to 1. For each bin the integral is approximated by a parabola. The parabola coefficients are stored as non persistent data members Getting one random number implies:

  • Generating a random number between 0 and 1 (say r1)
  • Look in which bin in the normalized integral r1 corresponds to
  • Evaluate the parabolic curve in the selected bin to find the corresponding X value.

The parabolic approximation is very good as soon as the number of bins is greater than 50.

Parameters
xminminimum value for generated random numbers
xmaxmaximum value for generated random numbers
rng(optional) random number generator pointer
option(optional) : LOG or LIN to force the usage of a log or linear scale for computing the cumulative integral table

IMPORTANT NOTE

The integral of the function is computed at fNpx points. If the function has sharp peaks, you should increase the number of points (SetNpx) such that the peak is correctly tabulated at several points.

Reimplemented in TF2.

Definition at line 2293 of file TF1.cxx.

◆ GetRandom() [2/2]

Double_t TF1::GetRandom ( TRandom * rng = nullptr,
Option_t * option = nullptr )
virtualinherited

Return a random number following this function shape.

Parameters
rngRandom number generator. By default (or when passing a nullptr) the global gRandom is used
optionOption string which controls the binning used to compute the integral. Default mode is automatic depending of xmax, xmin and Npx (function points). Possible values are:
  • "LOG" to force usage of log scale for tabulating the integral
  • "LIN" to force usage of linear scale when tabulating the integral

The distribution contained in the function fname (TF1) is integrated over the channel contents. It is normalized to 1. For each bin the integral is approximated by a parabola. The parabola coefficients are stored as non persistent data members Getting one random number implies:

  • Generating a random number between 0 and 1 (say r1)
  • Look in which bin in the normalized integral r1 corresponds to
  • Evaluate the parabolic curve in the selected bin to find the corresponding X value.

The user can provide as optional parameter a Random number generator. By default gRandom is used

If the ratio fXmax/fXmin > fNpx the integral is tabulated in log scale in x A log scale for the intergral is also always used if a user specifies the "LOG" option Instead if a user requestes a "LIN" option the integral binning is never done in log scale whatever the fXmax/fXmin ratio is

Note that the parabolic approximation is very good as soon as the number of bins is greater than 50.

Reimplemented in TF2.

Definition at line 2240 of file TF1.cxx.

◆ GetRange() [1/4]

void TF1::GetRange ( Double_t & xmin,
Double_t & xmax ) const
virtualinherited

Return range of a 1-D function.

Reimplemented in TF2, TF3, and TF3.

Definition at line 2356 of file TF1.cxx.

◆ GetRange() [2/4]

void TF1::GetRange ( Double_t & xmin,
Double_t & ymin,
Double_t & xmax,
Double_t & ymax ) const
virtualinherited

Return range of a 2-D function.

Reimplemented in TF2, TF3, TF2, and TF3.

Definition at line 2366 of file TF1.cxx.

◆ GetRange() [3/4]

void TF1::GetRange ( Double_t & xmin,
Double_t & ymin,
Double_t & zmin,
Double_t & xmax,
Double_t & ymax,
Double_t & zmax ) const
virtualinherited

Return range of function.

Reimplemented in TF2, TF3, TF2, and TF3.

Definition at line 2378 of file TF1.cxx.

◆ GetRange() [4/4]

void TF1::GetRange ( Double_t * xmin,
Double_t * xmax ) const
protectedvirtualinherited

Return range of a generic N-D function.

Reimplemented in TF2, and TF3.

Definition at line 2329 of file TF1.cxx.

◆ GetSave()

Double_t TF1::GetSave ( const Double_t * x)
virtualinherited

Get value corresponding to X in array of fSave values.

Reimplemented in TF2, and TF3.

Definition at line 2392 of file TF1.cxx.

◆ GetTitle()

const char * TNamed::GetTitle ( ) const
inlineoverridevirtualinherited

Returns title of object.

This default method returns the class title (i.e. description). Classes that give objects a title should override this method.

Reimplemented from TObject.

Definition at line 50 of file TNamed.h.

◆ GetUniqueID()

UInt_t TObject::GetUniqueID ( ) const
virtualinherited

Return the unique object id.

Definition at line 480 of file TObject.cxx.

◆ GetVariable()

virtual Double_t TF1::GetVariable ( const TString & name)
inlinevirtualinherited

Definition at line 532 of file TF1.h.

◆ GetX()

Double_t TF1::GetX ( Double_t fy,
Double_t xmin = 0,
Double_t xmax = 0,
Double_t epsilon = 1.E-10,
Int_t maxiter = 100,
Bool_t logx = false ) const
virtualinherited

Returns the X value corresponding to the function value fy for (xmin<x<xmax).

in other words it can find the roots of the function when fy=0 and successive calls by changing the next call to [xmin+eps,xmax] where xmin is the previous root.

Method: First, the grid search is used to bracket the maximum with the step size = (xmax-xmin)/fNpx. This way, the step size can be controlled via the SetNpx() function. If the function is unimodal or if its extrema are far apart, setting the fNpx to a small value speeds the algorithm up many times. Then, Brent's method is applied on the bracketed interval epsilon (default = 1.E-10) controls the relative accuracy (if |x| > 1 ) and absolute (if |x| < 1) and maxiter (default = 100) controls the maximum number of iteration of the Brent algorithm If the flag logx is set the grid search is done in log step size This is done automatically if the log scale is set in the current Pad

NOTE: see also TF1::GetMaximumX, TF1::GetMinimumX

Definition at line 1913 of file TF1.cxx.

◆ GetXaxis()

TAxis * TF1::GetXaxis ( ) const
inherited

Get x axis of the function.

Definition at line 2448 of file TF1.cxx.

◆ GetXmax()

virtual Double_t TF1::GetXmax ( ) const
inlinevirtualinherited

Definition at line 525 of file TF1.h.

◆ GetXmin()

virtual Double_t TF1::GetXmin ( ) const
inlinevirtualinherited

Definition at line 521 of file TF1.h.

◆ GetXY()

virtual Double_t TF12::GetXY ( ) const
inlinevirtual

Definition at line 47 of file TF12.h.

◆ GetYaxis()

TAxis * TF1::GetYaxis ( ) const
inherited

Get y axis of the function.

Definition at line 2459 of file TF1.cxx.

◆ GetZaxis()

TAxis * TF1::GetZaxis ( ) const
inherited

Get z axis of the function. (In case this object is a TF2 or TF3)

Definition at line 2470 of file TF1.cxx.

◆ GradientPar() [1/4]

void TF1::GradientPar ( const Double_t * x,
Double_t * grad,
Double_t eps = 0.01 ) const
virtualinherited

Compute the gradient wrt parameters If the TF1 object is based on a formula expression (TFormula) and TFormula::GenerateGradientPar() has been successfully called automatic differentiation using CLAD is used instead of the default numerical differentiation.

Parameters
xpoint, were the gradient is computed
gradused to return the computed gradient, assumed to be of at least fNpar size
epsif the errors of parameters have been computed, the step used in numerical differentiation is eps*parameter_error.

if the errors have not been computed, step=eps is used default value of eps = 0.01 Method is the same as in Derivative() function

If a parameter is fixed, the gradient on this parameter = 0

Definition at line 2516 of file TF1.cxx.

◆ GradientPar() [2/4]

template<class T >
void TF1::GradientPar ( const T * x,
T * grad,
Double_t eps = 0.01 ) const
inlineinherited

Definition at line 905 of file TF1.h.

◆ GradientPar() [3/4]

Double_t TF1::GradientPar ( Int_t ipar,
const Double_t * x,
Double_t eps = 0.01 ) const
virtualinherited

Compute the gradient (derivative) wrt a parameter ipar.

Parameters
iparindex of parameter for which the derivative is computed
xpoint, where the derivative is computed
eps- if the errors of parameters have been computed, the step used in numerical differentiation is eps*parameter_error.

if the errors have not been computed, step=eps is used default value of eps = 0.01 Method is the same as in Derivative() function

If a parameter is fixed, the gradient on this parameter = 0

Definition at line 2493 of file TF1.cxx.

◆ GradientPar() [4/4]

template<class T >
T TF1::GradientPar ( Int_t ipar,
const T * x,
Double_t eps = 0.01 ) const
inlineinherited

Definition at line 838 of file TF1.h.

◆ GradientParTempl() [1/2]

template<class T >
void TF1::GradientParTempl ( const T * x,
T * grad,
Double_t eps = 0.01 ) const
inlineinherited

Definition at line 914 of file TF1.h.

◆ GradientParTempl() [2/2]

template<class T >
T TF1::GradientParTempl ( Int_t ipar,
const T * x,
Double_t eps = 0.01 ) const
inlineinherited

Definition at line 847 of file TF1.h.

◆ HandleTimer()

Bool_t TObject::HandleTimer ( TTimer * timer)
virtualinherited

Execute action in response of a timer timing out.

This method must be overridden if an object has to react to timers.

Reimplemented in TGWindow, TGuiBldDragManager, TGraphTime, TGLEventHandler, TGCommandPlugin, TGDNDManager, TGFileContainer, TGPopupMenu, TGScrollBar, TGShutter, TGTextEdit, TGTextEditor, TGTextEntry, TGTextView, TGToolTip, TGHtml, and TTreeViewer.

Definition at line 516 of file TObject.cxx.

◆ Hash()

ULong_t TNamed::Hash ( ) const
inlineoverridevirtualinherited

Return hash value for this object.

Note: If this routine is overloaded in a derived class, this derived class should also add

void CallRecursiveRemoveIfNeeded(TObject &obj)
call RecursiveRemove for obj if gROOT is valid and obj.TestBit(kMustCleanup) is true.
Definition TROOT.h:406

Otherwise, when RecursiveRemove is called (by ~TObject or example) for this type of object, the transversal of THashList and THashTable containers will will have to be done without call Hash (and hence be linear rather than logarithmic complexity). You will also see warnings like

ULong_t Hash() const override
Return hash value for this object.
Definition TNamed.h:51
Mother of all ROOT objects.
Definition TObject.h:42
virtual void Error(const char *method, const char *msgfmt,...) const
Issue error message.
Definition TObject.cxx:1098
void RecursiveRemove(TObject *obj) override
Recursively remove this object from the list of Cleanups.
Definition TROOT.cxx:2651

Reimplemented from TObject.

Definition at line 51 of file TNamed.h.

◆ HasInconsistentHash()

Bool_t TObject::HasInconsistentHash ( ) const
inlineinherited

Return true is the type of this object is known to have an inconsistent setup for Hash and RecursiveRemove (i.e.

missing call to RecursiveRemove in destructor).

Note: Since the consistency is only tested for during inserts, this routine will return true for object that have never been inserted whether or not they have a consistent setup. This has no negative side-effect as searching for the object with the right or wrong Hash will always yield a not-found answer (Since anyway no hash can be guaranteed unique, there is always a check)

Definition at line 366 of file TObject.h.

◆ HasSave()

Bool_t TF1::HasSave ( ) const
inlineinherited

Return true if function has data in fSave buffer.

Definition at line 403 of file TF1.h.

◆ Info()

void TObject::Info ( const char * location,
const char * fmt,
... ) const
virtualinherited

Issue info message.

Use "location" to specify the method where the warning occurred. Accepts standard printf formatting arguments.

Definition at line 1072 of file TObject.cxx.

◆ InheritsFrom() [1/2]

Bool_t TObject::InheritsFrom ( const char * classname) const
virtualinherited

Returns kTRUE if object inherits from class "classname".

Reimplemented in TClass.

Definition at line 549 of file TObject.cxx.

◆ InheritsFrom() [2/2]

Bool_t TObject::InheritsFrom ( const TClass * cl) const
virtualinherited

Returns kTRUE if object inherits from TClass cl.

Reimplemented in TClass.

Definition at line 557 of file TObject.cxx.

◆ InitArgs()

void TF1::InitArgs ( const Double_t * x,
const Double_t * params )
virtualinherited

Initialize parameters addresses.

Definition at line 2530 of file TF1.cxx.

◆ InitStandardFunctions()

void TF1::InitStandardFunctions ( )
staticinherited

Create the basic function objects.

Definition at line 2545 of file TF1.cxx.

◆ Inspect()

void TObject::Inspect ( ) const
virtualinherited

Dump contents of this object in a graphics canvas.

Same action as Dump but in a graphical form. In addition pointers to other objects can be followed.

The following picture is the Inspect of a histogram object:

Reimplemented in TSystemFile, TInspectorObject, TGFrame, and ROOT::Experimental::XRooFit::xRooNode.

Definition at line 570 of file TObject.cxx.

◆ Integral()

Double_t TF1::Integral ( Double_t a,
Double_t b,
Double_t epsrel = 1.e-12 )
virtualinherited

IntegralOneDim or analytical integral.

Reimplemented in TF2, and TF3.

Definition at line 2580 of file TF1.cxx.

◆ IntegralError() [1/2]

Double_t TF1::IntegralError ( Double_t a,
Double_t b,
const Double_t * params = nullptr,
const Double_t * covmat = nullptr,
Double_t epsilon = 1.E-2 )
virtualinherited

Return Error on Integral of a parametric function between a and b due to the parameter uncertainties and their covariance matrix from the fit.

In addition to the integral limits, this method takes as input a pointer to the fitted parameter values and a pointer the covariance matrix from the fit. These pointers should be retrieved from the previously performed fit using the TFitResult class. Note that to get the TFitResult, te fit should be done using the fit option S. Example:

TFitResultPtr r = histo->Fit(func, "S");
func->IntegralError(x1,x2,r->GetParams(), r->GetCovarianceMatrix()->GetMatrixArray() );
Option_t Option_t TPoint TPoint const char GetTextMagnitude GetFillStyle GetLineColor GetLineWidth GetMarkerStyle GetTextAlign GetTextColor GetTextSize void char Point_t Rectangle_t WindowAttributes_t Float_t r
Provides an indirection to the TFitResult class and with a semantics identical to a TFitResult pointe...

IMPORTANT NOTE1:

A null pointer to the parameter values vector and to the covariance matrix can be passed. In this case, when the parameter values pointer is null, the parameter values stored in this TF1 function object are used in the integral error computation. When the poassed pointer to the covariance matrix is null, a covariance matrix from the last fit is retrieved from a global fitter instance when it exists. Note that the global fitter instance esists only when ROOT is not running with multi-threading enabled (ROOT::IsImplicitMTEnabled() == True). When the ovariance matrix from the last fit cannot be retrieved, an error message is printed and a zero value is returned.

IMPORTANT NOTE2:

When no covariance matrix is passed and in the meantime a fit is done using another function, the routine will signal an error and it will return zero only when the number of fit parameter is different than the values stored in TF1 (TF1::GetNpar() ). In the case that npar is the same, an incorrect result is returned.

IMPORTANT NOTE3:

The user must pass a pointer to the elements of the full covariance matrix dimensioned with the right size (npar*npar), where npar is the total number of parameters (TF1::GetNpar()), including also the fixed parameters. The covariance matrix must be retrieved from the TFitResult class as shown above and not from TVirtualFitter::GetCovarianceMatrix() function.

Definition at line 2757 of file TF1.cxx.

◆ IntegralError() [2/2]

Double_t TF1::IntegralError ( Int_t n,
const Double_t * a,
const Double_t * b,
const Double_t * params = nullptr,
const Double_t * covmat = nullptr,
Double_t epsilon = 1.E-2 )
virtualinherited

Return Error on Integral of a parametric function with dimension larger than one between a[] and b[] due to the parameters uncertainties.

For a TF1 with dimension larger than 1 (for example a TF2 or TF3) TF1::IntegralMultiple is used for the integral calculation

In addition to the integral limits, this method takes as input a pointer to the fitted parameter values and a pointer the covariance matrix from the fit. These pointers should be retrieved from the previously performed fit using the TFitResult class. Note that to get the TFitResult, te fit should be done using the fit option S. Example:

func2->IntegralError(a,b,r->GetParams(), r->GetCovarianceMatrix()->GetMatrixArray() );

IMPORTANT NOTE1:

A null pointer to the parameter values vector and to the covariance matrix can be passed. In this case, when the parameter values pointer is null, the parameter values stored in this TF1 function object are used in the integral error computation. When the poassed pointer to the covariance matrix is null, a covariance matrix from the last fit is retrieved from a global fitter instance when it exists. Note that the global fitter instance esists only when ROOT is not running with multi-threading enabled (ROOT::IsImplicitMTEnabled() == True). When the ovariance matrix from the last fit cannot be retrieved, an error message is printed and a zero value is returned.

IMPORTANT NOTE2:

When no covariance matrix is passed and in the meantime a fit is done using another function, the routine will signal an error and it will return zero only when the number of fit parameter is different than the values stored in TF1 (TF1::GetNpar() ). In the case that npar is the same, an incorrect result is returned.

IMPORTANT NOTE3:

The user must pass a pointer to the elements of the full covariance matrix dimensioned with the right size (npar*npar), where npar is the total number of parameters (TF1::GetNpar()), including also the fixed parameters. The covariance matrix must be retrieved from the TFitResult class as shown above and not from TVirtualFitter::GetCovarianceMatrix() function.

Definition at line 2807 of file TF1.cxx.

◆ IntegralFast()

Double_t TF1::IntegralFast ( Int_t num,
Double_t * x,
Double_t * w,
Double_t a,
Double_t b,
Double_t * params = nullptr,
Double_t epsilon = 1e-12 )
virtualinherited

Gauss-Legendre integral, see CalcGaussLegendreSamplingPoints.

Definition at line 2827 of file TF1.cxx.

◆ IntegralMultiple() [1/3]

Double_t TF1::IntegralMultiple ( Int_t n,
const Double_t * a,
const Double_t * b,
Double_t epsrel,
Double_t & relerr )
virtualinherited

See more general prototype below.

This interface kept for back compatibility It is recommended to use the other interface where one can specify also epsabs and the maximum number of points

Definition at line 2847 of file TF1.cxx.

◆ IntegralMultiple() [2/3]

Double_t TF1::IntegralMultiple ( Int_t n,
const Double_t * a,
const Double_t * b,
Int_t maxpts,
Double_t epsrel,
Double_t epsabs,
Double_t & relerr,
Int_t & nfnevl,
Int_t & ifail )
virtualinherited

This function computes, to an attempted specified accuracy, the value of the integral.

Parameters
[in]nNumber of dimensions [2,15]
[in]a,bOne-dimensional arrays of length >= N . On entry A[i], and B[i], contain the lower and upper limits of integration, respectively.
[in]maxptsMaximum number of function evaluations to be allowed. maxpts >= 2^n +2*n*(n+1) +1 if maxpts<minpts, maxpts is set to 10*minpts
[in]epsrelSpecified relative accuracy.
[in]epsabsSpecified absolute accuracy. The integration algorithm will attempt to reach either the relative or the absolute accuracy. In case the maximum function called is reached the algorithm will stop earlier without having reached the desired accuracy
[out]relerrContains, on exit, an estimation of the relative accuracy of the result.
[out]nfnevlnumber of function evaluations performed.
[out]ifail

0 Normal exit. At least minpts and at most maxpts calls to the function were performed.

1 maxpts is too small for the specified accuracy eps. The result and relerr contain the values obtainable for the specified value of maxpts.

3 n<2 or n>15

Method:

The default method used is the Genz-Mallik adaptive multidimensional algorithm using the class ROOT::Math::AdaptiveIntegratorMultiDim (see the reference documentation of the class)

Other methods can be used by setting ROOT::Math::IntegratorMultiDimOptions::SetDefaultIntegrator() to different integrators. Other possible integrators are MC integrators based on the ROOT::Math::GSLMCIntegrator class Possible methods are : Vegas, Miser or Plain IN case of MC integration the accuracy is determined by the number of function calls, one should be careful not to use a too large value of maxpts

Definition at line 2900 of file TF1.cxx.

◆ IntegralMultiple() [3/3]

virtual Double_t TF1::IntegralMultiple ( Int_t n,
const Double_t * a,
const Double_t * b,
Int_t ,
Int_t maxpts,
Double_t epsrel,
Double_t & relerr,
Int_t & nfnevl,
Int_t & ifail )
inlinevirtualinherited

Definition at line 557 of file TF1.h.

◆ IntegralOneDim()

Double_t TF1::IntegralOneDim ( Double_t a,
Double_t b,
Double_t epsrel,
Double_t epsabs,
Double_t & error )
virtualinherited

Return Integral of function between a and b using the given parameter values and relative and absolute tolerance.

The default integrator defined in ROOT::Math::IntegratorOneDimOptions::DefaultIntegrator() is used If ROOT contains the MathMore library the default integrator is set to be the adaptive ROOT::Math::GSLIntegrator (based on QUADPACK) or otherwise the ROOT::Math::GaussIntegrator is used See the reference documentation of these classes for more information about the integration algorithms To change integration algorithm just do : ROOT::Math::IntegratorOneDimOptions::SetDefaultIntegrator(IntegratorName); Valid integrator names are:

In order to use the GSL integrators one needs to have the MathMore library installed

Note 1:

Values of the function f(x) at the interval end-points A and B are not required. The subprogram may therefore be used when these values are undefined.

Note 2:

Instead of TF1::Integral, you may want to use the combination of TF1::CalcGaussLegendreSamplingPoints and TF1::IntegralFast. See an example with the following script:

void gint() {
TF1 *g = new TF1("g","gaus",-5,5);
g->SetParameters(1,0,1);
//default gaus integration method uses 6 points
//not suitable to integrate on a large domain
double r1 = g->Integral(0,5);
double r2 = g->Integral(0,1000);
//try with user directives computing more points
Int_t np = 1000;
double *x=new double[np];
double *w=new double[np];
g->CalcGaussLegendreSamplingPoints(np,x,w,1e-15);
double r3 = g->IntegralFast(np,x,w,0,5);
double r4 = g->IntegralFast(np,x,w,0,1000);
double r5 = g->IntegralFast(np,x,w,0,10000);
double r6 = g->IntegralFast(np,x,w,0,100000);
printf("g->Integral(0,5) = %g\n",r1);
printf("g->Integral(0,1000) = %g\n",r2);
printf("g->IntegralFast(n,x,w,0,5) = %g\n",r3);
printf("g->IntegralFast(n,x,w,0,1000) = %g\n",r4);
printf("g->IntegralFast(n,x,w,0,10000) = %g\n",r5);
printf("g->IntegralFast(n,x,w,0,100000)= %g\n",r6);
delete [] x;
delete [] w;
}
#define g(i)
Definition RSha256.hxx:105
#define e(i)
Definition RSha256.hxx:103
Option_t Option_t TPoint TPoint const char GetTextMagnitude GetFillStyle GetLineColor GetLineWidth GetMarkerStyle GetTextAlign GetTextColor GetTextSize void char Point_t Rectangle_t WindowAttributes_t Float_t Float_t Float_t Int_t Int_t UInt_t UInt_t Rectangle_t Int_t Int_t Window_t TString Int_t GCValues_t GetPrimarySelectionOwner GetDisplay GetScreen GetColormap GetNativeEvent const char const char dpyName wid window const char font_name cursor keysym reg const char only_if_exist regb h Point_t np
1-Dim function class
Definition TF1.h:182
TF1()
TF1 default constructor.
Definition TF1.cxx:490

This example produces the following results:

g->Integral(0,5) = 1.25331
g->Integral(0,1000) = 1.25319
g->IntegralFast(n,x,w,0,5) = 1.25331
g->IntegralFast(n,x,w,0,1000) = 1.25331
g->IntegralFast(n,x,w,0,10000) = 1.25331
g->IntegralFast(n,x,w,0,100000)= 1.253

Definition at line 2670 of file TF1.cxx.

◆ IntegrateForNormalization()

void TF1::IntegrateForNormalization ( )
protectedinherited

◆ InvertBit()

void TObject::InvertBit ( UInt_t f)
inlineinherited

Definition at line 206 of file TObject.h.

◆ IsA()

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

Reimplemented from TF1.

Definition at line 51 of file TF12.h.

◆ IsDestructed()

Bool_t TObject::IsDestructed ( ) const
inlineinherited

IsDestructed.

Note
This function must be non-virtual as it can be used on destructed (but not yet modified) memory. This is used for example in TClonesArray to record the element that have been destructed but not deleted and thus are ready for re-use (by operator new with placement).
Returns
true if this object's destructor has been run.

Definition at line 186 of file TObject.h.

◆ IsEqual()

Bool_t TObject::IsEqual ( const TObject * obj) const
virtualinherited

Default equal comparison (objects are equal if they have the same address in memory).

More complicated classes might want to override this function.

Reimplemented in TObjString, TQCommand, TPair, and TGObject.

Definition at line 589 of file TObject.cxx.

◆ IsEvalNormalized()

virtual Bool_t TF1::IsEvalNormalized ( ) const
inlinevirtualinherited

Definition at line 562 of file TF1.h.

◆ IsFolder()

◆ IsInside()

virtual Bool_t TF1::IsInside ( const Double_t * x) const
inlinevirtualinherited

return kTRUE if the point is inside the function range

Reimplemented in TF2, and TF3.

Definition at line 567 of file TF1.h.

◆ IsLinear()

virtual Bool_t TF1::IsLinear ( ) const
inlinevirtualinherited

Definition at line 571 of file TF1.h.

◆ IsOnHeap()

R__ALWAYS_INLINE Bool_t TObject::IsOnHeap ( ) const
inlineinherited

Definition at line 160 of file TObject.h.

◆ IsSortable()

Bool_t TNamed::IsSortable ( ) const
inlineoverridevirtualinherited

Reimplemented from TObject.

Reimplemented in TStructNodeProperty.

Definition at line 52 of file TNamed.h.

◆ IsTransparent()

Bool_t TAttFill::IsTransparent ( ) const
inlinevirtualinherited

Reimplemented in TGWin32VirtualXProxy.

Definition at line 49 of file TAttFill.h.

◆ IsValid()

Bool_t TF1::IsValid ( ) const
virtualinherited

Return kTRUE if the function is valid.

Definition at line 2931 of file TF1.cxx.

◆ IsVectorized()

bool TF1::IsVectorized ( )
inlineinherited

Definition at line 404 of file TF1.h.

◆ IsZombie()

R__ALWAYS_INLINE Bool_t TObject::IsZombie ( ) const
inlineinherited

Definition at line 161 of file TObject.h.

◆ ls()

void TNamed::ls ( Option_t * option = "") const
overridevirtualinherited

List TNamed name and title.

Reimplemented from TObject.

Reimplemented in ROOT::Experimental::XRooFit::xRooBrowser, TVirtualStreamerInfo, TROOT, TStreamerElement, TStreamerBase, TStreamerSTL, TText, TStreamerInfo, TTask, and TNode.

Definition at line 112 of file TNamed.cxx.

◆ MakeZombie()

void TObject::MakeZombie ( )
inlineprotectedinherited

Definition at line 55 of file TObject.h.

◆ MayNotUse()

void TObject::MayNotUse ( const char * method) const
inherited

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).

Definition at line 1160 of file TObject.cxx.

◆ Mean()

virtual Double_t TF1::Mean ( Double_t a,
Double_t b,
const Double_t * params = nullptr,
Double_t epsilon = 0.000001 )
inlinevirtualinherited

Definition at line 674 of file TF1.h.

◆ Modify() [1/3]

void TAttFill::Modify ( )
virtualinherited

Change current fill area attributes if necessary.

Definition at line 212 of file TAttFill.cxx.

◆ Modify() [2/3]

void TAttLine::Modify ( )
virtualinherited

Change current line attributes if necessary.

Definition at line 246 of file TAttLine.cxx.

◆ Modify() [3/3]

void TAttMarker::Modify ( )
virtualinherited

Change current marker attributes if necessary.

Definition at line 322 of file TAttMarker.cxx.

◆ ModifyOn() [1/3]

void TAttFill::ModifyOn ( TVirtualPad & pad)
virtualinherited

Change current fill area attributes on speicifed pad.

Definition at line 221 of file TAttFill.cxx.

◆ ModifyOn() [2/3]

void TAttLine::ModifyOn ( TVirtualPad & pad)
virtualinherited

Change current line attributes on specified pad.

Definition at line 255 of file TAttLine.cxx.

◆ ModifyOn() [3/3]

void TAttMarker::ModifyOn ( TVirtualPad & pad)
virtualinherited

Change current marker attributes if necessary on specified pad.

Definition at line 331 of file TAttMarker.cxx.

◆ Moment()

Double_t TF1::Moment ( Double_t n,
Double_t a,
Double_t b,
const Double_t * params = nullptr,
Double_t epsilon = 0.000001 )
virtualinherited

Return nth moment of function between a and b.

See TF1::Integral() for parameter definitions

Definition at line 3742 of file TF1.cxx.

◆ Notify()

Bool_t TObject::Notify ( )
virtualinherited

This method must be overridden to handle object notification (the base implementation is no-op).

Different objects in ROOT use the Notify method for different purposes, in coordination with other objects that call this method at the appropriate time.

For example, TLeaf uses it to load class information; TBranchRef to load contents of referenced branches TBranchRef; most notably, based on Notify, TChain implements a callback mechanism to inform interested parties when it switches to a new sub-tree.

Reimplemented in TMessageHandler, TNotifyLink< Type >, TNotifyLink< RNoCleanupNotifierHelper >, TNotifyLink< ROOT::Detail::TBranchProxy >, TNotifyLink< TTreeReader >, TFileHandler, TSignalHandler, TStdExceptionHandler, TProcessEventTimer, TTimer, TIdleTimer, TSingleShotCleaner, TCollection, TRefTable, TBrowserTimer, TInterruptHandler, TTermInputHandler, TThreadTimer, TGLRedrawTimer, TViewTimer, TGContainerKeyboardTimer, TGContainerScrollTimer, TGInputHandler, TViewUpdateTimer, TPopupDelayTimer, TRepeatTimer, TSBRepeatTimer, TGTextEditHist, TInsCharCom, TDelCharCom, TBreakLineCom, TInsTextCom, TDelTextCom, TBlinkTimer, TTipDelayTimer, TGuiBldDragManagerRepeatTimer, TARInterruptHandler, TASLogHandler, TASInterruptHandler, TASSigPipeHandler, TASInputHandler, TSocketHandler, TTimeOutTimer, TBranchElement, TBranchRef, TLeafObject, TSelector, TTree, TSelectorDraw, TSelectorEntries, TTreeFormula, TTreeFormulaManager, TTreeReader, h1analysis, h1analysisTreeReader, and TSysEvtHandler.

Definition at line 618 of file TObject.cxx.

◆ Obsolete()

void TObject::Obsolete ( const char * method,
const char * asOfVers,
const char * removedFromVers ) const
inherited

Use this method to declare a method obsolete.

Specify as of which version the method is obsolete and as from which version it will be removed.

Definition at line 1169 of file TObject.cxx.

◆ operator delete() [1/3]

void TObject::operator delete ( void * ptr,
size_t size )
inherited

Operator delete for sized deallocation.

Definition at line 1234 of file TObject.cxx.

◆ operator delete() [2/3]

void TObject::operator delete ( void * ptr)
inherited

Operator delete.

Definition at line 1212 of file TObject.cxx.

◆ operator delete() [3/3]

void TObject::operator delete ( void * ptr,
void * vp )
inherited

Only called by placement new when throwing an exception.

Definition at line 1266 of file TObject.cxx.

◆ operator delete[]() [1/3]

void TObject::operator delete[] ( void * ptr,
size_t size )
inherited

Operator delete [] for sized deallocation.

Definition at line 1245 of file TObject.cxx.

◆ operator delete[]() [2/3]

void TObject::operator delete[] ( void * ptr)
inherited

Operator delete [].

Definition at line 1223 of file TObject.cxx.

◆ operator delete[]() [3/3]

void TObject::operator delete[] ( void * ptr,
void * vp )
inherited

Only called by placement new[] when throwing an exception.

Definition at line 1274 of file TObject.cxx.

◆ operator new() [1/2]

void * TObject::operator new ( size_t sz)
inlineinherited

Definition at line 189 of file TObject.h.

◆ operator new() [2/2]

void * TObject::operator new ( size_t sz,
void * vp )
inlineinherited

Definition at line 191 of file TObject.h.

◆ operator new[]() [1/2]

void * TObject::operator new[] ( size_t sz)
inlineinherited

Definition at line 190 of file TObject.h.

◆ operator new[]() [2/2]

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

Definition at line 192 of file TObject.h.

◆ operator()() [1/2]

template<class T >
T TF1::operator() ( const T * x,
const Double_t * params = nullptr )
inlineinherited

Definition at line 768 of file TF1.h.

◆ operator()() [2/2]

Double_t TF1::operator() ( Double_t x,
Double_t y = 0,
Double_t z = 0,
Double_t t = 0 ) const
inlinevirtualinherited

Definition at line 762 of file TF1.h.

◆ Paint()

void TF1::Paint ( Option_t * option = "")
overridevirtualinherited

Paint this function with its current attributes.

The function is going to be converted in an histogram and the corresponding histogram is painted. The painted histogram can be retrieved calling afterwards the method TF1::GetHistogram()

Reimplemented from TObject.

Reimplemented in TF2, and TF3.

Definition at line 3002 of file TF1.cxx.

◆ Pop()

void TObject::Pop ( )
virtualinherited

Pop on object drawn in a pad to the top of the display list.

I.e. it will be drawn last and on top of all other primitives.

Reimplemented in TPad, TFrame, and TVirtualPad.

Definition at line 640 of file TObject.cxx.

◆ Print()

void TF1::Print ( Option_t * option = "") const
overridevirtualinherited

This method must be overridden when a class wants to print itself.

Reimplemented from TObject.

Definition at line 2946 of file TF1.cxx.

◆ ProvideSaveName()

TString TF1::ProvideSaveName ( Option_t * option)
protectedinherited

Provide variable name for function for saving as primitive When TH1 or TGraph stores list of functions, it applies special coding of created variable names.

Definition at line 3269 of file TF1.cxx.

◆ Read()

Int_t TObject::Read ( const char * name)
virtualinherited

Read contents of object with specified name from the current directory.

First the key with the given name is searched in the current directory, next the key buffer is deserialized into the object. The object must have been created before via the default constructor. See TObject::Write().

Reimplemented in TKeyXML, TBuffer, TKey, and TKeySQL.

Definition at line 673 of file TObject.cxx.

◆ RecursiveRemove()

◆ RejectedPoint()

Bool_t TF1::RejectedPoint ( )
staticinherited

See TF1::RejectPoint above.

Definition at line 3732 of file TF1.cxx.

◆ RejectPoint()

void TF1::RejectPoint ( Bool_t reject = kTRUE)
staticinherited

Static function to set the global flag to reject points the fgRejectPoint global flag is tested by all fit functions if TRUE the point is not included in the fit.

This flag can be set by a user in a fitting function. The fgRejectPoint flag is reset by the TH1 and TGraph fitting functions.

Definition at line 3723 of file TF1.cxx.

◆ ReleaseParameter()

void TF1::ReleaseParameter ( Int_t ipar)
virtualinherited

Release parameter number ipar during a fit operation.

After releasing it, the parameter can vary freely in the fit. The parameter limits are reset to 0,0.

Definition at line 3201 of file TF1.cxx.

◆ ResetAttFill()

void TAttFill::ResetAttFill ( Option_t * option = "")
virtualinherited

Reset this fill attributes to default values.

Reimplemented in TGWin32VirtualXProxy.

Definition at line 231 of file TAttFill.cxx.

◆ ResetAttLine()

void TAttLine::ResetAttLine ( Option_t * option = "")
virtualinherited

Reset this line attributes to default values.

Reimplemented in TGWin32VirtualXProxy.

Definition at line 279 of file TAttLine.cxx.

◆ ResetAttMarker()

void TAttMarker::ResetAttMarker ( Option_t * toption = "")
virtualinherited

Reset this marker attributes to the default values.

Reimplemented in TGWin32VirtualXProxy.

Definition at line 342 of file TAttMarker.cxx.

◆ ResetBit()

void TObject::ResetBit ( UInt_t f)
inlineinherited

Definition at line 203 of file TObject.h.

◆ Save()

void TF1::Save ( Double_t xmin,
Double_t xmax,
Double_t ymin,
Double_t ymax,
Double_t zmin,
Double_t zmax )
virtualinherited

Save values of function in array fSave.

Reimplemented in TF2, and TF3.

Definition at line 3211 of file TF1.cxx.

◆ SaveAs()

void TObject::SaveAs ( const char * filename = "",
Option_t * option = "" ) const
virtualinherited

Save this object in the file specified by filename.

  • if "filename" contains ".root" the object is saved in filename as root binary file.
  • if "filename" contains ".xml" the object is saved in filename as a xml ascii file.
  • if "filename" contains ".cc" the object is saved in filename as C code independent from ROOT. The code is generated via SavePrimitive(). Specific code should be implemented in each object to handle this option. Like in TF1::SavePrimitive().
  • otherwise the object is written to filename as a CINT/C++ script. The C++ code to rebuild this object is generated via SavePrimitive(). The "option" parameter is passed to SavePrimitive. By default it is an empty string. It can be used to specify the Draw option in the code generated by SavePrimitive.

    The function is available via the object context menu.

Reimplemented in TSpline, TFolder, TGeoVolume, TClassTree, TPad, TPaveClass, TGObject, TSpline3, TSpline5, ROOT::Experimental::XRooFit::xRooNode, TTreePerfStats, TVirtualPad, TGraph, and TH1.

Definition at line 708 of file TObject.cxx.

◆ SaveFillAttributes()

void TAttFill::SaveFillAttributes ( std::ostream & out,
const char * name,
Int_t coldef = 1,
Int_t stydef = 1001 )
virtualinherited

Save fill attributes as C++ statement(s) on output stream out.

Definition at line 240 of file TAttFill.cxx.

◆ SaveLineAttributes()

void TAttLine::SaveLineAttributes ( std::ostream & out,
const char * name,
Int_t coldef = 1,
Int_t stydef = 1,
Int_t widdef = 1 )
virtualinherited

Save line attributes as C++ statement(s) on output stream out.

Definition at line 289 of file TAttLine.cxx.

◆ SaveMarkerAttributes()

void TAttMarker::SaveMarkerAttributes ( std::ostream & out,
const char * name,
Int_t coldef = 1,
Int_t stydef = 1,
Int_t sizdef = 1 )
virtualinherited

Save line attributes as C++ statement(s) on output stream out.

Definition at line 352 of file TAttMarker.cxx.

◆ SavePrimitive()

void TF12::SavePrimitive ( std::ostream & out,
Option_t * option = "" )
overridevirtual

Save primitive as a C++ statement(s) on output stream out.

Reimplemented from TF1.

Definition at line 175 of file TF12.cxx.

◆ SavePrimitiveConstructor()

void TObject::SavePrimitiveConstructor ( std::ostream & out,
TClass * cl,
const char * variable_name,
const char * constructor_agrs = "",
Bool_t empty_line = kTRUE )
staticprotectedinherited

Save object constructor in the output stream "out".

Can be used as first statement when implementing SavePrimitive() method for the object

Definition at line 777 of file TObject.cxx.

◆ SavePrimitiveDraw()

void TObject::SavePrimitiveDraw ( std::ostream & out,
const char * variable_name,
Option_t * option = nullptr )
staticprotectedinherited

Save invocation of primitive Draw() method Skipped if option contains "nodraw" string.

Definition at line 845 of file TObject.cxx.

◆ SavePrimitiveNameTitle()

void TNamed::SavePrimitiveNameTitle ( std::ostream & out,
const char * variable_name )
protectedinherited

Save object name and title into the output stream "out".

Definition at line 135 of file TNamed.cxx.

◆ SavePrimitiveVector()

TString TObject::SavePrimitiveVector ( std::ostream & out,
const char * prefix,
Int_t len,
Double_t * arr,
Int_t flag = 0 )
staticprotectedinherited

Save array in the output stream "out" as vector.

Create unique variable name based on prefix value Returns name of vector which can be used in constructor or in other places of C++ code If flag === kTRUE, just add empty line If flag === 111, check if array is empty and return nullptr or <vectorname>.data()

Definition at line 796 of file TObject.cxx.

◆ SetBit() [1/2]

void TObject::SetBit ( UInt_t f)
inlineinherited

Definition at line 202 of file TObject.h.

◆ SetBit() [2/2]

void TObject::SetBit ( UInt_t f,
Bool_t set )
inherited

Set or unset the user status bits as specified in f.

Definition at line 888 of file TObject.cxx.

◆ SetChisquare()

virtual void TF1::SetChisquare ( Double_t chi2)
inlinevirtualinherited

Definition at line 581 of file TF1.h.

◆ SetCurrent()

void TF1::SetCurrent ( TF1 * f1)
staticinherited

Static function setting the current function.

the current function may be accessed in static C-like functions when fitting or painting a function.

Definition at line 3398 of file TF1.cxx.

◆ SetDrawOption()

void TObject::SetDrawOption ( Option_t * option = "")
virtualinherited

Set drawing option for object.

This option only affects the drawing style and is stored in the option field of the TObjOptLink supporting a TPad's primitive list (TList). Note that it does not make sense to call object.SetDrawOption(option) before having called object.Draw().

Reimplemented in TSystemDirectory, TSystemFile, TPad, TGFrame, TAxis, TBrowser, TPaveStats, TGedFrame, TRootBrowserLite, and RooPlot.

Definition at line 871 of file TObject.cxx.

◆ SetDtorOnly()

void TObject::SetDtorOnly ( void * obj)
staticinherited

Set destructor only flag.

Definition at line 1204 of file TObject.cxx.

◆ SetFillAttributes()

void TAttFill::SetFillAttributes ( )
virtualinherited

Invoke the DialogCanvas Fill attributes.

Reimplemented in TGWin32VirtualXProxy.

Definition at line 251 of file TAttFill.cxx.

◆ SetFillColor() [1/2]

virtual void TAttFill::SetFillColor ( Color_t fcolor)
inlinevirtualinherited

Set the fill area color.

Reimplemented in TVirtualX, TGQuartz, TGWin32, TGWin32VirtualXProxy, TGX11, TPDF, TPostScript, TSVG, TTeXDump, TSpider, and TGraphMultiErrors.

Definition at line 40 of file TAttFill.h.

◆ SetFillColor() [2/2]

void TAttFill::SetFillColor ( TColorNumber lcolor)
inherited

Set a fill color.

Definition at line 270 of file TAttFill.cxx.

◆ SetFillColorAlpha()

void TAttFill::SetFillColorAlpha ( Color_t fcolor,
Float_t falpha )
virtualinherited

Set a transparent fill color.

Parameters
fcolordefines the fill color
falphadefines the percentage of opacity from 0. (fully transparent) to 1. (fully opaque).
Note
falpha is ignored (treated as 1) if the TCanvas has no GL support activated.

Reimplemented in TGraphMultiErrors.

Definition at line 262 of file TAttFill.cxx.

◆ SetFillStyle()

virtual void TAttFill::SetFillStyle ( Style_t fstyle)
inlinevirtualinherited

Set the fill area style.

Reimplemented in TGraphMultiErrors, TPad, TSpider, TVirtualX, TGQuartz, TGWin32, TGWin32VirtualXProxy, and TGX11.

Definition at line 42 of file TAttFill.h.

◆ SetFitResult()

void TF1::SetFitResult ( const ROOT::Fit::FitResult & result,
const Int_t * indpar = nullptr )
virtualinherited

Set the result from the fit parameter values, errors, chi2, etc... Optionally a pointer to a vector (with size fNpar) of the parameter indices in the FitResult can be passed This is useful in the case of a combined fit with different functions, and the FitResult contains the global result By default it is assume that indpar = {0,1,2,....,fNpar-1}.

Definition at line 3410 of file TF1.cxx.

◆ SetFunction() [1/2]

template<typename Func >
void TF1::SetFunction ( Func f)
inherited

Definition at line 823 of file TF1.h.

◆ SetFunction() [2/2]

template<class PtrObj , typename MemFn >
void TF1::SetFunction ( PtrObj & p,
MemFn memFn )
inherited

Definition at line 830 of file TF1.h.

◆ SetLineAttributes()

void TAttLine::SetLineAttributes ( )
virtualinherited

Invoke the DialogCanvas Line attributes.

Reimplemented in TGWin32VirtualXProxy.

Definition at line 306 of file TAttLine.cxx.

◆ SetLineColor() [1/2]

◆ SetLineColor() [2/2]

void TAttLine::SetLineColor ( TColorNumber lcolor)
inherited

Definition at line 322 of file TAttLine.cxx.

◆ SetLineColorAlpha()

void TAttLine::SetLineColorAlpha ( Color_t lcolor,
Float_t lalpha )
virtualinherited

Set a transparent line color.

Parameters
lcolordefines the line color
lalphadefines the percentage of opacity from 0. (fully transparent) to 1. (fully opaque).
Note
lalpha is ignored (treated as 1) if the TCanvas has no GL support activated.

Reimplemented in TGraphMultiErrors.

Definition at line 317 of file TAttLine.cxx.

◆ SetLineStyle()

virtual void TAttLine::SetLineStyle ( Style_t lstyle)
inlinevirtualinherited

◆ SetLineWidth()

◆ SetMarkerAttributes()

void TAttMarker::SetMarkerAttributes ( )
virtualinherited

Invoke the DialogCanvas Marker attributes.

Reimplemented in TGWin32VirtualXProxy.

Definition at line 365 of file TAttMarker.cxx.

◆ SetMarkerColor() [1/2]

◆ SetMarkerColor() [2/2]

void TAttMarker::SetMarkerColor ( TColorNumber lcolor)
inherited

Definition at line 381 of file TAttMarker.cxx.

◆ SetMarkerColorAlpha()

void TAttMarker::SetMarkerColorAlpha ( Color_t mcolor,
Float_t malpha )
virtualinherited

Set a transparent marker color.

Parameters
mcolordefines the marker color
malphadefines the percentage of opacity from 0. (fully transparent) to 1. (fully opaque).
Note
malpha is ignored (treated as 1) if the TCanvas has no GL support activated.

Definition at line 376 of file TAttMarker.cxx.

◆ SetMarkerSize()

virtual void TAttMarker::SetMarkerSize ( Size_t msize = 1)
inlinevirtualinherited

Set the marker size.

Note that the marker styles number 1 6 and 7 (the dots), cannot be scaled. They are meant to be very fast to draw and are always drawn with the same number of pixels; therefore this method does not apply on them.

Reimplemented in TVirtualX, TGQuartz, TGWin32, TGWin32VirtualXProxy, TGX11, TTeXDump, TEvePointSet, TEvePointSetArray, ROOT::Experimental::REvePointSet, ROOT::Experimental::REvePointSetArray, TEveTrackList, and ROOT::Experimental::REveTrackList.

Definition at line 48 of file TAttMarker.h.

◆ SetMarkerStyle()

virtual void TAttMarker::SetMarkerStyle ( Style_t mstyle = 1)
inlinevirtualinherited

◆ SetMaximum()

void TF1::SetMaximum ( Double_t maximum = -1111)
virtualinherited

Set the maximum value along Y for this function In case the function is already drawn, set also the maximum in the helper histogram.

Definition at line 3449 of file TF1.cxx.

◆ SetMinimum()

void TF1::SetMinimum ( Double_t minimum = -1111)
virtualinherited

Set the minimum value along Y for this function In case the function is already drawn, set also the minimum in the helper histogram.

Definition at line 3462 of file TF1.cxx.

◆ SetName()

void TNamed::SetName ( const char * name)
virtualinherited

Set the name of the TNamed.

WARNING: if the object is a member of a THashTable or THashList container the container must be Rehash()'ed after SetName(). For example the list of objects in the current directory is a THashList.

Reimplemented in TEveScene, TColor, TSystemDirectory, TSystemFile, TNode, TRotMatrix, TShape, TEfficiency, TFormula, TGraph2D, TH1, RooAbsArg, RooAbsData, RooDataHist, RooDataSet, RooFitResult, RooPlot, ROOT::Experimental::XRooFit::xRooNode, TChain, TEventList, TTree, TGraph, and TDirectory.

Definition at line 149 of file TNamed.cxx.

◆ SetNameTitle()

void TNamed::SetNameTitle ( const char * name,
const char * title )
virtualinherited

Set all the TNamed parameters (name and title).

WARNING: if the name is changed and the object is a member of a THashTable or THashList container the container must be Rehash()'ed after SetName(). For example the list of objects in the current directory is a THashList.

Reimplemented in TContextMenu, TNode, TGraph2D, TH1, RooAbsArg, RooAbsData, RooDataHist, RooDataSet, RooFitResult, RooPlot, and TGraph.

Definition at line 163 of file TNamed.cxx.

◆ SetNDF()

void TF1::SetNDF ( Int_t ndf)
virtualinherited

Set the number of degrees of freedom ndf should be the number of points used in a fit - the number of free parameters.

Definition at line 3474 of file TF1.cxx.

◆ SetNdim()

void TF1::SetNdim ( Int_t ndim)
inlineinherited

Definition at line 602 of file TF1.h.

◆ SetNormalized()

virtual void TF1::SetNormalized ( Bool_t flag)
inlinevirtualinherited

Definition at line 597 of file TF1.h.

◆ SetNpx()

void TF1::SetNpx ( Int_t npx = 100)
virtualinherited

Set the number of points used to draw the function.

The default number of points along x is 100 for 1-d functions and 30 for 2-d/3-d functions You can increase this value to get a better resolution when drawing pictures with sharp peaks or to get a better result when using TF1::GetRandom the minimum number of points is 4, the maximum is 10000000 for 1-d and 10000 for 2-d/3-d functions

Definition at line 3488 of file TF1.cxx.

◆ SetNumberFitPoints()

virtual void TF1::SetNumberFitPoints ( Int_t npfits)
inlinevirtualinherited

Definition at line 593 of file TF1.h.

◆ SetObjectStat()

void TObject::SetObjectStat ( Bool_t stat)
staticinherited

Turn on/off tracking of objects in the TObjectTable.

Definition at line 1188 of file TObject.cxx.

◆ SetParameter() [1/2]

virtual void TF1::SetParameter ( const TString & name,
Double_t value )
inlinevirtualinherited

Definition at line 613 of file TF1.h.

◆ SetParameter() [2/2]

virtual void TF1::SetParameter ( Int_t param,
Double_t value )
inlinevirtualinherited

Definition at line 608 of file TF1.h.

◆ SetParameters() [1/2]

virtual void TF1::SetParameters ( const Double_t * params)
inlinevirtualinherited

Definition at line 618 of file TF1.h.

◆ SetParameters() [2/2]

virtual void TF1::SetParameters ( double p0,
double p1 = TMath::QuietNaN(),
double p2 = TMath::QuietNaN(),
double p3 = TMath::QuietNaN(),
double p4 = TMath::QuietNaN(),
double p5 = TMath::QuietNaN(),
double p6 = TMath::QuietNaN(),
double p7 = TMath::QuietNaN(),
double p8 = TMath::QuietNaN(),
double p9 = TMath::QuietNaN(),
double p10 = TMath::QuietNaN() )
inlinevirtualinherited

Set parameter values.

NaN values will be skipped, meaning that the corresponding parameters will not be changed.

Definition at line 625 of file TF1.h.

◆ SetParent()

virtual void TF1::SetParent ( TObject * p = nullptr)
inlinevirtualinherited

Definition at line 647 of file TF1.h.

◆ SetParError()

void TF1::SetParError ( Int_t ipar,
Double_t error )
virtualinherited

Set error for parameter number ipar.

Definition at line 3534 of file TF1.cxx.

◆ SetParErrors()

void TF1::SetParErrors ( const Double_t * errors)
virtualinherited

Set errors for all active parameters when calling this function, the array errors must have at least fNpar values.

Definition at line 3545 of file TF1.cxx.

◆ SetParLimits()

void TF1::SetParLimits ( Int_t ipar,
Double_t parmin,
Double_t parmax )
virtualinherited

Set lower and upper limits for parameter ipar.

The specified limits will be used in a fit operation. Note that when this function is a pre-defined function (e.g. gaus) one needs to use the fit option "B" to have the limits used in the fit. See TH1::Fit(TF1*, Option_t *, Option_t *, Double_t, Double_t) for the fitting documentation and the fitting options

To fix a parameter, use TF1::FixParameter

Definition at line 3562 of file TF1.cxx.

◆ SetParName()

void TF1::SetParName ( Int_t ipar,
const char * name )
virtualinherited

Set name of parameter number ipar.

Definition at line 3505 of file TF1.cxx.

◆ SetParNames()

void TF1::SetParNames ( const char * name0 = "",
const char * name1 = "",
const char * name2 = "",
const char * name3 = "",
const char * name4 = "",
const char * name5 = "",
const char * name6 = "",
const char * name7 = "",
const char * name8 = "",
const char * name9 = "",
const char * name10 = "" )
virtualinherited

Set up to 10 parameter names.

Empty strings will be skipped, meaning that the corresponding name will not be changed.

Definition at line 3518 of file TF1.cxx.

◆ SetRange() [1/3]

void TF1::SetRange ( Double_t xmin,
Double_t xmax )
virtualinherited

Initialize the upper and lower bounds to draw the function.

The function range is also used in an histogram fit operation when the option "R" is specified.

Reimplemented in TF2, and TF3.

Definition at line 3583 of file TF1.cxx.

◆ SetRange() [2/3]

void TF1::SetRange ( Double_t xmin,
Double_t ymin,
Double_t xmax,
Double_t ymax )
inlinevirtualinherited

Reimplemented in TF2, and TF3.

Definition at line 813 of file TF1.h.

◆ SetRange() [3/3]

void TF1::SetRange ( Double_t xmin,
Double_t ymin,
Double_t zmin,
Double_t xmax,
Double_t ymax,
Double_t zmax )
inlinevirtualinherited

Reimplemented in TF2, and TF3.

Definition at line 817 of file TF1.h.

◆ SetSavedPoint()

void TF1::SetSavedPoint ( Int_t point,
Double_t value )
virtualinherited

Restore value of function saved at point.

Reimplemented in TF2.

Definition at line 3597 of file TF1.cxx.

◆ SetTitle()

void TF1::SetTitle ( const char * title = "")
overridevirtualinherited

Set function title if title has the form "fffffff;xxxx;yyyy", it is assumed that the function title is "fffffff" and "xxxx" and "yyyy" are the titles for the X and Y axis respectively.

Reimplemented from TNamed.

Definition at line 3613 of file TF1.cxx.

◆ SetUniqueID()

void TObject::SetUniqueID ( UInt_t uid)
virtualinherited

Set the unique object id.

Definition at line 899 of file TObject.cxx.

◆ SetVectorized()

virtual void TF1::SetVectorized ( Bool_t vectorized)
inlinevirtualinherited

Definition at line 656 of file TF1.h.

◆ SetXY()

void TF12::SetXY ( Double_t xy)
virtual

Set the value of the constant for the TF2.

constant in X when projecting along Y constant in Y when projecting along X The function title is set to include the value of the constant The current pad is updated

Definition at line 211 of file TF12.cxx.

◆ Sizeof()

Int_t TNamed::Sizeof ( ) const
virtualinherited

Return size of the TNamed part of the TObject.

Reimplemented in TSQLFile, TXMLFile, TDirectory, TDirectoryFile, TFile, and TKey.

Definition at line 182 of file TNamed.cxx.

◆ Streamer()

void TF12::Streamer ( TBuffer & b)
overridevirtual

Stream a class object.

Reimplemented from TF1.

◆ StreamerNVirtual()

void TF12::StreamerNVirtual ( TBuffer & ClassDef_StreamerNVirtual_b)
inline

Definition at line 51 of file TF12.h.

◆ SysError()

void TObject::SysError ( const char * location,
const char * fmt,
... ) const
virtualinherited

Issue system error message.

Use "location" to specify the method where the system error occurred. Accepts standard printf formatting arguments.

Definition at line 1112 of file TObject.cxx.

◆ TermCoeffLength()

int TF1::TermCoeffLength ( TString & term)
privateinherited

Definition at line 925 of file TF1.cxx.

◆ TestBit()

R__ALWAYS_INLINE Bool_t TObject::TestBit ( UInt_t f) const
inlineinherited

Definition at line 204 of file TObject.h.

◆ TestBits()

Int_t TObject::TestBits ( UInt_t f) const
inlineinherited

Definition at line 205 of file TObject.h.

◆ Update()

void TF1::Update ( )
virtualinherited

Called by functions such as SetRange, SetNpx, SetParameters to force the deletion of the associated histogram or Integral.

Definition at line 3674 of file TF1.cxx.

◆ UseCurrentStyle()

void TObject::UseCurrentStyle ( )
virtualinherited

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

Reimplemented in TCanvas, TPad, TFrame, TPaveStats, TPaveText, TAxis3D, TGraph, TH1, and TTree.

Definition at line 909 of file TObject.cxx.

◆ Variance()

virtual Double_t TF1::Variance ( Double_t a,
Double_t b,
const Double_t * params = nullptr,
Double_t epsilon = 0.000001 )
inlinevirtualinherited

Definition at line 678 of file TF1.h.

◆ Warning()

void TObject::Warning ( const char * location,
const char * fmt,
... ) const
virtualinherited

Issue warning message.

Use "location" to specify the method where the warning occurred. Accepts standard printf formatting arguments.

Definition at line 1084 of file TObject.cxx.

◆ Write() [1/2]

Int_t TObject::Write ( const char * name = nullptr,
Int_t option = 0,
Int_t bufsize = 0 )
virtualinherited

Write this object to the current directory.

For more see the const version of this method.

Reimplemented in TSQLFile, TXMLFile, TDirectory, TBuffer, ROOT::TBufferMergerFile, TDirectoryFile, TFile, TParallelMergingFile, TCollection, TMap, and TTree.

Definition at line 989 of file TObject.cxx.

◆ Write() [2/2]

Int_t TObject::Write ( const char * name = nullptr,
Int_t option = 0,
Int_t bufsize = 0 ) const
virtualinherited

Write this object to the current directory.

The data structure corresponding to this object is serialized. The corresponding buffer is written to the current directory with an associated key with name "name".

Writing an object to a file involves the following steps:

  • Creation of a support TKey object in the current directory. The TKey object creates a TBuffer object.
  • The TBuffer object is filled via the class::Streamer function.
  • If the file is compressed (default) a second buffer is created to hold the compressed buffer.
  • Reservation of the corresponding space in the file by looking in the TFree list of free blocks of the file.
  • The buffer is written to the file.

Bufsize can be given to force a given buffer size to write this object. By default, the buffersize will be taken from the average buffer size of all objects written to the current file so far.

If a name is specified, it will be the name of the key. If name is not given, the name of the key will be the name as returned by GetName().

The option can be a combination of: kSingleKey, kOverwrite or kWriteDelete Using the kOverwrite option a previous key with the same name is overwritten. The previous key is deleted before writing the new object. Using the kWriteDelete option a previous key with the same name is deleted only after the new object has been written. This option is safer than kOverwrite but it is slower. NOTE: Neither kOverwrite nor kWriteDelete reduces the size of a TFile– the space is simply freed up to be overwritten; in the case of a TTree, it is more complicated. If one opens a TTree, appends some entries, then writes it out, the behaviour is effectively the same. If, however, one creates a new TTree and writes it out in this way, only the metadata is replaced, effectively making the old data invisible without deleting it. TTree::Delete() can be used to mark all disk space occupied by a TTree as free before overwriting its metadata this way. The kSingleKey option is only used by TCollection::Write() to write a container with a single key instead of each object in the container with its own key.

An object is read from the file into memory via TKey::Read() or via TObject::Read().

The function returns the total number of bytes written to the file. It returns 0 if the object cannot be written.

Reimplemented in TSQLFile, TXMLFile, TDirectory, TBuffer, TDirectoryFile, TFile, TParallelMergingFile, TCollection, TMap, and TTree.

Definition at line 964 of file TObject.cxx.

Member Data Documentation

◆ fAlpha

std::vector<Double_t> TF1::fAlpha
protectedinherited

! Array alpha. for each bin in x the deconvolution r of fIntegral

Definition at line 228 of file TF1.h.

◆ fBeta

std::vector<Double_t> TF1::fBeta
protectedinherited

! Array beta. is approximated by x = alpha +beta*r *gamma*r**2

Definition at line 229 of file TF1.h.

◆ fBits

UInt_t TObject::fBits
privateinherited

bit field status word

Definition at line 47 of file TObject.h.

◆ fCase

Int_t TF12::fCase
protected

Projection along X(0), or Y(1)

Definition at line 29 of file TF12.h.

◆ fChisquare

Double_t TF1::fChisquare {}
protectedinherited

Function fit chisquare.

Definition at line 220 of file TF1.h.

◆ fComposition

std::unique_ptr<TF1AbsComposition> TF1::fComposition
protectedinherited

Pointer to composition (NSUM or CONV)

Definition at line 239 of file TF1.h.

◆ fF2

TF2* TF12::fF2
protected

Pointer to the mother TF2.

Definition at line 30 of file TF12.h.

◆ fFillColor

Color_t TAttFill::fFillColor
protectedinherited

Fill area color.

Definition at line 24 of file TAttFill.h.

◆ fFillStyle

Style_t TAttFill::fFillStyle
protectedinherited

Fill area style.

Definition at line 25 of file TAttFill.h.

◆ fFormula

std::unique_ptr<TFormula> TF1::fFormula
protectedinherited

Pointer to TFormula in case when user define formula.

Definition at line 237 of file TF1.h.

◆ fFunctor

std::unique_ptr<TF1FunctorPointer> TF1::fFunctor
protectedinherited

! Functor object to wrap any C++ callable object

Definition at line 236 of file TF1.h.

◆ fgAbsValue

std::atomic< Bool_t > TF1::fgAbsValue
staticprotectedinherited

Definition at line 273 of file TF1.h.

◆ fgAddToGlobList

std::atomic< Bool_t > TF1::fgAddToGlobList
staticprotectedinherited

Definition at line 275 of file TF1.h.

◆ fGamma

std::vector<Double_t> TF1::fGamma
protectedinherited

! Array gamma.

Definition at line 230 of file TF1.h.

◆ fgCurrent

TF1 * TF1::fgCurrent = nullptr
staticprotectedinherited

Definition at line 276 of file TF1.h.

◆ fgDtorOnly

Longptr_t TObject::fgDtorOnly = 0
staticprivateinherited

object for which to call dtor only (i.e. no delete)

Definition at line 49 of file TObject.h.

◆ fgObjectStat

Bool_t TObject::fgObjectStat = kTRUE
staticprivateinherited

if true keep track of objects in TObjectTable

Definition at line 50 of file TObject.h.

◆ fgRejectPoint

Bool_t TF1::fgRejectPoint = kFALSE
staticprotectedinherited

Definition at line 274 of file TF1.h.

◆ fHistogram

TH1* TF1::fHistogram {nullptr}
protectedinherited

! Pointer to histogram used for visualisation

Definition at line 232 of file TF1.h.

◆ fIntegral

std::vector<Double_t> TF1::fIntegral
protectedinherited

! Integral of function binned on fNpx bins

Definition at line 227 of file TF1.h.

◆ fLineColor

Color_t TAttLine::fLineColor
protectedinherited

Line color.

Definition at line 24 of file TAttLine.h.

◆ fLineStyle

Style_t TAttLine::fLineStyle
protectedinherited

Line style.

Definition at line 25 of file TAttLine.h.

◆ fLineWidth

Width_t TAttLine::fLineWidth
protectedinherited

Line width.

Definition at line 26 of file TAttLine.h.

◆ fMarkerColor

Color_t TAttMarker::fMarkerColor
protectedinherited

Marker color.

Definition at line 24 of file TAttMarker.h.

◆ fMarkerSize

Size_t TAttMarker::fMarkerSize
protectedinherited

Marker size.

Definition at line 26 of file TAttMarker.h.

◆ fMarkerStyle

Style_t TAttMarker::fMarkerStyle
protectedinherited

Marker style.

Definition at line 25 of file TAttMarker.h.

◆ fMaximum

Double_t TF1::fMaximum {-1111}
protectedinherited

Maximum value for plotting.

Definition at line 222 of file TF1.h.

◆ fMethodCall

std::unique_ptr<TMethodCall> TF1::fMethodCall
protectedinherited

! Pointer to MethodCall in case of interpreted function

Definition at line 233 of file TF1.h.

◆ fMinimum

Double_t TF1::fMinimum {-1111}
protectedinherited

Minimum value for plotting.

Definition at line 221 of file TF1.h.

◆ fName

TString TNamed::fName
protectedinherited

Definition at line 32 of file TNamed.h.

◆ fNDF

Int_t TF1::fNDF {}
protectedinherited

Number of degrees of freedom in the fit.

Definition at line 219 of file TF1.h.

◆ fNdim

Int_t TF1::fNdim {}
protectedinherited

Function dimension.

Definition at line 215 of file TF1.h.

◆ fNormalized

Bool_t TF1::fNormalized {false}
protectedinherited

Normalization option (false by default)

Definition at line 234 of file TF1.h.

◆ fNormIntegral

Double_t TF1::fNormIntegral {}
protectedinherited

Integral of the function before being normalized.

Definition at line 235 of file TF1.h.

◆ fNpar

Int_t TF1::fNpar {}
protectedinherited

Number of parameters.

Definition at line 214 of file TF1.h.

◆ fNpfits

Int_t TF1::fNpfits {}
protectedinherited

Number of points used in the fit.

Definition at line 218 of file TF1.h.

◆ fNpx

Int_t TF1::fNpx {100}
protectedinherited

Number of points used for the graphical representation.

Definition at line 216 of file TF1.h.

◆ fParams

std::unique_ptr<TF1Parameters> TF1::fParams
protectedinherited

Pointer to Function parameters object (exists only for not-formula functions)

Definition at line 238 of file TF1.h.

◆ fParent

TObject* TF1::fParent {nullptr}
protectedinherited

! Parent object hooking this function (if one)

Definition at line 231 of file TF1.h.

◆ fParErrors

std::vector<Double_t> TF1::fParErrors
protectedinherited

Array of errors of the fNpar parameters.

Definition at line 223 of file TF1.h.

◆ fParMax

std::vector<Double_t> TF1::fParMax
protectedinherited

Array of upper limits of the fNpar parameters.

Definition at line 225 of file TF1.h.

◆ fParMin

std::vector<Double_t> TF1::fParMin
protectedinherited

Array of lower limits of the fNpar parameters.

Definition at line 224 of file TF1.h.

◆ fSave

std::vector<Double_t> TF1::fSave
protectedinherited

Array of fNsave function values.

Definition at line 226 of file TF1.h.

◆ fTitle

TString TNamed::fTitle
protectedinherited

Definition at line 33 of file TNamed.h.

◆ fType

EFType TF1::fType {EFType::kTemplScalar}
protectedinherited

Definition at line 217 of file TF1.h.

◆ fUniqueID

UInt_t TObject::fUniqueID
privateinherited

object unique identifier

Definition at line 46 of file TObject.h.

◆ fXmax

Double_t TF1::fXmax {-1111}
protectedinherited

Upper bounds for the range.

Definition at line 213 of file TF1.h.

◆ fXmin

Double_t TF1::fXmin {-1111}
protectedinherited

Lower bounds for the range.

Definition at line 212 of file TF1.h.

◆ fXY

Double_t TF12::fXY
protected

Value along Y (if projection X) or X (if projection Y)

Definition at line 28 of file TF12.h.


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