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.

{
   auto 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);
   }
   gStyle->SetPalette(1);
   h2->Draw("COLZ");
   gPad->Update();
   auto palette = (TPaletteAxis*)h2->GetListOfFunctions()->FindObject("palette");
   palette->SetY2NDC(0.7);
}

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 responsibility 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:

{
   gStyle->SetOptStat(0);
   auto c = new TCanvas("c","exa_CJUST",300,10,400,400);
   auto 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");
}

Definition at line 28 of file TPaletteAxis.h.

Public Types
enum	EStatusBits { kHasView = (1ULL << ( 11 )) }

Public Types inherited from TPave
enum	{ kNameIsAction = (1ULL << ( 11 )) }

Public Types inherited from TBox
enum	{ kCannotMove = (1ULL << ( 12 )) }

Public Types inherited from TObject
enum	{ kIsOnHeap = 0x01000000 , kNotDeleted = 0x02000000 , kZombie = 0x04000000 , kInconsistent = 0x08000000 , kBitMask = 0x00ffffff }

enum	{ kSingleKey = (1ULL << ( 0 )) , kOverwrite = (1ULL << ( 1 )) , kWriteDelete = (1ULL << ( 2 )) }

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
	TPaletteAxis ()
	Palette default constructor.

	TPaletteAxis (const TPaletteAxis &palette)
	Palette copy constructor.

	TPaletteAxis (Double_t x1, Double_t y1, Double_t x2, Double_t y2, Double_t min, Double_t max)
	Palette normal constructor.

	TPaletteAxis (Double_t x1, Double_t y1, Double_t x2, Double_t y2, TAxis *ax)
	Palette normal constructor.

	TPaletteAxis (Double_t x1, Double_t y1, Double_t x2, Double_t y2, TH1 *h)
	Palette normal constructor.

	~TPaletteAxis () override
	Palette destructor.

void	Copy (TObject &palette) const override
	Copy a palette to a palette.

Int_t	DistancetoPrimitive (Int_t px, Int_t py) override
	Check if mouse on the axis region.

void	ExecuteEvent (Int_t event, Int_t px, Int_t py) override
	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 ()

char *	GetObjectInfo (Int_t px, Int_t py) const override
	Displays the z value corresponding to cursor position py.

Int_t	GetValueColor (Double_t zc)
	Returns the color index of the given z value.

TClass *	IsA () const override

TPaletteAxis &	operator= (const TPaletteAxis &)
	Assignment operator.

void	Paint (Option_t *option="") override
	Paint the palette.

void	SavePrimitive (std::ostream &out, Option_t *option="") override
	Save primitive as a C++ statement(s) on output stream out.

virtual void	SetAxisColor (Int_t color=1, Float_t alpha=1)

void	SetHistogram (TH1 *h)

virtual void	SetLabelColor (Int_t color=1)

virtual void	SetLabelFont (Int_t font=42)

virtual void	SetLabelOffset (Float_t offset=0.005)

virtual void	SetLabelSize (Float_t size=0.035)

void	SetLineWidth (Width_t width) override
	Set the line width.

virtual void	SetMaxDigits (Float_t maxdigits=5)

virtual void	SetNdivisions (Int_t ndiv=10)

virtual void	SetTickLength (Float_t length=0.03)

virtual void	SetTitle (const char *title="")

virtual void	SetTitleColor (Int_t color=1)

virtual void	SetTitleFont (Int_t font=42)

virtual void	SetTitleOffset (Float_t offset=1)

virtual void	SetTitleSize (Float_t size=0.035)

void	Streamer (TBuffer &) override
	Stream an object of class TBox.

void	StreamerNVirtual (TBuffer &ClassDef_StreamerNVirtual_b)

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.

	~TPave () override
	Pave default destructor.

virtual void	ConvertNDCtoPad ()
	Convert pave coordinates from NDC to Pad coordinates.

void	Copy (TObject &pave) const override
	Copy this pave to pave.

Int_t	DistancetoPrimitive (Int_t px, Int_t py) override
	Compute distance from point px,py to a pave.

void	Draw (Option_t *option="") override
	Draw this pave with its current attributes.

virtual TPave *	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.

void	ExecuteEvent (Int_t event, Int_t px, Int_t py) override
	Execute action corresponding to one event.

Int_t	GetBorderSize () const

Double_t	GetCornerRadius () const

const char *	GetName () const override
	Returns name of object.

Option_t *	GetOption () const override

Int_t	GetShadowColor () const

Double_t	GetX1NDC () const

Double_t	GetX2NDC () const

Double_t	GetY1NDC () const

Double_t	GetY2NDC () const

ULong_t	Hash () const override
	Return hash value for this object.

