Logo ROOT  
Reference Guide

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.

{
TCanvas *c1 = new TCanvas("c1","c1",600,400);
TH2F *h2 = new TH2F("h2","Example of a resized palette ",40,-4,4,40,-20,20);
Float_t px, py;
for (Int_t i = 0; i < 25000; i++) {
gRandom->Rannor(px,py);
h2->Fill(px,5*py);
}
h2->Draw("COLZ");
gPad->Update();
TPaletteAxis *palette = (TPaletteAxis*)h2->GetListOfFunctions()->FindObject("palette");
palette->SetY2NDC(0.7);
return c1;
}
int Int_t
Definition: RtypesCore.h:43
float Float_t
Definition: RtypesCore.h:55
R__EXTERN TRandom * gRandom
Definition: TRandom.h:62
R__EXTERN TStyle * gStyle
Definition: TStyle.h:410
#define gPad
Definition: TVirtualPad.h:287
The Canvas class.
Definition: TCanvas.h:27
TList * GetListOfFunctions() const
Definition: TH1.h:239
virtual void Draw(Option_t *option="")
Draw this histogram with options.
Definition: TH1.cxx:2998
2-D histogram with a float per channel (see TH1 documentation)}
Definition: TH2.h:251
Int_t Fill(Double_t)
Invalid Fill method.
Definition: TH2.cxx:294
virtual TObject * FindObject(const char *name) const
Find an object in this list using its name.
Definition: TList.cxx:577
The palette painting class.
Definition: TPaletteAxis.h:29
virtual void SetY2NDC(Double_t y2)
Definition: TPave.h:81
virtual void Rannor(Float_t &a, Float_t &b)
Return 2 numbers distributed following a gaussian with mean=0 and sigma=1.
Definition: TRandom.cxx:489
void SetPalette(Int_t ncolors=kBird, Int_t *colors=0, Float_t alpha=1.)
See TColor::SetPalette.
Definition: TStyle.cxx:1783
return c1
Definition: legend1.C:41

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:

{
TCanvas *c1 = new TCanvas("c1","exa_CJUST",300,10,400,400);
TH2F *hpxpy = new TH2F("hpxpy","py vs px",40,-4,4,40,-4,4);
// Fill histograms randomly
TRandom3 randomNum;
Float_t px, py;
for (Int_t i = 0; i < 25000; i++) {
randomNum.Rannor(px,py);
hpxpy->Fill(px,py);
}
hpxpy->SetMaximum(200);
Double_t zcontours[5] = {0, 20, 40, 80, 120};
hpxpy->SetContour(5, zcontours);
hpxpy->GetZaxis()->SetTickSize(0.01);
hpxpy->GetZaxis()->SetLabelOffset(0.01);
gPad->SetRightMargin(0.13);
hpxpy->SetTitle("User contours, CJUST");
hpxpy->Draw("COL Z CJUST");
}
double Double_t
Definition: RtypesCore.h:57
virtual void SetLabelOffset(Float_t offset=0.005)
Set distance between the axis and the labels.
Definition: TAttAxis.cxx:193
virtual void SetTickSize(Float_t size=0.03)
Definition: TAttAxis.h:59
virtual void SetTitle(const char *title)
See GetStatOverflows for more information.
Definition: TH1.cxx:6345
TAxis * GetZaxis()
Definition: TH1.h:318
virtual void SetMaximum(Double_t maximum=-1111)
Definition: TH1.h:394
virtual void SetContour(Int_t nlevels, const Double_t *levels=0)
Set the number and values of contour levels.
Definition: TH1.cxx:7947
Random number generator class based on M.
Definition: TRandom3.h:27
void SetOptStat(Int_t stat=1)
The type of information printed in the histogram statistics box can be selected via the parameter mod...
Definition: TStyle.cxx:1590

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. More...
 
 TPaletteAxis (const TPaletteAxis &palette)
 Palette copy constructor. More...
 
 TPaletteAxis (Double_t x1, Double_t y1, Double_t x2, Double_t y2, TH1 *h)
 Palette normal constructor. More...
 
