The candle plot painter class.

Instances of this class are generated by the histograms painting classes (THistPainter and THStack) when an candle plot (box plot) is drawn. TCandle is the "painter class" of the box plots. Therefore it is never used directly to draw a candle.

Definition at line 27 of file TCandle.h.

Public Types
enum	CandleOption : long { kNoOption = 0 , kBox = 1 , kMedianLine = 10 , kMedianNotched = 20 , kMedianCircle = 30 , kMeanLine = 100 , kMeanCircle = 300 , kWhiskerAll = 1000 , kWhisker15 = 2000 , kAnchor = 10000 , kPointsOutliers = 100000 , kPointsAll = 200000 , kPointsAllScat = 300000 , kHistoLeft = 1000000 , kHistoRight = 2000000 , kHistoViolin = 3000000 , kHistoZeroIndicator = 10000000 , kHorizontal = 100000000 }

Public Member Functions
	TCandle ()
	TCandle default constructor.

	TCandle (const char *opt)
	TCandle constructor passing a draw-option.

	TCandle (const Double_t candlePos, const Double_t candleWidth, Long64_t n, Double_t *points)
	TCandle constructor for raw-data candles.

	TCandle (const Double_t candlePos, const Double_t candleWidth, TH1D *proj)
	TCandle TH1 data constructor.

	TCandle (const TCandle &candle)

	~TCandle () override
	TCandle default destructor.

void	ConvertToPadCoords (Double_t minAxis, Double_t maxAxis, Double_t axisMinCoord, Double_t axisMaxCoord)
	The coordinates in the TParallelCoordVar-class are in Pad-Coordinates, so we need to convert them.

void	Copy (TAttFill &attfill) const
	Copy this fill attributes to a new TAttFill.

void	Copy (TAttLine &attline) const
	Copy this line attributes to a new TAttLine.

void	Copy (TAttMarker &attmarker) const
	Copy this marker attributes to a new TAttMarker.

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.

const char *	GetDrawOption () const

virtual Color_t	GetFillColor () const
	Return the fill area color.

virtual Style_t	GetFillStyle () const
	Return the fill area style.

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 Color_t	GetMarkerColor () const
	Return the marker color.

virtual Size_t	GetMarkerSize () const
	Return the marker size.

virtual Style_t	GetMarkerStyle () const
	Return the marker style.

Double_t	GetMean () const

Double_t	GetMedian () const

long	GetOption () const

Double_t	GetQ1 () const

Double_t	GetQ2 () const

Double_t	GetQ3 () const

TClass *	IsA () const override

Bool_t	IsCandleScaled () const
	Returns true if candle plot should be scaled.

Bool_t	IsHorizontal () const

bool	IsOption (CandleOption opt) const
	Return true is this option is activated in fOption.

virtual Bool_t	IsTransparent () const

Bool_t	IsVertical () const

Bool_t	IsViolinScaled () const
	Returns true if violin plot should be scaled.

virtual void	Modify ()
	Change current fill area attributes if necessary.

virtual void	Modify ()
	Change current line attributes if necessary.

virtual void	Modify ()
	Change current marker attributes if necessary.

virtual void	ModifyOn (TVirtualPad &pad)
	Change current fill area attributes on speicifed pad.

virtual void	ModifyOn (TVirtualPad &pad)
	Change current line attributes on specified pad.

virtual void	ModifyOn (TVirtualPad &pad)
	Change current marker attributes if necessary on specified pad.

virtual void	Paint (Option_t *option="")
	Paint one candle with its current attributes.

int	ParseOption (char *optin)
	Parsing of the option-string.

virtual void	ResetAttFill (Option_t *option="")
	Reset this fill attributes to default values.

virtual void	ResetAttLine (Option_t *option="")
	Reset this line attributes to default values.

virtual void	ResetAttMarker (Option_t *toption="")
	Reset this marker attributes to the 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	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	SaveMarkerAttributes (std::ostream &out, const char *name, Int_t coldef=1, Int_t stydef=1, Int_t sizdef=1)
	Save line attributes as C++ statement(s) on output stream out.

void	SetAxisPosition (const Double_t candlePos)

void	SetCandleWidth (const Double_t width)

virtual void	SetFillAttributes ()
	Invoke the DialogCanvas Fill attributes.

virtual void	SetFillColor (Color_t fcolor)
	Set the fill area color.

void	SetFillColor (TColorNumber)
	Set a fill 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	SetHistogram (TH1D *proj)

void	SetHistoWidth (const Double_t width)

virtual void	SetLineAttributes ()
	Invoke the DialogCanvas Line attributes.

virtual void	SetLineColor (Color_t lcolor)
	Set the line color.

void	SetLineColor (TColorNumber lcolor)

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

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

virtual void	SetLineWidth (Width_t lwidth)
	Set the line width.

void	SetLog (int x, int y, int z)

virtual void	SetMarkerAttributes ()
	Invoke the DialogCanvas Marker attributes.

virtual void	SetMarkerColor (Color_t mcolor=1)
	Set the marker color.

void	SetMarkerColor (TColorNumber lcolor)

virtual void	SetMarkerColorAlpha (Color_t mcolor, Float_t malpha)
	Set a transparent marker color.