TClass *	IsA () const override

Bool_t	IsSortable () const override

void	ls (Option_t *option="") const override
	List this pave with its attributes.

TPave &	operator= (const TPave &src)
	Assignment operator.

void	Paint (Option_t *option="") override
	Paint this pave with its current attributes.

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.

void	Print (Option_t *option="") const override
	Dump this pave with its attributes.

void	SavePrimitive (std::ostream &out, Option_t *option="") override
	Save primitive as a C++ statement(s) on output stream out.

virtual void	SetBorderSize (Int_t bordersize=4)
	Sets the border size of the TPave box and shadow.

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)

void	SetX1 (Double_t x1) override
	Set the X1 value.

virtual void	SetX1NDC (Double_t x1)

void	SetX2 (Double_t x2) override
	Set the X2 value.

virtual void	SetX2NDC (Double_t x2)

void	SetY1 (Double_t y1) override
	Set the Y1 value.

virtual void	SetY1NDC (Double_t y1)

void	SetY2 (Double_t y2) override
	Set the Y2 value.

virtual void	SetY2NDC (Double_t y2)

void	Streamer (TBuffer &) override
	Stream an object of class TPave.

void	StreamerNVirtual (TBuffer &ClassDef_StreamerNVirtual_b)

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.

	~TBox () override
	Box destructor.

virtual TBox *	DrawBox (Double_t x1, Double_t y1, Double_t x2, Double_t y2)
	Draw this box with new coordinates.

Rectangle_t	GetBBox () override
	Return the "bounding Box" of the Box.

TPoint	GetBBoxCenter () override
	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.

void	SetBBoxCenter (const TPoint &p) override
	Set center of the Box.

void	SetBBoxCenterX (const Int_t x) override
	Set X coordinate of the center of the Box.

void	SetBBoxCenterY (const Int_t y) override
	Set Y coordinate of the center of the Box.

void	SetBBoxX1 (const Int_t x) override
	Set left hand side of BoundingBox to a value (resize in x direction on left)

void	SetBBoxX2 (const Int_t x) override
	Set right hand side of BoundingBox to a value (resize in x direction on right)

void	SetBBoxY1 (const Int_t y) override
	Set top of BoundingBox to a value (resize in y direction on top)

void	SetBBoxY2 (const Int_t y) override
	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.