virtual ~TPaletteAxis ()
 Palette destructor. More...
 
void Copy (TObject &palette) const
 Copy a palette to a palette. More...
 
virtual Int_t DistancetoPrimitive (Int_t px, Int_t py)
 Check if mouse on the axis region. More...
 
virtual void ExecuteEvent (Int_t event, Int_t px, Int_t py)
 Check if mouse on the axis region. More...
 
TGaxisGetAxis ()
 
Int_t GetBinColor (Int_t i, Int_t j)
 Returns the color index of the bin (i,j). More...
 
TH1GetHistogram ()
 
Option_tGetName () const
 Returns name of object. More...
 
virtual char * GetObjectInfo (Int_t px, Int_t py) const
 Displays the z value corresponding to cursor position py. More...
 
Int_t GetValueColor (Double_t zc)
 Returns the color index of the given z value. More...
 
TPaletteAxisoperator= (const TPaletteAxis &)
 Assignment operator. More...
 
virtual void Paint (Option_t *option="")
 Paint the palette. More...
 
virtual void SavePrimitive (std::ostream &out, Option_t *option="")
 Save primitive as a C++ statement(s) on output stream out. More...
 
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. More...
 
virtual void SetLineWidth (Width_t linewidth)
 Set the line width. More...
 
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. More...
 
- Public Member Functions inherited from TPave
 TPave ()
 Pave default constructor. More...
 
 TPave (const TPave &pave)
 Pave copy constructor. More...
 
 TPave (Double_t x1, Double_t y1, Double_t x2, Double_t y2, Int_t bordersize=4, Option_t *option="br")
 Pave normal constructor. More...
 
virtual ~TPave ()
 Pave default destructor. More...
 
virtual void ConvertNDCtoPad ()
 Convert pave coordinates from NDC to Pad coordinates. More...
 
void Copy (TObject &pave) const
 Copy this pave to pave. More...
 
virtual Int_t DistancetoPrimitive (Int_t px, Int_t py)
 Compute distance from point px,py to a pave. More...
 
virtual void Draw (Option_t *option="")
 Draw this pave with its current attributes. More...
 
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. More...
 
virtual void ExecuteEvent (Int_t event, Int_t px, Int_t py)
 Execute action corresponding to one event. More...
 
Int_t GetBorderSize () const
 
Double_t GetCornerRadius () const
 
Option_tGetName () const
 Returns name of object. More...
 
Option_tGetOption () 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. More...
 
virtual Bool_t IsSortable () const
 
virtual void ls (Option_t *option="") const
 List this pave with its attributes. More...
 
TPaveoperator= (const TPave &src)
 Assignment operator. More...
 
virtual void Paint (Option_t *option="")
 Paint this pave with its current attributes. More...
 
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. More...
 
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. More...
 
virtual void Print (Option_t *option="") const
 Dump this pave with its attributes. More...
 
virtual void SavePrimitive (std::ostream &out, Option_t *option="")
 Save primitive as a C++ statement(s) on output stream out. More...
 
virtual void SetBorderSize (Int_t bordersize=4)
 
virtual void SetCornerRadius (Double_t rad=0.2)
 
virtual void SetName (const char *name="")
 
virtual void SetOption (Option_t *option="br")
 
virtual void SetShadowColor (Int_t color)
 
virtual void SetX1 (Double_t x1)
 Set the X1 value. More...
 
virtual void SetX1NDC (Double_t x1)
 
virtual void SetX2 (Double_t x2)
 Set the X2 value. More...
 
virtual void SetX2NDC (Double_t x2)
 
virtual void SetY1 (Double_t y1)
 Set the Y1 value. More...
 
virtual void SetY1NDC (Double_t y1)
 
virtual void SetY2 (Double_t y2)
 Set the Y2 value. More...
 
virtual void SetY2NDC (Double_t y2)
 
- Public Member Functions inherited from TBox
 TBox ()
 Box default constructor. More...
 
 TBox (const TBox &box)
 Box copy constructor. More...
 
 TBox (Double_t x1, Double_t y1, Double_t x2, Double_t y2)
 Box standard constructor. More...
 
