Logo ROOT   6.10/09
Reference Guide
TParallelCoord.h
Go to the documentation of this file.
1 // @(#)root/treeviewer:$Id$
2 // Author: Bastien Dalla Piazza 02/08/2007
3 
4 /*************************************************************************
5  * Copyright (C) 1995-2007, Rene Brun and Fons Rademakers. *
6  * All rights reserved. *
7  * *
8  * For the licensing terms see $ROOTSYS/LICENSE. *
9  * For the list of contributors see $ROOTSYS/README/CREDITS. *
10  *************************************************************************/
11 
12 #ifndef ROOT_TParallelCoord
13 #define ROOT_TParallelCoord
14 
15 #include "TAttLine.h"
16 #include "TNamed.h"
17 
18 class TTree;
19 class TPaveText;
20 class TEntryList;
22 class TParallelCoordVar;
24 class TList;
25 class TGaxis;
26 class TSelectorDraw;
27 
28 class TParallelCoord : public TNamed {
29 public:
30  enum {
31  kVertDisplay =BIT(14), // If the axes are drawn vertically, false if horizontally.
32  kCurveDisplay =BIT(15), // If the polylines are replaced by interpolated curves.
33  kPaintEntries =BIT(16), // To prentry the TParallelCoord to paint all the entries.
34  kLiveUpdate =BIT(17), // To paint the entries when being modified.
35  kGlobalScale =BIT(19), // Every variable is on the same scale.
36  kCandleChart =BIT(20), // To produce a candle chart.
37  kGlobalLogScale =BIT(21) // Every variable in log scale.
38  };
39 
40 private:
41  UInt_t fNvar; // Number of variables.
42  Long64_t fCurrentFirst; // First entry to display.
43  Long64_t fCurrentN; // Number of entries to display.
44  Long64_t fNentries; // Number of entries;
45  Int_t fDotsSpacing; // Spacing between dots to draw the entries.
46  Color_t fLineColor; // entries line color.
47  Width_t fLineWidth; // entries line width.
48  Int_t fWeightCut; // Specify a cut on the entries from their weight (see TParallelCoordVar::GetEvtWeight(Long64_t))
49  TEntryList *fCurrentEntries; //-> Current selected entries in the tree.
50  TEntryList *fInitEntries; //-> Selected entries when TParallelCoord first initialized.
51  TTree *fTree; //! Pointer to the TTree.
52  TString fTreeName; // Name of the tree.
53  TString fTreeFileName; // Name of the file containing the tree.
54  TList *fVarList; // List of the variables.
55  TList *fSelectList; // List of selections over the variables.
56  TParallelCoordSelect* fCurrentSelection; //! Current Selection being edited.
57  TGaxis *fCandleAxis; //! An axis used when displaying a candle chart.
58 
59  void Init();
61  void SetAxesPosition();
62 
63 public:
68 
69  void AddVariable(Double_t* val, const char* title="");
70  void AddVariable(const char* varexp);
71  void AddSelection(const char* title);
72  void ApplySelectionToTree(); // *MENU*
73  static void BuildParallelCoord(TSelectorDraw* selector, Bool_t candle);
76  TParallelCoordVar* RemoveVariable(const char* var);
78  virtual Int_t DistancetoPrimitive(Int_t px, Int_t py);
79  virtual void Draw(Option_t* options="");
80  virtual void ExecuteEvent(Int_t entry, Int_t px, Int_t py);
86  Int_t GetDotsSpacing() const {return fDotsSpacing;}
94  Int_t GetNbins();
95  UInt_t GetNvar() {return fNvar;}
98  TParallelCoordSelect* GetSelection(const char* title);
99  TTree *GetTree();
100  Double_t *GetVariable(const char* var);
102  TList *GetVarList() {return fVarList;}
104  Int_t GetWeightCut() const {return fWeightCut;};
105  virtual void Paint(Option_t* options="");
106  void ResetTree();
107  void SaveEntryLists(const char* filename="", Bool_t overwrite=kFALSE); // *MENU*
108  void SavePrimitive(std::ostream & out,Option_t *options);
109  void SaveTree(const char* filename="", Bool_t overwrite=kFALSE); // *MENU*
110  void SetAxisHistogramBinning(Int_t n=100); // *MENU*
111  void SetAxisHistogramHeight(Double_t h=0.5); // *MENU*
112  void SetAxisHistogramLineWidth(Int_t lw=2); // *MENU*
113  void SetCandleChart(Bool_t can); // *TOGGLE* *GETTER=GetCandleChart
114  virtual void SetCurveDisplay(Bool_t curve=1) {SetBit(kCurveDisplay,curve);} // *TOGGLE* *GETTER=GetCurveDisplay
115  void SetCurrentEntries(TEntryList* entries) {fCurrentEntries = entries;}
117  void SetCurrentN(Long64_t);
118  TParallelCoordSelect* SetCurrentSelection(const char* title);
120  void SetDotsSpacing(Int_t s=0); // *MENU*
121  static void SetEntryList(TParallelCoord* para, TEntryList* enlist);
122  void SetGlobalScale(Bool_t gl); // *TOGGLE* *GETTER=GetGlobalScale
123  void SetGlobalLogScale(Bool_t); // *TOGGLE* *GETTER=GetGlobalLogScale
124  void SetGlobalMin(Double_t min);
125  void SetGlobalMax(Double_t max);
126  void SetInitEntries(TEntryList* entries) {fInitEntries = entries;}
127  void SetLineColor(Color_t col) {fLineColor = col;}
128  void SetLineWidth(Width_t wid) {fLineWidth = wid;}
130  void SetNentries(Long64_t n) {fNentries = n;}
131  void SetTree(TTree* tree) {fTree = tree;}
132  void SetVertDisplay(Bool_t vert=kTRUE); // *TOGGLE* *GETTER=GetVertDisplay
133  void SetWeightCut(Int_t w=0) {fWeightCut = w;} // *MENU*
134  void UnzoomAll(); // *MENU*
135 
136  ClassDef(TParallelCoord,1); // To display parallel coordinates plots.
137 };
138 
139 #endif
TEntryList * fInitEntries
void Init()
An axis used when displaying a candle chart.
Long64_t fNentries
void PaintEntries(TParallelCoordSelect *sel=NULL)
Loop over the entries and paint them.
A TParallelCoordSelect is a specialised TList to hold TParallelCoordRanges used by TParallelCoord...
void CleanUpSelections(TParallelCoordRange *range)
Clean up the selections from the ranges which could have been deleted when a variable has been delete...
void SetLineColor(Color_t col)
TString fTreeFileName
long long Long64_t
Definition: RtypesCore.h:69
TParallelCoordSelect * GetCurrentSelection()
Return the selection currently being edited.
static void BuildParallelCoord(TSelectorDraw *selector, Bool_t candle)
Call constructor and add the variables.
TParallelCoordSelect * GetSelection(const char *title)
Get a selection from its title.
Bool_t GetGlobalScale()
const char Option_t
Definition: RtypesCore.h:62
Long64_t fCurrentFirst
void SetAxisHistogramHeight(Double_t h=0.5)
Set the same histogram axis height for all axis.
Bool_t TestBit(UInt_t f) const
Definition: TObject.h:159
#define BIT(n)
Definition: Rtypes.h:75
TH1 * h
Definition: legend2.C:5
void SetLineWidth(Width_t wid)
void SetAxisHistogramLineWidth(Int_t lw=2)
Set the same histogram axis line width for all axis.
virtual void Draw(Option_t *options="")
Draw the parallel coordinates graph.
void SetLiveRangesUpdate(Bool_t)
If true, the pad is updated while the motion of a dragged range.
void SetWeightCut(Int_t w=0)
Basic string class.
Definition: TString.h:129
A TParallelCoordRange is a range used for parallel coordinates plots.
int Int_t
Definition: RtypesCore.h:41
void ResetTree()
Reset the tree entry list to the initial one..
bool Bool_t
Definition: RtypesCore.h:59
void SetCurrentFirst(Long64_t)
Set the first entry to be displayed.
void SetVertDisplay(Bool_t vert=kTRUE)
Set the vertical or horizontal display.
void SetCurrentN(Long64_t)
Set the number of entry to be displayed.
#define NULL
Definition: RtypesCore.h:88
Color_t fLineColor
Double_t GetGlobalMin()
return the global minimum.
void SetBit(UInt_t f, Bool_t set)
Set or unset the user status bits as specified in f.
Definition: TObject.cxx:687
TParallelCoordSelect * fCurrentSelection
TParallelCoord axes.
void SetAxisHistogramBinning(Int_t n=100)
Set the same histogram axis binning for all axis.
TEntryList * fCurrentEntries
Color_t GetLineColor()
TList * GetVarList()
#define ClassDef(name, id)
Definition: Rtypes.h:297
Int_t GetNbins()
get the binning of the histograms.
void ApplySelectionToTree()
Apply the current selection to the tree.
The TNamed class is the base class for all named ROOT classes.
Definition: TNamed.h:29
void SetInitEntries(TEntryList *entries)
void SetCurrentEntries(TEntryList *entries)
Long64_t GetCurrentN()
virtual void Paint(Option_t *options="")
Paint the parallel coordinates graph.
void SaveTree(const char *filename="", Bool_t overwrite=kFALSE)
Save the tree in a file if fTreeFileName == "".
short Color_t
Definition: RtypesCore.h:79
void SetGlobalMax(Double_t max)
Force all variables to adopt the same max.
Bool_t GetCurveDisplay() const
A doubly linked list.
Definition: TList.h:43
Long64_t fCurrentN
void RemoveVariable(TParallelCoordVar *var)
Delete a variable from the graph.
Long64_t GetCurrentFirst()
static void SetEntryList(TParallelCoord *para, TEntryList *enlist)
Set the entry lists of "para".
Double_t GetGlobalMax()
return the global maximum.
void SetCandleChart(Bool_t can)
Set a candle chart display.
TParallelCoord()
Default constructor.
void AddSelection(const char *title)
Add a selection.
void SetGlobalScale(Bool_t gl)
Constraint all axes to the same scale.
TString fTreeName
Pointer to the TTree.
virtual void ExecuteEvent(Int_t entry, Int_t px, Int_t py)
Execute the corresponding entry.
TList * GetSelectList()
void SetGlobalLogScale(Bool_t)
All axes in log scale.
unsigned int UInt_t
Definition: RtypesCore.h:42
TGaxis * fCandleAxis
Current Selection being edited.
TTree * GetTree()
return the tree if fTree is defined.
void SetGlobalMin(Double_t min)
Force all variables to adopt the same min.
The axis painter class.
Definition: TGaxis.h:24
~TParallelCoord()
Destructor.
void AddVariable(Double_t *val, const char *title="")
Add a variable.
Width_t GetLineWidth()
Long64_t GetNentries()
Int_t GetWeightCut() const
A specialized TSelector for TTree::Draw.
Definition: TSelectorDraw.h:31
short Width_t
Definition: RtypesCore.h:78
void UnzoomAll()
Unzoom all variables.
const Bool_t kFALSE
Definition: RtypesCore.h:92
Width_t fLineWidth
A Pave (see TPave) with text, lines or/and boxes inside.
Definition: TPaveText.h:21
double Double_t
Definition: RtypesCore.h:55
TParallelCoordSelect * SetCurrentSelection(const char *title)
Set the selection being edited.
void SetTree(TTree *tree)
int nentries
Definition: THbookFile.cxx:89
virtual void SetCurveDisplay(Bool_t curve=1)
void SetDotsSpacing(Int_t s=0)
Set dots spacing.
Bool_t GetVertDisplay() const
Bool_t GetCandleChart()
void DeleteSelection(TParallelCoordSelect *sel)
Delete a selection.
Bool_t GetGlobalLogScale()
void SavePrimitive(std::ostream &out, Option_t *options)
Save the TParallelCoord in a macro.
Parallel Coordinates class.
void SetAxesPosition()
Update the position of the axes.
UInt_t GetNvar()
Double_t * GetVariable(const char *var)
Get the variables values from its title.
TList * fSelectList
Definition: tree.py:1
Int_t GetDotsSpacing() const
A TTree object has a header with a name and a title.
Definition: TTree.h:78
void SetNentries(Long64_t n)
virtual Int_t DistancetoPrimitive(Int_t px, Int_t py)
Compute the distance from the TParallelCoord.
A List of entry numbers in a TTree or TChain.
Definition: TEntryList.h:25
const Bool_t kTRUE
Definition: RtypesCore.h:91
TEntryList * GetEntryList(Bool_t sel=kTRUE)
Get the whole entry list or one for a selection.
const Int_t n
Definition: legend1.C:16
void SaveEntryLists(const char *filename="", Bool_t overwrite=kFALSE)
Save the entry lists in a root file "filename.root".