Warning, /analysis/EnergyCorrelatorsJets/ColdQCDENC/SCorrelatorUtilities/README.md is written in an unsupported language. File is not indexed.
0001 # SCorrelatorUtilities
0002
0003 Collected here useful types, methods, and constant used throughout the sPHENIX Cold QCD Energy-Energy
0004 Correlator analysis. There are four components:
0005
0006 - `Constants::`: enums and methods used to consolidate important constants as well as mappings between
0007 various flags, nodes, etc.;
0008 - `Types::`: classes used to consolidate relevant information and operations on said information from things
0009 like tracks, calorimeter clusters, jets, etc.;
0010 - `Tools::`: methods defining frequently used operations and calculations; and
0011 - `Interfaces::`: methods which streamline interfacing with Fun4All, ROOT, and potentially other frameworks.
0012
0013 Each component has an "all-in-one" header which collects all of the relevant constituent headers for convenience.
0014 For example, to use a data type in another module make sure to include the following with your other includes:
0015
0016 ```
0017 // includes
0018 #include "<path-to-install>/scorrelatorutilities/Types.h"
0019
0020 // and where you load libraries
0021 R__LOAD_LIBRARY(<path-to-install>/libscorrelatorutilities.so)
0022 ```
0023
0024 ## Compilation Instructions
0025
0026 As this is used throughout the entire analysis chain, this library should be built first. As always, build with:
0027
0028 ```
0029 cd src
0030 mkdir build
0031 ./sphx-build
0032 ```