virtual void	SetMarkerSize (Size_t msize=1)
	Set the marker size.

virtual void	SetMarkerStyle (Style_t mstyle=1)
	Set the marker style.

virtual void	SetMean (Double_t mean)

virtual void	SetMedian (Double_t median)

void	SetOption (CandleOption opt)

virtual void	SetQ1 (Double_t q1)

virtual void	SetQ2 (Double_t q2)

virtual void	SetQ3 (Double_t q3)

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

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 Width_t	GetMarkerLineWidth (Style_t style)
	Internal helper function that returns the line width of the given marker style (0 = filled marker)

static Style_t	GetMarkerStyleBase (Style_t style)
	Internal helper function that returns the corresponding marker style with line width 1 for the given style.

static void	SetBoxRange (const Double_t bRange)
	Static function to set BoxRange, by setting box-range, one can force the box of the candle-chart to cover that given fraction of the distribution.

static void	SetScaledCandle (const Bool_t cScale=true)
	Static function to set scaling between candles-withs.

static void	SetScaledViolin (const Bool_t vScale=true)
	Static function to set scaling between violin-withs.

static void	SetWhiskerRange (const Double_t wRange)
	Static function to set WhiskerRange, by setting whisker-range, one can force the whiskers to cover the fraction of the distribution.

Protected Member Functions
void	Calculate ()
	Calculates all values needed by the candle definition depending on the candle options.

int	GetCandleOption (const int pos) const

void	PaintBox (Int_t nPoints, Double_t x, Double_t y, Bool_t swapXY)
	Paint a box for candle.

void	PaintLine (Double_t x1, Double_t y1, Double_t x2, Double_t y2, Bool_t swapXY)
	Paint a line for candle.

Protected Attributes
Double_t	fAxisMax
	The Maximum which is visible by the axis (used by zero indicator)

Double_t	fAxisMin
	The Minimum which is visible by the axis (used by zero indicator)

Double_t	fBoxDown
	Position of the lower box end.

Double_t	fBoxUp
	Position of the upper box end.

Double_t	fCandleWidth
	The candle width.

Double_t *	fDatapoints {nullptr}
	position of all Datapoints within this candle

bool	fDismiss
	True if the candle cannot be painted.

Double_t	fDrawPointsX [kNMAXPOINTS]
	x-coord for every outlier, ..

Double_t	fDrawPointsY [kNMAXPOINTS]
	y-coord for every outlier, ..

Color_t	fFillColor
	Fill area color.

Style_t	fFillStyle
	Fill area style.

Double_t	fHistoPointsX [kNMAXPOINTS]
	x-coord for the polyline of the histo

Double_t	fHistoPointsY [kNMAXPOINTS]
	y-coord for the polyline of the histo

Double_t	fHistoWidth
	The histo width (the height of the max bin)

bool	fIsCalculated

bool	fIsRaw
	0: for TH1 projection, 1: using raw data

Color_t	fLineColor
	Line color.

Style_t	fLineStyle
	Line style.

Width_t	fLineWidth
	Line width.

int	fLogX
	make the candle appear logx-like

int	fLogY
	make the candle appear logy-like

int	fLogZ
	make the candle appear logz-like

Color_t	fMarkerColor
	Marker color.

Size_t	fMarkerSize
	Marker size.

Style_t	fMarkerStyle
	Marker style.

Double_t	fMean
	Position of the mean.

Double_t	fMedian
	Position of the median.

Double_t	fMedianErr
	The size of the notch.

Long64_t	fNDatapoints
	Number of Datapoints within this candle.

Long64_t	fNDrawPoints
	max number of outliers or other point to be shown

int	fNHistoPoints

CandleOption	fOption
	Setting the style of the candle.

TString	fOptionStr
	String to draw the candle.

Double_t	fPosCandleAxis
	x-pos for a vertical candle

TH1D *	fProj {nullptr}

Double_t	fWhiskerDown
	Position of the lower whisker end.

Double_t	fWhiskerUp
	Position of the upper whisker end.

#include <TCandle.h>

Inheritance diagram for TCandle:

Member Enumeration Documentation

◆ CandleOption

enum TCandle::CandleOption : long

Enumerator
kNoOption
kBox
kMedianLine
kMedianNotched
kMedianCircle
kMeanLine
kMeanCircle
kWhiskerAll
kWhisker15
kAnchor
kPointsOutliers
kPointsAll
kPointsAllScat
kHistoLeft
kHistoRight
kHistoViolin
kHistoZeroIndicator
kHorizontal	If this bit is not set it is vertical.

Definition at line 30 of file TCandle.h.

Constructor & Destructor Documentation

◆ TCandle() [1/5]

TCandle::TCandle ( )

TCandle default constructor.

Definition at line 37 of file TCandle.cxx.

◆ TCandle() [2/5]

TCandle::TCandle ( const char * opt )

TCandle constructor passing a draw-option.

Definition at line 69 of file TCandle.cxx.

◆ TCandle() [3/5]

TCandle::TCandle	(	const Double_t	candlePos,
		const Double_t	candleWidth,
		Long64_t	n,
		Double_t *	points )

TCandle constructor for raw-data candles.

