jet::CorrelationMatrix Class Reference

#include <CorrelationMatrix.h>

Inheritance diagram for jet::CorrelationMatrix:

Collaboration diagram for jet::CorrelationMatrix:

Public Member Functions
	CorrelationMatrix (const TString &name, const int numBins, const double minVal, const double maxVal, const double fixedVal1, const double fixedVal2)
virtual	~CorrelationMatrix ()
virtual StatusCode	initializeForPt (const JetUncertaintiesTool &uncTool)
virtual StatusCode	initializeForEta (const JetUncertaintiesTool &uncTool)
virtual TString	getName () const
virtual const TH2D *	getMatrix () 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.

Private Member Functions
	CorrelationMatrix (const std::string &name="")
StatusCode	checkInitialization (const JetUncertaintiesTool &uncTool) const
StatusCode	createStore ()
StatusCode	clearStore ()
StatusCode	setDefaultProperties (const JetUncertaintiesTool &uncTool)
TH2D *	buildMatrix (const std::vector< double > &bins) const
double	getCorrelation (const JetUncertaintiesTool &uncTool) const
double	getCovariance (const JetUncertaintiesTool &uncTool, const xAOD::Jet *jet1, const xAOD::Jet *jet2) const
void	initMessaging () const
	Initialize our message level and MessageSvc.

Private Attributes
bool	m_isInit
const TString	m_name
const int	m_numBins
const double	m_minVal
const double	m_maxVal
const double	m_fixedVal1
const double	m_fixedVal2
TH2D *	m_corrMat
xAOD::JetContainer *	m_jets
xAOD::EventInfoContainer *	m_eInfos
xAOD::Jet *	m_jet1
xAOD::Jet *	m_jet2
xAOD::EventInfo *	m_eInfo
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

Definition at line 26 of file CorrelationMatrix.h.

Constructor & Destructor Documentation

CorrelationMatrix() [1/2]

jet::CorrelationMatrix::CorrelationMatrix	(	const TString &	name,
		const int	numBins,
		const double	minVal,
		const double	maxVal,
		const double	fixedVal1,
		const double	fixedVal2 )

Definition at line 38 of file CorrelationMatrix.cxx.

    : asg::AsgMessaging(name.Data())
    , m_isInit(false)
    , m_name(name)
    , m_numBins(numBins)
    , m_minVal(minVal)
    , m_maxVal(maxVal)
    , m_fixedVal1(fixedVal1)
    , m_fixedVal2(fixedVal2)
    , m_corrMat(nullptr)
    , m_jets(nullptr)
    , m_eInfos(nullptr)
    , m_jet1(nullptr)
    , m_jet2(nullptr)
    , m_eInfo(nullptr)
{
    ATH_MSG_DEBUG("Creating CorrelationMatrix named " << m_name.Data());
}

~CorrelationMatrix()

jet::CorrelationMatrix::~CorrelationMatrix ( )

virtual

Definition at line 58 of file CorrelationMatrix.cxx.

{
    JESUNC_SAFE_DELETE(m_corrMat);
}

CorrelationMatrix() [2/2]

jet::CorrelationMatrix::CorrelationMatrix ( const std::string & name = "" )

private

Definition at line 19 of file CorrelationMatrix.cxx.

    : asg::AsgMessaging(name)
    , m_isInit(false)
    , m_name(name.c_str())
    , m_numBins(-1)
    , m_minVal(1e10)
    , m_maxVal(-1e10)
    , m_fixedVal1(0)
    , m_fixedVal2(0)
    , m_corrMat(nullptr)
    , m_jets(nullptr)
    , m_eInfos(nullptr)
    , m_jet1(nullptr)
    , m_jet2(nullptr)
    , m_eInfo(nullptr)
{
    JESUNC_NO_DEFAULT_CONSTRUCTOR;
}

Member Function Documentation

buildMatrix()

TH2D * jet::CorrelationMatrix::buildMatrix ( const std::vector< double > & bins ) const

private

Definition at line 322 of file CorrelationMatrix.cxx.

{
    TH2D* matrix = new TH2D(m_name,m_name,bins.size()-1,&bins[0],bins.size()-1,&bins[0]);
    matrix->GetZaxis()->SetRangeUser(-1,1);
    return matrix;
}

checkInitialization()

StatusCode jet::CorrelationMatrix::checkInitialization ( const JetUncertaintiesTool & uncTool ) const

private

Definition at line 197 of file CorrelationMatrix.cxx.