virtual ~TBox ()
 Box destructor. More...
 
void Copy (TObject &box) const
 Copy a Box. More...
 
virtual Int_t DistancetoPrimitive (Int_t px, Int_t py)
 Compute distance from point px,py to a box. More...
 
virtual void Draw (Option_t *option="")
 Draw this box with its current attributes. More...
 
virtual TBoxDrawBox (Double_t x1, Double_t y1, Double_t x2, Double_t y2)
 Draw this box with new coordinates. More...
 
virtual void ExecuteEvent (Int_t event, Int_t px, Int_t py)
 Execute action corresponding to one event. More...
 
virtual Rectangle_t GetBBox ()
 Return the "bounding Box" of the Box. More...
 
virtual TPoint GetBBoxCenter ()
 Return the center of the Box as TPoint in pixels. More...
 
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. More...
 
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. More...
 
virtual void ls (Option_t *option="") const
 List this box with its attributes. More...
 
TBoxoperator= (const TBox &)
 Assignment operator. More...
 
virtual void Paint (Option_t *option="")
 Paint this box with its current attributes. More...
 
virtual void PaintBox (Double_t x1, Double_t y1, Double_t x2, Double_t y2, Option_t *option="")
 Draw this box with new coordinates. More...
 
virtual void Print (Option_t *option="") const
 Dump this box with its attributes. More...
 
virtual void SavePrimitive (std::ostream &out, Option_t *option="")
 Save primitive as a C++ statement(s) on output stream out. More...
 
virtual void SetBBoxCenter (const TPoint &p)
 Set center of the Box. More...
 
virtual void SetBBoxCenterX (const Int_t x)
 Set X coordinate of the center of the Box. More...
 
virtual void SetBBoxCenterY (const Int_t y)
 Set Y coordinate of the center of the Box. More...
 
virtual void SetBBoxX1 (const Int_t x)
 Set left hand side of BoundingBox to a value (resize in x direction on left) More...
 
virtual void SetBBoxX2 (const Int_t x)
 Set right hand side of BoundingBox to a value (resize in x direction on right) More...
 
virtual void SetBBoxY1 (const Int_t y)
 Set top of BoundingBox to a value (resize in y direction on top) More...
 
virtual void SetBBoxY2 (const Int_t y)
 Set bottom of BoundingBox to a value (resize in y direction on bottom) More...
 
virtual void SetToolTipText (const char *text, Long_t delayms=1000)
 Set tool tip text associated with this box. More...
 
virtual void SetX1 (Double_t x1)
 
virtual void SetX2 (Double_t x2)
 
virtual void SetY1 (Double_t y1)
 
virtual void SetY2 (Double_t y2)
 
- Public Member Functions inherited from TObject
 TObject ()
 TObject constructor. More...
 
 TObject (const TObject &object)
 TObject copy ctor. More...
 
virtual ~TObject ()
 TObject destructor. More...
 
void AbstractMethod (const char *method) const
 Use this method to implement an "abstract" method that you don't want to leave purely abstract. More...
 
virtual void AppendPad (Option_t *option="")
 Append graphics object to current pad. More...
 
virtual void Browse (TBrowser *b)
 Browse object. May be overridden for another default action. More...
 
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. More...
 
virtual const char * ClassName () const
 Returns name of class to which the object belongs. More...
 
virtual void Clear (Option_t *="")
 
virtual TObjectClone (const char *newname="") const
 Make a clone of an object using the Streamer facility. More...
 
virtual Int_t Compare (const TObject *obj) const
 Compare abstract method. More...
 
virtual void Copy (TObject &object) const
 Copy this to obj. More...
 
virtual void Delete (Option_t *option="")
 Delete this object. More...
 
virtual Int_t DistancetoPrimitive (Int_t px, Int_t py)
 Computes distance from point (px,py) to the object. More...
 
virtual void Draw (Option_t *option="")
 Default Draw method for all objects. More...
 
virtual void DrawClass () const
 Draw class inheritance tree of the class to which this object belongs. More...
 