Definition at line 108 of file TCandle.cxx.

◆ TCandle() [4/5]

TCandle::TCandle	(	const Double_t	candlePos,
		const Double_t	candleWidth,
		TH1D *	proj )

TCandle TH1 data constructor.

Definition at line 141 of file TCandle.cxx.

◆ TCandle() [5/5]

TCandle::TCandle ( const TCandle & candle )

◆ ~TCandle()

TCandle::~TCandle ( )

override

TCandle default destructor.

Definition at line 174 of file TCandle.cxx.

Member Function Documentation

◆ Calculate()

void TCandle::Calculate ( )

protected

Calculates all values needed by the candle definition depending on the candle options.

Definition at line 378 of file TCandle.cxx.

◆ Class()

static TClass * TCandle::Class ( )

static

Returns: TClass describing this class

◆ Class_Name()

static const char * TCandle::Class_Name ( )

static

Returns: Name of this class

◆ Class_Version()

static constexpr Version_t TCandle::Class_Version ( )

inlinestaticconstexpr

Returns: Version of this class

Definition at line 151 of file TCandle.h.

◆ ConvertToPadCoords()

void TCandle::ConvertToPadCoords	(	Double_t	minAxis,
		Double_t	maxAxis,
		Double_t	axisMinCoord,
		Double_t	axisMaxCoord )

The coordinates in the TParallelCoordVar-class are in Pad-Coordinates, so we need to convert them.

Definition at line 934 of file TCandle.cxx.

◆ Copy() [1/3]

void TAttFill::Copy ( TAttFill & attfill ) const

inherited

Copy this fill attributes to a new TAttFill.

Definition at line 203 of file TAttFill.cxx.

◆ Copy() [2/3]

void TAttLine::Copy ( TAttLine & attline ) const

inherited

Copy this line attributes to a new TAttLine.

Definition at line 176 of file TAttLine.cxx.

◆ Copy() [3/3]

void TAttMarker::Copy ( TAttMarker & attmarker ) const

inherited

Copy this marker attributes to a new TAttMarker.

Definition at line 243 of file TAttMarker.cxx.

◆ DeclFileName()

static const char * TCandle::DeclFileName ( )

inlinestatic

Returns: Name of the file containing the class declaration

Definition at line 151 of file TCandle.h.

◆ DistancetoLine()

Int_t TAttLine::DistancetoLine	(	Int_t	px,
		Int_t	py,
		Double_t	xp1,
		Double_t	yp1,
		Double_t	xp2,
		Double_t	yp2 )

inherited

Compute distance from point px,py to a line.

Compute the closest distance of approach from point px,py to this line. The distance is computed in pixels units.

Algorithm:

  A(x1,y1)         P                             B(x2,y2)
  -----------------+------------------------------
                   |
                   |
                   |
                   |
                  M(x,y)
 
Let us call  a = distance AM     A=a**2
             b = distance BM     B=b**2
             c = distance AB     C=c**2
             d = distance PM     D=d**2
             u = distance AP     U=u**2
             v = distance BP     V=v**2     c = u + v
 
D = A - U
D = B - V  = B -(c-u)**2
   ==> u = (A -B +C)/2c

Definition at line 210 of file TAttLine.cxx.

◆ GetCandleOption()

int TCandle::GetCandleOption ( const int pos ) const

inlineprotected

Definition at line 101 of file TCandle.h.

◆ GetDrawOption()

const char * TCandle::GetDrawOption ( ) const

inline

Definition at line 143 of file TCandle.h.

◆ GetFillColor()

virtual Color_t TAttFill::GetFillColor ( ) const

inlinevirtualinherited

Return the fill area color.

Reimplemented in TGraphMultiErrors, TGWin32, TGWin32VirtualXProxy, and TGX11.

Definition at line 32 of file TAttFill.h.

◆ GetFillStyle()

virtual Style_t TAttFill::GetFillStyle ( ) const

inlinevirtualinherited

Return the fill area style.

Reimplemented in TGraphMultiErrors, TGWin32, TGWin32VirtualXProxy, and TGX11.

Definition at line 33 of file TAttFill.h.

◆ GetLineColor()

virtual Color_t TAttLine::GetLineColor ( ) const

inlinevirtualinherited

Return the line color.

Reimplemented in TGraphMultiErrors, and TGWin32VirtualXProxy.

Definition at line 36 of file TAttLine.h.

◆ GetLineStyle()

virtual Style_t TAttLine::GetLineStyle ( ) const

inlinevirtualinherited

Return the line style.

Reimplemented in TGraphMultiErrors, TGWin32, TGWin32VirtualXProxy, and TGX11.

Definition at line 37 of file TAttLine.h.

◆ GetLineWidth()

virtual Width_t TAttLine::GetLineWidth ( ) const

inlinevirtualinherited

Return the line width.

Reimplemented in TGraphMultiErrors, TGWin32, TGWin32VirtualXProxy, and TGX11.

Definition at line 38 of file TAttLine.h.

◆ GetMarkerColor()

virtual Color_t TAttMarker::GetMarkerColor ( ) const

inlinevirtualinherited

Return the marker color.

Reimplemented in TGWin32VirtualXProxy.

