#include <ZdcInjPulserAmpMap.h>

Inheritance diagram for ZdcInjPulserAmpMap:

Collaboration diagram for ZdcInjPulserAmpMap:

Classes
class	Token

Public Types
using	json = nlohmann::json

Public Member Functions
	ZdcInjPulserAmpMap ()

const std::string &	getFilePath () const

Token	lookupRun (unsigned int runNumber, bool allowDefault=false)

unsigned int	getFirstLumiBlock (const Token &token) const

unsigned int	getNumSteps (const Token &token) const

int	getCycleNumber (const Token &token, unsigned int lumiBlock) const

float	getPulserAmplitude (const Token &token, unsigned int lumiBlock) const

void	setLevel (MSG::Level lvl)
	Change the current logging level. More...

Static Public Member Functions
static const ZdcInjPulserAmpMap *	getInstance ()

Private Types
using	StepsVector = std::vector< float >

using	StepsDescr = std::pair< unsigned int, StepsVector >

using	RunRangeDescr = std::tuple< unsigned int, unsigned int, std::string, float >

Private Member Functions
bool	parseJsonFile (std::ifstream &ifs)

void	readPulserSteps (StepsDescr &steps, const json &stepsJson)

void	fillVVector (StepsVector &stepVec, const nlohmann::json &entry)

std::pair< unsigned int, StepsVector >	getContext (const Token &token) const

void	initMessaging () const
	Initialize our message level and MessageSvc. More...

Private Attributes
std::mutex	m_lock

std::string	m_filePath

bool	m_validJSon {false}

std::vector< RunRangeDescr >	m_runRangeDescrs

std::map< std::string, StepsDescr >	m_stepsConfigs

std::vector< const StepsDescr * >	m_activeConfigs

std::string	m_nm
	Message source name. More...

boost::thread_specific_ptr< MsgStream >	m_msg_tls
	MsgStream instance (a std::cout like with print-out levels) More...

std::atomic< IMessageSvc * >	m_imsg { nullptr }
	MessageSvc pointer. More...

std::atomic< MSG::Level >	m_lvl { MSG::NIL }
	Current logging level. More...

std::atomic_flag m_initialized	ATLAS_THREAD_SAFE = ATOMIC_FLAG_INIT
	Messaging initialized (initMessaging) More...

Detailed Description

Definition at line 24 of file ZdcInjPulserAmpMap.h.

Member Typedef Documentation

◆ json

using ZdcInjPulserAmpMap::json = nlohmann::json

Definition at line 51 of file ZdcInjPulserAmpMap.h.

◆ RunRangeDescr

using ZdcInjPulserAmpMap::RunRangeDescr = std::tuple<unsigned int, unsigned int, std::string, float>

private

Definition at line 58 of file ZdcInjPulserAmpMap.h.

◆ StepsDescr

using ZdcInjPulserAmpMap::StepsDescr = std::pair<unsigned int, StepsVector>

private

Definition at line 56 of file ZdcInjPulserAmpMap.h.

◆ StepsVector

using ZdcInjPulserAmpMap::StepsVector = std::vector<float>

private

Definition at line 55 of file ZdcInjPulserAmpMap.h.

Constructor & Destructor Documentation

◆ ZdcInjPulserAmpMap()

ZdcInjPulserAmpMap::ZdcInjPulserAmpMap ( )

Definition at line 19 of file ZdcInjPulserAmpMap.cxx.

                                        : asg::AsgMessaging("ZdcInjPulserAmpMap")
 {
   msg().setLevel(MSG::INFO);
  
   // std::string filePath = PathResolverFindCalibFile("ZdcConditions/ZDC_InjectPulseSteps.json"); // change back file name after other changes get merged + ready for T0 reprocessing
   std::string filePath = PathResolverFindCalibFile("ZdcConditions/INJpulser_combined_2024.json");
  
   if (!filePath.empty())
     {
       ATH_MSG_DEBUG( "ZdcInjPulserAmpMap::found ZDC JSON at " << filePath );
     }
   else
     {
       ATH_MSG_WARNING(  "ZdcInjPulserAmpMap constructor, JSON file not found in search path, trying local file" ) ;
       filePath = "./ZDC_InjectPulseSteps.json";
     }
  
  
   std::ifstream ifs(filePath);
   if (!ifs.is_open()) {
     ATH_MSG_FATAL("ZdcInjPulserAmpMap constructor, JSON file cannot be opened!" ) ;
   }
  
   m_filePath = filePath;
   if (parseJsonFile(ifs)) m_validJSon = true;;
 }

