macros/common/sPhenixStyle.h

0001 //
0002 //   @file    sPhenixStyle.h
0003 //
0004 //            sPHENIX Style, based on a style file from ATLAS
0005 //
0006 //
0007 //   @author Peter Steinberg
0008 //
0009 //   Copyright (C) 2017 sPhenix Collaboration
0010 //
0011 //   Version 0.1
0012
0013 #ifndef MACRO_SPHENIXSTYLE_H
0014 #define MACRO_SPHENIXSTYLE_H
0015
0016 #include <TStyle.h>
0017
0018 //! \brief sPHENIX Style, based on a style file from ATLAS by Peter Steinberg
0019 /*
0020 Please find instruction at https://wiki.bnl.gov/sPHENIX/index.php/Plot_template . Here is a snapshot:
0021
0022 # How to use
0023
0024 To ensure some consistency among plots produced by different sPHENIX members, a candidate style file is being proposed (May 2017), based on the ATLAS style file. Please click here for the gzipped tar file.
0025 For general use, copy or link the ``sPHENIXStyle.h`` and ``sPHENIXStyle.C`` files somewhere, either locally or in your macro path (``gROOT->GetMacroPath()`` will tell you, and add it in ``.rootrc`` if you need one).
0026 Then do
0027 ``
0028 [0] gROOT->LoadMacro("sPhenixStyle.C")
0029 [1] SetsPhenixStyle()
0030 ``
0031 and you're good to go (even better, add this all into your ``.rootlogon.C`` file)
0032
0033 # Rules of the sPHENIX style
0034
0035 * Don't talk about the style file.
0036 * Always use the style file.
0037 * Units should always be indicated in brackets "[ ]", while counts will typically specify the bin width "Events / 2 GeV" or "Events / 0.13 rad".
0038 * Every plot should have a legend indicating "sPHENIX", "sPHENIX Preliminary", "sPHENIX Simulation", etc.
0039 * sPHENIX should be bold, italic
0040 * Where possible, indicate the system being considered and it's energy
0041 * "MC" predictions should be filled, with distinguishable colors
0042 * Data or pseudodata should always be histograms or graphs with error bars
0043 * Elements should never overlap, with each other or with the axis
0044
0045  *
0046  */
0047 void SetsPhenixStyle();
0048
0049 TStyle* sPhenixStyle();
0050
0051 #endif // MACRO_SPHENIXSTYLE_H