Definition at line 33 of file TAttMarker.h.

◆ GetMarkerLineWidth()

Width_t TAttMarker::GetMarkerLineWidth ( Style_t style )

staticinherited

Internal helper function that returns the line width of the given marker style (0 = filled marker)

Definition at line 305 of file TAttMarker.cxx.

◆ GetMarkerSize()

virtual Size_t TAttMarker::GetMarkerSize ( ) const

inlinevirtualinherited

Return the marker size.

Reimplemented in TGWin32VirtualXProxy.

Definition at line 35 of file TAttMarker.h.

◆ GetMarkerStyle()

virtual Style_t TAttMarker::GetMarkerStyle ( ) const

inlinevirtualinherited

Return the marker style.

Reimplemented in TGWin32VirtualXProxy.

Definition at line 34 of file TAttMarker.h.

◆ GetMarkerStyleBase()

Style_t TAttMarker::GetMarkerStyleBase ( Style_t style )

staticinherited

Internal helper function that returns the corresponding marker style with line width 1 for the given style.

Definition at line 254 of file TAttMarker.cxx.

◆ GetMean()

Double_t TCandle::GetMean ( ) const

inline

Definition at line 115 of file TCandle.h.

◆ GetMedian()

Double_t TCandle::GetMedian ( ) const

inline

Definition at line 116 of file TCandle.h.

◆ GetOption()

long TCandle::GetOption ( ) const

inline

Definition at line 144 of file TCandle.h.

◆ GetQ1()

Double_t TCandle::GetQ1 ( ) const

inline

Definition at line 117 of file TCandle.h.

◆ GetQ2()

Double_t TCandle::GetQ2 ( ) const

inline

Definition at line 118 of file TCandle.h.

◆ GetQ3()

Double_t TCandle::GetQ3 ( ) const

inline

Definition at line 119 of file TCandle.h.

◆ IsA()

TClass * TCandle::IsA ( ) const

inlineoverridevirtual

Returns: TClass describing current object

Reimplemented from TAttLine.

Definition at line 151 of file TCandle.h.

◆ IsCandleScaled()

Bool_t TCandle::IsCandleScaled ( ) const

Returns true if candle plot should be scaled.

Definition at line 182 of file TCandle.cxx.

◆ IsHorizontal()

Bool_t TCandle::IsHorizontal ( ) const

inline

Definition at line 120 of file TCandle.h.

◆ IsOption()

bool TCandle::IsOption ( CandleOption opt ) const

Return true is this option is activated in fOption.

Definition at line 847 of file TCandle.cxx.

◆ IsTransparent()

Bool_t TAttFill::IsTransparent ( ) const

inlinevirtualinherited

Reimplemented in TGWin32VirtualXProxy.

Definition at line 49 of file TAttFill.h.

◆ IsVertical()

Bool_t TCandle::IsVertical ( ) const

inline

Definition at line 121 of file TCandle.h.

◆ IsViolinScaled()

Bool_t TCandle::IsViolinScaled ( ) const

Returns true if violin plot should be scaled.

Definition at line 190 of file TCandle.cxx.

◆ Modify() [1/3]

void TAttFill::Modify ( )

virtualinherited

Change current fill area attributes if necessary.

Definition at line 212 of file TAttFill.cxx.

◆ Modify() [2/3]

void TAttLine::Modify ( )

virtualinherited

Change current line attributes if necessary.

Definition at line 246 of file TAttLine.cxx.

◆ Modify() [3/3]

void TAttMarker::Modify ( )

virtualinherited

Change current marker attributes if necessary.

Definition at line 322 of file TAttMarker.cxx.

◆ ModifyOn() [1/3]

void TAttFill::ModifyOn ( TVirtualPad & pad )

virtualinherited

Change current fill area attributes on speicifed pad.

Definition at line 221 of file TAttFill.cxx.

◆ ModifyOn() [2/3]

void TAttLine::ModifyOn ( TVirtualPad & pad )

virtualinherited

Change current line attributes on specified pad.

Definition at line 255 of file TAttLine.cxx.

◆ ModifyOn() [3/3]

void TAttMarker::ModifyOn ( TVirtualPad & pad )

virtualinherited

Change current marker attributes if necessary on specified pad.

Definition at line 331 of file TAttMarker.cxx.

◆ Paint()

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

virtual

Paint one candle with its current attributes.

Definition at line 665 of file TCandle.cxx.

◆ PaintBox()

void TCandle::PaintBox	(	Int_t	nPoints,
		Double_t *	x,
		Double_t *	y,
		Bool_t	swapXY )

protected

Paint a box for candle.

Definition at line 863 of file TCandle.cxx.

◆ PaintLine()

void TCandle::PaintLine	(	Double_t	x1,
		Double_t	y1,
		Double_t	x2,
		Double_t	y2,
		Bool_t	swapXY )

protected

Paint a line for candle.

Definition at line 893 of file TCandle.cxx.

◆ ParseOption()

int TCandle::ParseOption ( char * opt )

Parsing of the option-string.

The option-string will be empty at the end (by-reference).

Definition at line 243 of file TCandle.cxx.

◆ ResetAttFill()

void TAttFill::ResetAttFill ( Option_t * option = "" )

