MaCh3Plotting::StyleManager Class Reference

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

#include <Plotting/plottingUtils/styleManager.h>

Public Member Functions
	StyleManager (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...
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 20 of file styleManager.h.

Constructor & Destructor Documentation

StyleManager() [1/3]

MaCh3Plotting::StyleManager::StyleManager

(

std::string

configName

)

Constructor.

Parameters

configName

The style config to read from

Definition at line 4 of file styleManager.cpp.

                                                    {
  _styleConfig = M3OpenConfig(styleConfigName);
}

StyleManager() [2/3]

MaCh3Plotting::StyleManager::StyleManager ( const StyleManager &  )

delete

StyleManager() [3/3]

MaCh3Plotting::StyleManager::StyleManager ( StyleManager &&  )

default

~StyleManager()

MaCh3Plotting::StyleManager::~StyleManager ( )

inline

Definition at line 30 of file styleManager.h.

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

Member Function Documentation

prettifyName()

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

private

Definition at line 8 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 MaCh3Plotting::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 39 of file styleManager.h.

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

prettifySampleName()

std::string MaCh3Plotting::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 48 of file styleManager.h.

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

setPalette() [1/2]

void MaCh3Plotting::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 15 of file styleManager.cpp.

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

setPalette() [2/2]

void MaCh3Plotting::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 20 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["MarkerColor"],
    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 MaCh3Plotting::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 60 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 MaCh3Plotting::StyleManager::_styleConfig

private

Definition at line 69 of file styleManager.h.

---

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

• Plotting/plottingUtils/styleManager.h
• Plotting/plottingUtils/styleManager.cpp