virtual TObjectDrawClone (Option_t *option="") const
 Draw a clone of this object in the current selected pad for instance with: gROOT->SetSelectedPad(gPad). More...
 
virtual void Dump () const
 Dump contents of object on stdout. More...
 
virtual void Error (const char *method, const char *msgfmt,...) const
 Issue error message. More...
 
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. More...
 
virtual void Execute (TMethod *method, TObjArray *params, Int_t *error=0)
 Execute method on this object with parameters stored in the TObjArray. More...
 
virtual void ExecuteEvent (Int_t event, Int_t px, Int_t py)
 Execute action corresponding to an event at (px,py). More...
 
virtual void Fatal (const char *method, const char *msgfmt,...) const
 Issue fatal error message. More...
 
virtual TObjectFindObject (const char *name) const
 Must be redefined in derived classes. More...
 
virtual TObjectFindObject (const TObject *obj) const
 Must be redefined in derived classes. More...
 
virtual Option_tGetDrawOption () const
 Get option used by the graphics system to draw this object. More...
 
virtual const char * GetIconName () const
 Returns mime type name of object. More...
 
virtual const char * GetName () const
 Returns name of object. More...
 
virtual char * GetObjectInfo (Int_t px, Int_t py) const
 Returns string containing info about the object at position (px,py). More...
 
virtual Option_tGetOption () const
 
virtual const char * GetTitle () const
 Returns title of object. More...
 
virtual UInt_t GetUniqueID () const
 Return the unique object id. More...
 
virtual Bool_t HandleTimer (TTimer *timer)
 Execute action in response of a timer timing out. More...
 
virtual ULong_t Hash () const
 Return hash value for this object. More...
 
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. More...
 
virtual void Info (const char *method, const char *msgfmt,...) const
 Issue info message. More...
 
virtual Bool_t InheritsFrom (const char *classname) const
 Returns kTRUE if object inherits from class "classname". More...
 
virtual Bool_t InheritsFrom (const TClass *cl) const
 Returns kTRUE if object inherits from TClass cl. More...
 
virtual void Inspect () const
 Dump contents of this object in a graphics canvas. More...
 
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). More...
 
virtual Bool_t IsFolder () const
 Returns kTRUE in case object contains browsable objects (like containers or lists of other objects). More...
 
R__ALWAYS_INLINE Bool_t IsOnHeap () const
 
virtual Bool_t IsSortable () const
 
R__ALWAYS_INLINE Bool_t IsZombie () const
 
virtual void ls (Option_t *option="") const
 The ls function lists the contents of a class on stdout. More...
 
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). More...
 
virtual Bool_t Notify ()
 This method must be overridden to handle object notification. More...
 
void Obsolete (const char *method, const char *asOfVers, const char *removedFromVers) const
 Use this method to declare a method obsolete. More...
 
void operator delete (void *ptr)
 Operator delete. More...
 
void operator delete[] (void *ptr)
 Operator delete []. More...
 
voidoperator new (size_t sz)
 
voidoperator new (size_t sz, void *vp)
 
voidoperator new[] (size_t sz)
 
voidoperator new[] (size_t sz, void *vp)
 
TObjectoperator= (const TObject &rhs)
 TObject assignment operator. More...
 
virtual void Paint (Option_t *option="")
 This method must be overridden if a class wants to paint itself. More...
 
virtual void Pop ()
 Pop on object drawn in a pad to the top of the display list. More...
 
virtual void Print (Option_t *option="") const
 This method must be overridden when a class wants to print itself. More...
 
virtual Int_t Read (const char *name)
 Read contents of object with specified name from the current directory. More...
 
virtual void RecursiveRemove (TObject *obj)
 Recursively remove this object from a list. More...
 
void ResetBit (UInt_t f)
 
virtual void SaveAs (const char *filename="", Option_t *option="") const
 Save this object in the file specified by filename. More...
 
virtual void SavePrimitive (std::ostream &out, Option_t *option="")
 Save a primitive as a C++ statement(s) on output stream "out". More...
 
void SetBit (UInt_t f)
 
