DerivationFramework::EGElectronLikelihoodToolWrapper Class Reference

#include <EGElectronLikelihoodToolWrapper.h>

Inheritance diagram for DerivationFramework::EGElectronLikelihoodToolWrapper:

Collaboration diagram for DerivationFramework::EGElectronLikelihoodToolWrapper:

Public Member Functions
	EGElectronLikelihoodToolWrapper (const std::string &t, const std::string &n, const IInterface *p)
virtual StatusCode	initialize () override final
virtual StatusCode	addBranches (const EventContext &ctx) const override final

Private Attributes
ToolHandle< IAsgElectronLikelihoodTool >	m_tool
ToolHandle< IElectronPhotonShowerShapeFudgeTool >	m_fudgeMCTool { this, "EGammaFudgeMCTool", "", "Fudging tool" }
SG::ReadHandleKey< xAOD::EgammaContainer >	m_ContainerName
SG::WriteDecorHandleKey< xAOD::EgammaContainer >	m_decoratorPass { this, "decoratorPass", "", "" }
SG::WriteDecorHandleKey< xAOD::EgammaContainer >	m_decoratorIsEM { this, "decoratorIsEM", "", "" }
SG::WriteDecorHandleKey< xAOD::EgammaContainer >	m_decoratorResult { this, "decoratorResult", "", "" }
SG::WriteDecorHandleKeyArray< xAOD::EgammaContainer, float >	m_decoratorMultipleOutputs {this, "decoratorMultipleOutputs", {}, ""}
std::string	m_cut
std::string	m_sgName
bool	m_storeTResult
std::vector< std::string >	m_sgMultipleNames
bool	m_storeMultipleOutputs

Detailed Description

Definition at line 36 of file EGElectronLikelihoodToolWrapper.h.

Constructor & Destructor Documentation

EGElectronLikelihoodToolWrapper()

DerivationFramework::EGElectronLikelihoodToolWrapper::EGElectronLikelihoodToolWrapper	(	const std::string &	t,
		const std::string &	n,
		const IInterface *	p
	)

Definition at line 22 of file EGElectronLikelihoodToolWrapper.cxx.

  : base_class(t, n, p)
  , m_cut("")
  , m_sgName("")
  , m_storeTResult(false)
  , m_sgMultipleNames({})
  , m_storeMultipleOutputs(false)
{
  declareProperty("CutType", m_cut);
  declareProperty("StoreGateEntryName", m_sgName);
  declareProperty("StoreTResult", m_storeTResult);
  declareProperty("StoreGateEntryMultipleNames", m_sgMultipleNames);
  declareProperty("StoreMultipleOutputs", m_storeMultipleOutputs);
}

Member Function Documentation

addBranches()

StatusCode DerivationFramework::EGElectronLikelihoodToolWrapper::addBranches ( const EventContext &  ctx ) const

finaloverridevirtual

Definition at line 77 of file EGElectronLikelihoodToolWrapper.cxx.

