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

A class providing multidimensional binning.

The class implements multidimensional binning by constructing a TKDTree inner structure from the data which is used as the bins. The bins are retrieved as two double*, one for the minimum bin edges, the other as the maximum bin edges. For one dimension one of these is enough to correctly define the bins. For the multidimensional case both minimum and maximum ones are necessary for the bins to be well defined. The bin edges of d-dimensional data is a d-tet of the bin's thresholds. For example if d=3 the minimum bin edges of bin b is of the form of the following array: {xbmin, ybmin, zbmin}. You also have the possibility to sort the bins by their density.

kdTreeBinning.C and more information on the embedded TKDTree documentation.

Definition at line 29 of file TKDTreeBinning.h.

Classes

struct  CompareAsc
struct  CompareDesc

Public Types

enum  { kAdjustBinEdges = (1ULL << (14)) }
enum  { kSingleKey = (1ULL << (0)) , kOverwrite = (1ULL << (1)) , kWriteDelete = (1ULL << (2)) }
enum  {
  kIsOnHeap = 0x01000000 , kNotDeleted = 0x02000000 , kZombie = 0x04000000 , kInconsistent = 0x08000000 ,
  kBitMask = 0x00ffffff
}
enum  EDeprecatedStatusBits { kObjInCanvas = (1ULL << (3)) }
enum  EStatusBits {
  kCanDelete = (1ULL << (0)) , kMustCleanup = (1ULL << (3)) , kIsReferenced = (1ULL << (4)) , kHasUUID = (1ULL << (5)) ,
  kCannotPick = (1ULL << (6)) , kNoContextMenu = (1ULL << (8)) , kInvalidObject = (1ULL << (13))
}

Public Member Functions

 TKDTreeBinning ()
 Default constructor (for I/O).
 TKDTreeBinning (UInt_t dataSize, UInt_t dataDim, const std::vector< double > &data, UInt_t nBins=100, bool adjustBinEdges=false)
 Class's constructor taking the size of the data points, dimension, a data vector and the number of bins (default = 100).
 TKDTreeBinning (UInt_t dataSize, UInt_t dataDim, Double_t *data, UInt_t nBins=100, bool adjustBinEdges=false)
 Class's constructor taking the size of the data points, dimension, a data array and the number of bins (default = 100).
 ~TKDTreeBinning () override
 Class's 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 AppendPad (Option_t *option="")
 Append graphics object to current pad.
virtual void Browse (TBrowser *b)
 Browse object. May be overridden for another default action.
ULong_t CheckedHash ()
 Check and record whether this class has a consistent Hash/RecursiveRemove setup (*) and then return the regular Hash value for this object.
virtual const char * ClassName () const
 Returns name of class to which the object belongs.
virtual void Clear (Option_t *="")
virtual TObjectClone (const char *newname="") const
 Make a clone of an object using the Streamer facility.
virtual Int_t Compare (const TObject *obj) const
 Compare abstract method.
virtual void Copy (TObject &object) const
 Copy this to obj.
virtual void Delete (Option_t *option="")
 Delete this object.
virtual Int_t DistancetoPrimitive (Int_t px, Int_t py)
 Computes distance from point (px,py) to the object.
virtual void Draw (Option_t *option="")
 Default Draw method for all objects.
virtual void DrawClass () const
 Draw class inheritance tree of the class to which this object belongs.
virtual TObjectDrawClone (Option_t *option="") const
 Draw a clone of this object in the current selected pad with: gROOT->SetSelectedPad(c1).
virtual void Dump () const
 Dump contents of object on stdout.
virtual void Error (const char *method, const char *msgfmt,...) const
 Issue error message.
virtual void Execute (const char *method, const char *params, Int_t *error=nullptr)
 Execute method on this object with the given parameter string, e.g.
virtual void Execute (TMethod *method, TObjArray *params, Int_t *error=nullptr)
 Execute method on this object with parameters stored in the TObjArray.
virtual void ExecuteEvent (Int_t event, Int_t px, Int_t py)
 Execute action corresponding to an event at (px,py).
virtual void Fatal (const char *method, const char *msgfmt,...) const
 Issue fatal error message.
void FillBinData (ROOT::Fit::BinData &data) const
 Fill the bin data set (class ROOT::Fit::BinData) with the result of the TKDTree binning.
UInt_t FindBin (const Double_t *point) const
 find the corresponding bin index given the coordinate of a point
virtual TObjectFindObject (const char *name) const
 Must be redefined in derived classes.
virtual TObjectFindObject (const TObject *obj) const
 Must be redefined in derived classes.
const Double_tGetBinCenter (UInt_t bin) const
 Returns the geometric center of of the bin.
UInt_t GetBinContent (UInt_t bin) const
 Returns the number of points in bin. 'bin' is between 0 and fNBins - 1.
Double_t GetBinDensity (UInt_t bin) const
 Returns the density in bin.
std::pair< const Double_t *, const Double_t * > GetBinEdges (UInt_t bin) const
 Returns a pir with the bin's edges. 'bin' is between 0 and fNBins - 1.
UInt_t GetBinMaxDensity () const
 Return the bin with maximum density.
const Double_tGetBinMaxEdges (UInt_t bin) const
 Returns the bin's maximum edges. 'bin' is between 0 and fNBins - 1.
UInt_t GetBinMinDensity () const
 Return the bin with minimum density.
const Double_tGetBinMinEdges (UInt_t bin) const
 Returns the bin's minimum edges. 'bin' is between 0 and fNBins - 1.
std::pair< const Double_t *, const Double_t * > GetBinsEdges () const
 Returns a pair of an array with all bins minimum and maximum edges.
const Double_tGetBinsMaxEdges () const
 Returns an array with all bins' maximum edges The edges are arranges as xmax_1,ymax_1, xmax_2,ymax_2,....xmax_{nbin},ymax_{nbin}.
const Double_tGetBinsMinEdges () const
 Returns an array with all bins' minimum edges The edges are arranges as xmin_1,ymin_1, xmin_2,ymin_2,....xmin_{nbin},ymin_{nbin}.
Double_t GetBinVolume (UInt_t bin) const
 Returns the (hyper)volume of bin. 'bin' is between 0 and fNBins - 1.
const Double_tGetBinWidth (UInt_t bin) const
 Returns a pointer to the vector of the bin widths.
Double_t GetDataMax (UInt_t dim) const
 Returns the maximum of the data in the dim coordinate. 'dim' is between 0 and fDim - 1.
