LArTemperatureCorrectionTool Class Reference

Correction on the energy for temperature fluctuations authors: Ruggero Turra 2015. More...

#include <LArTemperatureCorrectionTool.h>

Inheritance diagram for LArTemperatureCorrectionTool:

Collaboration diagram for LArTemperatureCorrectionTool:

Classes
struct	AllValues

Public Member Functions
	LArTemperatureCorrectionTool (const std::string &filename)
AllValues	get_corrections (int run)
	correction should be applied on MC as a multiplication: E = E * correction
double	get_correction_barrel (int run)
double	get_correction_endcapA (int run)
double	get_correction_endcapC (int run)
int	get_cache_size () const
int	get_first_run () const
int	get_last_run () const
void	setLevel (MSG::Level lvl)
	Change the current logging level.
Functions providing the same interface as AthMessaging
bool	msgLvl (const MSG::Level lvl) const
	Test the output level of the object.
MsgStream &	msg () const
	The standard message stream.
MsgStream &	msg (const MSG::Level lvl) const
	The standard message stream.

Public Attributes
AllValues	base_temperature {}
AllValues	sensitivity_temperature {}

Private Member Functions
AllValues	search_temperature (int run)
AllValues	search_correction (int run)
void	initMessaging () const
	Initialize our message level and MessageSvc.

Private Attributes
std::unique_ptr< TFile >	m_file
TTree *	m_tree
std::map< int, AllValues >	m_cache
int	m_first_run
int	m_last_run
std::string	m_nm
	Message source name.
boost::thread_specific_ptr< MsgStream >	m_msg_tls
	MsgStream instance (a std::cout like with print-out levels)
std::atomic< IMessageSvc * >	m_imsg { nullptr }
	MessageSvc pointer.
std::atomic< MSG::Level >	m_lvl { MSG::NIL }
	Current logging level.
std::atomic_flag m_initialized	ATLAS_THREAD_SAFE = ATOMIC_FLAG_INIT
	Messaging initialized (initMessaging)

Detailed Description

Correction on the energy for temperature fluctuations authors: Ruggero Turra 2015.

Compute the relative correction to the energy due to temperature fluctuations for barrel / endcap A / C, where endcap = EMEC + HEC. This is not a CP tool, and it should not be used alone. The correction K is run-dependent and should be applied as E -> E (1 + K) on the raw energy (for example on the layer energies). The correction is relative to a reference temperature, different for every partition.

If a run is in the future (with respect to the runs known by the tool) the correction is based on the temperature of the last run. Similarly if it is in the past (but it should not happen).

Temperature values are from oracle, and averaged for every run.

Definition at line 33 of file LArTemperatureCorrectionTool.h.

Constructor & Destructor Documentation

LArTemperatureCorrectionTool()

LArTemperatureCorrectionTool::LArTemperatureCorrectionTool

(

const std::string &

filename

)

Definition at line 19 of file LArTemperatureCorrectionTool.cxx.

    : asg::AsgMessaging("LArTemperatureCorrectionTool"),
      m_file(TFile::Open(filename.c_str())) {
  if (!m_file or m_file->IsZombie()) {
    throw std::runtime_error("LArTemperatureCorrectionTool: Cannot open file");
  }
 
  m_tree = dynamic_cast<TTree*>(m_file->Get("temperature"));
  if (!m_tree) {
    throw std::runtime_error("LArTemperatureCorrectionTool: Cannot find tree");
  }
 
  Int_t t_run = 0;
  m_tree->SetBranchAddress("run", &t_run);
  m_tree->GetEntry(0);
  m_first_run = t_run;
  m_tree->GetEntry(m_tree->GetEntries() - 1);
  m_last_run = t_run;
 
  base_temperature.barrel =
      get_value_parameter<double>(*m_file, "base_temperature_barrel");
  base_temperature.endcapA =
      get_value_parameter<double>(*m_file, "base_temperature_endcapA");
  base_temperature.endcapC =
      get_value_parameter<double>(*m_file, "base_temperature_endcapC");
 
  sensitivity_temperature.barrel =
      get_value_parameter<double>(*m_file, "sensitivity_temperature_barrel");
  sensitivity_temperature.endcapA =
      get_value_parameter<double>(*m_file, "sensitivity_temperature_endcapA");
  sensitivity_temperature.endcapC =
      get_value_parameter<double>(*m_file, "sensitivity_temperature_endcapC");
 
  ATH_MSG_INFO("LArTemperatureCorrectionTool initialized for runs "
               << m_first_run << ".." << m_last_run);
  ATH_MSG_INFO("base temperatures (barrel/endcapA/endcapC) = "
               << base_temperature.barrel << "/" << base_temperature.endcapA
               << "/" << base_temperature.endcapC);
  ATH_MSG_INFO("sensitivity relE/K (barrel/endcapA/endcapC) = "
               << sensitivity_temperature.barrel << "/"
               << sensitivity_temperature.endcapA << "/"
               << sensitivity_temperature.endcapC);
}

Member Function Documentation

get_cache_size()

int LArTemperatureCorrectionTool::get_cache_size ( ) const

inline

Definition at line 51 of file LArTemperatureCorrectionTool.h.

{ return m_cache.size(); }

get_correction_barrel()

double LArTemperatureCorrectionTool::get_correction_barrel ( int run )

inline

Definition at line 44 of file LArTemperatureCorrectionTool.h.

{ return get_corrections(run).barrel; }

get_correction_endcapA()

double LArTemperatureCorrectionTool::get_correction_endcapA ( int run )

inline

Definition at line 45 of file LArTemperatureCorrectionTool.h.

                                         {
    return get_corrections(run).endcapA;
  }