{
    // Prevent double-initialization
    if (m_isInit)
    {
        ATH_MSG_ERROR("CorrelationMatrix is already initialized: " << m_name.Data());
        return StatusCode::FAILURE;
    }
 
    // Warn about any non-four-vector terms which will be ignored
    bool scalesFourVec = false;
    for (size_t iComp = 0; iComp < uncTool.getNumComponents(); ++iComp)
        if (!uncTool.getComponentScalesFourVec(iComp))
            ATH_MSG_WARNING("CorrelationMatrix will ignore component which does not scale the jet four-vector: " << uncTool.getComponentName(iComp));
        else
            scalesFourVec = true;
    
    // If no components scale the four-vector, end now
    if (!scalesFourVec)
    {
        ATH_MSG_ERROR("No components scale the four-vector for the CorrelationMatrix: " << m_name.Data());
        return StatusCode::FAILURE;
    }
    
    return StatusCode::SUCCESS;
}

clearStore()

StatusCode jet::CorrelationMatrix::clearStore ( )

private

Definition at line 243 of file CorrelationMatrix.cxx.

{
    m_jet1  = nullptr;
    m_jet2  = nullptr;
    m_eInfo = nullptr;
    
    //for (size_t iJet = 0; iJet < m_jets->size(); ++iJet)
    //    JESUNC_SAFE_DELETE((*m_jets)[iJet]);
    m_jets->clear();
    JESUNC_SAFE_DELETE(m_jets);
 
    //for (size_t iInfo = 0; iInfo < m_eInfos->size(); ++iInfo)
    //    JESUNC_SAFE_DELETE((*m_eInfos)[iInfo]);
    m_eInfos->clear();
    JESUNC_SAFE_DELETE(m_eInfos);
 
    return StatusCode::SUCCESS;
}

createStore()

StatusCode jet::CorrelationMatrix::createStore ( )

private

Definition at line 224 of file CorrelationMatrix.cxx.

{
    // Build a jet container and a pair of jets for us to manipulate later
    m_jets   = new xAOD::JetContainer();
    m_jets->setStore(new xAOD::JetAuxContainer());
    m_jets->push_back(new xAOD::Jet());
    m_jets->push_back(new xAOD::Jet());
    m_jet1 = m_jets->at(0);
    m_jet2 = m_jets->at(1);
 
    // Build an EventInfo object for us to manipulate later
    m_eInfos = new xAOD::EventInfoContainer();
    m_eInfos->setStore(new xAOD::EventInfoAuxContainer());
    m_eInfos->push_back(new xAOD::EventInfo());
    m_eInfo = m_eInfos->at(0);
 
    return StatusCode::SUCCESS;
}

getCorrelation()

double jet::CorrelationMatrix::getCorrelation ( const JetUncertaintiesTool & uncTool ) const

private

Definition at line 329 of file CorrelationMatrix.cxx.

{
    return getCovariance(uncTool,m_jet1,m_jet2)/sqrt(getCovariance(uncTool,m_jet1,m_jet1)*getCovariance(uncTool,m_jet2,m_jet2));
}

getCovariance()

double jet::CorrelationMatrix::getCovariance ( const JetUncertaintiesTool & uncTool, const xAOD::Jet * jet1, const xAOD::Jet * jet2 ) const

private

Definition at line 334 of file CorrelationMatrix.cxx.

{
    double covariance = 0;
    for (size_t iComp = 0; iComp < uncTool.getNumComponents(); ++iComp)
        covariance += uncTool.getUncertainty(iComp,*jet1,*m_eInfo)*uncTool.getUncertainty(iComp,*jet2,*m_eInfo);
 
    return covariance;
}

getMatrix()

virtual const TH2D * jet::CorrelationMatrix::getMatrix ( ) const

inlinevirtual

Definition at line 45 of file CorrelationMatrix.h.

{ return m_corrMat; }

getName()

virtual TString jet::CorrelationMatrix::getName ( ) const

inlinevirtual

Definition at line 44 of file CorrelationMatrix.h.

{ return m_name; }

initializeForEta()

StatusCode jet::CorrelationMatrix::initializeForEta ( const JetUncertaintiesTool & uncTool )

virtual

Definition at line 130 of file CorrelationMatrix.cxx.