void SetBit (UInt_t f, Bool_t set)
 Set or unset the user status bits as specified in f. More...
 
virtual void SetDrawOption (Option_t *option="")
 Set drawing option for object. More...
 
virtual void SetUniqueID (UInt_t uid)
 Set the unique object id. More...
 
virtual void SysError (const char *method, const char *msgfmt,...) const
 Issue system error message. More...
 
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. More...
 
virtual void Warning (const char *method, const char *msgfmt,...) const
 Issue warning message. More...
 
virtual Int_t Write (const char *name=0, Int_t option=0, Int_t bufsize=0)
 Write this object to the current directory. More...
 
virtual Int_t Write (const char *name=0, Int_t option=0, Int_t bufsize=0) const
 Write this object to the current directory. More...
 
- Public Member Functions inherited from TAttLine
 TAttLine ()
 AttLine default constructor. More...
 
 TAttLine (Color_t lcolor, Style_t lstyle, Width_t lwidth)
 AttLine normal constructor. More...
 
virtual ~TAttLine ()
 AttLine destructor. More...
 
void Copy (TAttLine &attline) const
 Copy this line attributes to a new TAttLine. More...
 
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. More...
 
virtual Color_t GetLineColor () const
 Return the line color. More...
 
virtual Style_t GetLineStyle () const
 Return the line style. More...
 
virtual Width_t GetLineWidth () const
 Return the line width. More...
 
virtual void Modify ()
 Change current line attributes if necessary. More...
 
virtual void ResetAttLine (Option_t *option="")
 Reset this line attributes to default values. More...
 
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. More...
 
virtual void SetLineAttributes ()
 Invoke the DialogCanvas Line attributes. More...
 
virtual void SetLineColor (Color_t lcolor)
 Set the line color. More...
 
virtual void SetLineColorAlpha (Color_t lcolor, Float_t lalpha)
 Set a transparent line color. More...
 
virtual void SetLineStyle (Style_t lstyle)
 Set the line style. More...
 
virtual void SetLineWidth (Width_t lwidth)
 Set the line width. More...
 
- Public Member Functions inherited from TAttFill
 TAttFill ()
 AttFill default constructor. More...
 
 TAttFill (Color_t fcolor, Style_t fstyle)
 AttFill normal constructor. More...
 
virtual ~TAttFill ()
 AttFill destructor. More...
 
void Copy (TAttFill &attfill) const
 Copy this fill attributes to a new TAttFill. More...
 
virtual Color_t GetFillColor () const
 Return the fill area color. More...
 
virtual Style_t GetFillStyle () const
 Return the fill area style. More...
 
virtual Bool_t IsTransparent () const
 
virtual void Modify ()
 Change current fill area attributes if necessary. More...
 
virtual void ResetAttFill (Option_t *option="")
 Reset this fill attributes to default values. More...
 
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. More...
 
virtual void SetFillAttributes ()
 Invoke the DialogCanvas Fill attributes. More...
 
virtual void SetFillColor (Color_t fcolor)
 Set the fill area color. More...
 
virtual void SetFillColorAlpha (Color_t fcolor, Float_t falpha)
 Set a transparent fill color. More...
 
virtual void SetFillStyle (Style_t fstyle)
 Set the fill area style. More...
 
- Public Member Functions inherited from TAttBBox2D
virtual ~TAttBBox2D ()
 
virtual Rectangle_t GetBBox ()=0
 
virtual TPoint GetBBoxCenter ()=0
 
virtual void SetBBoxCenter (const TPoint &p)=0
 
virtual void SetBBoxCenterX (const Int_t x)=0
 
virtual void SetBBoxCenterY (const Int_t y)=0
 
virtual void SetBBoxX1 (const Int_t x)=0
 
virtual void SetBBoxX2 (const Int_t x)=0
 
virtual void SetBBoxY1 (const Int_t y)=0
 
virtual void SetBBoxY2 (const Int_t y)=0
 

Protected Attributes

TGaxis fAxis
 
TH1fH
 
TString fName
 pointer to parent histogram More...
 