Double_t GetDataMin (UInt_t dim) const
 Returns the minimum of the data in the dim coordinate. 'dim' is between 0 and fDim - 1.
UInt_t GetDim () const
 Returns the number of dimensions.
const Double_tGetDimData (UInt_t dim) const
virtual Option_tGetDrawOption () const
 Get option used by the graphics system to draw this object.
virtual const char * GetIconName () const
 Returns mime type name of object.
virtual const char * GetName () const
 Returns name of object.
UInt_t GetNBins () const
 Returns the number of bins.
virtual char * GetObjectInfo (Int_t px, Int_t py) const
 Returns string containing info about the object at position (px,py).
const Double_tGetOneDimBinEdges () const
 Returns a pointer to the vector of the bin edges for one dimensional binning only.
virtual Option_tGetOption () const
std::vector< std::vector< Double_t > > GetPointsInBin (UInt_t bin) const
 Return the corresponding point belonging to the bin i.
virtual const char * GetTitle () const
 Returns title of object.
TKDTreeIDGetTree () const
 Returns the kD-Tree structure of the binning.
virtual UInt_t GetUniqueID () const
 Return the unique object id.
virtual Bool_t HandleTimer (TTimer *timer)
 Execute action in response of a timer timing out.
virtual ULong_t Hash () const
 Return hash value for this object.