Member Function Documentation

◆ fillVVector()

void ZdcInjPulserAmpMap::fillVVector	(	StepsVector &	stepVec,
		const nlohmann::json &	entry
	)

private

Definition at line 129 of file ZdcInjPulserAmpMap.cxx.

 {
   unsigned int nStep = entry.at("nStep");
   float vStart = entry.at("vStart");
   float vStep = entry.at("vStep");
  
   float voltage = vStart;
   for (size_t step = 0; step < nStep; step++) {
     stepVec.push_back(voltage);
     voltage += vStep;
   }
 }

◆ getContext()

std::pair<unsigned int, StepsVector> ZdcInjPulserAmpMap::getContext ( const Token & token ) const

inlineprivate

Definition at line 88 of file ZdcInjPulserAmpMap.h.

   {
     if (!m_validJSon) {
       throw std::runtime_error("Invalid Injected Pulser configuration");
     }
     if (!token.isValid() || size_t(token.value()) >= m_activeConfigs.size()) {
       throw std::runtime_error("Invalid Injected Pulser configuration");
     }
     
     unsigned int index = token.value();
     const StepsDescr& stepsConfig = *(m_activeConfigs[index]);
   
     unsigned int firstLB = stepsConfig.first;
     const StepsVector& steps = stepsConfig.second;
   
     return std::make_pair(firstLB, steps);
   }

◆ getCycleNumber()

int ZdcInjPulserAmpMap::getCycleNumber	(	const Token &	token,
		unsigned int	lumiBlock
	)		const

inline

Definition at line 130 of file ZdcInjPulserAmpMap.h.

   {
     auto [firstLB, map] = getContext(token);
       
     if (lumiBlock < firstLB) return -1;
     return std::floor(float(lumiBlock - firstLB)/map.size());
   }

◆ getFilePath()

const std::string& ZdcInjPulserAmpMap::getFilePath ( ) const

inline

Definition at line 112 of file ZdcInjPulserAmpMap.h.

112 {return m_filePath;}

◆ getFirstLumiBlock()

unsigned int ZdcInjPulserAmpMap::getFirstLumiBlock ( const Token & token ) const

inline

Definition at line 118 of file ZdcInjPulserAmpMap.h.

                                                            {
     auto result = getContext(token);
     return result.first;
   }

◆ getInstance()

const ZdcInjPulserAmpMap * ZdcInjPulserAmpMap::getInstance ( )

static

Definition at line 11 of file ZdcInjPulserAmpMap.cxx.

 {
   static const ZdcInjPulserAmpMap pulser_map;
   return &pulser_map;
 }

◆ getNumSteps()

unsigned int ZdcInjPulserAmpMap::getNumSteps ( const Token & token ) const

inline

Definition at line 123 of file ZdcInjPulserAmpMap.h.

                                                      {
     auto result = getContext(token);
     return result.second.size();
   }

◆ getPulserAmplitude()

float ZdcInjPulserAmpMap::getPulserAmplitude	(	const Token &	token,
		unsigned int	lumiBlock
	)		const

inline

Definition at line 140 of file ZdcInjPulserAmpMap.h.

   {
     auto [firstLB, map] = getContext(token);
  
     // We do a cyclic lookup of the pulser amplitude (in volts) starting from the first LB
     //
     if (lumiBlock < firstLB) return -1000.;
     unsigned int vecIndex = (lumiBlock - firstLB) % map.size();
     return map.at(vecIndex) * token.scaleFactor();
   }

◆ initMessaging()

void AthMessaging::initMessaging ( ) const

privateinherited

Initialize our message level and MessageSvc.

This method should only be called once.

Definition at line 39 of file AthMessaging.cxx.

 {
   m_imsg = Athena::getMessageSvc();
   m_lvl = m_imsg ?
     static_cast<MSG::Level>( m_imsg.load()->outputLevel(m_nm) ) :
     MSG::INFO;
 }

◆ lookupRun()

ZdcInjPulserAmpMap::Token ZdcInjPulserAmpMap::lookupRun	(	unsigned int	runNumber,
		bool	allowDefault = `false`
	)