- Protected Attributes inherited from TPave
Int_t fBorderSize
 window box bordersize in pixels More...
 
Double_t fCornerRadius
 Corner radius in case of option arc. More...
 
Int_t fInit
 (=0 if transformation to NDC not yet done) More...
 
TString fName
 Pave name. More...
 
TString fOption
 Pave style. More...
 
Int_t fShadowColor
 Color of the pave's shadow. More...
 
Double_t fX1NDC
 X1 point in NDC coordinates. More...
 
Double_t fX2NDC
 X2 point in NDC coordinates. More...
 
Double_t fY1NDC
 Y1 point in NDC coordinates. More...
 
Double_t fY2NDC
 Y2 point in NDC coordinates. More...
 
- Protected Attributes inherited from TBox
Bool_t fResizing
 ! True if box is being resized More...
 
Double_t fX1
 X of 1st point. More...
 
Double_t fX2
 X of 2nd point. More...
 
Double_t fY1
 Y of 1st point. More...
 
Double_t fY2
 Y of 2nd point. More...
 
- Protected Attributes inherited from TAttLine
Color_t fLineColor
 Line color. More...
 
Style_t fLineStyle
 Line style. More...
 
Width_t fLineWidth
 Line width. More...
 
- Protected Attributes inherited from TAttFill
Color_t fFillColor
 Fill area color. More...
 
Style_t fFillStyle
 Fill area style. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from TObject
static Long_t GetDtorOnly ()
 Return destructor only flag. More...
 
static Bool_t GetObjectStat ()
 Get status of object stat flag. More...
 
static void SetDtorOnly (void *obj)
 Set destructor only flag. More...
 
static void SetObjectStat (Bool_t stat)
 Turn on/off tracking of objects in the TObjectTable. More...
 
- 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). More...
 
void MakeZombie ()
 

#include <TPaletteAxis.h>

Inheritance diagram for TPaletteAxis:
[legend]

Member Enumeration Documentation

◆ EStatusBits

Enumerator
kHasView 

Definition at line 38 of file TPaletteAxis.h.

Constructor & Destructor Documentation

◆ TPaletteAxis() [1/3]

TPaletteAxis::TPaletteAxis ( )

Palette default constructor.

Definition at line 118 of file TPaletteAxis.cxx.

◆ TPaletteAxis() [2/3]

TPaletteAxis::TPaletteAxis ( Double_t  x1,
Double_t  y1,
Double_t  x2,
Double_t  y2,
TH1 h 
)

Palette normal constructor.

Definition at line 128 of file TPaletteAxis.cxx.

◆ TPaletteAxis() [3/3]

TPaletteAxis::TPaletteAxis ( const TPaletteAxis palette)

Palette copy constructor.

Definition at line 150 of file TPaletteAxis.cxx.

◆ ~TPaletteAxis()

TPaletteAxis::~TPaletteAxis ( )
virtual

Palette destructor.

Definition at line 142 of file TPaletteAxis.cxx.

Member Function Documentation

◆ Copy()

void TPaletteAxis::Copy ( TObject palette) const
virtual

Copy a palette to a palette.

Reimplemented from TPave.

Definition at line 169 of file TPaletteAxis.cxx.

◆ DistancetoPrimitive()

Int_t TPaletteAxis::DistancetoPrimitive ( Int_t  px,
Int_t  py 
)
virtual

Check if mouse on the axis region.

Reimplemented from TPave.

Definition at line 180 of file TPaletteAxis.cxx.

◆ ExecuteEvent()

void TPaletteAxis::ExecuteEvent ( Int_t  event,
Int_t  px,
Int_t  py 
)
virtual

Check if mouse on the axis region.

Reimplemented from TPave.

Definition at line 195 of file TPaletteAxis.cxx.

◆ GetAxis()

TGaxis * TPaletteAxis::GetAxis ( )
inline

Definition at line 49 of file TPaletteAxis.h.

◆ GetBinColor()

Int_t TPaletteAxis::GetBinColor ( Int_t  i,
Int_t  j 
)

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 306 of file TPaletteAxis.cxx.