virtualinherited

Reset this fill attributes to default values.

Reimplemented in TGWin32VirtualXProxy.

Definition at line 231 of file TAttFill.cxx.

◆ ResetAttLine()

void TAttLine::ResetAttLine ( Option_t * option = "" )

virtualinherited

Reset this line attributes to default values.

Reimplemented in TGWin32VirtualXProxy.

Definition at line 279 of file TAttLine.cxx.

◆ ResetAttMarker()

void TAttMarker::ResetAttMarker ( Option_t * toption = "" )

virtualinherited

Reset this marker attributes to the default values.

Reimplemented in TGWin32VirtualXProxy.

Definition at line 342 of file TAttMarker.cxx.

◆ SaveFillAttributes()

void TAttFill::SaveFillAttributes	(	std::ostream &	out,
		const char *	name,
		Int_t	coldef = 1,
		Int_t	stydef = 1001 )

virtualinherited

Save fill attributes as C++ statement(s) on output stream out.

Definition at line 240 of file TAttFill.cxx.

◆ SaveLineAttributes()

void TAttLine::SaveLineAttributes	(	std::ostream &	out,
		const char *	name,
		Int_t	coldef = 1,
		Int_t	stydef = 1,
		Int_t	widdef = 1 )

virtualinherited

Save line attributes as C++ statement(s) on output stream out.

Definition at line 289 of file TAttLine.cxx.

◆ SaveMarkerAttributes()

void TAttMarker::SaveMarkerAttributes	(	std::ostream &	out,
		const char *	name,
		Int_t	coldef = 1,
		Int_t	stydef = 1,
		Int_t	sizdef = 1 )

virtualinherited

Save line attributes as C++ statement(s) on output stream out.

Definition at line 352 of file TAttMarker.cxx.

◆ SetAxisPosition()

void TCandle::SetAxisPosition ( const Double_t candlePos )

inline

Definition at line 127 of file TCandle.h.

◆ SetBoxRange()

void TCandle::SetBoxRange ( const Double_t bRange )

static

Static function to set BoxRange, by setting box-range, one can force the box of the candle-chart to cover that given fraction of the distribution.

Set bRange between 0 and 1. Default is 0.5 TCandle::SetBoxRange(0.68) will set all candle-charts to cover 68% of the distribution by the box

Definition at line 215 of file TCandle.cxx.

◆ SetCandleWidth()

void TCandle::SetCandleWidth ( const Double_t width )

inline

Definition at line 129 of file TCandle.h.

◆ SetFillAttributes()

void TAttFill::SetFillAttributes ( )

virtualinherited

Invoke the DialogCanvas Fill attributes.

Reimplemented in TGWin32VirtualXProxy.

Definition at line 251 of file TAttFill.cxx.

◆ SetFillColor() [1/2]

virtual void TAttFill::SetFillColor ( Color_t fcolor )

inlinevirtualinherited

Set the fill area color.

Reimplemented in TVirtualX, TGQuartz, TGWin32, TGWin32VirtualXProxy, TGX11, TPDF, TPostScript, TSVG, TTeXDump, TSpider, and TGraphMultiErrors.

Definition at line 40 of file TAttFill.h.

◆ SetFillColor() [2/2]

void TAttFill::SetFillColor ( TColorNumber lcolor )

inherited

Set a fill color.

Definition at line 270 of file TAttFill.cxx.

◆ SetFillColorAlpha()

void TAttFill::SetFillColorAlpha	(	Color_t	fcolor,
		Float_t	falpha )

virtualinherited

Set a transparent fill color.

Parameters

fcolor	defines the fill color
falpha	defines the percentage of opacity from 0. (fully transparent) to 1. (fully opaque).

Note: falpha is ignored (treated as 1) if the TCanvas has no GL support activated.

Reimplemented in TGraphMultiErrors.

Definition at line 262 of file TAttFill.cxx.

◆ SetFillStyle()

virtual void TAttFill::SetFillStyle ( Style_t fstyle )

inlinevirtualinherited

Set the fill area style.

Reimplemented in TGraphMultiErrors, TPad, TSpider, TVirtualX, TGQuartz, TGWin32, TGWin32VirtualXProxy, and TGX11.

Definition at line 42 of file TAttFill.h.

◆ SetHistogram()

void TCandle::SetHistogram ( TH1D * proj )

inline

Definition at line 131 of file TCandle.h.

◆ SetHistoWidth()

void TCandle::SetHistoWidth ( const Double_t width )

inline

Definition at line 130 of file TCandle.h.

◆ SetLineAttributes()

void TAttLine::SetLineAttributes ( )

virtualinherited

Invoke the DialogCanvas Line attributes.

Reimplemented in TGWin32VirtualXProxy.

Definition at line 306 of file TAttLine.cxx.

◆ SetLineColor() [1/2]

virtual void TAttLine::SetLineColor ( Color_t lcolor )

inlinevirtualinherited

Set the line color.

Reimplemented in TEveTrackList, ROOT::Experimental::REveTrackList, TVirtualX, TGQuartz, TGWin32, TGWin32VirtualXProxy, TGX11, TPDF, TPostScript, TSVG, TTeXDump, TEveLine, TEveStraightLineSet, ROOT::Experimental::REveLine, ROOT::Experimental::REveStraightLineSet, TParallelCoordRange, TSpider, TGraphMultiErrors, TGeoVolume, and TGeoVolumeMulti.