Definition at line 142 of file ZdcInjPulserAmpMap.cxx.

 {
   std::string configName = (allowDefault ? "Default" : "_none_");
   float scaleFactor = 1;
   
   for ( auto rangeDescr : m_runRangeDescrs) {
     if (runNumber >= std::get<0>(rangeDescr) && runNumber < std::get<1>(rangeDescr)) {
       configName = std::get<2>(rangeDescr);
       scaleFactor = std::get<3>(rangeDescr);
  
       ATH_MSG_DEBUG( "ZdcInjPulserAmpMap::lookupRun():  found config name " << configName  << " for run number " 
              << runNumber);
     }
   }
  
  
   // Find the corresponding configuration -- we hope
   //
   auto findIter = m_stepsConfigs.find(configName);
   if (findIter == m_stepsConfigs.end()) return Token();
  
   // Now we make a new active configuration -- the only thing that needs to be thread-protected
   //
   const std::lock_guard<std::mutex> lock(m_lock);
  
   // Put a new entry in the active configuration vector 
   //
   int newIndex = m_activeConfigs.size();
   m_activeConfigs.push_back(&findIter->second);
  
   ATH_MSG_DEBUG( "ZdcInjPulserAmpMap::lookupRun():  creating token for run number " << runNumber
          << " with index " << newIndex << ", and scaleFactor " << scaleFactor);
   
   return Token(newIndex, scaleFactor);
 }

◆ msg() [1/2]

MsgStream & asg::AsgMessaging::msg ( ) const

inherited

The standard message stream.

Returns: A reference to the default message stream of this object.

Definition at line 49 of file AsgMessaging.cxx.

                                       {
 #ifndef XAOD_STANDALONE
       return ::AthMessaging::msg();
 #else // not XAOD_STANDALONE
       return m_msg;
 #endif // not XAOD_STANDALONE
    }

◆ msg() [2/2]

MsgStream & asg::AsgMessaging::msg ( const MSG::Level lvl ) const

inherited

The standard message stream.

Parameters

lvl	The message level to set the stream to

Returns: A reference to the default message stream, set to level "lvl"

Definition at line 57 of file AsgMessaging.cxx.

                                                           {
 #ifndef XAOD_STANDALONE
       return ::AthMessaging::msg( lvl );
 #else // not XAOD_STANDALONE
       m_msg << lvl;
       return m_msg;
 #endif // not XAOD_STANDALONE
    }

◆ msgLvl()

bool asg::AsgMessaging::msgLvl ( const MSG::Level lvl ) const

inherited

Test the output level of the object.

Parameters

lvl	The message level to test against

Returns: boolean Indicting if messages at given level will be printed; true If messages at level "lvl" will be printed

Definition at line 41 of file AsgMessaging.cxx.

                                                        {
 #ifndef XAOD_STANDALONE
       return ::AthMessaging::msgLvl( lvl );
 #else // not XAOD_STANDALONE
       return m_msg.msgLevel( lvl );
 #endif // not XAOD_STANDALONE
    }

◆ parseJsonFile()

bool ZdcInjPulserAmpMap::parseJsonFile ( std::ifstream & ifs )

private

Definition at line 46 of file ZdcInjPulserAmpMap.cxx.

 {
   try {
     nlohmann::json j = nlohmann::json::parse(ifs);
     
     // Check for the existence of the run range section of the json file
     //
     auto rangeIter = j.find("RunRanges");
     if (rangeIter == j.end()) return false;
     
     //
     //  We loop over all the defined run ranges and save
     //
     for (json range : *rangeIter) {
       unsigned int first = range.at("First");
       unsigned int last = range.at("Last");
       std::string name = range.at("StepsConfig");
       float scale = range.at("ScaleFactor");
       
       m_runRangeDescrs.push_back(std::make_tuple(first, last, name, scale));
  
       ATH_MSG_DEBUG( "ZdcInjPulserAmpMap::found run range: first, last = " << first << ", " << last
              << ", config name = " << name << ", scale factor = " << scale );
     }
     
     auto stepConfigIter = j.find("StepConfigurations");
     if (stepConfigIter == j.end()) return false;
     
     // Now loop over the configurations and save
     //
     for (json::iterator configIt = stepConfigIter->begin(); configIt != stepConfigIter->end(); ++configIt) {
       std::string confName = configIt.key();
       
       // First we make a spot in the map
       //
       auto [insertIter, insertResult] = m_stepsConfigs.insert(std::make_pair(confName, StepsDescr()));
       if (!insertResult) return false;
       
       // And now we fill it
       //
       json steps = configIt.value();
       if (!steps.is_array()) {
     return false;
       }
       
       // Unpack the elements of the step confg array
       //
       StepsDescr& stepsDesc = insertIter->second;
       readPulserSteps(stepsDesc, steps);
  
       ATH_MSG_DEBUG( "ZdcInjPulserAmpMap::found steps configuration with name " << confName  << ", starting LB = "
              << stepsDesc.first << ", number of LBs = " <<  stepsDesc.second.size());    
     }
   }
   catch (...) {
     return false;
   }
  
   return true;
 }