{
    // Check for initialization and tool status
    if (checkInitialization(uncTool).isFailure())
        return StatusCode::FAILURE;
    m_isInit = true;
    
    // Determine the center of mass energy for kinematic limits if possible
    // If not possible, then ignores kinematic limits
    // pt * cosh(eta) = sqrtS/2 for kinematic limit
    const double sqrtS = uncTool.getSqrtS();
    const double kinLimit1 = sqrtS > 0 ? acosh((sqrtS/2.) / m_fixedVal1) : 1e99;
    const double kinLimit2 = sqrtS > 0 ? acosh((sqrtS/2.) / m_fixedVal2) : 1e99;
    
    // Build the correlation matrix
    m_corrMat = buildMatrix(utils::getUniformBins(m_numBins,m_minVal,m_maxVal));
 
    // Prepare the objects for use
    if (createStore().isFailure())
        return StatusCode::FAILURE;
 
    // Set default values
    if (setDefaultProperties(uncTool).isFailure())
        return StatusCode::FAILURE;
 
    // Fill the correlation matrix
    for (int binX = 1; binX <= m_corrMat->GetNbinsX(); ++binX)
    {
        // Set the jet values, (pT, eta, phi, m)
        // note that only pT and eta matter right now
        const double valX = m_corrMat->GetXaxis()->GetBinCenter(binX);
        m_jet1->setJetP4(xAOD::JetFourMom_t(m_fixedVal1,valX,0,0));
        
        for (int binY = 1; binY <= m_corrMat->GetNbinsY(); ++binY)
        {
            const double valY = m_corrMat->GetYaxis()->GetBinCenter(binY);
 
            // Check for the kinematic limit (simple case)
            if (valX > kinLimit1 || valY > kinLimit2) {
                m_corrMat->SetBinContent(binX,binY,JESUNC_ERROR_CODE);
            } else
            {
                // Set the jet values, (pT, eta, phi, m)
                // note that only pT and eta matter right now
                m_jet2->setJetP4(xAOD::JetFourMom_t(m_fixedVal2,valY,0,0));
 
                // Now determine the correlation for the two jets
                m_corrMat->SetBinContent(binX,binY,getCorrelation(uncTool));
            }
        }
    }
 
    // Clear up the objects we used
    if (clearStore().isFailure())
        return StatusCode::FAILURE;
 
    // Done
    return StatusCode::SUCCESS;
}

initializeForPt()

StatusCode jet::CorrelationMatrix::initializeForPt ( const JetUncertaintiesTool & uncTool )

virtual

Definition at line 64 of file CorrelationMatrix.cxx.

{
    // Check for initialization and tool status
    if (checkInitialization(uncTool).isFailure())
        return StatusCode::FAILURE;
    m_isInit = true;
 
    // Determine the center of mass energy for kinematic limits if possible
    // If not possible, then ignores kinematic limits
    // pt * cosh(eta) = sqrtS/2 for kinematic limit
    const double sqrtS = uncTool.getSqrtS();
    const double kinLimit1 = sqrtS > 0 ? (sqrtS/2.) / cosh(m_fixedVal1) : 1e99;
    const double kinLimit2 = sqrtS > 0 ? (sqrtS/2.) / cosh(m_fixedVal2) : 1e99;
 
    std::cout << "Initializing for Pt with fixedVal1, fixedVal2 " << m_fixedVal1 << " " << m_fixedVal2 << std::endl;
    std::cout << "Corresponding to kinematic limits " << kinLimit1 << " " << kinLimit2 << std::endl;
 
 
    // Build the correlation matrix
    m_corrMat = buildMatrix(utils::getLogBins(m_numBins,m_minVal,m_maxVal));
 
    // Prepare the objects for use
    if (createStore().isFailure())
        return StatusCode::FAILURE;
    
    // Set default values
    if (setDefaultProperties(uncTool).isFailure())
        return StatusCode::FAILURE;
 
    // Fill the correlation matrix
    for (int binX = 1; binX <= m_corrMat->GetNbinsX(); ++binX)
    {
        // Set the jet values, (pT, eta, phi, m)
        // note that only pT and eta matter right now
        const double valX = m_corrMat->GetXaxis()->GetBinCenter(binX);
        m_jet1->setJetP4(xAOD::JetFourMom_t(valX,m_fixedVal1,0,0));
        
        for (int binY = 1; binY <= m_corrMat->GetNbinsY(); ++binY)
        {
            const double valY = m_corrMat->GetYaxis()->GetBinCenter(binY);
 
            // Check for the kinematic limit (simple case)
            if (valX > kinLimit1 || valY > kinLimit2 ) {
//                std::cout << "Setting error code in space 2" << std::endl;
//                std::cout << "Values, kin limits are " << valX << " " << kinLimit1 << " " << valY << " " << kinLimit2 << std::endl;
                m_corrMat->SetBinContent(binX,binY,JESUNC_ERROR_CODE);
            } else
            {
                // Set the jet values, (pT, eta, phi, m)
                // note that only pT and eta matter right now
                m_jet2->setJetP4(xAOD::JetFourMom_t(valY,m_fixedVal2,0,0));
 
                // Now determine the correlation for the two jets
                m_corrMat->SetBinContent(binX,binY,getCorrelation(uncTool));
            }
        }
    }
 
    // Clear up the objects we used
    if (clearStore().isFailure())
        return StatusCode::FAILURE;
 
    // Done
    return StatusCode::SUCCESS;
}

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
   }