◆ GetHistogram()

TH1 * TPaletteAxis::GetHistogram ( )
inline

Definition at line 51 of file TPaletteAxis.h.

◆ GetName()

Option_t * TPaletteAxis::GetName ( ) const
inlinevirtual

Returns name of object.

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

Reimplemented from TPave.

Definition at line 52 of file TPaletteAxis.h.

◆ GetObjectInfo()

char * TPaletteAxis::GetObjectInfo ( Int_t  px,
Int_t  py 
) const
virtual

Displays the z value corresponding to cursor position py.

Reimplemented from TObject.

Definition at line 316 of file TPaletteAxis.cxx.

◆ GetValueColor()

Int_t TPaletteAxis::GetValueColor ( Double_t  zc)

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 360 of file TPaletteAxis.cxx.

◆ operator=()

TPaletteAxis & TPaletteAxis::operator= ( const TPaletteAxis orig)

Assignment operator.

Definition at line 159 of file TPaletteAxis.cxx.

◆ Paint()

void TPaletteAxis::Paint ( Option_t option = "")
virtual

Paint the palette.

Reimplemented from TPave.

Definition at line 394 of file TPaletteAxis.cxx.

◆ SavePrimitive()

void TPaletteAxis::SavePrimitive ( std::ostream &  out,
Option_t option = "" 
)
virtual

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

Reimplemented from TPave.

Definition at line 537 of file TPaletteAxis.cxx.

◆ SetHistogram()

void TPaletteAxis::SetHistogram ( TH1 h)
inline

Definition at line 57 of file TPaletteAxis.h.

◆ SetLabelColor()

virtual void TPaletteAxis::SetLabelColor ( Int_t  labelcolor)
inlinevirtual

Definition at line 59 of file TPaletteAxis.h.

◆ SetLabelFont()

virtual void TPaletteAxis::SetLabelFont ( Int_t  labelfont)
inlinevirtual

Definition at line 60 of file TPaletteAxis.h.

◆ SetLabelOffset()

virtual void TPaletteAxis::SetLabelOffset ( Float_t  labeloffset)
inlinevirtual

Definition at line 61 of file TPaletteAxis.h.

◆ SetLabelSize()

virtual void TPaletteAxis::SetLabelSize ( Float_t  labelsize)
inlinevirtual

Definition at line 62 of file TPaletteAxis.h.

◆ SetLineColor()

virtual void TPaletteAxis::SetLineColor ( Color_t  lcolor)
inlinevirtual

Set the line color.

Reimplemented from TAttLine.

Definition at line 65 of file TPaletteAxis.h.

◆ SetLineWidth()

virtual void TPaletteAxis::SetLineWidth ( Width_t  lwidth)
inlinevirtual

Set the line width.

Reimplemented from TAttLine.

Definition at line 66 of file TPaletteAxis.h.

◆ SetName()

virtual void TPaletteAxis::SetName ( const char *  name = "")
inlinevirtual

Reimplemented from TPave.

Definition at line 58 of file TPaletteAxis.h.

◆ SetTitleOffset()

virtual void TPaletteAxis::SetTitleOffset ( Float_t  titleoffset = 1)
inlinevirtual

Definition at line 63 of file TPaletteAxis.h.

◆ SetTitleSize()

virtual void TPaletteAxis::SetTitleSize ( Float_t  titlesize)
inlinevirtual

Definition at line 64 of file TPaletteAxis.h.

◆ UnZoom()

void TPaletteAxis::UnZoom ( )
virtual

Unzoom the palette.

Definition at line 567 of file TPaletteAxis.cxx.

Member Data Documentation

◆ fAxis

TGaxis TPaletteAxis::fAxis
protected

Definition at line 32 of file TPaletteAxis.h.

◆ fH

TH1* TPaletteAxis::fH
protected

Definition at line 33 of file TPaletteAxis.h.

◆ fName

TString TPaletteAxis::fName
protected

pointer to parent histogram

Definition at line 34 of file TPaletteAxis.h.

Libraries for TPaletteAxis:
[legend]

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