◆ readPulserSteps()

void ZdcInjPulserAmpMap::readPulserSteps	(	StepsDescr &	steps,
		const json &	stepsJson
	)

private

Definition at line 107 of file ZdcInjPulserAmpMap.cxx.

 {
   // Loop over all entries in the json array
   //
   for (unsigned int index = 0; index < stepsJson.size(); index++) {
     const json& elem = stepsJson[index];
  
     // Get the starting LB entry in the json if it exists
     //
     if (index ==0 && elem.size() == 1) {
       if (elem.find("startLB") != elem.end()) {
     steps.first = elem["startLB"];
       }
     }
     else {
       // Fill out the pulser amplitudes for this step
       //
       fillVVector(steps.second, elem);
     }
   }
 }

◆ setLevel()

void AthMessaging::setLevel ( MSG::Level lvl )

inherited

Change the current logging level.

Use this rather than msg().setLevel() for proper operation with MT.

Definition at line 28 of file AthMessaging.cxx.

 {
   m_lvl = lvl;
 }

Member Data Documentation

◆ ATLAS_THREAD_SAFE

std::atomic_flag m_initialized AthMessaging::ATLAS_THREAD_SAFE = ATOMIC_FLAG_INIT

mutableprivateinherited

Messaging initialized (initMessaging)

Definition at line 141 of file AthMessaging.h.

◆ m_activeConfigs

std::vector<const StepsDescr*> ZdcInjPulserAmpMap::m_activeConfigs

private

Definition at line 80 of file ZdcInjPulserAmpMap.h.

◆ m_filePath

std::string ZdcInjPulserAmpMap::m_filePath

private

Definition at line 67 of file ZdcInjPulserAmpMap.h.

◆ m_imsg

std::atomic<IMessageSvc*> AthMessaging::m_imsg { nullptr }

mutableprivateinherited

MessageSvc pointer.

Definition at line 135 of file AthMessaging.h.

◆ m_lock

std::mutex ZdcInjPulserAmpMap::m_lock

private

Definition at line 62 of file ZdcInjPulserAmpMap.h.

◆ m_lvl

std::atomic<MSG::Level> AthMessaging::m_lvl { MSG::NIL }

mutableprivateinherited

Current logging level.

Definition at line 138 of file AthMessaging.h.

◆ m_msg_tls

boost::thread_specific_ptr<MsgStream> AthMessaging::m_msg_tls

mutableprivateinherited

MsgStream instance (a std::cout like with print-out levels)

Definition at line 132 of file AthMessaging.h.

◆ m_nm

std::string AthMessaging::m_nm

privateinherited

Message source name.

Definition at line 129 of file AthMessaging.h.

◆ m_runRangeDescrs

std::vector<RunRangeDescr> ZdcInjPulserAmpMap::m_runRangeDescrs

private

Definition at line 72 of file ZdcInjPulserAmpMap.h.

◆ m_stepsConfigs

std::map<std::string, StepsDescr> ZdcInjPulserAmpMap::m_stepsConfigs

private

Definition at line 76 of file ZdcInjPulserAmpMap.h.

◆ m_validJSon

bool ZdcInjPulserAmpMap::m_validJSon {false}

private

Definition at line 68 of file ZdcInjPulserAmpMap.h.

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

Classes

Public Types

Public Member Functions

Static Public Member Functions

Private Types

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ json

◆ RunRangeDescr

◆ StepsDescr

◆ StepsVector

Constructor & Destructor Documentation

◆ ZdcInjPulserAmpMap()

Member Function Documentation

◆ fillVVector()

◆ getContext()

◆ getCycleNumber()

◆ getFilePath()

◆ getFirstLumiBlock()

◆ getInstance()

◆ getNumSteps()

◆ getPulserAmplitude()

◆ initMessaging()

◆ lookupRun()

◆ msg() [1/2]

◆ msg() [2/2]

◆ msgLvl()

◆ parseJsonFile()

◆ readPulserSteps()

◆ setLevel()

Member Data Documentation

◆ ATLAS_THREAD_SAFE

◆ m_activeConfigs

◆ m_filePath

◆ m_imsg

◆ m_lock

◆ m_lvl

◆ m_msg_tls

◆ m_nm

◆ m_runRangeDescrs

◆ m_stepsConfigs

◆ m_validJSon