{
  // retrieve container
  SG::ReadHandle<xAOD::EgammaContainer> particles{ m_ContainerName, ctx };
 
  // If we're applying corrections, the correction tools will give us
  // copies that we need to keep track of.  (We want to do all the copies
  // before we start writing decorations, to avoid warnings about having
  // unlocked decorations in a copy).
  // The copies we get back from the tool will have standalone aux stores.
  // We'll put them in a DataVector to get them deleted, but we don't
  // need to copy the aux data to the container, so construct it with
  // @c NEVER_TRACK_INDICES.
  xAOD::EgammaContainer pCopies (SG::OWN_ELEMENTS, SG::NEVER_TRACK_INDICES);
  if (!m_fudgeMCTool.empty()) {
    pCopies.reserve (particles->size());
    for (const xAOD::Egamma* par : *particles) {
      xAOD::Type::ObjectType type = par->type();
      // apply the shower shape corrections
      CP::CorrectionCode correctionCode = CP::CorrectionCode::Ok;
      xAOD::Egamma* pCopy = nullptr;
      if (type == xAOD::Type::Electron) {
        const xAOD::Electron* eg = static_cast<const xAOD::Electron*>(par);
        xAOD::Electron* el = nullptr;
        correctionCode = m_fudgeMCTool->correctedCopy(*eg, el);
        pCopy = el;
      } else {
        const xAOD::Photon* eg = static_cast<const xAOD::Photon*>(par);
        xAOD::Photon* ph = nullptr;
        correctionCode = m_fudgeMCTool->correctedCopy(*eg, ph);
        pCopy = ph;
      }
      if (correctionCode == CP::CorrectionCode::Ok) { // All OK
      } else if (correctionCode == CP::CorrectionCode::Error) {
        Error("addBranches()",
              "Error applying fudge factors to current photon");
      } else if (correctionCode == CP::CorrectionCode::OutOfValidityRange) {
        Warning(
                "addBranches()",
                "Current object has no valid fudge factors due to out-of-range");
      } else {
        Warning(
                "addBranches()",
                "Unknown correction code %d from ElectronPhotonShowerShapeFudgeTool",
                (int)correctionCode);
      }
      pCopies.push_back (pCopy);
    }
  }
  else {
    pCopies.resize (particles->size());
  }
 
  // Decorators
  SG::WriteDecorHandle<xAOD::EgammaContainer, char> decoratorPass{
    m_decoratorPass, ctx
  };
  SG::WriteDecorHandle<xAOD::EgammaContainer, unsigned int> decoratorIsEM{
    m_decoratorIsEM, ctx
  };
 
  std::unique_ptr<SG::WriteDecorHandle<xAOD::EgammaContainer, float>>
    decoratorResult = nullptr;
  if (m_storeTResult) {
    decoratorResult =
      std::make_unique<SG::WriteDecorHandle<xAOD::EgammaContainer, float>>(
        m_decoratorResult, ctx);
  }
 
  auto decoratorMultipleOutputs = m_decoratorMultipleOutputs.makeHandles(ctx);
 
  // Write mask for each element and record to SG for subsequent selection
  for (size_t ipar = 0; const xAOD::Egamma* par : *particles) {
    const xAOD::Egamma* pCopy = pCopies[ipar++];
    if (!pCopy) pCopy = par;
    // compute the output of the selector
    asg::AcceptData theAccept(m_tool->accept(ctx, pCopy));
    const unsigned int isEM =
      (unsigned int)theAccept.getCutResultInvertedBitSet()
        .to_ulong(); // this should work for both the
                     // cut-based and the LH selectors
 
    // decorate the original object
    if (m_cut.empty()) {
      const bool pass_selection = (bool)theAccept;
      if (pass_selection) {
        decoratorPass(*par) = 1;
      } else {
        decoratorPass(*par) = 0;
      }
      decoratorIsEM(*par) = isEM;
      if (decoratorResult) {
        (*decoratorResult)(*par) =
          static_cast<float>(m_tool->calculate(ctx, pCopy));
      }
      if (m_storeMultipleOutputs) {
        // calculateMultipleOutputs only supports xAOD::Electron as input
        const xAOD::Electron *eCopy = static_cast<const xAOD::Electron *>(pCopy);
        std::vector<float> toolOutput = m_tool->calculateMultipleOutputs(ctx, eCopy);
        for (size_t i = 0; i < toolOutput.size(); i++){
          decoratorMultipleOutputs.at(i)(*par) = toolOutput.at(i);
        }
      }
    } else {
      if (theAccept.getCutResult(m_cut)) {
        decoratorPass(*par) = 1;
      } else {
        decoratorPass(*par) = 0;
      }
      decoratorIsEM(*par) = isEM;
      if (decoratorResult) {
        static const SG::AuxElement::Decorator<float> decResult(m_sgName +
                                                                "Result");
        (*decoratorResult)(*par) =
          static_cast<float>(m_tool->calculate(ctx, pCopy));
      }
      if (m_storeMultipleOutputs) {
        // calculateMultipleOutputs only supports xAOD::Electron as input
        const xAOD::Electron* eCopy = static_cast<const xAOD::Electron*>(pCopy);
        std::vector<float> toolOutput = m_tool->calculateMultipleOutputs(ctx, eCopy);
        for (size_t i = 0; i < toolOutput.size(); i++){
          decoratorMultipleOutputs.at(i)(*par) = toolOutput.at(i);
        }
      }
    }
  }
 
  return StatusCode::SUCCESS;
}

initialize()

StatusCode DerivationFramework::EGElectronLikelihoodToolWrapper::initialize ( )

finaloverridevirtual

Definition at line 41 of file EGElectronLikelihoodToolWrapper.cxx.

