Gaudi::Histograming::Sink::details Namespace Reference

Classes
struct	Axis
	Small helper struct representing the Axis of an Histogram. More...
struct	TraitsBase
	Common base for Traits dealing with Histogram conversions to Root Provides generic implementation for creating the histogram and filling meta data The filling (method fill) is not implemented. More...
struct	ProfileWrapper
	helper Wrapper around TProfileX to be able to fill it More...
struct	BinAvValue

Functions
Axis	jsonToAxis (nlohmann::json &jAxis)
	extract an Axis from json data
void	fixNameAndDir (std::string &name, std::string &dir)
	handles cases where name includes '/' character(s) and move needed part of it to dir.
template<typename Traits, std::size_t... index>
std::tuple< typename Traits::Histo, std::string >	jsonToRootHistogramInternal (std::string &dir, std::string &name, nlohmann::json const &j, std::index_sequence< index... >)
	generic function to convert json to a ROOT Histogram - internal implementation
TDirectory *	changeDir (TFile &file, std::string_view dir)
	changes to the ROOT directory given in the current ROOT file and returns the current directory before the change
template<typename Histo>
nlohmann::json	allAxisTojson (Histo const &h)
template<typename Histo>
nlohmann::json	binsTojson (Histo const &h)
template<typename Histo>
nlohmann::json	rootHistogramToJson (Histo const &h)
	automatic translation of Root Histograms to json

Function Documentation

allAxisTojson()

template<typename Histo>

nlohmann::json Gaudi::Histograming::Sink::details::allAxisTojson

(

Histo const &

h

)

Definition at line 421 of file Utils.h.

                                                 {
      if constexpr ( std::is_base_of_v<TH3D, Histo> ) {
        return { *h.GetXaxis(), *h.GetYaxis(), *h.GetZaxis() };
      } else if constexpr ( std::is_base_of_v<TProfile2D, Histo> || std::is_base_of_v<TH2D, Histo> ) {
        return { *h.GetXaxis(), *h.GetYaxis() };
      } else {
        return { *h.GetXaxis() };
      }
    }

binsTojson()

template<typename Histo>

nlohmann::json Gaudi::Histograming::Sink::details::binsTojson

(

Histo const &

h

)

Definition at line 432 of file Utils.h.

                                              {
      if constexpr ( std::is_base_of_v<TProfile, Histo> || std::is_base_of_v<TProfile2D, Histo> ) {
        nlohmann::json j;
        // ROOT TProfile interface being completely inconsistent, we have to play
        // with different ways to access values of the histogram... one per value !
        auto* sums  = h.GetArray();
        auto* sums2 = h.GetSumw2();
        for ( unsigned long n = 0; n < (unsigned long)h.GetSize(); n++ ) {
          j.push_back( nlohmann::json{ { h.GetBinEntries( n ), sums[n] }, sums2->At( n ) } );
        }
        return j;
      } else {
        return gsl::span{ h.GetArray(), (unsigned long)h.GetSize() };
      }
    }

changeDir()

TDirectory * Gaudi::Histograming::Sink::details::changeDir ( TFile & file, std::string_view dir )

inline

changes to the ROOT directory given in the current ROOT file and returns the current directory before the change

Definition at line 398 of file Utils.h.

                                                                    {
      // remember the current directory
      auto previousDir = gDirectory;
      // find or create the directory for the histogram
      auto currentDir = ranges::accumulate(
          dir | std::views::transform( []( char c ) { return c == '.' ? '/' : c; } ) | std::views::split( '/' ) |
              std::views::transform( []<std::ranges::input_range R>( R&& r ) {
                return std::string( std::ranges::begin( r ), std::ranges::end( r ) );
              } ),
          file.GetDirectory( "" ), []( TDirectory* current, std::string const& d ) -> TDirectory* {
            if ( !current ) return current;
            if ( auto next = current->GetDirectory( d.c_str() ); next ) return next;
            return current->mkdir( d.c_str() );
          } );
      if ( !currentDir )
        throw GaudiException( fmt::format( "Could not create directory {}", dir ), "Histogram::Sink::Root",
                              StatusCode::FAILURE );
      // switch to the directory
      currentDir->cd();
      return previousDir;
    }

fixNameAndDir()

void Gaudi::Histograming::Sink::details::fixNameAndDir ( std::string & name, std::string & dir )

inline

handles cases where name includes '/' character(s) and move needed part of it to dir.

Also handle case of absolute names

Definition at line 248 of file Utils.h.

                                                                 {
      if ( name[0] == '/' ) {
        dir  = "";
        name = name.substr( 1 );
      }
      // take into account the case where name contains '/'s (e.g. "Group/Name") by
      // moving the prefix into dir
      if ( auto pos = name.rfind( '/' ); pos != std::string::npos ) {
        dir += '/' + name.substr( 0, pos );
        name = name.substr( pos + 1 );
      }
    }

jsonToAxis()

Axis Gaudi::Histograming::Sink::details::jsonToAxis ( nlohmann::json & jAxis )

inline

extract an Axis from json data