setDefaultProperties()

StatusCode jet::CorrelationMatrix::setDefaultProperties ( const JetUncertaintiesTool & uncTool )

private

Definition at line 262 of file CorrelationMatrix.cxx.

{
 
    // TODO make this part of a common file
    static const SG::AuxElement::Accessor<int> Nsegments("GhostMuonSegmentCount");
    static const SG::AuxElement::Accessor<char> IsBjet("IsBjet");
    static const SG::AuxElement::Accessor<float> mu("averageInteractionsPerCrossing");
    static const SG::AuxElement::Accessor<float> NPV("NPV");   
 
    // 25 segments is about average for jets receiving a correction
    // This is modulated by the probability of punchthrough
    // TODO add punch-through Nsegments/etc dependence on probability
    Nsegments(*m_jet1) = 0; //25;
    Nsegments(*m_jet2) = 0; //25;
    IsBjet(*m_jet1) = false;
    IsBjet(*m_jet2) = false;
    
    float    sigmaMu  = 0;
    float    sigmaNPV = 0;
 
    const TString config = uncTool.getConfigFile();
    if (config.Contains("_2011/"))
    {
        // Dag, night of Febuary 4/5, 2013
        sigmaMu  = 3.0;
        sigmaNPV = 3.0;
    }
    else if (config.Contains("_2012/") || config.Contains("_2015/Prerec"))
    {
        // Craig Sawyer, Jan 22 2013
        sigmaMu  = 5.593*1.11;
        sigmaNPV = 3.672;
    }
    else if (config.Contains("_2015"))
    {
        // Kate, Jan 31 2016
        sigmaMu = 1.9;
        sigmaNPV = 2.9;
    }
    else if (config.Contains("_2016"))
    {
        // Kate, Nov 2016 
        // via Eric Corrigan's pileup studies
        // Scaling term taken from 
        // https://indico.cern.ch/event/437993/contributions/1925644/attachments/1138739/1630981/spagan_MuRescaling.pdf
        sigmaMu = 5.35;
        sigmaNPV = 3.49;
    }
    else
    {
        ATH_MSG_ERROR("Unexpected year for setPileupShiftsForYear in config: " << config.Data());
        return StatusCode::FAILURE;
    }
    
    mu(*m_eInfo) = uncTool.getRefMu()+sigmaMu;
    NPV(*m_eInfo) = uncTool.getRefNPV()+sigmaNPV;
 
    return StatusCode::SUCCESS;
}

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_corrMat

TH2D* jet::CorrelationMatrix::m_corrMat

private

Definition at line 61 of file CorrelationMatrix.h.

m_eInfo

xAOD::EventInfo* jet::CorrelationMatrix::m_eInfo

private

Definition at line 69 of file CorrelationMatrix.h.

m_eInfos

xAOD::EventInfoContainer* jet::CorrelationMatrix::m_eInfos

private

Definition at line 65 of file CorrelationMatrix.h.

m_fixedVal1

const double jet::CorrelationMatrix::m_fixedVal1

private

Definition at line 58 of file CorrelationMatrix.h.

m_fixedVal2

const double jet::CorrelationMatrix::m_fixedVal2

private

Definition at line 59 of file CorrelationMatrix.h.

m_imsg

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

mutableprivateinherited

MessageSvc pointer.

Definition at line 135 of file AthMessaging.h.

{ nullptr };

m_isInit

bool jet::CorrelationMatrix::m_isInit

private

Definition at line 52 of file CorrelationMatrix.h.

m_jet1

xAOD::Jet* jet::CorrelationMatrix::m_jet1

private

Definition at line 67 of file CorrelationMatrix.h.

m_jet2

xAOD::Jet* jet::CorrelationMatrix::m_jet2

private

Definition at line 68 of file CorrelationMatrix.h.

m_jets

xAOD::JetContainer* jet::CorrelationMatrix::m_jets

private

Definition at line 64 of file CorrelationMatrix.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_maxVal

const double jet::CorrelationMatrix::m_maxVal

private

Definition at line 57 of file CorrelationMatrix.h.

m_minVal

const double jet::CorrelationMatrix::m_minVal

private

Definition at line 56 of file CorrelationMatrix.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_name

const TString jet::CorrelationMatrix::m_name

private

Definition at line 53 of file CorrelationMatrix.h.

m_nm

std::string AthMessaging::m_nm

privateinherited

Message source name.

Definition at line 129 of file AthMessaging.h.

m_numBins

const int jet::CorrelationMatrix::m_numBins

private

Definition at line 55 of file CorrelationMatrix.h.

---

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

• CorrelationMatrix.h
• CorrelationMatrix.cxx