The palette painting class.
A TPaletteAxis
object is used to display the color palette when drawing 2-d histograms.
The TPaletteAxis
is automatically created drawn when drawing a 2-D histogram when the option "Z" is specified.
A TPaletteAxis
object is added to the histogram list of functions and can be retrieved doing:
TPaletteAxis *palette = (TPaletteAxis*)h->GetListOfFunctions()->FindObject("palette");
then the pointer palette
can be used to change the palette attributes.
Because the palette is created at painting time only, one must issue a:
gPad->Update();
before retrieving the palette pointer in order to create the palette. The following macro gives an example.
TPaletteAxis
inherits from TBox
and TPave
. The methods allowing to specify the palette position are inherited from these two classes.
The palette can be interactively moved and resized. The context menu can be used to set the axis attributes.
It is possible to select a range on the axis to set the min/max in z
As default labels and ticks are drawn by TGAxis
at equidistant (lin or log) points as controlled by SetNdivisions. If option "CJUST" is given labels and ticks are justified at the color boundaries defined by the contour levels. In this case no optimization can be done. It is responsiblity of the user to adjust minimum, maximum of the histogram and/or the contour levels to get a reasonable look of the plot. Only overlap of the labels is avoided if too many contour levels are used.
This option is especially useful with user defined contours. An example is shown here:
Definition at line 29 of file TPaletteAxis.h.
Public Types | |
enum | EStatusBits { kHasView = BIT(11) } |
Public Types inherited from TPave | |
enum | { kNameIsAction = BIT(11) } |
Public Types inherited from TBox | |
enum | { kCannotMove = BIT(12) } |
Public Types inherited from TObject | |
enum | { kIsOnHeap = 0x01000000 , kNotDeleted = 0x02000000 , kZombie = 0x04000000 , kInconsistent = 0x08000000 , kBitMask = 0x00ffffff } |
enum | { kSingleKey = BIT(0) , kOverwrite = BIT(1) , kWriteDelete = BIT(2) } |
enum | EDeprecatedStatusBits { kObjInCanvas = BIT(3) } |
enum | EStatusBits { kCanDelete = BIT(0) , kMustCleanup = BIT(3) , kIsReferenced = BIT(4) , kHasUUID = BIT(5) , kCannotPick = BIT(6) , kNoContextMenu = BIT(8) , kInvalidObject = BIT(13) } |
Public Member Functions | |
TPaletteAxis () | |
Palette default constructor. | |
TPaletteAxis (const TPaletteAxis &palette) | |
Palette copy constructor. | |
TPaletteAxis (Double_t x1, Double_t y1, Double_t x2, Double_t y2, TH1 *h) | |
Palette normal constructor. | |
virtual | ~TPaletteAxis () |
Palette destructor. | |
void | Copy (TObject &palette) const |
Copy a palette to a palette. | |
virtual Int_t | DistancetoPrimitive (Int_t px, Int_t py) |
Check if mouse on the axis region. | |
virtual void | ExecuteEvent (Int_t event, Int_t px, Int_t py) |
Check if mouse on the axis region. | |
TGaxis * | GetAxis () |
Int_t | GetBinColor (Int_t i, Int_t j) |
Returns the color index of the bin (i,j). | |
TH1 * | GetHistogram () |
Option_t * | GetName () const |
Returns name of object. | |
virtual char * | GetObjectInfo (Int_t px, Int_t py) const |
Displays the z value corresponding to cursor position py. | |
Int_t | GetValueColor (Double_t zc) |
Returns the color index of the given z value. | |
TPaletteAxis & | operator= (const TPaletteAxis &) |
Assignment operator. | |
virtual void | Paint (Option_t *option="") |
Paint the palette. | |
virtual void | SavePrimitive (std::ostream &out, Option_t *option="") |
Save primitive as a C++ statement(s) on output stream out. | |
void | SetHistogram (TH1 *h) |
virtual void | SetLabelColor (Int_t labelcolor) |
virtual void | SetLabelFont (Int_t labelfont) |
virtual void | SetLabelOffset (Float_t labeloffset) |
virtual void | SetLabelSize (Float_t labelsize) |
virtual void | SetLineColor (Color_t linecolor) |
Set the line color. | |
virtual void | SetLineWidth (Width_t linewidth) |
Set the line width. | |
virtual void | SetName (const char *name="") |
virtual void | SetTitleOffset (Float_t titleoffset=1) |
virtual void | SetTitleSize (Float_t titlesize) |
virtual void | UnZoom () |
Unzoom the palette. | |
Public Member Functions inherited from TPave | |
TPave () | |
Pave default constructor. | |
TPave (const TPave &pave) | |
Pave copy constructor. | |
TPave (Double_t x1, Double_t y1, Double_t x2, Double_t y2, Int_t bordersize=4, Option_t *option="br") | |
Pave normal constructor. | |
virtual | ~TPave () |
Pave default destructor. | |
virtual void | ConvertNDCtoPad () |
Convert pave coordinates from NDC to Pad coordinates. | |
void | Copy (TObject &pave) const |
Copy this pave to pave. | |
virtual void | Draw (Option_t *option="") |
Draw this pave with its current attributes. | |
virtual void | DrawPave (Double_t x1, Double_t y1, Double_t x2, Double_t y2, Int_t bordersize=4, Option_t *option="br") |
Draw this pave with new coordinates. | |
Int_t | GetBorderSize () const |
Double_t | GetCornerRadius () const |
Option_t * | GetName () const |
Returns name of object. | |
Option_t * | GetOption () const |
Int_t | GetShadowColor () const |
Double_t | GetX1NDC () const |
Double_t | GetX2NDC () const |
Double_t | GetY1NDC () const |
Double_t | GetY2NDC () const |
virtual ULong_t | Hash () const |
Return hash value for this object. | |
virtual Bool_t | IsSortable () const |
virtual void | ls (Option_t *option="") const |
List this pave with its attributes. | |
TPave & | operator= (const TPave &src) |
Assignment operator. | |
virtual void | PaintPave (Double_t x1, Double_t y1, Double_t x2, Double_t y2, Int_t bordersize=4, Option_t *option="br") |
Draw this pave with new coordinates. | |
virtual void | PaintPaveArc (Double_t x1, Double_t y1, Double_t x2, Double_t y2, Int_t bordersize=4, Option_t *option="br") |
Draw this pave with rounded corners. | |
virtual void | Print (Option_t *option="") const |
Dump this pave with its attributes. | |
virtual void | SetBorderSize (Int_t bordersize=4) |
virtual void | SetCornerRadius (Double_t rad=0.2) |
virtual void | SetOption (Option_t *option="br") |
virtual void | SetShadowColor (Int_t color) |
virtual void | SetX1 (Double_t x1) |
Set the X1 value. | |
virtual void | SetX1NDC (Double_t x1) |
virtual void | SetX2 (Double_t x2) |
Set the X2 value. | |
virtual void | SetX2NDC (Double_t x2) |
virtual void | SetY1 (Double_t y1) |
Set the Y1 value. | |
virtual void | SetY1NDC (Double_t y1) |
virtual void | SetY2 (Double_t y2) |
Set the Y2 value. | |
virtual void | SetY2NDC (Double_t y2) |
Public Member Functions inherited from TBox | |
TBox () | |
Box default constructor. | |
TBox (const TBox &box) | |
Box copy constructor. | |
TBox (Double_t x1, Double_t y1, Double_t x2, Double_t y2) | |
Box standard constructor. | |
virtual | ~TBox () |
Box destructor. | |
virtual TBox * | DrawBox (Double_t x1, Double_t y1, Double_t x2, Double_t y2) |
Draw this box with new coordinates. | |
virtual Rectangle_t | GetBBox () |
Return the "bounding Box" of the Box. | |
virtual TPoint | GetBBoxCenter () |
Return the center of the Box as TPoint in pixels. | |
Double_t | GetX1 () const |
Double_t | GetX2 () const |
Double_t | GetY1 () const |
Double_t | GetY2 () const |
virtual void | HideToolTip (Int_t event) |
Hide tool tip depending on the event type. | |
Bool_t | IsBeingResized () const |
virtual Int_t | IsInside (Double_t x, Double_t y) const |
Function which returns 1 if point x,y lies inside the box, 0 otherwise. | |
TBox & | operator= (const TBox &) |
Assignment operator. | |
virtual void | PaintBox (Double_t x1, Double_t y1, Double_t x2, Double_t y2, Option_t *option="") |
Draw this box with new coordinates. | |
virtual void | SetBBoxCenter (const TPoint &p) |
Set center of the Box. | |
virtual void | SetBBoxCenterX (const Int_t x) |
Set X coordinate of the center of the Box. | |
virtual void | SetBBoxCenterY (const Int_t y) |
Set Y coordinate of the center of the Box. | |
virtual void | SetBBoxX1 (const Int_t x) |
Set left hand side of BoundingBox to a value (resize in x direction on left) | |
virtual void | SetBBoxX2 (const Int_t x) |
Set right hand side of BoundingBox to a value (resize in x direction on right) | |
virtual void | SetBBoxY1 (const Int_t y) |
Set top of BoundingBox to a value (resize in y direction on top) | |
virtual void | SetBBoxY2 (const Int_t y) |
Set bottom of BoundingBox to a value (resize in y direction on bottom) | |
virtual void | SetToolTipText (const char *text, Long_t delayms=1000) |
Set tool tip text associated with this box. | |
Public Member Functions inherited from TObject | |
TObject () | |
TObject constructor. | |
TObject (const TObject &object) | |
TObject copy ctor. | |
virtual | ~TObject () |
TObject destructor. | |
void | AbstractMethod (const char *method) const |
Use this method to implement an "abstract" method that you don't want to leave purely abstract. | |
virtual void | AppendPad (Option_t *option="") |
Append graphics object to current pad. | |
virtual void | Browse (TBrowser *b) |
Browse object. May be overridden for another default action. | |
ULong_t | CheckedHash () |
Check and record whether this class has a consistent Hash/RecursiveRemove setup (*) and then return the regular Hash value for this object. | |
virtual const char * | ClassName () const |
Returns name of class to which the object belongs. | |
virtual void | Clear (Option_t *="") |
virtual TObject * | Clone (const char *newname="") const |
Make a clone of an object using the Streamer facility. | |
virtual Int_t | Compare (const TObject *obj) const |
Compare abstract method. | |
virtual void | Delete (Option_t *option="") |
Delete this object. | |
virtual void | DrawClass () const |
Draw class inheritance tree of the class to which this object belongs. | |
virtual TObject * | DrawClone (Option_t *option="") const |
Draw a clone of this object in the current selected pad for instance with: gROOT->SetSelectedPad(gPad) . | |
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=0) |
Execute method on this object with the given parameter string, e.g. | |
virtual void | Execute (TMethod *method, TObjArray *params, Int_t *error=0) |
Execute method on this object with parameters stored in the TObjArray. | |
virtual void | Fatal (const char *method, const char *msgfmt,...) const |
Issue fatal error message. | |
virtual TObject * | FindObject (const char *name) const |
Must be redefined in derived classes. | |
virtual TObject * | FindObject (const TObject *obj) const |
Must be redefined in derived classes. | |
virtual Option_t * | GetDrawOption () const |
Get option used by the graphics system to draw this object. | |
virtual const char * | GetIconName () const |
Returns mime type name of object. | |
virtual const char * | GetTitle () const |
Returns title of object. | |
virtual UInt_t | GetUniqueID () const |
Return the unique object id. | |
virtual Bool_t | HandleTimer (TTimer *timer) |
Execute action in response of a timer timing out. | |
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) |
virtual Bool_t | IsEqual (const TObject *obj) const |
Default equal comparison (objects are equal if they have the same address in memory). | |
virtual Bool_t | IsFolder () const |
Returns kTRUE in case object contains browsable objects (like containers or lists of other objects). | |
R__ALWAYS_INLINE Bool_t | IsOnHeap () const |
R__ALWAYS_INLINE Bool_t | IsZombie () const |
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. | |
void | Obsolete (const char *method, const char *asOfVers, const char *removedFromVers) const |
Use this method to declare a method obsolete. | |
void | operator delete (void *ptr) |
Operator delete. | |
void | operator delete[] (void *ptr) |
Operator delete []. | |
void * | operator new (size_t sz) |
void * | operator new (size_t sz, void *vp) |
void * | operator new[] (size_t sz) |
void * | operator new[] (size_t sz, void *vp) |
TObject & | operator= (const TObject &rhs) |
TObject assignment operator. | |
virtual void | Pop () |
Pop on object drawn in a pad to the top of the display list. | |
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. | |
void | SetBit (UInt_t f) |
void | SetBit (UInt_t f, Bool_t set) |
Set or unset the user status bits as specified in f. | |
virtual void | SetDrawOption (Option_t *option="") |
Set drawing option for object. | |
virtual void | SetUniqueID (UInt_t uid) |
Set the unique object id. | |
virtual void | SysError (const char *method, const char *msgfmt,...) const |
Issue system error message. | |
R__ALWAYS_INLINE Bool_t | TestBit (UInt_t f) const |
Int_t | TestBits (UInt_t f) const |
virtual void | UseCurrentStyle () |
Set current style settings in this object This function is called when either TCanvas::UseCurrentStyle or TROOT::ForceStyle have been invoked. | |
virtual void | Warning (const char *method, const char *msgfmt,...) const |
Issue warning message. | |
virtual Int_t | Write (const char *name=0, Int_t option=0, Int_t bufsize=0) |
Write this object to the current directory. | |
virtual Int_t | Write (const char *name=0, Int_t option=0, Int_t bufsize=0) const |
Write this object to the current directory. | |
Public Member Functions inherited from TAttLine | |
TAttLine () | |
AttLine default constructor. | |
TAttLine (Color_t lcolor, Style_t lstyle, Width_t lwidth) | |
AttLine normal constructor. | |
virtual | ~TAttLine () |
AttLine destructor. | |
void | Copy (TAttLine &attline) const |
Copy this line attributes to a new TAttLine. | |
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. | |
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 void | Modify () |
Change current line attributes if necessary. | |
virtual void | ResetAttLine (Option_t *option="") |
Reset this line attributes to default values. | |
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 | SetLineAttributes () |
Invoke the DialogCanvas Line attributes. | |
virtual void | SetLineColorAlpha (Color_t lcolor, Float_t lalpha) |
Set a transparent line color. | |
virtual void | SetLineStyle (Style_t lstyle) |
Set the line style. | |
Public Member Functions inherited from TAttFill | |
TAttFill () | |
AttFill default constructor. | |
TAttFill (Color_t fcolor, Style_t fstyle) | |
AttFill normal constructor. | |
virtual | ~TAttFill () |
AttFill destructor. | |
void | Copy (TAttFill &attfill) const |
Copy this fill attributes to a new TAttFill. | |
virtual Color_t | GetFillColor () const |
Return the fill area color. | |
virtual Style_t | GetFillStyle () const |
Return the fill area style. | |
virtual Bool_t | IsTransparent () const |
virtual void | Modify () |
Change current fill area attributes if necessary. | |
virtual void | ResetAttFill (Option_t *option="") |
Reset this fill attributes to default values. | |
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 | SetFillAttributes () |
Invoke the DialogCanvas Fill attributes. | |
virtual void | SetFillColor (Color_t fcolor) |
Set the fill area 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. | |
Public Member Functions inherited from TAttBBox2D | |
virtual | ~TAttBBox2D () |
Protected Attributes | |
TGaxis | fAxis |
TH1 * | fH |
TString | fName |
pointer to parent histogram | |
Protected Attributes inherited from TPave | |
Int_t | fBorderSize |
window box bordersize in pixels | |
Double_t | fCornerRadius |
Corner radius in case of option arc. | |
Int_t | fInit |
(=0 if transformation to NDC not yet done) | |
TString | fName |
Pave name. | |
TString | fOption |
Pave style. | |
Int_t | fShadowColor |
Color of the pave's shadow. | |
Double_t | fX1NDC |
X1 point in NDC coordinates. | |
Double_t | fX2NDC |
X2 point in NDC coordinates. | |
Double_t | fY1NDC |
Y1 point in NDC coordinates. | |
Double_t | fY2NDC |
Y2 point in NDC coordinates. | |
Protected Attributes inherited from TBox | |
Bool_t | fResizing |
! True if box is being resized | |
Double_t | fX1 |
X of 1st point. | |
Double_t | fX2 |
X of 2nd point. | |
Double_t | fY1 |
Y of 1st point. | |
Double_t | fY2 |
Y of 2nd point. | |
Protected Attributes inherited from TAttLine | |
Color_t | fLineColor |
Line color. | |
Style_t | fLineStyle |
Line style. | |
Width_t | fLineWidth |
Line width. | |
Protected Attributes inherited from TAttFill | |
Color_t | fFillColor |
Fill area color. | |
Style_t | fFillStyle |
Fill area style. | |
Additional Inherited Members | |
Static Public Member Functions inherited from TObject | |
static Long_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 inherited from TObject | |
enum | { kOnlyPrepStep = BIT(3) } |
Protected Member Functions inherited from TObject | |
virtual void | DoError (int level, const char *location, const char *fmt, va_list va) const |
Interface to ErrorHandler (protected). | |
void | MakeZombie () |
#include <TPaletteAxis.h>
Enumerator | |
---|---|
kHasView |
Definition at line 38 of file TPaletteAxis.h.
TPaletteAxis::TPaletteAxis | ( | ) |
Palette default constructor.
Definition at line 120 of file TPaletteAxis.cxx.
Palette normal constructor.
Definition at line 130 of file TPaletteAxis.cxx.
TPaletteAxis::TPaletteAxis | ( | const TPaletteAxis & | palette | ) |
Palette copy constructor.
Definition at line 152 of file TPaletteAxis.cxx.
|
virtual |
Palette destructor.
Definition at line 144 of file TPaletteAxis.cxx.
Copy a palette to a palette.
Reimplemented from TBox.
Definition at line 171 of file TPaletteAxis.cxx.
Check if mouse on the axis region.
Reimplemented from TPave.
Definition at line 182 of file TPaletteAxis.cxx.
Check if mouse on the axis region.
Reimplemented from TPave.
Definition at line 197 of file TPaletteAxis.cxx.
|
inline |
Definition at line 49 of file TPaletteAxis.h.
Returns the color index of the bin (i,j).
This function should be used after an histogram has been plotted with the option COL or COLZ like in the following example:
h2->Draw("COLZ"); gPad->Update(); TPaletteAxis *palette = (TPaletteAxis*)h2->GetListOfFunctions()->FindObject("palette"); Int_t ci = palette->GetBinColor(20,15);
Then it is possible to retrieve the RGB components in the following way:
TColor *c = gROOT->GetColor(ci); float x,y,z; c->GetRGB(x,y,z);
Definition at line 308 of file TPaletteAxis.cxx.
|
inline |
Definition at line 51 of file TPaletteAxis.h.
|
inlinevirtual |
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 52 of file TPaletteAxis.h.
Displays the z value corresponding to cursor position py.
Reimplemented from TObject.
Definition at line 318 of file TPaletteAxis.cxx.
Returns the color index of the given z value.
This function should be used after an histogram has been plotted with the option COL or COLZ like in the following example:
h2->Draw("COLZ"); gPad->Update(); TPaletteAxis *palette = (TPaletteAxis*)h2->GetListOfFunctions()->FindObject("palette"); Int_t ci = palette->GetValueColor(30.);
Then it is possible to retrieve the RGB components in the following way:
TColor *c = gROOT->GetColor(ci); float x,y,z; c->GetRGB(x,y,z);
Definition at line 362 of file TPaletteAxis.cxx.
TPaletteAxis & TPaletteAxis::operator= | ( | const TPaletteAxis & | orig | ) |
Assignment operator.
Definition at line 161 of file TPaletteAxis.cxx.
Save primitive as a C++ statement(s) on output stream out.
Reimplemented from TPave.
Definition at line 539 of file TPaletteAxis.cxx.
Definition at line 57 of file TPaletteAxis.h.
Definition at line 59 of file TPaletteAxis.h.
Definition at line 60 of file TPaletteAxis.h.
Definition at line 61 of file TPaletteAxis.h.
Definition at line 62 of file TPaletteAxis.h.
|
inlinevirtual |
Reimplemented from TPave.
Definition at line 58 of file TPaletteAxis.h.
Definition at line 63 of file TPaletteAxis.h.
Definition at line 64 of file TPaletteAxis.h.
|
virtual |
Unzoom the palette.
Definition at line 569 of file TPaletteAxis.cxx.
|
protected |
Definition at line 32 of file TPaletteAxis.h.
|
protected |
Definition at line 33 of file TPaletteAxis.h.
|
protected |
pointer to parent histogram
Definition at line 34 of file TPaletteAxis.h.