include/root/Hoption.h

0001 /* @(#)root/histpainter:$Id$ */
0002
0003 /*************************************************************************
0004  * Copyright (C) 1995-2000, Rene Brun and Fons Rademakers.               *
0005  * All rights reserved.                                                  *
0006  *                                                                       *
0007  * For the licensing terms see $ROOTSYS/LICENSE.                         *
0008  * For the list of contributors see $ROOTSYS/README/CREDITS.             *
0009  *************************************************************************/
0010
0011 #ifndef ROOT_Hoption
0012 #define ROOT_Hoption
0013
0014
0015 ////////////////////////////////////////////////////////////////////////////////
0016 /*! \struct Hoption_t
0017     \brief Histograms' drawing options structure.
0018
0019 Used internally by THistPainter to manage histograms' drawing options.
0020
0021 */
0022
0023
0024 typedef struct Hoption_t {
0025
0026 ///@{
0027 /// @name Histogram's drawing options
0028 /// The drawing option may be the concatenation of some of the following options:
0029
0030    int Axis;        ///< <b>"A"</b> Axis are not drawn around the graph.
0031    int Bar;         ///< <b>"B"</b>, <b>"BAR"</b> and <b>"HBAR"</b> A Bar chart is drawn at each point.
0032    int Curve;       ///< <b>"C"</b> A smooth Curve is drawn.
0033    int Error;       ///< <b>"En"</b> Draw Errors with current marker type and size (0 <= n <=6).
0034    int Fill;        ///< <b>"F"</b> A fill area is drawn ("CF" draw a smooth fill area).
0035    int Off;         ///< <b>"]["</b> The first and last vertical lines are not drawn.
0036    int Line;        ///< <b>"L"</b> A simple polyline through every point is drawn.
0037    int Mark;        ///< <b>"P"</b> The current Marker is drawn at each point.
0038    int Same;        ///< <b>"SAME"</b>  Histogram is plotted in the current pad.
0039    int Star;        ///< <b>"*"</b> With option <b>"P"</b>, a * is plotted at each point.
0040    int Arrow;       ///< <b>"ARR"</b> Draw 2D plot with Arrows.
0041    int Box;         ///< <b>"BOX"</b> Draw 2D plot with proportional Boxes.
0042    int Char;        ///< <b>"CHAR"</b> Draw 2D plot with a character set.
0043    int Color;       ///< <b>"COL"</b> Draw 2D plot with Colored boxes.
0044    int Contour;     ///< <b>"CONTn"</b> Draw 2D plot as a Contour plot (0 <= n <= 5).
0045    int Func;        ///< <b>"FUNC"</b> Draw only the function (for example in case of fit).
0046    int Hist;        ///< <b>"HIST"</b> Draw only the histogram.
0047    int Lego;        ///< <b>"LEGO"</b> and <b>"LEGOn"</b> Draw as a Lego plot(1 <= n <= 4).
0048    int Scat;        ///< <b>"SCAT"</b> Draw 2D plot a Scatter plot.
0049    int Surf;        ///< <b>"SURF"</b> and <b>"SURFn"</b> Draw as a Surface ((1 <= n <= 4).
0050    int Text;        ///< <b>"TEXT"</b> Draw 2D plot with the content of each cell.
0051    int Tri;         ///< <b>"TRI"</b> Draw TGraph2D with Delaunay triangles.
0052    int Pie;         ///< <b>"PIE"</b>  Draw 1D plot as a pie chart.
0053    long Candle;     ///< <b>"CANDLE"</b> and <b>"VIOLIN"</b> Draw a 2D histogram as candle/box plot or violin plot.
0054    int System;      ///< <b>"POL"</b>, <b>"CYL"</b>, <b>"SPH"</b> and <b>"PSR"</b> Type of coordinate system for 3D plots.
0055    int Zscale;      ///< <b>"Z"</b> Display the color palette.
0056    int FrontBox;    ///< <b>"FB"</b> Suppress the front box for the 3D plots.
0057    int BackBox;     ///< <b>"BB"</b> Suppress the back box for the 3D plots.
0058    int List;        ///< <b>"LIST"</b> Generate the TObjArray "contours". To be used with option <b>"CONT"</b>
0059    int Proj;        ///< <b>"AITOFF"</b>, <b>"MERCATOR"</b>, <b>"SINUSOIDAL"</b> and <b>"PARABOLIC"</b> projections for 2d plots.
0060    int AxisPos;     ///< <b>"X+"</b> and <b>"Y+"</b> Axis position
0061    int Spec;        ///< <b>"SPEC"</b> TSpectrum graphics
0062    int Zero;        ///< <b>"0"</b> if selected with any LEGO option the empty bins are not drawn.
0063    int MinimumZero; ///< <b>"MIN0"</b> or gStyle->GetHistMinimumZero()
0064 ///@}
0065
0066 ///@{
0067 /// @name Other options
0068 /// The following structure members are set to 1 if the corresponding setting is selected.
0069
0070    int Logx;        ///< log scale in X. Also set by histogram option
0071    int Logy;        ///< log scale in Y. Also set by histogram option
0072    int Logz;        ///< log scale in Z. Also set by histogram option
0073
0074 ///@}
0075
0076 } Hoption_t;
0077
0078 #endif