get_correction_endcapC()

double LArTemperatureCorrectionTool::get_correction_endcapC ( int run )

inline

Definition at line 48 of file LArTemperatureCorrectionTool.h.

                                         {
    return get_corrections(run).endcapC;
  }

get_corrections()

LArTemperatureCorrectionTool::AllValues LArTemperatureCorrectionTool::get_corrections

(

int

run

)

correction should be applied on MC as a multiplication: E = E * correction

Definition at line 119 of file LArTemperatureCorrectionTool.cxx.

                                                     {
  const auto it = m_cache.find(run);
  if (it != m_cache.end()) {
    return it->second;
  } else {
    AllValues corrections{};
    if (run < m_first_run) {
      ATH_MSG_WARNING(
          "run " << run << " is before the first run - using the first run");
      corrections = search_correction(m_first_run);
    } else if (run > m_last_run) {
      ATH_MSG_WARNING("run " << run
                             << " is after the last run - using the last run");
      corrections = search_correction(m_last_run);
    } else {
      corrections = search_correction(run);
    }
    m_cache[run] = corrections;
    return corrections;
  }
}

get_first_run()

int LArTemperatureCorrectionTool::get_first_run ( ) const

inline

Definition at line 52 of file LArTemperatureCorrectionTool.h.

{ return m_first_run; }

get_last_run()

int LArTemperatureCorrectionTool::get_last_run ( ) const

inline

Definition at line 53 of file LArTemperatureCorrectionTool.h.

{ return m_last_run; }

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();
  // If user did not set an explicit level, set a default
  if (m_lvl == MSG::NIL) {
    m_lvl = m_imsg ?
      static_cast<MSG::Level>( m_imsg.load()->outputLevel(m_nm) ) :
      MSG::INFO;
  }
}

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
   }

search_correction()

LArTemperatureCorrectionTool::AllValues LArTemperatureCorrectionTool::search_correction ( int run )

private

Definition at line 65 of file LArTemperatureCorrectionTool.cxx.

                                                       {
  AllValues temp = search_temperature(run);
  temp.barrel = 1. - (temp.barrel - base_temperature.barrel) *
                         sensitivity_temperature.barrel;
  temp.endcapA = 1. - (temp.endcapA - base_temperature.endcapA) *
                          sensitivity_temperature.endcapA;
  temp.endcapC = 1. - (temp.endcapC - base_temperature.endcapC) *
                          sensitivity_temperature.endcapC;
  return temp;
}

search_temperature()

LArTemperatureCorrectionTool::AllValues LArTemperatureCorrectionTool::search_temperature ( int run )

private

Definition at line 77 of file LArTemperatureCorrectionTool.cxx.

                                                        {
  Float_t t_barrel = base_temperature.barrel;
  Float_t t_endcapA = base_temperature.endcapA;
  Float_t t_endcapC = base_temperature.endcapC;
  Int_t t_run = 0;
  m_tree->SetBranchAddress("run", &t_run);
  m_tree->SetBranchAddress("average_temperature_barrel", &t_barrel);
  m_tree->SetBranchAddress("average_temperature_endcapA", &t_endcapA);
  m_tree->SetBranchAddress("average_temperature_endcapC", &t_endcapC);
 
  // use bisection, tree is ordered by run number
  int low = 0;
  int high = m_tree->GetEntries() - 1;
  int mid = 0;
  while (low <= high) {
 
    if (high - low < 50) {  // prefer sequential scan
      for (int i = low; i <= high; ++i) {
        m_tree->GetEntry(i);
        if (run == t_run) {
          return AllValues{t_barrel, t_endcapA, t_endcapC};
        }
      }
      break;
    }
 
    mid = low + (high - low) / 2;  // scared of overflow?
    m_tree->GetEntry(mid);
    if (run == t_run) {
      return AllValues{t_barrel, t_endcapA, t_endcapC};
    } else if (run < t_run) {
      high = mid - 1;
    } else {
      low = mid + 1;
    }
  }
 
  ATH_MSG_WARNING("run " << run << " not found - no temperature correction");
  return base_temperature;
}

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.

base_temperature

AllValues LArTemperatureCorrectionTool::base_temperature {}

Definition at line 54 of file LArTemperatureCorrectionTool.h.

{};

m_cache

std::map<int, AllValues> LArTemperatureCorrectionTool::m_cache

private

Definition at line 62 of file LArTemperatureCorrectionTool.h.

m_file

std::unique_ptr<TFile> LArTemperatureCorrectionTool::m_file

private

Definition at line 58 of file LArTemperatureCorrectionTool.h.

m_first_run

int LArTemperatureCorrectionTool::m_first_run

private

Definition at line 63 of file LArTemperatureCorrectionTool.h.

m_imsg

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

mutableprivateinherited

MessageSvc pointer.

Definition at line 135 of file AthMessaging.h.

{ nullptr };

m_last_run

int LArTemperatureCorrectionTool::m_last_run

private

Definition at line 63 of file LArTemperatureCorrectionTool.h.

m_lvl

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

mutableprivateinherited

Current logging level.

Definition at line 138 of file AthMessaging.h.

{ MSG::NIL };

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_tree

TTree* LArTemperatureCorrectionTool::m_tree

private

Definition at line 59 of file LArTemperatureCorrectionTool.h.

sensitivity_temperature

AllValues LArTemperatureCorrectionTool::sensitivity_temperature {}

Definition at line 55 of file LArTemperatureCorrectionTool.h.

{};

---

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

• LArTemperatureCorrectionTool.h
• LArTemperatureCorrectionTool.cxx