Definition at line 44 of file TAttLine.h.

◆ SetLineColor() [2/2]

void TAttLine::SetLineColor ( TColorNumber lcolor )

inherited

Definition at line 322 of file TAttLine.cxx.

◆ SetLineColorAlpha()

void TAttLine::SetLineColorAlpha	(	Color_t	lcolor,
		Float_t	lalpha )

virtualinherited

Set a transparent line color.

Parameters

lcolor	defines the line color
lalpha	defines the percentage of opacity from 0. (fully transparent) to 1. (fully opaque).

Note: lalpha is ignored (treated as 1) if the TCanvas has no GL support activated.

Reimplemented in TGraphMultiErrors.

Definition at line 317 of file TAttLine.cxx.

◆ SetLineStyle()

virtual void TAttLine::SetLineStyle ( Style_t lstyle )

inlinevirtualinherited

Set the line style.

Reimplemented in TVirtualX, TGQuartz, TGWin32, TGWin32VirtualXProxy, TGX11, TPDF, TPostScript, TSVG, TTeXDump, TGraphMultiErrors, TGeoVolume, TGeoVolumeMulti, TEveLine, ROOT::Experimental::REveLine, TEveTrackList, ROOT::Experimental::REveTrackList, and TSpider.

Definition at line 46 of file TAttLine.h.

◆ SetLineWidth()

virtual void TAttLine::SetLineWidth ( Width_t lwidth )

inlinevirtualinherited

Set the line width.

Reimplemented in TPDF, TPostScript, TSVG, TTeXDump, TGraphMultiErrors, TGeoVolume, TGeoVolumeMulti, TEveLine, ROOT::Experimental::REveLine, TEveTrackList, ROOT::Experimental::REveTrackList, TParallelCoordRange, TSpider, TVirtualX, TGQuartz, TGWin32, TGWin32VirtualXProxy, TGX11, and TPaletteAxis.

Definition at line 47 of file TAttLine.h.

◆ SetLog()

void TCandle::SetLog	(	int	x,
		int	y,
		int	z )

inline

Definition at line 126 of file TCandle.h.

◆ SetMarkerAttributes()

void TAttMarker::SetMarkerAttributes ( )

virtualinherited

Invoke the DialogCanvas Marker attributes.

Reimplemented in TGWin32VirtualXProxy.

Definition at line 365 of file TAttMarker.cxx.

◆ SetMarkerColor() [1/2]

virtual void TAttMarker::SetMarkerColor ( Color_t mcolor = 1 )

inlinevirtualinherited

Set the marker color.

Reimplemented in TEveTrackList, ROOT::Experimental::REveTrackList, TVirtualX, TGQuartz, TGWin32, TGWin32VirtualXProxy, TGX11, TPDF, TPostScript, TSVG, TTeXDump, TEveLine, TEvePointSet, ROOT::Experimental::REveLine, ROOT::Experimental::REvePointSet, TEvePointSetArray, and ROOT::Experimental::REvePointSetArray.

Definition at line 41 of file TAttMarker.h.

◆ SetMarkerColor() [2/2]

void TAttMarker::SetMarkerColor ( TColorNumber lcolor )

inherited

Definition at line 381 of file TAttMarker.cxx.

◆ SetMarkerColorAlpha()

void TAttMarker::SetMarkerColorAlpha	(	Color_t	mcolor,
		Float_t	malpha )

virtualinherited

Set a transparent marker color.

Parameters

mcolor	defines the marker color
malpha	defines the percentage of opacity from 0. (fully transparent) to 1. (fully opaque).

Note: malpha is ignored (treated as 1) if the TCanvas has no GL support activated.

Definition at line 376 of file TAttMarker.cxx.

◆ SetMarkerSize()

virtual void TAttMarker::SetMarkerSize ( Size_t msize = 1 )

inlinevirtualinherited

Set the marker size.

Note that the marker styles number 1 6 and 7 (the dots), cannot be scaled. They are meant to be very fast to draw and are always drawn with the same number of pixels; therefore this method does not apply on them.

Reimplemented in TVirtualX, TGQuartz, TGWin32, TGWin32VirtualXProxy, TGX11, TTeXDump, TEvePointSet, TEvePointSetArray, ROOT::Experimental::REvePointSet, ROOT::Experimental::REvePointSetArray, TEveTrackList, and ROOT::Experimental::REveTrackList.

Definition at line 48 of file TAttMarker.h.

◆ SetMarkerStyle()

virtual void TAttMarker::SetMarkerStyle ( Style_t mstyle = 1 )

inlinevirtualinherited

Set the marker style.

Reimplemented in TVirtualX, TGQuartz, TGWin32, TGWin32VirtualXProxy, TGX11, TEvePointSet, TEvePointSetArray, ROOT::Experimental::REvePointSet, ROOT::Experimental::REvePointSetArray, TEveTrackList, and ROOT::Experimental::REveTrackList.

Definition at line 43 of file TAttMarker.h.