Definition at line 238 of file Utils.h.

                                                  {
      return { jAxis.at( "nBins" ).get<unsigned int>(), jAxis.at( "minValue" ).get<double>(),
               jAxis.at( "maxValue" ).get<double>(),
               ";" + jAxis.at( "title" ).get<std::string>() }; // ";" to prepare concatenations of titles
    }

jsonToRootHistogramInternal()

template<typename Traits, std::size_t... index>

std::tuple< typename Traits::Histo, std::string > Gaudi::Histograming::Sink::details::jsonToRootHistogramInternal	(	std::string &	dir,
		std::string &	name,
		nlohmann::json const &	j,
		std::index_sequence< index... >	)

generic function to convert json to a ROOT Histogram - internal implementation

Definition at line 265 of file Utils.h.

                                                                                                               {
      // extract data from json
      auto jsonAxis = j.at( "axis" );
      auto axis     = std::array{ jsonToAxis( jsonAxis[index] )... };
      auto weights  = j.at( "bins" ).get<typename Traits::WeightType>();
      auto title    = j.at( "title" ).get<std::string>();
      auto nentries = j.at( "nEntries" ).get<unsigned int>();
      // weird way ROOT has to give titles to axis
      title += ( axis[index].title + ... );
      // compute total number of bins, multiplying bins per axis
      auto totNBins = ( ( axis[index].nBins + 2 ) * ... );
      // fix name and dir if needed
      fixNameAndDir( name, dir );
      // Create Root histogram calling constructors with the args tuple
      auto histo = Traits::create( name, title, axis[index]... );
      // fill Histo
      Traits::fill( histo, totNBins, weights );
      // in case we have sums, overwrite them in the histogram with our more precise values
      // FIXME This is only supporting regular histograms. It won't work in case of weighted histograms
      if constexpr ( sizeof...( index ) == 1 ) {
        if ( j.find( "sum" ) != j.end() ) {
          double s[13];
          s[0] = j.at( "nTotEntries" ).get<double>();
          s[1] = j.at( "nTotEntries" ).get<double>();
          s[2] = j.at( "sum" ).get<double>();
          s[3] = j.at( "sum2" ).get<double>();
          histo.PutStats( s );
        }
      } else {
        if ( j.find( "sumx" ) != j.end() ) {
          double s[13];
          s[0] = j.at( "nTotEntries" ).get<double>();
          s[1] = j.at( "nTotEntries" ).get<double>();
          s[2] = j.at( "sumx" ).get<double>();
          s[3] = j.at( "sumx2" ).get<double>();
          s[4] = j.at( "sumy" ).get<double>();
          s[5] = j.at( "sumy2" ).get<double>();
          s[6] = j.at( "sumxy" ).get<double>();
          if constexpr ( sizeof...( index ) > 2 ) {
            s[7]  = j.at( "sumz" ).get<double>();
            s[8]  = j.at( "sumz2" ).get<double>();
            s[9]  = j.at( "sumxz" ).get<double>();
            s[10] = j.at( "sumyz" ).get<double>();
          }
          histo.PutStats( s );
        }
      }
      // fill histo metadata, e.g. bins and number of entries
      Traits::fillMetaData( histo, jsonAxis, nentries );
      return { histo, dir };
    }

rootHistogramToJson()

template<typename Histo>

nlohmann::json Gaudi::Histograming::Sink::details::rootHistogramToJson

(

Histo const &

h

)

automatic translation of Root Histograms to json

Definition at line 450 of file Utils.h.

                                                       {
      bool        isProfile = std::is_base_of_v<TProfile, Histo> || std::is_base_of_v<TProfile2D, Histo>;
      std::string type      = isProfile ? "histogram:ProfileHistogram:double" : "histogram:Histogram:double";
      auto        j         = nlohmann::json{ { "type", type },
                                              { "title", h.GetTitle() },
                                              { "dimension", h.GetDimension() },
                                              { "empty", (int)h.GetEntries() == 0 },
                                              { "nEntries", (int)h.GetEntries() },
                                              { "axis", allAxisTojson( h ) },
                                              { "bins", binsTojson( h ) } };
      if ( !isProfile ) {
        double s[13];
        h.GetStats( s );
        if ( h.GetDimension() == 1 ) {
          j["nTotEntries"] = s[0];
          j["sum"]         = s[2];
          j["sum2"]        = s[3];
          j["mean"]        = s[2] / s[0];
        } else {
          j["nTotEntries"] = s[0];
          j["sumx"]        = s[2];
          j["sumx2"]       = s[3];
          j["meanx"]       = s[2] / s[0];
          j["sumy"]        = s[4];
          j["sumy2"]       = s[5];
          j["sumxy"]       = s[6];
          j["meany"]       = s[4] / s[0];
          if ( h.GetDimension() >= 3 ) {
            j["sumz"]  = s[7];
            j["sumz2"] = s[8];
            j["sumxz"] = s[9];
            j["sumyz"] = s[10];
            j["meanz"] = s[7] / s[0];
          }
        }
      }
      return j;
    }