Logo ROOT   6.30.04
Reference Guide
 All Namespaces Files Pages
Haxis.cxx
Go to the documentation of this file.
1 // @(#)root/hist:$Id$
2 // Author: Rene Brun 18/05/95
3 
4 #include <string.h>
5 #include <stdio.h>
6 #include <ctype.h>
7 
8 #include "TH1.h"
9 
10 
11 ////////////////////////////////////////////////////////////////////////////////
12 /// Choose an axis according to "axis".
13 
14 Int_t TH1::AxisChoice( Option_t *axis) const
15 {
16  char achoice = toupper(axis[0]);
17  if (achoice == 'X') return 1;
18  if (achoice == 'Y') return 2;
19  if (achoice == 'Z') return 3;
20  return 0;
21 }
22 
23 
24 ////////////////////////////////////////////////////////////////////////////////
25 /// Return the number of divisions for "axis".
26 
27 Int_t TH1::GetNdivisions( Option_t *axis) const
28 {
29  Int_t ax = AxisChoice(axis);
30  if (ax == 1) return fXaxis.GetNdivisions();
31  if (ax == 2) return fYaxis.GetNdivisions();
32  if (ax == 3) return fZaxis.GetNdivisions();
33  return 0;
34 }
35 
36 
37 ////////////////////////////////////////////////////////////////////////////////
38 /// Return the number of divisions for "axis".
39 
40 Color_t TH1::GetAxisColor( Option_t *axis) const
41 {
42  Int_t ax = AxisChoice(axis);
43  if (ax == 1) return fXaxis.GetAxisColor();
44  if (ax == 2) return fYaxis.GetAxisColor();
45  if (ax == 3) return fZaxis.GetAxisColor();
46  return 0;
47 }
48 
49 
50 ////////////////////////////////////////////////////////////////////////////////
51 /// Return the "axis" label color.
52 
53 Color_t TH1::GetLabelColor( Option_t *axis) const
54 {
55  Int_t ax = AxisChoice(axis);
56  if (ax == 1) return fXaxis.GetLabelColor();
57  if (ax == 2) return fYaxis.GetLabelColor();
58  if (ax == 3) return fZaxis.GetLabelColor();
59  return 0;
60 }
61 
62 
63 ////////////////////////////////////////////////////////////////////////////////
64 /// Return the "axis" label font.
65 
66 Style_t TH1::GetLabelFont( Option_t *axis) const
67 {
68  Int_t ax = AxisChoice(axis);
69  if (ax == 1) return fXaxis.GetLabelFont();
70  if (ax == 2) return fYaxis.GetLabelFont();
71  if (ax == 3) return fZaxis.GetLabelFont();
72  return 0;
73 }
74 
75 
76 ////////////////////////////////////////////////////////////////////////////////
77 /// Return the "axis" label offset.
78 
79 Float_t TH1::GetLabelOffset( Option_t *axis) const
80 {
81  Int_t ax = AxisChoice(axis);
82  if (ax == 1) return fXaxis.GetLabelOffset();
83  if (ax == 2) return fYaxis.GetLabelOffset();
84  if (ax == 3) return fZaxis.GetLabelOffset();
85  return 0;
86 }
87 
88 
89 ////////////////////////////////////////////////////////////////////////////////
90 /// Return the "axis" label size.
91 
92 Float_t TH1::GetLabelSize( Option_t *axis) const
93 {
94  Int_t ax = AxisChoice(axis);
95  if (ax == 1) return fXaxis.GetLabelSize();
96  if (ax == 2) return fYaxis.GetLabelSize();
97  if (ax == 3) return fZaxis.GetLabelSize();
98  return 0;
99 }
100 
101 
102 ////////////////////////////////////////////////////////////////////////////////
103 /// Return the "axis" tick length.
104 
105 Float_t TH1::GetTickLength( Option_t *axis) const
106 {
107  Int_t ax = AxisChoice(axis);
108  if (ax == 1) return fXaxis.GetTickLength();
109  if (ax == 2) return fYaxis.GetTickLength();
110  if (ax == 3) return fZaxis.GetTickLength();
111  return 0;
112 }
113 
114 
115 ////////////////////////////////////////////////////////////////////////////////
116 /// Return the "axis" title font.
117 
118 Style_t TH1::GetTitleFont( Option_t *axis) const
119 {
120  Int_t ax = AxisChoice(axis);
121  if (ax == 1) return fXaxis.GetTitleFont();
122  if (ax == 2) return fYaxis.GetTitleFont();
123  if (ax == 3) return fZaxis.GetTitleFont();
124  return 0;
125 }
126 
127 
128 ////////////////////////////////////////////////////////////////////////////////
129 /// Return the "axis" title offset.
130 
131 Float_t TH1::GetTitleOffset( Option_t *axis) const
132 {
133  Int_t ax = AxisChoice(axis);
134  if (ax == 1) return fXaxis.GetTitleOffset();
135  if (ax == 2) return fYaxis.GetTitleOffset();
136  if (ax == 3) return fZaxis.GetTitleOffset();
137  return 0;
138 }
139 
140 
141 ////////////////////////////////////////////////////////////////////////////////
142 /// Return the "axis" title size.
143 
144 Float_t TH1::GetTitleSize( Option_t *axis) const
145 {
146  Int_t ax = AxisChoice(axis);
147  if (ax == 1) return fXaxis.GetTitleSize();
148  if (ax == 2) return fYaxis.GetTitleSize();
149  if (ax == 3) return fZaxis.GetTitleSize();
150  return 0;
151 }
152 
153 
154 ////////////////////////////////////////////////////////////////////////////////
155 /// Set the number of divisions to draw an axis.
156 ///
157 /// ndiv : Number of divisions.
158 ///
159 /// n = N1 + 100*N2 + 10000*N3
160 /// N1=number of primary divisions.
161 /// N2=number of secondary divisions.
162 /// N3=number of 3rd divisions.
163 /// e.g.:
164 /// nndi=0 --> no tick marks.
165 /// nndi=2 --> 2 divisions, one tick mark in the middle
166 /// of the axis.
167 /// axis specifies which axis ("x","y","z"), default = "x"
168 /// if axis="xyz" set all 3 axes
169 
170 void TH1::SetNdivisions(Int_t n, Option_t *axis)
171 {
172  TString opt = axis;
173  opt.ToLower();
174 
175  if (opt.Contains("x")) fXaxis.SetNdivisions(n);
176  if (opt.Contains("y")) fYaxis.SetNdivisions(n);
177  if (opt.Contains("z")) fZaxis.SetNdivisions(n);
178 }
179 
180 
181 ////////////////////////////////////////////////////////////////////////////////
182 /// Set color to draw the axis line and tick marks.
183 ///
184 /// axis specifies which axis ("x","y","z"), default = "x"
185 /// if axis="xyz" set all 3 axes
186 
187 void TH1::SetAxisColor(Color_t color, Option_t *axis)
188 {
189  TString opt = axis;
190  opt.ToLower();
191 
192  if (opt.Contains("x")) fXaxis.SetAxisColor(color);
193  if (opt.Contains("y")) fYaxis.SetAxisColor(color);
194  if (opt.Contains("z")) fZaxis.SetAxisColor(color);
195 }
196 
197 
198 ////////////////////////////////////////////////////////////////////////////////
199 /// Set the "axis" range.
200 
201 void TH1::SetAxisRange(Axis_t xmin, Axis_t xmax, Option_t *axis)
202 {
203  Int_t ax = AxisChoice(axis);
204  TAxis *theAxis = 0;
205  if (ax == 1) theAxis = GetXaxis();
206  if (ax == 2) theAxis = GetYaxis();
207  if (ax == 3) theAxis = GetZaxis();
208  if (!theAxis) return;
209  if (ax > fDimension) {
210  SetMinimum(xmin);
211  SetMaximum(xmax);
212  return;
213  }
214  Int_t bin1 = theAxis->FindFixBin(xmin);
215  Int_t bin2 = theAxis->FindFixBin(xmax);
216  theAxis->SetRange(bin1, bin2);
217 }
218 
219 
220 ////////////////////////////////////////////////////////////////////////////////
221 /// Set axis labels color.
222 ///
223 /// axis specifies which axis ("x","y","z"), default = "x"
224 /// if axis="xyz" set all 3 axes
225 
226 void TH1::SetLabelColor(Color_t color, Option_t *axis)
227 {
228  TString opt = axis;
229  opt.ToLower();
230 
231  if (opt.Contains("x")) fXaxis.SetLabelColor(color);
232  if (opt.Contains("y")) fYaxis.SetLabelColor(color);
233  if (opt.Contains("z")) fZaxis.SetLabelColor(color);
234 }
235 
236 
237 ////////////////////////////////////////////////////////////////////////////////
238 /// Set font number used to draw axis labels.
239 ///
240 /// font : Text font code = 10*fontnumber + precision
241 /// Font numbers must be between 1 and 14
242 /// precision = 1 fast hardware fonts (steps in the size)
243 /// precision = 2 scalable and rotatable hardware fonts
244 ///
245 /// The default font number is 62.
246 /// axis specifies which axis ("x","y","z"), default = "x"
247 /// if axis="xyz" set all 3 axes
248 
249 void TH1::SetLabelFont(Style_t font, Option_t *axis)
250 {
251  TString opt = axis;
252  opt.ToLower();
253 
254  if (opt.Contains("x")) fXaxis.SetLabelFont(font);
255  if (opt.Contains("y")) fYaxis.SetLabelFont(font);
256  if (opt.Contains("z")) fZaxis.SetLabelFont(font);
257 }
258 
259 
260 ////////////////////////////////////////////////////////////////////////////////
261 /// Set offset between axis and axis' labels.
262 ///
263 /// The offset is expressed as a percent of the pad height.
264 /// axis specifies which axis ("x","y","z"), default = "x"
265 /// if axis="xyz" set all 3 axes
266 
267 void TH1::SetLabelOffset(Float_t offset, Option_t *axis)
268 {
269  TString opt = axis;
270  opt.ToLower();
271 
272  if (opt.Contains("x")) fXaxis.SetLabelOffset(offset);
273  if (opt.Contains("y")) fYaxis.SetLabelOffset(offset);
274  if (opt.Contains("z")) fZaxis.SetLabelOffset(offset);
275 }
276 
277 
278 ////////////////////////////////////////////////////////////////////////////////
279 /// Set size of axis' labels.
280 ///
281 /// The size is expressed as a percent of the pad height.
282 /// axis specifies which axis ("x","y","z"), default = "x"
283 /// if axis="xyz" set all 3 axes
284 
285 void TH1::SetLabelSize(Float_t size, Option_t *axis)
286 {
287  TString opt = axis;
288  opt.ToLower();
289 
290  if (opt.Contains("x")) fXaxis.SetLabelSize(size);
291  if (opt.Contains("y")) fYaxis.SetLabelSize(size);
292  if (opt.Contains("z")) fZaxis.SetLabelSize(size);
293 }
294 
295 
296 ////////////////////////////////////////////////////////////////////////////////
297 /// Set the axis' tick marks length.
298 ///
299 /// axis specifies which axis ("x","y","z"), default = "x"
300 /// if axis="xyz" set all 3 axes
301 
302 void TH1::SetTickLength(Float_t length, Option_t *axis)
303 {
304  TString opt = axis;
305  opt.ToLower();
306 
307  if (opt.Contains("x")) fXaxis.SetTickLength(length);
308  if (opt.Contains("y")) fYaxis.SetTickLength(length);
309  if (opt.Contains("z")) fZaxis.SetTickLength(length);
310 }
311 
312 
313 ////////////////////////////////////////////////////////////////////////////////
314 /// Set the axis' title font.
315 ///
316 /// - if axis =="x" set the X axis title font
317 /// - if axis =="y" set the Y axis title font
318 /// - if axis =="z" set the Z axis title font
319 /// any other value of axis will set the pad title font
320 ///
321 /// if axis="xyz" set all 3 axes
322 
323 void TH1::SetTitleFont(Style_t font, Option_t *axis)
324 {
325  TString opt = axis;
326  opt.ToLower();
327 
328  if (opt.Contains("x")) fXaxis.SetTitleFont(font);
329  if (opt.Contains("y")) fYaxis.SetTitleFont(font);
330  if (opt.Contains("z")) fZaxis.SetTitleFont(font);
331 }
332 
333 
334 ////////////////////////////////////////////////////////////////////////////////
335 /// Specify a parameter offset to control the distance between the axis
336 /// and the axis' title.
337 ///
338 /// - offset = 1 means : use the default distance
339 /// - offset = 1.2 means: the distance will be 1.2*(default distance)
340 /// - offset = 0.8 means: the distance will be 0.8*(default distance)
341 ///
342 /// axis specifies which axis ("x","y","z"), default = "x"
343 /// if axis="xyz" set all 3 axes
344 
345 void TH1::SetTitleOffset(Float_t offset, Option_t *axis)
346 {
347  TString opt = axis;
348  opt.ToLower();
349 
350  if (opt.Contains("x")) fXaxis.SetTitleOffset(offset);
351  if (opt.Contains("y")) fYaxis.SetTitleOffset(offset);
352  if (opt.Contains("z")) fZaxis.SetTitleOffset(offset);
353 }
354 
355 
356 ////////////////////////////////////////////////////////////////////////////////
357 /// Set the axis' title size.
358 ///
359 /// - if axis = "x" set the X axis title size
360 /// - if axis = "y" set the Y axis title size
361 /// - if axis = "z" set the Z axis title size
362 ///
363 /// if axis ="xyz" set all 3 axes
364 
365 void TH1::SetTitleSize(Float_t size, Option_t *axis)
366 {
367  TString opt = axis;
368  opt.ToLower();
369 
370  if (opt.Contains("x")) fXaxis.SetTitleSize(size);
371  if (opt.Contains("y")) fYaxis.SetTitleSize(size);
372  if (opt.Contains("z")) fZaxis.SetTitleSize(size);
373 }