Logo ROOT  
Reference Guide
Hoption.h
Go to the documentation of this file.
1/* @(#)root/histpainter:$Id$ */
2
3/*************************************************************************
4 * Copyright (C) 1995-2000, Rene Brun and Fons Rademakers. *
5 * All rights reserved. *
6 * *
7 * For the licensing terms see $ROOTSYS/LICENSE. *
8 * For the list of contributors see $ROOTSYS/README/CREDITS. *
9 *************************************************************************/
10
11#ifndef ROOT_Hoption
12#define ROOT_Hoption
13
14
15////////////////////////////////////////////////////////////////////////////////
16/*! \struct Hoption_t
17 \brief Histograms' drawing options structure.
18
19Used internally by THistPainter to manage histograms' drawing options.
20
21*/
22
23
24typedef struct Hoption_t {
25
26///@{
27/// @name Histogram's drawing options
28/// The drawing option may be the concatenation of some of the following options:
29
30 int Axis; ///< <b>"A"</b> Axis are not drawn around the graph.
31 int Bar; ///< <b>"B"</b>, <b>"BAR"</b> and <b>"HBAR"</b> A Bar chart is drawn at each point.
32 int Curve; ///< <b>"C"</b> A smooth Curve is drawn.
33 int Error; ///< <b>"En"</b> Draw Errors with current marker type and size (0 <= n <=6).
34 int Fill; ///< <b>"F"</b> A fill area is drawn ("CF" draw a smooth fill area).
35 int Off; ///< <b>"]["</b> The first and last vertical lines are not drawn.
36 int Line; ///< <b>"L"</b> A simple polyline through every point is drawn.
37 int Mark; ///< <b>"P"</b> The current Marker is drawn at each point.
38 int Same; ///< <b>"SAME"</b> Histogram is plotted in the current pad.
39 int Star; ///< <b>"*"</b> With option <b>"P"</b>, a * is plotted at each point.
40 int Arrow; ///< <b>"ARR"</b> Draw 2D plot with Arrows.
41 int Box; ///< <b>"BOX"</b> Draw 2D plot with proportional Boxes.
42 int Char; ///< <b>"CHAR"</b> Draw 2D plot with a character set.
43 int Color; ///< <b>"COL"</b> Draw 2D plot with Colored boxes.
44 int Contour; ///< <b>"CONTn"</b> Draw 2D plot as a Contour plot (0 <= n <= 5).
45 int Func; ///< <b>"FUNC"</b> Draw only the function (for example in case of fit).
46 int Hist; ///< <b>"HIST"</b> Draw only the histogram.
47 int Lego; ///< <b>"LEGO"</b> and <b>"LEGOn"</b> Draw as a Lego plot(1 <= n <= 4).
48 int Scat; ///< <b>"SCAT"</b> Draw 2D plot a Scatter plot.
49 int Surf; ///< <b>"SURF"</b> and <b>"SURFn"</b> Draw as a Surface ((1 <= n <= 4).
50 int Text; ///< <b>"TEXT"</b> Draw 2D plot with the content of each cell.
51 int Tri; ///< <b>"TRI"</b> Draw TGraph2D with Delaunay triangles.
52 int Pie; ///< <b>"PIE"</b> Draw 1D plot as a pie chart.
53 long Candle; ///< <b>"CANDLE"</b> and <b>"VIOLIN"</b> Draw a 2D histogram as candle/box plot or violin plot.
54 int System; ///< <b>"POL"</b>, <b>"CYL"</b>, <b>"SPH"</b> and <b>"PSR"</b> Type of coordinate system for 3D plots.
55 int Zscale; ///< <b>"Z"</b> Display the color palette.
56 int FrontBox; ///< <b>"FB"</b> Suppress the front box for the 3D plots.
57 int BackBox; ///< <b>"BB"</b> Suppress the back box for the 3D plots.
58 int List; ///< <b>"LIST"</b> Generate the TObjArray "contours". To be used with option <b>"CONT"</b>
59 int Proj; ///< <b>"AITOFF"</b>, <b>"MERCATOR"</b>, <b>"SINUSOIDAL"</b> and <b>"PARABOLIC"</b> projections for 2d plots.
60 int AxisPos; ///< <b>"X+"</b> and <b>"Y+"</b> Axis position
61 int Spec; ///< <b>"SPEC"</b> TSpectrum graphics
62 int Zero; ///< <b>"0"</b> if selected with any LEGO option the empty bins are not drawn.
63 int MinimumZero; ///< <b>"MIN0"</b> or gStyle->GetHistMinimumZero()
64///@}
65
66///@{
67/// @name Other options
68/// The following structure members are set to 1 if the corresponding setting is selected.
69
70 int Logx; ///< log scale in X. Also set by histogram option
71 int Logy; ///< log scale in Y. Also set by histogram option
72 int Logz; ///< log scale in Z. Also set by histogram option
73
74///@}
75
77
78#endif
struct Hoption_t Hoption_t
Histograms' drawing options structure.
Definition: Hoption.h:24
int Curve
"C" A smooth Curve is drawn.
Definition: Hoption.h:32
int Proj
"AITOFF", "MERCATOR", "SINUSOIDAL" and "PARABOLIC" projections for 2d plots.
Definition: Hoption.h:59
int Axis
"A" Axis are not drawn around the graph.
Definition: Hoption.h:30
int Box
"BOX" Draw 2D plot with proportional Boxes.
Definition: Hoption.h:41
int Scat
"SCAT" Draw 2D plot a Scatter plot.
Definition: Hoption.h:48
int Text
"TEXT" Draw 2D plot with the content of each cell.
Definition: Hoption.h:50
int Color
"COL" Draw 2D plot with Colored boxes.
Definition: Hoption.h:43
int AxisPos
"X+" and "Y+" Axis position
Definition: Hoption.h:60
int List
"LIST" Generate the TObjArray "contours". To be used with option "CONT"
Definition: Hoption.h:58
int Logx
log scale in X. Also set by histogram option
Definition: Hoption.h:70
int Zscale
"Z" Display the color palette.
Definition: Hoption.h:55
int MinimumZero
"MIN0" or gStyle->GetHistMinimumZero()
Definition: Hoption.h:63
int Contour
"CONTn" Draw 2D plot as a Contour plot (0 <= n <= 5).
Definition: Hoption.h:44
int Off
"][" The first and last vertical lines are not drawn.
Definition: Hoption.h:35
int Func
"FUNC" Draw only the function (for example in case of fit).
Definition: Hoption.h:45
long Candle
"CANDLE" and "VIOLIN" Draw a 2D histogram as candle/box plot or violin plot.
Definition: Hoption.h:53
int Spec
"SPEC" TSpectrum graphics
Definition: Hoption.h:61
int FrontBox
"FB" Suppress the front box for the 3D plots.
Definition: Hoption.h:56
int Pie
"PIE" Draw 1D plot as a pie chart.
Definition: Hoption.h:52
int Char
"CHAR" Draw 2D plot with a character set.
Definition: Hoption.h:42
int Star
"*" With option "P", a * is plotted at each point.
Definition: Hoption.h:39
int Zero
"0" if selected with any LEGO option the empty bins are not drawn.
Definition: Hoption.h:62
int Logz
log scale in Z. Also set by histogram option
Definition: Hoption.h:72
int Tri
"TRI" Draw TGraph2D with Delaunay triangles.
Definition: Hoption.h:51
int BackBox
"BB" Suppress the back box for the 3D plots.
Definition: Hoption.h:57
int Mark
"P" The current Marker is drawn at each point.
Definition: Hoption.h:37
int Arrow
"ARR" Draw 2D plot with Arrows.
Definition: Hoption.h:40
int Line
"L" A simple polyline through every point is drawn.
Definition: Hoption.h:36
int Same
"SAME" Histogram is plotted in the current pad.
Definition: Hoption.h:38
int Lego
"LEGO" and "LEGOn" Draw as a Lego plot(1 <= n <= 4).
Definition: Hoption.h:47
int Bar
"B", "BAR" and "HBAR" A Bar chart is drawn at each point.
Definition: Hoption.h:31
int Fill
"F" A fill area is drawn ("CF" draw a smooth fill area).
Definition: Hoption.h:34
int Hist
"HIST" Draw only the histogram.
Definition: Hoption.h:46
int Surf
"SURF" and "SURFn" Draw as a Surface ((1 <= n <= 4).
Definition: Hoption.h:49
int Logy
log scale in Y. Also set by histogram option
Definition: Hoption.h:71
int System
"POL", "CYL", "SPH" and "PSR" Type of coordinate system for 3D plots.
Definition: Hoption.h:54
int Error
"En" Draw Errors with current marker type and size (0 <= n <=6).
Definition: Hoption.h:33