EW: provides centralized styling utilities for plots, including name prettification and style application. More...

#include <Utils/Plotting/StyleManager.h>

Public Member Functions
	StyleManager (const std::string &configName)
	Constructor. More...

	StyleManager (const StyleManager &)=delete

	StyleManager (StyleManager &&)=default

	~StyleManager ()

std::string	prettifyParamName (const std::string &origName) const
	Convert hideous and vulgar internal parameter name into a beautiful presentable name. More...

std::string	prettifySampleName (const std::string &origName) const
	Convert hideous and vulgar internal sample name into a beautiful presentable name. More...

std::string	prettifyKinematicName (const std::string &origName) const
	Convert hideous and vulgar internal kinematics name into a beautiful presentable name. More...

double	getBinWidthScale (const std::string &Name) const
	Get bin-width scaling factor for a given kinematic variable. More...

void	setPalette (const int rootPlotStyle) const
	Set the root colour palette to one of the default root pallettes as defined in (root docs)[https://root.cern.ch/doc/master/classTColor.html#C05]. More...

void	setPalette (const std::string &configStyleName) const
	Set the root colour palette to one of the ones defined in the style config. More...

void	setTH1Style (TH1 *hist, const std::string &styleName) const
	Set the style of a TH1 to one of the styles defined in the style config. More...

Private Member Functions
std::string	prettifyName (const std::string &origName, const std::string &nameType) const

Private Attributes
YAML::Node	_styleConfig

Detailed Description

EW: provides centralized styling utilities for plots, including name prettification and style application.

Author: Ewan Miller

Definition at line 21 of file StyleManager.h.

Constructor & Destructor Documentation

◆ StyleManager() [1/3]

M3::Plotting::StyleManager::StyleManager ( const std::string & configName )

Constructor.

Parameters

configName The style config to read from

Definition at line 5 of file StyleManager.cpp.

                                                            {
   _styleConfig = M3OpenConfig(styleConfigName);
 }

◆ StyleManager() [2/3]

M3::Plotting::StyleManager::StyleManager ( const StyleManager & )

delete

◆ StyleManager() [3/3]

M3::Plotting::StyleManager::StyleManager ( StyleManager && )

default

◆ ~StyleManager()

M3::Plotting::StyleManager::~StyleManager ( )

inline

Definition at line 31 of file StyleManager.h.

                  {
     MACH3LOG_DEBUG("##### Deleting StyleManager Instance #####");
   }

Member Function Documentation

◆ getBinWidthScale()

double M3::Plotting::StyleManager::getBinWidthScale ( const std::string & Name ) const

Get bin-width scaling factor for a given kinematic variable.

Parameters

variable Name of the kinematic variable (e.g. RecoNeutrinoEnergy, TrueQ2)

Definition at line 77 of file StyleManager.cpp.

                                                                  {
   constexpr const double DefaultScalingFactor = 10;
   if(!_styleConfig["BinWidthScaleFactor"]) return DefaultScalingFactor;
  
   return GetFromManager<double>(_styleConfig["BinWidthScaleFactor"][Name], DefaultScalingFactor, __FILE__, __LINE__);
 }

◆ prettifyKinematicName()

std::string M3::Plotting::StyleManager::prettifyKinematicName ( const std::string & origName ) const

inline

Convert hideous and vulgar internal kinematics name into a beautiful presentable name.

The pretty kinematics names should be specified in the style config file

Parameters

origName The "internal" name used to uniquely identify the kinematics inside the plotting code

Returns: A beautiful formatted name that can be used in plots

Definition at line 58 of file StyleManager.h.

                                                                    {
     return prettifyName(origName, "kinematics");
   };

◆ prettifyName()

std::string M3::Plotting::StyleManager::prettifyName	(	const std::string &	origName,
		const std::string &	nameType
	)		const

private

Definition at line 9 of file StyleManager.cpp.

                                                                                                {
   YAML::Node prettyNames = _styleConfig["PrettyNames"][nameType];
   auto prettyName = GetFromManager<std::string>(prettyNames[origName], origName, __FILE__, __LINE__);
  
   return prettyName;
 }

◆ prettifyParamName()

std::string M3::Plotting::StyleManager::prettifyParamName ( const std::string & origName ) const

inline

Convert hideous and vulgar internal parameter name into a beautiful presentable name.

The pretty parameter names should be specified in the style config file

Parameters

origName The "internal" name used to uniquely identify the parameter inside the plotting code

Returns: A beautiful formatted name that can be used in plots

Definition at line 40 of file StyleManager.h.

                                                                {
     return prettifyName(origName, "parameters");
   };

◆ prettifySampleName()

std::string M3::Plotting::StyleManager::prettifySampleName ( const std::string & origName ) const

inline

Convert hideous and vulgar internal sample name into a beautiful presentable name.

The pretty sample names should be specified in the style config file

Parameters

origName The "internal" name used to uniquely identify the sample inside the plotting code

Returns: A beautiful formatted name that can be used in plots

Definition at line 49 of file StyleManager.h.

                                                                 {
     return prettifyName(origName, "samples");
   };

◆ setPalette() [1/2]

void M3::Plotting::StyleManager::setPalette ( const int rootPlotStyle ) const

Set the root colour palette to one of the default root pallettes as defined in (root docs)[https://root.cern.ch/doc/master/classTColor.html#C05].

Parameters

rootPlotStyle The index of the palette as defined by root

Definition at line 16 of file StyleManager.cpp.

                                                            {
   // set the colour palette to one of the root palettes
   gStyle->SetPalette(rootPlotStyle);
 }

◆ setPalette() [2/2]

void M3::Plotting::StyleManager::setPalette ( const std::string & configStyleName ) const

Set the root colour palette to one of the ones defined in the style config.

Parameters

rootPlotStyle The name of the palette you want to use, should be the same as it appears in the style config

Definition at line 21 of file StyleManager.cpp.

                                                                     {
   // set the colour palette to one of the palettes defined in PlottingConfig.yaml
  
   // get the definition of the provided style from the config file
   YAML::Node palettes = _styleConfig["ColorPallettes"];
   YAML::Node styleDef;
   if (palettes) {
     styleDef = palettes[configStyleName];
   }
  
   auto paletteDef = GetFromManager<std::vector<std::vector<double>>>(
     styleDef,
     std::vector<std::vector<double>>{
       {4.0},                         // NCont
       {0.0   , 0.33  , 0.66 , 1.0},  // stops
       {0.0   , 0.0   , 0.0  , 0.0},  // Reds
       {0.0   , 0.0   , 1.0  , 0.0},  // Greens
       {0.0   , 1.0   , 0.0  , 0.0}   // Blues
     }, __FILE__, __LINE__);
   const Int_t NCont = Int_t(paletteDef[0][0]);
  
   std::vector<double> stopVec = paletteDef[1];
   std::vector<double> redsVec = paletteDef[2];
   std::vector<double> greensVec = paletteDef[3];
   std::vector<double> bluesVec = paletteDef[4];
  
   // get the number of colour stops and check all vectors are same size
   const size_t NRGBs = stopVec.size();
   if (redsVec.size() != NRGBs || greensVec.size() != NRGBs ||
       bluesVec.size() != NRGBs)
   {
     MACH3LOG_ERROR("invalid colour palette defined in style config file: {}");
     MACH3LOG_ERROR("RGB arrays don't all have the same size, please fix that");
   }
  
   // now actually set the palette
   TColor::CreateGradientColorTable(int(NRGBs), stopVec.data(), redsVec.data(), greensVec.data(), bluesVec.data(), NCont);
   gStyle->SetNumberContours(NCont);
 }

◆ setTH1Style()

void M3::Plotting::StyleManager::setTH1Style	(	TH1 *	hist,
		const std::string &	styleName
	)		const

Set the style of a TH1 to one of the styles defined in the style config.

Parameters

hist	The TH1 that you wish to modify
styleName	The name of the style you want to use, as it appears in the config file

Definition at line 61 of file StyleManager.cpp.

                                                                           {
   // get the definition of the provided style from the config file
   YAML::Node TH1Styles = _styleConfig["TH1Styles"];
   YAML::Node styleDef ;
   if (TH1Styles) {
     styleDef = TH1Styles[styleName];
   }
  
   hist->SetMarkerColor(GetFromManager<Color_t>(styleDef["MarkerColor"], kRed, __FILE__, __LINE__));
   hist->SetMarkerStyle(GetFromManager<Color_t>(styleDef["MarkerStyle"], 7, __FILE__, __LINE__));
   hist->SetFillColor(GetFromManager<Color_t>(styleDef["FillColor"], kRed, __FILE__, __LINE__));
   hist->SetFillStyle(GetFromManager<Color_t>(styleDef["FillStyle"], 3003, __FILE__, __LINE__));
   hist->SetLineColor(GetFromManager<Color_t>(styleDef["LineColor"], kRed, __FILE__, __LINE__));
   hist->SetLineStyle(GetFromManager<Color_t>(styleDef["LineStyle"], 1, __FILE__, __LINE__));
 }

Member Data Documentation

◆ _styleConfig

YAML::Node M3::Plotting::StyleManager::_styleConfig

private

Definition at line 83 of file StyleManager.h.

The documentation for this class was generated from the following files:

Utils/Plotting/StyleManager.h
Utils/Plotting/StyleManager.cpp

Public Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ StyleManager() [1/3]

◆ StyleManager() [2/3]

◆ StyleManager() [3/3]

◆ ~StyleManager()

Member Function Documentation

◆ getBinWidthScale()

◆ prettifyKinematicName()

◆ prettifyName()

◆ prettifyParamName()

◆ prettifySampleName()

◆ setPalette() [1/2]

◆ setPalette() [2/2]

◆ setTH1Style()

Member Data Documentation

◆ _styleConfig