void	StreamerNVirtual (TBuffer &ClassDef_StreamerNVirtual_b)

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

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

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 (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 *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.

void	StreamerNVirtual (TBuffer &ClassDef_StreamerNVirtual_b)

virtual void	SysError (const char method, const char msgfmt,...) const
	Issue system error message.

R__ALWAYS_INLINE Bool_t	TestBit (UInt_t f) const

Int_t	TestBits (UInt_t f) const

virtual void	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.

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	SetLineColor (Color_t lcolor)
	Set the line color.

virtual void	SetLineColorAlpha (Color_t lcolor, Float_t lalpha)
	Set a transparent line color.

virtual void	SetLineStyle (Style_t lstyle)
	Set the line style.

void	StreamerNVirtual (TBuffer &ClassDef_StreamerNVirtual_b)

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.

void	StreamerNVirtual (TBuffer &ClassDef_StreamerNVirtual_b)

Public Member Functions inherited from TAttBBox2D
virtual	~TAttBBox2D ()

void	StreamerNVirtual (TBuffer &ClassDef_StreamerNVirtual_b)

Static Public Member Functions
static TClass *	Class ()

static const char *	Class_Name ()

static constexpr Version_t	Class_Version ()

static const char *	DeclFileName ()

Static Public Member Functions inherited from TPave
static TClass *	Class ()

static const char *	Class_Name ()

static constexpr Version_t	Class_Version ()

static const char *	DeclFileName ()

Static Public Member Functions inherited from TBox
static TClass *	Class ()

static const char *	Class_Name ()

static constexpr Version_t	Class_Version ()

static const char *	DeclFileName ()

Static Public Member Functions inherited from TObject
static TClass *	Class ()

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.

Static Public Member Functions inherited from TAttLine
static TClass *	Class ()

static const char *	Class_Name ()

static constexpr Version_t	Class_Version ()

static const char *	DeclFileName ()

Static Public Member Functions inherited from TAttFill
static TClass *	Class ()

static const char *	Class_Name ()

static constexpr Version_t	Class_Version ()

static const char *	DeclFileName ()

Static Public Member Functions inherited from TAttBBox2D
static TClass *	Class ()

static const char *	Class_Name ()

static constexpr Version_t	Class_Version ()

static const char *	DeclFileName ()

Protected Attributes
TGaxis	fAxis
	Palette axis.

TH1 *	fH
	! 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
Protected Types inherited from TObject
enum	{ kOnlyPrepStep = (1ULL << ( 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>

Inheritance diagram for TPaletteAxis:

[legend]

Member Enumeration Documentation

◆ EStatusBits

enum TPaletteAxis::EStatusBits

Enumerator
kHasView

Definition at line 36 of file TPaletteAxis.h.

Constructor & Destructor Documentation

◆ TPaletteAxis() [1/5]

TPaletteAxis::TPaletteAxis ( )

Palette default constructor.

Definition at line 119 of file TPaletteAxis.cxx.

◆ TPaletteAxis() [2/5]

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

Palette normal constructor.

Definition at line 129 of file TPaletteAxis.cxx.

◆ TPaletteAxis() [3/5]

TPaletteAxis::TPaletteAxis	(	Double_t	x1,
		Double_t	y1,
		Double_t	x2,
		Double_t	y2,
		Double_t	min,
		Double_t	max
	)

Palette normal constructor.

Definition at line 144 of file TPaletteAxis.cxx.

◆ TPaletteAxis() [4/5]

TPaletteAxis::TPaletteAxis	(	Double_t	x1,
		Double_t	y1,
		Double_t	x2,
		Double_t	y2,
		TAxis *	ax
	)

Palette normal constructor.

Definition at line 158 of file TPaletteAxis.cxx.

◆ TPaletteAxis() [5/5]

TPaletteAxis::TPaletteAxis ( const TPaletteAxis & palette )

Palette copy constructor.

Definition at line 179 of file TPaletteAxis.cxx.

◆ ~TPaletteAxis()

TPaletteAxis::~TPaletteAxis ( )

override

Palette destructor.

Definition at line 171 of file TPaletteAxis.cxx.

Member Function Documentation

◆ Class()

static TClass * TPaletteAxis::Class ( )

static

Returns: TClass describing this class

◆ Class_Name()

static const char * TPaletteAxis::Class_Name ( )

static

Returns: Name of this class

◆ Class_Version()

static constexpr Version_t TPaletteAxis::Class_Version ( )

inlinestaticconstexpr

Returns: Version of this class

Definition at line 74 of file TPaletteAxis.h.

◆ Copy()

void TPaletteAxis::Copy ( TObject & palette ) const

overridevirtual

Copy a palette to a palette.

Reimplemented from TBox.

Definition at line 199 of file TPaletteAxis.cxx.

◆ DeclFileName()

static const char * TPaletteAxis::DeclFileName ( )

inlinestatic

Returns: Name of the file containing the class declaration

Definition at line 74 of file TPaletteAxis.h.

◆ DistancetoPrimitive()

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

overridevirtual

Check if mouse on the axis region.

Reimplemented from TBox.

Definition at line 209 of file TPaletteAxis.cxx.

◆ ExecuteEvent()

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

overridevirtual

Check if mouse on the axis region.

Reimplemented from TBox.

Definition at line 224 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 337 of file TPaletteAxis.cxx.

◆ GetHistogram()

TH1 * TPaletteAxis::GetHistogram ( )

inline

Definition at line 51 of file TPaletteAxis.h.

◆ GetObjectInfo()

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

overridevirtual

Displays the z value corresponding to cursor position py.

Reimplemented from TObject.

Definition at line 348 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 396 of file TPaletteAxis.cxx.

◆ IsA()

TClass * TPaletteAxis::IsA ( ) const

inlineoverridevirtual

Returns: TClass describing current object

Reimplemented from TBox.

Definition at line 74 of file TPaletteAxis.h.

◆ operator=()

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

Assignment operator.

Definition at line 188 of file TPaletteAxis.cxx.

◆ Paint()

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

overridevirtual

Paint the palette.

Reimplemented from TBox.

Definition at line 433 of file TPaletteAxis.cxx.

◆ SavePrimitive()

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

overridevirtual

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

Reimplemented from TBox.

Definition at line 623 of file TPaletteAxis.cxx.

◆ SetAxisColor()

virtual void TPaletteAxis::SetAxisColor	(	Int_t	color = `1`,
		Float_t	alpha = `1`
	)

inlinevirtual

Definition at line 69 of file TPaletteAxis.h.

◆ SetHistogram()

void TPaletteAxis::SetHistogram ( TH1 * h )

inline

Definition at line 56 of file TPaletteAxis.h.

◆ SetLabelColor()

virtual void TPaletteAxis::SetLabelColor ( Int_t color = 1 )

inlinevirtual

Definition at line 58 of file TPaletteAxis.h.

◆ SetLabelFont()

virtual void TPaletteAxis::SetLabelFont ( Int_t font = 42 )

inlinevirtual

Definition at line 59 of file TPaletteAxis.h.

◆ SetLabelOffset()

virtual void TPaletteAxis::SetLabelOffset ( Float_t offset = 0.005 )

inlinevirtual

Definition at line 60 of file TPaletteAxis.h.

◆ SetLabelSize()

virtual void TPaletteAxis::SetLabelSize ( Float_t size = 0.035 )

inlinevirtual

Definition at line 61 of file TPaletteAxis.h.

◆ SetLineWidth()

void TPaletteAxis::SetLineWidth ( Width_t lwidth )

inlineoverridevirtual

Set the line width.

Reimplemented from TAttLine.

Definition at line 70 of file TPaletteAxis.h.

◆ SetMaxDigits()

virtual void TPaletteAxis::SetMaxDigits ( Float_t maxdigits = 5 )

inlinevirtual

Definition at line 62 of file TPaletteAxis.h.

◆ SetNdivisions()

virtual void TPaletteAxis::SetNdivisions ( Int_t ndiv = 10 )

inlinevirtual

Definition at line 57 of file TPaletteAxis.h.

◆ SetTickLength()

virtual void TPaletteAxis::SetTickLength ( Float_t length = 0.03 )

inlinevirtual

Definition at line 63 of file TPaletteAxis.h.

◆ SetTitle()

virtual void TPaletteAxis::SetTitle ( const char * title = "" )

inlinevirtual

Definition at line 68 of file TPaletteAxis.h.

◆ SetTitleColor()

virtual void TPaletteAxis::SetTitleColor ( Int_t color = 1 )

inlinevirtual

Definition at line 66 of file TPaletteAxis.h.

◆ SetTitleFont()

virtual void TPaletteAxis::SetTitleFont ( Int_t font = 42 )

inlinevirtual

Definition at line 67 of file TPaletteAxis.h.

◆ SetTitleOffset()

virtual void TPaletteAxis::SetTitleOffset ( Float_t offset = 1 )

inlinevirtual

Definition at line 64 of file TPaletteAxis.h.

◆ SetTitleSize()

virtual void TPaletteAxis::SetTitleSize ( Float_t size = 0.035 )

inlinevirtual

Definition at line 65 of file TPaletteAxis.h.

◆ Streamer()

void TPaletteAxis::Streamer ( TBuffer & R__b )

overridevirtual

Stream an object of class TBox.

Reimplemented from TBox.

◆ StreamerNVirtual()

void TPaletteAxis::StreamerNVirtual ( TBuffer & ClassDef_StreamerNVirtual_b )

inline

Definition at line 74 of file TPaletteAxis.h.

◆ UnZoom()

void TPaletteAxis::UnZoom ( )

virtual

Unzoom the palette.

Definition at line 663 of file TPaletteAxis.cxx.

Member Data Documentation

◆ fAxis

TGaxis TPaletteAxis::fAxis

protected

Palette axis.

Definition at line 31 of file TPaletteAxis.h.

◆ fH

TH1* TPaletteAxis::fH

protected

! Pointer to parent histogram

Definition at line 32 of file TPaletteAxis.h.

Libraries for TPaletteAxis:

[legend]

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

hist/histpainter/inc/TPaletteAxis.h
hist/histpainter/src/TPaletteAxis.cxx

Public Types

Public Member Functions

Static Public Member Functions

Protected Attributes

Additional Inherited Members

Member Enumeration Documentation

◆ EStatusBits

Constructor & Destructor Documentation

◆ TPaletteAxis() [1/5]

◆ TPaletteAxis() [2/5]

◆ TPaletteAxis() [3/5]

◆ TPaletteAxis() [4/5]

◆ TPaletteAxis() [5/5]

◆ ~TPaletteAxis()

Member Function Documentation

◆ Class()

◆ Class_Name()

◆ Class_Version()

◆ Copy()

◆ DeclFileName()

◆ DistancetoPrimitive()

◆ ExecuteEvent()

◆ GetAxis()

◆ GetBinColor()

◆ GetHistogram()

◆ GetObjectInfo()

◆ GetValueColor()

◆ IsA()

◆ operator=()

◆ Paint()

◆ SavePrimitive()

◆ SetAxisColor()

◆ SetHistogram()

◆ SetLabelColor()

◆ SetLabelFont()

◆ SetLabelOffset()

◆ SetLabelSize()

◆ SetLineWidth()

◆ SetMaxDigits()

◆ SetNdivisions()

◆ SetTickLength()

◆ SetTitle()

◆ SetTitleColor()

◆ SetTitleFont()

◆ SetTitleOffset()

◆ SetTitleSize()

◆ Streamer()

◆ StreamerNVirtual()

◆ UnZoom()

Member Data Documentation

◆ fAxis

◆ fH