{
  if (m_sgName.empty()) {
    ATH_MSG_ERROR(
      "No SG name provided for the output of EGElectronLikelihoodToolWrapper!");
    return StatusCode::FAILURE;
  }
  ATH_CHECK(m_tool.retrieve());
 
  if (!(m_fudgeMCTool.name().empty())) {
    ATH_CHECK(m_fudgeMCTool.retrieve());
  } else {
    m_fudgeMCTool.disable();
  }
 
  ATH_CHECK(m_ContainerName.initialize());
  //
  m_decoratorPass = m_ContainerName.key() + "." + m_sgName;
  m_decoratorIsEM = m_ContainerName.key() + "." + m_sgName + "IsEMValue";
  ATH_CHECK(m_decoratorPass.initialize());
  ATH_CHECK(m_decoratorIsEM.initialize());
  //
  if (m_storeTResult) {
    m_decoratorResult = m_ContainerName.key() + "." + m_sgName + "Result";
    ATH_CHECK(m_decoratorResult.initialize(m_storeTResult));
  }
  if (m_storeMultipleOutputs) {
    for (auto& sgName : m_sgMultipleNames) {
      m_decoratorMultipleOutputs.emplace_back(m_ContainerName.key() + "." + sgName);
    }
    ATH_CHECK(m_decoratorMultipleOutputs.initialize(m_storeMultipleOutputs));
  }
  return StatusCode::SUCCESS;
}

Member Data Documentation

m_ContainerName

SG::ReadHandleKey<xAOD::EgammaContainer> DerivationFramework::EGElectronLikelihoodToolWrapper::m_ContainerName

private

Initial value:

{ this,
                                                            "ContainerName",
                                                            "",
                                                            "Input" }

Definition at line 56 of file EGElectronLikelihoodToolWrapper.h.

m_cut

std::string DerivationFramework::EGElectronLikelihoodToolWrapper::m_cut

private

Definition at line 70 of file EGElectronLikelihoodToolWrapper.h.

m_decoratorIsEM

SG::WriteDecorHandleKey<xAOD::EgammaContainer> DerivationFramework::EGElectronLikelihoodToolWrapper::m_decoratorIsEM { this, "decoratorIsEM", "", "" }

private

Definition at line 65 of file EGElectronLikelihoodToolWrapper.h.

m_decoratorMultipleOutputs

SG::WriteDecorHandleKeyArray<xAOD::EgammaContainer, float> DerivationFramework::EGElectronLikelihoodToolWrapper::m_decoratorMultipleOutputs {this, "decoratorMultipleOutputs", {}, ""}

private

Definition at line 69 of file EGElectronLikelihoodToolWrapper.h.

m_decoratorPass

SG::WriteDecorHandleKey<xAOD::EgammaContainer> DerivationFramework::EGElectronLikelihoodToolWrapper::m_decoratorPass { this, "decoratorPass", "", "" }

private

Definition at line 63 of file EGElectronLikelihoodToolWrapper.h.

m_decoratorResult

SG::WriteDecorHandleKey<xAOD::EgammaContainer> DerivationFramework::EGElectronLikelihoodToolWrapper::m_decoratorResult { this, "decoratorResult", "", "" }

private

Definition at line 67 of file EGElectronLikelihoodToolWrapper.h.

m_fudgeMCTool

ToolHandle<IElectronPhotonShowerShapeFudgeTool> DerivationFramework::EGElectronLikelihoodToolWrapper::m_fudgeMCTool { this, "EGammaFudgeMCTool", "", "Fudging tool" }

private

Definition at line 54 of file EGElectronLikelihoodToolWrapper.h.

m_sgMultipleNames

std::vector<std::string> DerivationFramework::EGElectronLikelihoodToolWrapper::m_sgMultipleNames

private

Definition at line 73 of file EGElectronLikelihoodToolWrapper.h.

m_sgName

std::string DerivationFramework::EGElectronLikelihoodToolWrapper::m_sgName

private

Definition at line 71 of file EGElectronLikelihoodToolWrapper.h.

m_storeMultipleOutputs

bool DerivationFramework::EGElectronLikelihoodToolWrapper::m_storeMultipleOutputs

private

Definition at line 74 of file EGElectronLikelihoodToolWrapper.h.

m_storeTResult

bool DerivationFramework::EGElectronLikelihoodToolWrapper::m_storeTResult

private

Definition at line 72 of file EGElectronLikelihoodToolWrapper.h.

m_tool

ToolHandle<IAsgElectronLikelihoodTool> DerivationFramework::EGElectronLikelihoodToolWrapper::m_tool

private

Initial value:

{
    this,
    "EGammaElectronLikelihoodTool",
    "",
    "Electron  Likelihood Selector"
  }

Definition at line 47 of file EGElectronLikelihoodToolWrapper.h.

---

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

• EGElectronLikelihoodToolWrapper.h
• EGElectronLikelihoodToolWrapper.cxx