◆ SetMean()

virtual void TCandle::SetMean ( Double_t mean )

inlinevirtual

Definition at line 136 of file TCandle.h.

◆ SetMedian()

virtual void TCandle::SetMedian ( Double_t median )

inlinevirtual

Definition at line 137 of file TCandle.h.

◆ SetOption()

void TCandle::SetOption ( CandleOption opt )

inline

Definition at line 125 of file TCandle.h.

◆ SetQ1()

virtual void TCandle::SetQ1 ( Double_t q1 )

inlinevirtual

Definition at line 138 of file TCandle.h.

◆ SetQ2()

virtual void TCandle::SetQ2 ( Double_t q2 )

inlinevirtual

Definition at line 139 of file TCandle.h.

◆ SetQ3()

virtual void TCandle::SetQ3 ( Double_t q3 )

inlinevirtual

Definition at line 140 of file TCandle.h.

◆ SetScaledCandle()

void TCandle::SetScaledCandle ( const Bool_t cScale = true )

static

Static function to set scaling between candles-withs.

A candle containing 100 entries will be two times wider than a candle containing 50 entries

Definition at line 224 of file TCandle.cxx.

◆ SetScaledViolin()

void TCandle::SetScaledViolin ( const Bool_t vScale = true )

static

Static function to set scaling between violin-withs.

A violin or histo chart with a maximum bin content to 100 will be two times as high as a violin with a maximum bin content of 50

Definition at line 234 of file TCandle.cxx.

◆ SetWhiskerRange()

void TCandle::SetWhiskerRange ( const Double_t wRange )

static

Static function to set WhiskerRange, by setting whisker-range, one can force the whiskers to cover the fraction of the distribution.

Set wRange between 0 and 1. Default is 1 TCandle::SetWhiskerRange(0.95) will set all candle-charts to cover 95% of the distribution with the whiskers. Can only be used with the standard-whisker definition

Definition at line 203 of file TCandle.cxx.

◆ Streamer()

void TCandle::Streamer ( TBuffer & R__b )

overridevirtual

Stream an object of class TCandle.

Reimplemented from TAttLine.

Definition at line 917 of file TCandle.cxx.

◆ StreamerNVirtual()

void TCandle::StreamerNVirtual ( TBuffer & ClassDef_StreamerNVirtual_b )

inline

Definition at line 151 of file TCandle.h.

Member Data Documentation

◆ fAxisMax

Double_t TCandle::fAxisMax

protected

The Maximum which is visible by the axis (used by zero indicator)

Definition at line 97 of file TCandle.h.

◆ fAxisMin

Double_t TCandle::fAxisMin

protected

The Minimum which is visible by the axis (used by zero indicator)

Definition at line 96 of file TCandle.h.

◆ fBoxDown

Double_t TCandle::fBoxDown

protected

Position of the lower box end.

Definition at line 75 of file TCandle.h.

◆ fBoxUp

Double_t TCandle::fBoxUp

protected

Position of the upper box end.

Definition at line 74 of file TCandle.h.

◆ fCandleWidth

Double_t TCandle::fCandleWidth

protected

The candle width.

Definition at line 68 of file TCandle.h.

◆ fDatapoints

Double_t* TCandle::fDatapoints {nullptr}

protected

position of all Datapoints within this candle

Definition at line 79 of file TCandle.h.

◆ fDismiss

bool TCandle::fDismiss

protected

True if the candle cannot be painted.

Definition at line 65 of file TCandle.h.

◆ fDrawPointsX

Double_t TCandle::fDrawPointsX[kNMAXPOINTS]

protected

x-coord for every outlier, ..

Definition at line 82 of file TCandle.h.

◆ fDrawPointsY

Double_t TCandle::fDrawPointsY[kNMAXPOINTS]

protected

y-coord for every outlier, ..

Definition at line 83 of file TCandle.h.

◆ fFillColor

Color_t TAttFill::fFillColor

protectedinherited

Fill area color.

Definition at line 24 of file TAttFill.h.

◆ fFillStyle

Style_t TAttFill::fFillStyle

protectedinherited

Fill area style.

Definition at line 25 of file TAttFill.h.

◆ fHistoPointsX

Double_t TCandle::fHistoPointsX[kNMAXPOINTS]

protected

x-coord for the polyline of the histo

Definition at line 86 of file TCandle.h.

◆ fHistoPointsY

Double_t TCandle::fHistoPointsY[kNMAXPOINTS]

protected

y-coord for the polyline of the histo

Definition at line 87 of file TCandle.h.

◆ fHistoWidth

Double_t TCandle::fHistoWidth

protected

The histo width (the height of the max bin)

Definition at line 69 of file TCandle.h.

◆ fIsCalculated

bool TCandle::fIsCalculated

protected

Definition at line 63 of file TCandle.h.

◆ fIsRaw

bool TCandle::fIsRaw

protected

0: for TH1 projection, 1: using raw data

Definition at line 62 of file TCandle.h.

◆ fLineColor

Color_t TAttLine::fLineColor

protectedinherited

Line color.

Definition at line 24 of file TAttLine.h.

◆ fLineStyle

Style_t TAttLine::fLineStyle

protectedinherited

Line style.