Bool_t HasInconsistentHash () const
 Return true is the type of this object is known to have an inconsistent setup for Hash and RecursiveRemove (i.e.
virtual void Info (const char *method, const char *msgfmt,...) const
 Issue info message.
virtual Bool_t InheritsFrom (const char *classname) const
 Returns kTRUE if object inherits from class "classname".
virtual Bool_t InheritsFrom (const TClass *cl) const
 Returns kTRUE if object inherits from TClass cl.
virtual void Inspect () const
 Dump contents of this object in a graphics canvas.
void InvertBit (UInt_t f)
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 IsFolder () const
 Returns kTRUE in case object contains browsable objects (like containers or lists of other objects).
Bool_t IsOnHeap () const
virtual Bool_t IsSortable () const
Bool_t IsZombie () const
virtual void ls (Option_t *option="") const
 The ls function lists the contents of a class on stdout.
void MayNotUse (const char *method) const
 Use this method to signal that a method (defined in a base class) may not be called in a derived class (in principle against good design since a child class should not provide less functionality than its parent, however, sometimes it is necessary).
virtual Bool_t Notify ()
 This method must be overridden to handle object notification (the base implementation is no-op).
void Obsolete (const char *method, const char *asOfVers, const char *removedFromVers) const
 Use this method to declare a method obsolete.
void operator delete (void *, 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)
virtual void Paint (Option_t *option="")
 This method must be overridden if a class wants to paint itself.
virtual void Pop ()
 Pop on object drawn in a pad to the top of the display list.
virtual void Print (Option_t *option="") const
 This method must be overridden when a class wants to print itself.
virtual Int_t Read (const char *name)
 Read contents of object with specified name from the current directory.
virtual void RecursiveRemove (TObject *obj)
 Recursively remove this object from a list.
void ResetBit (UInt_t f)
virtual void SaveAs (const char *filename="", Option_t *option="") const
 Save this object in the file specified by filename.
virtual void SavePrimitive (std::ostream &out, Option_t *option="")
 Save a primitive as a C++ statement(s) on output stream "out".
void SetBit (UInt_t f)
void SetBit (UInt_t f, Bool_t set)
 Set or unset the user status bits as specified in f.
virtual void SetDrawOption (Option_t *option="")
 Set drawing option for object.
void SetNBins (UInt_t bins)
 Sets binning inner structure.
virtual void SetUniqueID (UInt_t uid)
 Set the unique object id.
void SortBinsByDensity (Bool_t sortAsc=kTRUE)
 Sorts bins by their density.
const Double_tSortOneDimBinEdges (Bool_t sortAsc=kTRUE)
 Sort the one-dimensional bin edges and returns a pointer to them.
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.
Bool_t TestBit (UInt_t f) const
Int_t TestBits (UInt_t f) const
virtual void UseCurrentStyle ()
 Set current style settings in this object This function is called when either TCanvas::UseCurrentStyle or TROOT::ForceStyle have been invoked.
virtual void Warning (const char *method, const char *msgfmt,...) const
 Issue warning message.
virtual Int_t Write (const char *name=nullptr, Int_t option=0, Int_t bufsize=0)
 Write this object to the current directory.
virtual Int_t Write (const char *name=nullptr, Int_t option=0, Int_t bufsize=0) const
 Write this object to the current directory.

Static Public Member Functions

static TClassClass ()
static const char * Class_Name ()
static constexpr Version_t Class_Version ()
static const char * DeclFileName ()
static Longptr_t GetDtorOnly ()
 Return destructor only flag.
static Bool_t GetObjectStat ()
 Get status of object stat flag.
static void SetDtorOnly (void *obj)
 Set destructor only flag.
static void SetObjectStat (Bool_t stat)
 Turn on/off tracking of objects in the TObjectTable.

Protected Types

enum  { kOnlyPrepStep = (1ULL << (3)) }

Protected Member Functions

virtual void DoError (int level, const char *location, const char *fmt, va_list va) const
 Interface to ErrorHandler (protected).
void MakeZombie ()

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.

Private Member Functions

 TKDTreeBinning (TKDTreeBinning &bins)
 Disallowed copy constructor.
TKDTreeBinning operator= (TKDTreeBinning &bins)
 Disallowed assign operator.
void ReadjustMaxBinEdges (Double_t *binEdges)
void ReadjustMinBinEdges (Double_t *binEdges)
void SetBinMinMaxEdges (Double_t *binEdges)
void SetBinsContent ()
void SetBinsEdges ()
void SetCommonBinEdges (Double_t *binEdges)
void SetData (const std::vector< double > &data)
void SetData (Double_t *data)
void SetTreeData ()

Static Private Member Functions

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

Private Attributes

std::vector< Double_tfBinMaxEdges
 The maximum values for the bins' edges for each dimension.
std::vector< Double_tfBinMinEdges
 The minimum values for the bins' edges for each dimension.
std::vector< UInt_tfBinsContent
 Holds the contents of the bins.
UInt_t fBits
 bit field status word
std::vector< std::vector< std::pair< Bool_t, Bool_t > > > fCheckedBinEdges
 ! Auxiliary structure for readjusting the bin edges. Flags if the bin edge was processed in the algorithm
std::vector< std::map< Double_t, std::vector< UInt_t > > > fCommonBinEdges
 ! Auxiliary structure for readjusting the bin edges. Keeps the common bin boundaries
std::vector< Double_tfData
 [fDataSize*fDim] The data from which a KDTree partition is computed for binning
TKDTreeIDfDataBins
 ! The binning inner structure.
UInt_t fDataSize
 The data size.
std::vector< std::pair< Double_t, Double_t > > fDataThresholds
 Minimum and maximum data values.
UInt_t fDim
 The data dimension.
std::vector< UInt_tfIndices
 Index of the bins in the kd-tree (needed when bins are sorted).
Bool_t fIsSorted
 Flags if the bin edges are sorted densitywise (or by bin endges in case of 1-dim ).
Bool_t fIsSortedAsc
 Flags if the bin edges are sorted densitywise (or by bin-edge for 1D) in ascending order.
UInt_t fNBins
 The number of bins.
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

Friends

struct CompareAsc
 ! Predicate for ascending sort
struct CompareDesc
 ! Predicate for descending sort

#include <TKDTreeBinning.h>

Inheritance diagram for TKDTreeBinning:
TObject

Member Enumeration Documentation

◆ anonymous enum

anonymous enum
Enumerator
kAdjustBinEdges 

adjust bin edges to avoid overlapping with data

Definition at line 66 of file TKDTreeBinning.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.

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

◆ EDeprecatedStatusBits

Enumerator
kObjInCanvas 

for backward compatibility only, use kMustCleanup

Definition at line 84 of file TObject.h.

◆ EStatusBits

enum TObject::EStatusBits
inherited
Enumerator
kCanDelete 

if object in a list can be deleted

kMustCleanup 

if object destructor must call RecursiveRemove()

kIsReferenced 

if object is referenced by a TRef or TRefArray

kHasUUID 

if object has a TUUID (its fUniqueID=UUIDNumber)

kCannotPick 

if object in a pad cannot be picked

kNoContextMenu 

if object does not want context menu

kInvalidObject 

if object ctor succeeded but object should not be used

Definition at line 70 of file TObject.h.

Constructor & Destructor Documentation

◆ TKDTreeBinning() [1/4]

TKDTreeBinning::TKDTreeBinning ( TKDTreeBinning & bins)
private

Disallowed copy constructor.

◆ TKDTreeBinning() [2/4]

TKDTreeBinning::TKDTreeBinning ( )

Default constructor (for I/O).

Definition at line 111 of file TKDTreeBinning.cxx.

◆ TKDTreeBinning() [3/4]

TKDTreeBinning::TKDTreeBinning ( UInt_t dataSize,
UInt_t dataDim,
Double_t * data,
UInt_t nBins = 100,
bool adjustBinEdges = false )

Class's constructor taking the size of the data points, dimension, a data array and the number of bins (default = 100).

It is recommended to have the number of bins as an exact divider of the data size. The data array must be organized with a stride=1 for the points and = N (the dataSize) for the dimension.

Thus data[] = x1,x2,x3,......xN, y1,y2,y3......yN, z1,z2,...........zN,....

Note that the passed dataSize is not the size of the array but is the number of points (N) The size of the array must be at least dataDim*dataSize

Definition at line 72 of file TKDTreeBinning.cxx.

◆ TKDTreeBinning() [4/4]

TKDTreeBinning::TKDTreeBinning ( UInt_t dataSize,
UInt_t dataDim,
const std::vector< double > & data,
UInt_t nBins = 100,
bool adjustBinEdges = false )

Class's constructor taking the size of the data points, dimension, a data vector and the number of bins (default = 100).

It is recommended to have the number of bins as an exact divider of the data size. The data array must be organized with a stride=1 for the points and = N (the dataSize) for the dimension.

Thus data[] = x1,x2,x3,......xN, y1,y2,y3......yN, z1,z2,...........zN,....

Note that the passed data vector may contains a larger size, in case extra coordinates are associated but not used in building the kdtree The size of thedata vector must be at least dataDim*dataSize

Definition at line 96 of file TKDTreeBinning.cxx.

◆ ~TKDTreeBinning()

TKDTreeBinning::~TKDTreeBinning ( )
override

Class's destructor.

Definition at line 121 of file TKDTreeBinning.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.

◆ 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()

◆ 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()

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

◆ Class_Name()

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

◆ Class_Version()

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

Definition at line 101 of file TKDTreeBinning.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()

◆ Clone()

TObject * TObject::Clone ( const char * newname = "") const
virtualinherited

Make a clone of an object using the Streamer facility.

If the object derives from TNamed, this function is called by TNamed::Clone. TNamed::Clone uses the optional argument to set a new name to the newly created object.

If the object class has a DirectoryAutoAdd function, it will be called at the end of the function with the parameter gDirectory. This usually means that the object will be appended to the current ROOT directory.

Reimplemented in RooAbsArg, RooAbsBinning, RooAbsCollection, RooAbsStudy, RooCatType, RooCmdArg, RooDataHist, RooDataSet, RooFitResult, RooLinkedList, RooStats::HypoTestResult, RooStats::ModelConfig, RooStudyPackage, RooTemplateProxy< T >, RooTemplateProxy< const RooHistFunc >, RooTemplateProxy< RooAbsCategory >, RooTemplateProxy< RooAbsPdf >, RooTemplateProxy< RooAbsReal >, RooTemplateProxy< RooAbsRealLValue >, RooTemplateProxy< RooMultiCategory >, RooTemplateProxy< RooRealVar >, RooWorkspace, TASImage, TChainIndex, TClass, TCollection, TF1, TFunction, TFunctionTemplate, TH1, TImage, TMethod, TMethodCall, TMinuit, TMVA::MinuitWrapper, TNamed, TStreamerInfo, and TTreeIndex.

Definition at line 243 of file TObject.cxx.

◆ Compare()

Int_t TObject::Compare ( const TObject * obj) const
virtualinherited

Compare abstract method.

Must be overridden if a class wants to be able to compare itself with other objects. Must return -1 if this is smaller than obj, 0 if objects are equal and 1 if this is larger than obj.

Reimplemented in RooAbsArg, RooDouble, TCollection, TEnvRec, TFileInfo, TGeoBranchArray, TGeoOverlap, TGFSFrameElement, TGLBFrameElement, TNamed, TObjString, TParameter< AParamType >, TParameter< Long64_t >, TStructNode, TStructNodeProperty, and TUrl.

Definition at line 258 of file TObject.cxx.

◆ Copy()

◆ DeclFileName()

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

Definition at line 101 of file TKDTreeBinning.h.

◆ Delete()

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

◆ DistancetoPrimitive()

◆ DoError()

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

Interface to ErrorHandler (protected).

Reimplemented in TThread, and TTreeViewer.

Definition at line 1059 of file TObject.cxx.

◆ Draw()

◆ 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 TGFrame, TSystemDirectory, and TSystemFile.

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 TAxis, TCanvas, TGFrame, TSystemDirectory, and TSystemFile.

Definition at line 319 of file TObject.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
fUniqueID 0 object unique identifier
fBits 50331648 bit field status word
fLineColor 1 line color
fLineStyle 1 line style
fLineWidth 1 line width
fFillColor 19 fill area color
fFillStyle 1001 fill area style
#define X(type, name)
std::vector< Double_t > fData
[fDataSize*fDim] The data from which a KDTree partition is computed for binning
UInt_t fUniqueID
object unique identifier
Definition TObject.h:46
UInt_t fBits
bit field status word
Definition TObject.h:47
TLine * line
TCanvas * style()
Definition style.C:1

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

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.

◆ 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 ROOT::R::TRInterface, TCling, TContextMenu, TInterpreter, and TMethodCall.

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 ROOT::R::TRInterface, TCling, TContextMenu, TInterpreter, and TMethodCall.

Definition at line 398 of file TObject.cxx.

◆ ExecuteEvent()

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

◆ FillBinData()

void TKDTreeBinning::FillBinData ( ROOT::Fit::BinData & data) const

Fill the bin data set (class ROOT::Fit::BinData) with the result of the TKDTree binning.

Definition at line 614 of file TKDTreeBinning.cxx.

◆ FindBin()

UInt_t TKDTreeBinning::FindBin ( const Double_t * point) const

find the corresponding bin index given the coordinate of a point

Definition at line 624 of file TKDTreeBinning.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 RooAbsCollection, RooLinkedList, TBtree, TCollection, TDirectory, TFolder, TGeometry, TGraph2D, TGraph, TH1, THashList, THashTable, THbookFile, TList, TListOfDataMembers, TListOfEnums, TListOfEnumsWithLock, TListOfFunctions, TListOfFunctionTemplates, TListOfTypes, TMap, TObjArray, TPad, TROOT, TViewPubDataMembers, and TViewPubFunctions.

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 RooAbsCollection, RooLinkedList, TBtree, TCollection, TDirectory, TFolder, TGeometry, TGraph2D, TGraph, TH1, THashList, THashTable, THbookFile, TList, TListOfDataMembers, TListOfEnums, TListOfEnumsWithLock, TListOfFunctions, TListOfFunctionTemplates, TListOfTypes, TMap, TObjArray, TPad, TROOT, TViewPubDataMembers, and TViewPubFunctions.

Definition at line 435 of file TObject.cxx.

◆ GetBinCenter()

const Double_t * TKDTreeBinning::GetBinCenter ( UInt_t bin) const

Returns the geometric center of of the bin.

'bin' is between 0 and fNBins - 1, Array must be deleted as "delete [] res"

Definition at line 553 of file TKDTreeBinning.cxx.

◆ GetBinContent()

UInt_t TKDTreeBinning::GetBinContent ( UInt_t bin) const

Returns the number of points in bin. 'bin' is between 0 and fNBins - 1.

Definition at line 427 of file TKDTreeBinning.cxx.

◆ GetBinDensity()

Double_t TKDTreeBinning::GetBinDensity ( UInt_t bin) const

Returns the density in bin.

'bin' is between 0 and fNBins - 1 The density is the bin content/ bin volume

Definition at line 473 of file TKDTreeBinning.cxx.

◆ GetBinEdges()

std::pair< const Double_t *, const Double_t * > TKDTreeBinning::GetBinEdges ( UInt_t bin) const

Returns a pir with the bin's edges. 'bin' is between 0 and fNBins - 1.

Definition at line 404 of file TKDTreeBinning.cxx.

◆ GetBinMaxDensity()

UInt_t TKDTreeBinning::GetBinMaxDensity ( ) const

Return the bin with maximum density.

Definition at line 584 of file TKDTreeBinning.cxx.

◆ GetBinMaxEdges()

const Double_t * TKDTreeBinning::GetBinMaxEdges ( UInt_t bin) const

Returns the bin's maximum edges. 'bin' is between 0 and fNBins - 1.

Definition at line 391 of file TKDTreeBinning.cxx.

◆ GetBinMinDensity()

UInt_t TKDTreeBinning::GetBinMinDensity ( ) const

Return the bin with minimum density.

Definition at line 599 of file TKDTreeBinning.cxx.

◆ GetBinMinEdges()

const Double_t * TKDTreeBinning::GetBinMinEdges ( UInt_t bin) const

Returns the bin's minimum edges. 'bin' is between 0 and fNBins - 1.

Definition at line 378 of file TKDTreeBinning.cxx.

◆ GetBinsEdges()

std::pair< const Double_t *, const Double_t * > TKDTreeBinning::GetBinsEdges ( ) const

Returns a pair of an array with all bins minimum and maximum edges.

Definition at line 368 of file TKDTreeBinning.cxx.

◆ GetBinsMaxEdges()

const Double_t * TKDTreeBinning::GetBinsMaxEdges ( ) const

Returns an array with all bins' maximum edges The edges are arranges as xmax_1,ymax_1, xmax_2,ymax_2,....xmax_{nbin},ymax_{nbin}.

Definition at line 358 of file TKDTreeBinning.cxx.

◆ GetBinsMinEdges()

const Double_t * TKDTreeBinning::GetBinsMinEdges ( ) const

Returns an array with all bins' minimum edges The edges are arranges as xmin_1,ymin_1, xmin_2,ymin_2,....xmin_{nbin},ymin_{nbin}.

Definition at line 348 of file TKDTreeBinning.cxx.

◆ GetBinVolume()

Double_t TKDTreeBinning::GetBinVolume ( UInt_t bin) const

Returns the (hyper)volume of bin. 'bin' is between 0 and fNBins - 1.

Definition at line 486 of file TKDTreeBinning.cxx.

◆ GetBinWidth()

const Double_t * TKDTreeBinning::GetBinWidth ( UInt_t bin) const

Returns a pointer to the vector of the bin widths.

'bin' is between 0 and fNBins - 1 Array must be deleted as "delete [] res"

Definition at line 569 of file TKDTreeBinning.cxx.

◆ GetDataMax()

Double_t TKDTreeBinning::GetDataMax ( UInt_t dim) const

Returns the maximum of the data in the dim coordinate. 'dim' is between 0 and fDim - 1.

Definition at line 463 of file TKDTreeBinning.cxx.

◆ GetDataMin()

Double_t TKDTreeBinning::GetDataMin ( UInt_t dim) const

Returns the minimum of the data in the dim coordinate. 'dim' is between 0 and fDim - 1.

Definition at line 454 of file TKDTreeBinning.cxx.

◆ GetDim()

UInt_t TKDTreeBinning::GetDim ( ) const

Returns the number of dimensions.

Definition at line 422 of file TKDTreeBinning.cxx.

◆ GetDimData()

const Double_t * TKDTreeBinning::GetDimData ( UInt_t dim) const

Definition at line 445 of file TKDTreeBinning.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.

◆ 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 ROOT::Experimental::XRooFit::xRooNode, TASImage, TBranch, TBranchElement, TGeoVolume, TGMainFrame, TKey, TMethodBrowsable, TSystemFile, and TVirtualBranchBrowsable.

Definition at line 472 of file TObject.cxx.

◆ GetName()

◆ GetNBins()

UInt_t TKDTreeBinning::GetNBins ( ) const

Returns the number of bins.

Definition at line 417 of file TKDTreeBinning.cxx.

◆ GetObjectInfo()

char * TObject::GetObjectInfo ( Int_t px,
Int_t py ) const
virtualinherited

Returns string containing info about the object at position (px,py).

This method is typically overridden by classes of which the objects can report peculiarities for different positions. Returned string will be re-used (lock in MT environment).

Reimplemented in TASImage, TAxis3D, TColorWheel, TF1, TF2, TFileDrawMap, TGeoNode, TGeoTrack, TGeoVolume, TGL5DDataSet, TGLHistPainter, TGLParametricEquation, TGLTH3Composition, TGraph, TH1, THistPainter, TNode, TPaletteAxis, TParallelCoordVar, and TVirtualHistPainter.

Definition at line 491 of file TObject.cxx.

◆ GetObjectStat()

Bool_t TObject::GetObjectStat ( )
staticinherited

Get status of object stat flag.

Definition at line 1181 of file TObject.cxx.

◆ GetOneDimBinEdges()

const double * TKDTreeBinning::GetOneDimBinEdges ( ) const

Returns a pointer to the vector of the bin edges for one dimensional binning only.

size of the vector is fNBins + 1 is the vector has been sorted in increasing bin edges N.B : if one does not call SortOneDimBinEdges the bins are not ordered

Definition at line 503 of file TKDTreeBinning.cxx.

◆ GetOption()

virtual Option_t * TObject::GetOption ( ) const
inlinevirtualinherited

◆ GetPointsInBin()

std::vector< std::vector< Double_t > > TKDTreeBinning::GetPointsInBin ( UInt_t bin) const

Return the corresponding point belonging to the bin i.

Definition at line 639 of file TKDTreeBinning.cxx.

◆ GetTitle()

const char * TObject::GetTitle ( ) const
virtualinherited

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 in Axis2, TASImage, TAxis, TBaseClass, TClassMenuItem, TEveGeoNode, TEvePointSet, TGaxis, TGGroupFrame, TGLabel, TGLVEntry, TGTextButton, TGTextEntry, TGTextLBEntry, TKey, TMapFile, TNamed, TPad, TPair, TParallelCoordSelect, TParticle, TPaveLabel, TPrimary, TQCommand, TRootIconList, and TVirtualPad.

Definition at line 507 of file TObject.cxx.

◆ GetTree()

TKDTreeID * TKDTreeBinning::GetTree ( ) const

Returns the kD-Tree structure of the binning.

Definition at line 437 of file TKDTreeBinning.cxx.

◆ GetUniqueID()

UInt_t TObject::GetUniqueID ( ) const
virtualinherited

Return the unique object id.

Definition at line 480 of file TObject.cxx.

◆ 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 TGCommandPlugin, TGDNDManager, TGFileContainer, TGHtml, TGLEventHandler, TGPopupMenu, TGraphTime, TGScrollBar, TGShutter, TGTextEdit, TGTextEditor, TGTextEntry, TGTextView, TGToolTip, TGuiBldDragManager, TGWindow, and TTreeViewer.

Definition at line 516 of file TObject.cxx.

◆ Hash()

ULong_t TObject::Hash ( ) const
virtualinherited

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

Error in <ROOT::Internal::TCheckHashRecursiveRemoveConsistency::CheckRecursiveRemove>: The class SomeName overrides
TObject::Hash but does not call TROOT::RecursiveRemove in its destructor.
virtual void Error(const char *method, const char *msgfmt,...) const
Issue error message.
Definition TObject.cxx:1098
TObject()
TObject constructor.
Definition TObject.h:259
virtual ULong_t Hash() const
Return hash value for this object.
Definition TObject.cxx:539
void RecursiveRemove(TObject *obj) override
Recursively remove this object from the list of Cleanups.
Definition TROOT.cxx:2651

Reimplemented in RooLinkedList, TASImagePlugin, TASPluginGS, TCollection, TEnvRec, TGObject, TGPicture, TIconBoxThumb, TImagePlugin, TNamed, TObjString, TPad, TPair, TParameter< AParamType >, TParameter< Long64_t >, TPave, and TStatistic.

Definition at line 539 of file TObject.cxx.

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

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

◆ 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 ROOT::Experimental::XRooFit::xRooNode, TGFrame, TInspectorObject, and TSystemFile.

Definition at line 570 of file TObject.cxx.

◆ InvertBit()

void TObject::InvertBit ( UInt_t f)
inlineinherited

Definition at line 206 of file TObject.h.

◆ IsA()

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

Reimplemented from TObject.

Definition at line 101 of file TKDTreeBinning.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 TGObject, TObjString, TPair, and TQCommand.

Definition at line 589 of file TObject.cxx.

◆ IsFolder()

◆ IsOnHeap()

Bool_t TObject::IsOnHeap ( ) const
inlineinherited

Definition at line 160 of file TObject.h.

◆ IsSortable()

virtual Bool_t TObject::IsSortable ( ) const
inlinevirtualinherited

◆ IsZombie()

Bool_t TObject::IsZombie ( ) const
inlineinherited

Definition at line 161 of file TObject.h.

◆ ls()

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

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

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=()

TKDTreeBinning TKDTreeBinning::operator= ( TKDTreeBinning & bins)
private

Disallowed assign operator.

◆ Paint()

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

This method must be overridden if a class wants to paint itself.

The difference between Paint() and Draw() is that when a object draws itself it is added to the display list of the pad in which it is drawn (and automatically redrawn whenever the pad is redrawn). While paint just draws the object without adding it to the pad display list.

Reimplemented in ROOT::Experimental::RTreeMapPainter, ROOT::RGeoPainter, TAnnotation, TArrow, TASImage, TASPaletteEditor::LimitLine, TASPaletteEditor::PaintPalette, TAxis3D, TBits, TBox, TButton, TCanvas, TClassTree, TCollection, TColorWheel, TCrown, TDiamond, TDirectory, TEfficiency, TEllipse, TEveArrow, TEveCaloViz, TEveDigitSet, TEveGeoShape, TEveGeoTopNode, TEvePlot3D, TEvePointSet, TEveProjectionAxes, TEveScene, TEveShape, TEveStraightLineSet, TEveText, TEveTriangleSet, TExec, TF1, TF2, TF3, TFile, TFileDrawMap, TFrame, TGaxis, TGenerator, TGeoBoolNode, TGeoIntersection, TGeoNode, TGeoOverlap, TGeoPainter, TGeoPhysicalNode, TGeoShape, TGeoSubtraction, TGeoTrack, TGeoUnion, TGeoVGShape, TGeoVolume, TGL5DDataSet, TGLHistPainter, TGLParametricEquation, TGLTH3Composition, TGraph2D, TGraph2DPainter, TGraph, TGraphEdge, TGraphNode, TGraphPolargram, TGraphTime, TH1, THistPainter, THStack, TLatex, TLegend, TLine, TMacro, TMarker3DBox, TMarker, TMathText, TMultiGraph, TNode, TNodeDiv, TPad, TPaletteAxis, TParallelCoord, TParallelCoordRange, TParallelCoordVar, TParticle, TPave, TPaveLabel, TPaveStats, TPavesText, TPaveText, TPie, TPolyLine3D, TPolyLine, TPolyMarker3D, TPolyMarker, TPrimary, TRatioPlot, TScatter2D, TScatter, TShape, TSpectrum2Painter, TSpider, TSpline, TSQLFile, TStyle, TText, TTreePerfStats, TVirtualGeoPainter, TVirtualGeoTrack, TVirtualHistPainter, TVirtualPad, TWbox, and TXMLFile.

Definition at line 631 of file TObject.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 TFrame, TPad, and TVirtualPad.

Definition at line 640 of file TObject.cxx.

◆ Print()

void TObject::Print ( Option_t * option = "") const
virtualinherited

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

Reimplemented in Roo1DTable, RooAbsArg, RooAbsBinning, RooAbsCollection, RooAbsData, RooAbsDataStore, RooAbsGenContext, RooCatType, RooCmdArg, RooCurve, RooEllipse, RooFitResult, RooGenFitStudy, RooHist, RooLinkedList, RooMsgService, RooNumGenConfig, RooNumIntConfig, RooPlot, RooSharedProperties, RooStats::ModelConfig, ROOT::Experimental::REveTrans, ROOT::Experimental::XRooFit::xRooNLLVar::xRooHypoPoint, ROOT::Experimental::XRooFit::xRooNLLVar::xRooHypoSpace, ROOT::Experimental::XRooFit::xRooNode, ROOT::v5::TFormula, RooWorkspace, TAnnotation, TApplicationRemote, TAttParticle, TBenchmark, TBits, TBox, TBranch, TBranchClones, TBranchElement, TBranchObject, TBranchRef, TBranchSTL, TChain, TClassTable, TCling, TCollection, TColor, TDatabasePDG, TDecompBase, TDecompBK, TDecompChol, TDecompLU, TDecompQRH, TDecompSparse, TDecompSVD, TDirectory, TEllipse, TEnv, TEventList, TEveTrans, TF1, TFile, TFileCacheRead, TFileCacheWrite, TFileCollection, TFileInfo, TFileInfoMeta, TFitResult, TFoamCell, TFoamVect, TFormula, TFunction, TGCompositeFrame, TGDMLMatrix, TGeoBatemanSol, TGeoBorderSurface, TGeoBranchArray, TGeoDecayChannel, TGeoElement, TGeoElementRN, TGeoElementTable, TGeoIsotope, TGeoMatrix, TGeoOpticalSurface, TGeoOverlap, TGeoPhysicalNode, TGeoRegion, TGeoSkinSurface, TGeoTessellated, TGeoTrack, TGeoVolume, TGeoVoxelFinder, TGFont, TGFontPool, TGFrame, TGFrameElement, TGGC, TGGCPool, TGLayoutHints, TGMimeTypes, TGPicture, TGPicturePool, TGraph2D, TGraph2DAsymmErrors, TGraph2DErrors, TGraph, TGraphAsymmErrors, TGraphBentErrors, TGraphErrors, TGraphMultiErrors, TGTextEdit, TGWindow, TH1, THashTable, THbookTree, THelix, THnBase, THStack, TInetAddress, TKey, TLegend, TLegendEntry, TLine, TLorentzVector, TMacro, TMapFile, TMarker, TMatrixTBase< Element >, TMatrixTBase< Double_t >, TMatrixTBase< Float_t >, TMemFile, TMessageHandler, TMultiDimFit, TMultiGraph, TMVA::Event, TMVA::Option< T >, TMVA::Option< T * >, TMVA::OptionBase, TMVA::PDEFoamCell, TMVA::PDEFoamVect, TMVA::TNeuron, TNamed, TObjectTable, TObjString, TPad, TParallelCoordRange, TParallelCoordVar, TParameter< AParamType >, TParameter< Long64_t >, TParticle, TParticleClassPDG, TParticlePDG, TPave, TPaveText, TPluginHandler, TPluginManager, TPolyLine3D, TPolyLine, TPolyMarker3D, TPolyMarker, TPrimary, TPrincipal, TQpDataDens, TQpDataSparse, TQpVar, TQSlot, TQuaternion, TRolke, TRootBrowserHistoryCursor, TScatter2D, TScatter, TSpectrum2, TSpectrum3, TSpectrum, TSQLColumnInfo, TSQLFile, TSQLStructure, TSQLTableInfo, TStatistic, TStopwatch, TStreamerInfoActions::TActionSequence, TText, TTree, TTreeCache, TTreeCacheUnzip, TTreeIndex, TTreePerfStats, TUri, TUrl, TVector2, TVector3, TVectorT< Element >, TVectorT< Double_t >, TVectorT< Float_t >, TVirtualPad, TXMLFile, TXTRU, TZIPFile, and TZIPMember.

Definition at line 661 of file TObject.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 TBuffer, TKey, TKeySQL, and TKeyXML.

Definition at line 673 of file TObject.cxx.

◆ ReadjustMaxBinEdges()

void TKDTreeBinning::ReadjustMaxBinEdges ( Double_t * binEdges)
private

Definition at line 327 of file TKDTreeBinning.cxx.

◆ ReadjustMinBinEdges()

void TKDTreeBinning::ReadjustMinBinEdges ( Double_t * binEdges)
private

Definition at line 298 of file TKDTreeBinning.cxx.

◆ RecursiveRemove()

◆ ResetBit()

void TObject::ResetBit ( UInt_t f)
inlineinherited

Definition at line 203 of file TObject.h.

◆ 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 ROOT::Experimental::XRooFit::xRooNode, TClassTree, TFolder, TGeoVolume, TGObject, TGraph, TH1, TPad, TPaveClass, TSpline3, TSpline5, TSpline, TTreePerfStats, and TVirtualPad.

Definition at line 708 of file TObject.cxx.

◆ SavePrimitive()

void TObject::SavePrimitive ( std::ostream & out,
Option_t * option = "" )
virtualinherited

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

Reimplemented in TAnnotation, TArc, TArrow, TASImage, TAxis3D, TBox, TButton, TCanvas, TChain, TCrown, TCurlyArc, TCurlyLine, TCutG, TDiamond, TEfficiency, TEllipse, TExec, TF12, TF1, TF2, TF3, TFrame, TGaxis, TGButton, TGButtonGroup, TGCanvas, TGCheckButton, TGColorSelect, TGColumnLayout, TGComboBox, TGCompositeFrame, TGContainer, TGDockableFrame, TGDoubleHSlider, TGDoubleVSlider, TGedMarkerSelect, TGedPatternSelect, TGeoArb8, TGeoBBox, TGeoBoolNode, TGeoCombiTrans, TGeoCompositeShape, TGeoCone, TGeoConeSeg, TGeoCtub, TGeoDecayChannel, TGeoElementRN, TGeoEltu, TGeoGtra, TGeoHalfSpace, TGeoHMatrix, TGeoHype, TGeoIdentity, TGeoIntersection, TGeoMaterial, TGeoMedium, TGeoMixture, TGeoPara, TGeoParaboloid, TGeoPatternCylPhi, TGeoPatternCylR, TGeoPatternParaX, TGeoPatternParaY, TGeoPatternParaZ, TGeoPatternSphPhi, TGeoPatternSphR, TGeoPatternSphTheta, TGeoPatternTrapZ, TGeoPatternX, TGeoPatternY, TGeoPatternZ, TGeoPcon, TGeoPgon, TGeoRotation, TGeoScaledShape, TGeoShapeAssembly, TGeoSphere, TGeoSubtraction, TGeoTessellated, TGeoTorus, TGeoTranslation, TGeoTrap, TGeoTrd1, TGeoTrd2, TGeoTube, TGeoTubeSeg, TGeoUnion, TGeoVolume, TGeoXtru, TGFileContainer, TGFont, TGFrame, TGFSComboBox, TGGC, TGGroupFrame, TGHButtonGroup, TGHorizontal3DLine, TGHorizontalFrame, TGHorizontalLayout, TGHProgressBar, TGHScrollBar, TGHSlider, TGHSplitter, TGHtml, TGIcon, TGLabel, TGLayoutHints, TGLineStyleComboBox, TGLineWidthComboBox, TGListBox, TGListDetailsLayout, TGListLayout, TGListTree, TGListView, TGLVContainer, TGMainFrame, TGMatrixLayout, TGMdiFrame, TGMdiMainFrame, TGMdiMenuBar, TGMenuBar, TGMenuTitle, TGNumberEntry, TGNumberEntryField, TGPictureButton, TGPopupMenu, TGProgressBar, TGRadioButton, TGraph2D, TGraph2DAsymmErrors, TGraph2DErrors, TGraph, TGraphAsymmErrors, TGraphBentErrors, TGraphEdge, TGraphErrors, TGraphMultiErrors, TGraphNode, TGraphPolar, TGraphPolargram, TGraphStruct, TGroupButton, TGRowLayout, TGShapedFrame, TGShutter, TGShutterItem, TGSplitFrame, TGStatusBar, TGTab, TGTabLayout, TGTableLayout, TGTableLayoutHints, TGTextButton, TGTextEdit, TGTextEntry, TGTextLBEntry, TGTextView, TGTileLayout, TGToolBar, TGTransientFrame, TGTripleHSlider, TGTripleVSlider, TGVButtonGroup, TGVertical3DLine, TGVerticalFrame, TGVerticalLayout, TGVFileSplitter, TGVProgressBar, TGVScrollBar, TGVSlider, TGVSplitter, TGXYLayout, TGXYLayoutHints, TH1, TH2Poly, THelix, THStack, TLatex, TLegend, TLine, TMacro, TMarker3DBox, TMarker, TMathText, TMultiGraph, TPad, TPaletteAxis, TParallelCoord, TParallelCoordVar, TPave, TPaveClass, TPaveLabel, TPaveStats, TPavesText, TPaveText, TPie, TPieSlice, TPolyLine3D, TPolyLine, TPolyMarker3D, TPolyMarker, TProfile2D, TProfile3D, TProfile, TRootContainer, TRootEmbeddedCanvas, TScatter2D, TScatter, TSlider, TSliderBox, TSpline3, TSpline5, TStyle, TText, TTreePerfStats, and TWbox.

Definition at line 858 of file TObject.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.

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

◆ SetBinMinMaxEdges()

void TKDTreeBinning::SetBinMinMaxEdges ( Double_t * binEdges)
private

Definition at line 265 of file TKDTreeBinning.cxx.

◆ SetBinsContent()

void TKDTreeBinning::SetBinsContent ( )
private

Definition at line 240 of file TKDTreeBinning.cxx.

◆ SetBinsEdges()

void TKDTreeBinning::SetBinsEdges ( )
private

Definition at line 249 of file TKDTreeBinning.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.

◆ SetCommonBinEdges()

void TKDTreeBinning::SetCommonBinEdges ( Double_t * binEdges)
private

Definition at line 277 of file TKDTreeBinning.cxx.

◆ SetData() [1/2]

void TKDTreeBinning::SetData ( const std::vector< double > & data)
private

Definition at line 222 of file TKDTreeBinning.cxx.

◆ SetData() [2/2]

void TKDTreeBinning::SetData ( Double_t * data)
private

Definition at line 209 of file TKDTreeBinning.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 RooPlot, TAxis, TBrowser, TGedFrame, TGFrame, TPad, TPaveStats, TRootBrowserLite, TSystemDirectory, and TSystemFile.

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.

◆ SetNBins()

void TKDTreeBinning::SetNBins ( UInt_t bins)

Sets binning inner structure.

Definition at line 127 of file TKDTreeBinning.cxx.

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

◆ SetTreeData()

void TKDTreeBinning::SetTreeData ( )
private

Definition at line 234 of file TKDTreeBinning.cxx.

◆ SetUniqueID()

void TObject::SetUniqueID ( UInt_t uid)
virtualinherited

Set the unique object id.

Definition at line 899 of file TObject.cxx.

◆ SortBinsByDensity()

void TKDTreeBinning::SortBinsByDensity ( Bool_t sortAsc = kTRUE)

Sorts bins by their density.

Definition at line 157 of file TKDTreeBinning.cxx.

◆ SortOneDimBinEdges()

const Double_t * TKDTreeBinning::SortOneDimBinEdges ( Bool_t sortAsc = kTRUE)

Sort the one-dimensional bin edges and returns a pointer to them.

Definition at line 514 of file TKDTreeBinning.cxx.

◆ Streamer()

void TKDTreeBinning::Streamer ( TBuffer & b)
overridevirtual

Stream a class object.

Reimplemented from TObject.

Definition at line 670 of file TKDTreeBinning.cxx.

◆ StreamerNVirtual()

void TKDTreeBinning::StreamerNVirtual ( TBuffer & ClassDef_StreamerNVirtual_b)
inline

Definition at line 101 of file TKDTreeBinning.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.

◆ TestBit()

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.

◆ 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 TAxis3D, TCanvas, TFrame, TGraph, TH1, TPad, TPaveStats, TPaveText, and TTree.

Definition at line 909 of file TObject.cxx.

◆ 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 ROOT::TBufferMergerFile, TBuffer, TCollection, TDirectory, TDirectoryFile, TFile, TMap, TParallelMergingFile, TSQLFile, TTree, and TXMLFile.

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 TBuffer, TCollection, TDirectory, TDirectoryFile, TFile, TMap, TParallelMergingFile, TSQLFile, TTree, and TXMLFile.

Definition at line 964 of file TObject.cxx.

◆ CompareAsc

friend struct CompareAsc
friend

! Predicate for ascending sort

Definition at line 47 of file TKDTreeBinning.h.

◆ CompareDesc

friend struct CompareDesc
friend

! Predicate for descending sort

Definition at line 49 of file TKDTreeBinning.h.

Member Data Documentation

◆ fBinMaxEdges

std::vector<Double_t> TKDTreeBinning::fBinMaxEdges
private

The maximum values for the bins' edges for each dimension.

Definition at line 34 of file TKDTreeBinning.h.

◆ fBinMinEdges

std::vector<Double_t> TKDTreeBinning::fBinMinEdges
private

The minimum values for the bins' edges for each dimension.

Definition at line 33 of file TKDTreeBinning.h.

◆ fBinsContent

std::vector<UInt_t> TKDTreeBinning::fBinsContent
private

Holds the contents of the bins.

Definition at line 45 of file TKDTreeBinning.h.

◆ fBits

UInt_t TObject::fBits
privateinherited

bit field status word

Definition at line 47 of file TObject.h.

◆ fCheckedBinEdges

std::vector<std::vector<std::pair<Bool_t, Bool_t> > > TKDTreeBinning::fCheckedBinEdges
private

! Auxiliary structure for readjusting the bin edges. Flags if the bin edge was processed in the algorithm

Definition at line 41 of file TKDTreeBinning.h.

◆ fCommonBinEdges

std::vector<std::map<Double_t, std::vector<UInt_t> > > TKDTreeBinning::fCommonBinEdges
private

! Auxiliary structure for readjusting the bin edges. Keeps the common bin boundaries

Definition at line 42 of file TKDTreeBinning.h.

◆ fData

std::vector<Double_t> TKDTreeBinning::fData
private

[fDataSize*fDim] The data from which a KDTree partition is computed for binning

Definition at line 32 of file TKDTreeBinning.h.

◆ fDataBins

TKDTreeID* TKDTreeBinning::fDataBins
private

! The binning inner structure.

Definition at line 36 of file TKDTreeBinning.h.

◆ fDataSize

UInt_t TKDTreeBinning::fDataSize
private

The data size.

Definition at line 39 of file TKDTreeBinning.h.

◆ fDataThresholds

std::vector<std::pair<Double_t, Double_t> > TKDTreeBinning::fDataThresholds
private

Minimum and maximum data values.

Definition at line 40 of file TKDTreeBinning.h.

◆ fDim

UInt_t TKDTreeBinning::fDim
private

The data dimension.

Definition at line 38 of file TKDTreeBinning.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.

◆ fIndices

std::vector<UInt_t> TKDTreeBinning::fIndices
private

Index of the bins in the kd-tree (needed when bins are sorted).

Definition at line 35 of file TKDTreeBinning.h.

◆ fIsSorted

Bool_t TKDTreeBinning::fIsSorted
private

Flags if the bin edges are sorted densitywise (or by bin endges in case of 1-dim ).

Definition at line 43 of file TKDTreeBinning.h.

◆ fIsSortedAsc

Bool_t TKDTreeBinning::fIsSortedAsc
private

Flags if the bin edges are sorted densitywise (or by bin-edge for 1D) in ascending order.

Definition at line 44 of file TKDTreeBinning.h.

◆ fNBins

UInt_t TKDTreeBinning::fNBins
private

The number of bins.

Definition at line 37 of file TKDTreeBinning.h.

◆ fUniqueID

UInt_t TObject::fUniqueID
privateinherited

object unique identifier

Definition at line 46 of file TObject.h.


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