Definition at line 25 of file TAttLine.h.

◆ fLineWidth

Width_t TAttLine::fLineWidth

protectedinherited

Line width.

Definition at line 26 of file TAttLine.h.

◆ fLogX

int TCandle::fLogX

protected

make the candle appear logx-like

Definition at line 92 of file TCandle.h.

◆ fLogY

int TCandle::fLogY

protected

make the candle appear logy-like

Definition at line 93 of file TCandle.h.

◆ fLogZ

int TCandle::fLogZ

protected

make the candle appear logz-like

Definition at line 94 of file TCandle.h.

◆ fMarkerColor

Color_t TAttMarker::fMarkerColor

protectedinherited

Marker color.

Definition at line 24 of file TAttMarker.h.

◆ fMarkerSize

Size_t TAttMarker::fMarkerSize

protectedinherited

Marker size.

Definition at line 26 of file TAttMarker.h.

◆ fMarkerStyle

Style_t TAttMarker::fMarkerStyle

protectedinherited

Marker style.

Definition at line 25 of file TAttMarker.h.

◆ fMean

Double_t TCandle::fMean

protected

Position of the mean.

Definition at line 71 of file TCandle.h.

◆ fMedian

Double_t TCandle::fMedian

protected

Position of the median.

Definition at line 72 of file TCandle.h.

◆ fMedianErr

Double_t TCandle::fMedianErr

protected

The size of the notch.

Definition at line 73 of file TCandle.h.

◆ fNDatapoints

Long64_t TCandle::fNDatapoints

protected

Number of Datapoints within this candle.

Definition at line 80 of file TCandle.h.

◆ fNDrawPoints

Long64_t TCandle::fNDrawPoints

protected

max number of outliers or other point to be shown

Definition at line 84 of file TCandle.h.

◆ fNHistoPoints

int TCandle::fNHistoPoints

protected

Definition at line 88 of file TCandle.h.

◆ fOption

CandleOption TCandle::fOption

protected

Setting the style of the candle.

Definition at line 90 of file TCandle.h.

◆ fOptionStr

TString TCandle::fOptionStr

protected

String to draw the candle.

Definition at line 91 of file TCandle.h.

◆ fPosCandleAxis

Double_t TCandle::fPosCandleAxis

protected

x-pos for a vertical candle

Definition at line 67 of file TCandle.h.

◆ fProj

TH1D* TCandle::fProj {nullptr}

protected

Definition at line 64 of file TCandle.h.

◆ fWhiskerDown

Double_t TCandle::fWhiskerDown

protected

Position of the lower whisker end.

Definition at line 77 of file TCandle.h.

◆ fWhiskerUp

Double_t TCandle::fWhiskerUp

protected

Position of the upper whisker end.

Definition at line 76 of file TCandle.h.

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

graf2d/graf/inc/TCandle.h
graf2d/graf/src/TCandle.cxx

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Member Enumeration Documentation

◆ CandleOption

Constructor & Destructor Documentation

◆ TCandle() [1/5]

◆ TCandle() [2/5]

◆ TCandle() [3/5]

◆ TCandle() [4/5]

◆ TCandle() [5/5]

◆ ~TCandle()

Member Function Documentation

◆ Calculate()

◆ Class()

◆ Class_Name()

◆ Class_Version()

◆ ConvertToPadCoords()

◆ Copy() [1/3]

◆ Copy() [2/3]

◆ Copy() [3/3]

◆ DeclFileName()

◆ DistancetoLine()

◆ GetCandleOption()

◆ GetDrawOption()

◆ GetFillColor()

◆ GetFillStyle()

◆ GetLineColor()

◆ GetLineStyle()

◆ GetLineWidth()

◆ GetMarkerColor()

◆ GetMarkerLineWidth()

◆ GetMarkerSize()

◆ GetMarkerStyle()

◆ GetMarkerStyleBase()

◆ GetMean()

◆ GetMedian()

◆ GetOption()

◆ GetQ1()

◆ GetQ2()

◆ GetQ3()

◆ IsA()

◆ IsCandleScaled()

◆ IsHorizontal()

◆ IsOption()

◆ IsTransparent()

◆ IsVertical()

◆ IsViolinScaled()

◆ Modify() [1/3]

◆ Modify() [2/3]

◆ Modify() [3/3]

◆ ModifyOn() [1/3]

◆ ModifyOn() [2/3]

◆ ModifyOn() [3/3]

◆ Paint()

◆ PaintBox()

◆ PaintLine()

◆ ParseOption()

◆ ResetAttFill()

◆ ResetAttLine()

◆ ResetAttMarker()

◆ SaveFillAttributes()

◆ SaveLineAttributes()

◆ SaveMarkerAttributes()

◆ SetAxisPosition()

◆ SetBoxRange()

◆ SetCandleWidth()

◆ SetFillAttributes()

◆ SetFillColor() [1/2]

◆ SetFillColor() [2/2]

◆ SetFillColorAlpha()

◆ SetFillStyle()

◆ SetHistogram()

◆ SetHistoWidth()

◆ SetLineAttributes()

◆ SetLineColor() [1/2]

◆ SetLineColor() [2/2]

◆ SetLineColorAlpha()