D3PD::egammaTraversedMaterialFillerTool Class Reference

Block filler tool for the material traversed by a photon/electron until the entrance of the calorimeter (in X0) More...

#include <egammaTraversedMaterialFillerTool.h>

Inheritance diagram for D3PD::egammaTraversedMaterialFillerTool:

Collaboration diagram for D3PD::egammaTraversedMaterialFillerTool:

Public Types
typedef BlockFillerTool< Types< xAOD::Electron, xAOD::Photon > >	Base

Public Member Functions
	egammaTraversedMaterialFillerTool (const std::string &type, const std::string &name, const IInterface *parent)
	Standard Gaudi tool constructor.
virtual	~egammaTraversedMaterialFillerTool ()
virtual StatusCode	initialize () override
virtual StatusCode	book () final
	Book variables for this block.
virtual StatusCode	fill (const xAOD::Electron &p) override
	Fill one block — type-safe version.
virtual StatusCode	fill (const xAOD::Photon &p) override
	Fill one block — type-safe version.
virtual StatusCode	configureD3PD (IAddVariable *tree, const std::type_info &ti)
	Configure during initialization: type-check.
StatusCode	configureD3PD (IAddVariable *tree)
	Configure the parent tree.
virtual StatusCode	fillUntyped (const void *p, bool again=false)
	Fill one block.
virtual StatusCode	fill (const Types< xAOD::Electron, xAOD::Photon > &p)=0
	Fill one block — type-safe version.
virtual StatusCode	fillAgain (const Types< xAOD::Electron, xAOD::Photon > &p)
	Fill one block, after AGAIN has been returned (type-safe).
	BlockFillerToolImpl (const std::string &type, const std::string &name, const IInterface *parent)
	Standard Gaudi tool constructor.
virtual StatusCode	addVariable (const std::string &name, const std::type_info &ti, void *&ptr, const std::string &docstring="", const void *defval=0)
	Add a variable to the tuple.
StatusCode	addVariable (const std::string &name, Types< xAOD::Electron, xAOD::Photon > *&ptr, const std::string &docstring="")
	Make the template implementation from IAddVariable visible.
StatusCode	addVariable (const std::string &name, Types< xAOD::Electron, xAOD::Photon > *&ptr, const std::string &docstring, const U &defval)
	Make the template implementation from IAddVariable visible.
virtual StatusCode	addDimensionedVariable (const std::string &name, const std::type_info &ti, void *&ptr, const std::string &dim, const std::string &docstring="", const void *defval=0)
	Add a variable to the tuple.
StatusCode	addDimensionedVariable (const std::string &name, Types< xAOD::Electron, xAOD::Photon > *&ptr, const std::string &dim, const std::string &docstring="")
	Add a variable to the tuple.
StatusCode	addDimensionedVariable (const std::string &name, Types< xAOD::Electron, xAOD::Photon > *&ptr, const std::string &dim, const std::string &docstring, const U &defval)
	Add a variable to the tuple.

Protected Member Functions
StatusCode	configureImpl (IAddVariable *tree, const std::type_info &ti, const std::type_info &fill_ti)
	Configure during initialization: type-check.
StatusCode	configureImpl (IAddVariable *tree, const std::type_info &ti, const std::vector< const std::type_info * > &tis, size_t &which)
	Configure during initialization: type-check.
StatusCode	convert (void const *&p) const
	Do type conversion.

Protected Attributes
ObjectMetadata	m_metadata
	Metadata about the variables created by this object.

Private Member Functions
StatusCode	fill (const xAOD::Egamma &eg, const Trk::TrackParameters &parameters)
	Common part.

Private Attributes
float *	m_materialTraversed
	Variable: Material traversed between vertex (conversion vertex) and the entrance of the calorimeter (in X0)
ToolHandle< Trk::IExtrapolator >	m_extrapolator
	Property: The extrapolator tool.
ToolHandle< ICaloSurfaceBuilder >	m_caloSurfaceBuilder
	Property: CaloSurfaceBuilder tool.
SG::ReadCondHandleKey< CaloDetDescrManager >	m_caloMgrKey
float	m_minPt
	Property: Minimum track pT to do the extrapolation.
std::string	m_prefix
	Property: the variable prefix for this block.
std::string	m_suffix
	Property: the variable prefix for this block.
std::string	m_blockName
	Property: the name of this block.
TypeConverter	m_converter
	Helper to do type conversions.
IAddVariable *	m_tree
	Reference to the block name.

Static Private Attributes
static const std::string	s_emptyString
	Used to provide a default value for blockName.

Detailed Description

Block filler tool for the material traversed by a photon/electron until the entrance of the calorimeter (in X0)

Definition at line 33 of file egammaTraversedMaterialFillerTool.h.

Member Typedef Documentation

Base

typedef BlockFillerTool<Types<xAOD::Electron, xAOD::Photon> > D3PD::egammaTraversedMaterialFillerTool::Base

Definition at line 37 of file egammaTraversedMaterialFillerTool.h.

Constructor & Destructor Documentation

egammaTraversedMaterialFillerTool()

D3PD::egammaTraversedMaterialFillerTool::egammaTraversedMaterialFillerTool	(	const std::string &	type,
		const std::string &	name,
		const IInterface *	parent )

Standard Gaudi tool constructor.

Parameters

type	The name of the tool type.
name	The tool name.
parent	The tool's Gaudi parent.

Definition at line 34 of file egammaTraversedMaterialFillerTool.cxx.

    : Base (type, name, parent),
      m_extrapolator (this, "Trk::Extrapolator/AtlasExtrapolator"),
      m_caloSurfaceBuilder ("CaloSurfaceBuilder")
  {  
    declareProperty ("Extrapolator", 
                     m_extrapolator,
                     "Extrapolator tool.");
 
    declareProperty ("CaloSurfaceBuilder", 
                     m_caloSurfaceBuilder,
                     "CaloSurfaceBuilder tool.");
 
    declareProperty ("MinPt",
                     m_minPt = 1 * GeV,
                     "Minimum track pT to do the extrapolation.");
 
    book().ignore(); // avoid coverity warnings.
  }

~egammaTraversedMaterialFillerTool()

D3PD::egammaTraversedMaterialFillerTool::~egammaTraversedMaterialFillerTool ( )

virtual

Definition at line 57 of file egammaTraversedMaterialFillerTool.cxx.

  {
  }

Member Function Documentation

addDimensionedVariable() [1/3]

StatusCode D3PD::AddVariable::addDimensionedVariable ( const std::string & name, const std::type_info & ti, void *& ptr, const std::string & dim, const std::string & docstring = "", const void * defval = 0 )

virtualinherited

Add a variable to the tuple.

Parameters

name	The name of the variable.
type	The type of the variable.
ptr	Pointer to the type of the variable. The pointer need not be initialized; the D3PD software will set the pointer prior to calling fill().
dim	Dimension for the variable. (Presently unimplemented!)
docstring	Documentation string for this variable.
defval	Pointer to the default value to use for this variable. Null for no default (generally means to fill with zeros). Of the type given by ti. Only works for basic types.

If called from the constructor, the only effect is to clear ptr.

Definition at line 119 of file AddVariable.cxx.

{
  if (!m_tree) {
    // Called from constructor --- just initialize pointer.
    ptr = 0;
    return StatusCode::SUCCESS;
  }
 
  CHECK( m_metadata.addDimensionedVariable( m_prefix + name + m_suffix,
                                            ti, ptr, dim,
                                            docstring, defval ) );
  return m_tree->addDimensionedVariable (m_prefix + name + m_suffix,
                                         ti, ptr, dim,
                                         docstring, defval);
}

addDimensionedVariable() [2/3]

StatusCode D3PD::IAddVariable::addDimensionedVariable ( const std::string & name, Types< xAOD::Electron, xAOD::Photon > *& ptr, const std::string & dim, const std::string & docstring, const U & defval )

inherited

Add a variable to the tuple.

Parameters

name	The name of the variable.
ptr	Pointer to the type of the variable. The pointer need not be initialized; the D3PD software will set the pointer prior to calling fill().
dim	Dimension for the variable. (Presently unimplemented!)
docstring	Documentation string for this variable.
defval	Pointer to the default value to use for this variable. Only works for basic types.

If called from the constructor, the only effect is to clear ptr.

addDimensionedVariable() [3/3]

StatusCode D3PD::IAddVariable::addDimensionedVariable ( const std::string & name, Types< xAOD::Electron, xAOD::Photon > *& ptr, const std::string & dim, const std::string & docstring = "" )

inherited

Add a variable to the tuple.

Parameters

name	The name of the variable.
ptr	Pointer to the type of the variable. The pointer need not be initialized; the D3PD software will set the pointer prior to calling fill().
dim	Dimension for the variable. (Presently unimplemented!)
docstring	Documentation string for this variable.

If called from the constructor, the only effect is to clear ptr.

addVariable() [1/3]

StatusCode D3PD::AddVariable::addVariable ( const std::string & name, const std::type_info & ti, void *& ptr, const std::string & docstring = "", const void * defval = 0 )

virtualinherited

Add a variable to the tuple.

Parameters

name	The name of the variable.
type	The type of the variable.
ptr	Pointer to the type of the variable. The pointer need not be initialized; the D3PD software will set the pointer prior to calling fill().
docstring	Documentation string for this variable.
defval	Pointer to the default value to use for this variable. Null for no default (generally means to fill with zeros). Of the type given by ti. Only works for basic types.

If called from the constructor, the only effect is to clear ptr.

Definition at line 93 of file AddVariable.cxx.

{
  if (!m_tree) {
    // Called from constructor --- just initialize pointer.
    ptr = 0;
    return StatusCode::SUCCESS;
  }
 
  CHECK( m_metadata.addVariable( m_prefix + name + m_suffix,
                                 ti, ptr, docstring, defval ) );
  return m_tree->addVariable (m_prefix + name + m_suffix,
                              ti, ptr, docstring, defval);
}

addVariable() [2/3]

StatusCode D3PD::IAddVariable::addVariable ( const std::string & name, Types< xAOD::Electron, xAOD::Photon > *& ptr, const std::string & docstring, const U & defval )

inherited

Make the template implementation from IAddVariable visible.

addVariable() [3/3]

StatusCode D3PD::IAddVariable::addVariable ( const std::string & name, Types< xAOD::Electron, xAOD::Photon > *& ptr, const std::string & docstring = "" )

inherited

Make the template implementation from IAddVariable visible.

BlockFillerToolImpl()

( const std::string & type, const std::string & name, const IInterface * parent )

inherited

Standard Gaudi tool constructor.

Parameters

type	The name of the tool type.
name	The tool name.
parent	The tool's Gaudi parent.

book()

StatusCode D3PD::egammaTraversedMaterialFillerTool::book ( )

finalvirtual

Book variables for this block.

Implements D3PD::BlockFillerTool< Types< xAOD::Electron, xAOD::Photon > >.

Definition at line 72 of file egammaTraversedMaterialFillerTool.cxx.

  {
    CHECK( addVariable ("materialTraversed", m_materialTraversed,
                        "Material traversed between vertex "
                        "(conversion vertex) and the entrance of the "
                        "calorimeter (in X0)") );
    return StatusCode::SUCCESS;
  }

configureD3PD() [1/2]

StatusCode D3PD::AddVariable::configureD3PD ( IAddVariable * tree )

inherited

Configure the parent tree.

Parameters

tree	The parent IAddVariable instance.

Definition at line 69 of file AddVariable.cxx.

{
  m_tree = tree;
  m_metadata.clear();
  return StatusCode::SUCCESS;
}

configureD3PD() [2/2]

virtual StatusCode D3PD::BlockFillerTool< Types< xAOD::Electron, xAOD::Photon > >::configureD3PD ( IAddVariable * tree, const std::type_info & ti )

virtualinherited

Configure during initialization: type-check.

Parameters

tree	Our parent for tuple making.
ti	Gives the type of the object being passed to fillUntyped.

configureD3PD should check that the type of the object coming as input is compatible with what it expects, and raise an error otherwise.

configureImpl() [1/2]

StatusCode D3PD::BlockFillerToolImpl::configureImpl ( IAddVariable * tree, const std::type_info & ti, const std::type_info & fill_ti )

protectedinherited

Configure during initialization: type-check.

Parameters

tree	Our parent for tuple making.
ti	Gives the type of the object being passed to fillUntyped.
fill_ti	is the type of object that the user code will expect.

This is the common implementation for the configureD3PD method of IBlockFillerTool. It checks that the type of the object coming as input is compatible with what the user code is expecting, and raises an error otherwise.

Definition at line 70 of file BlockFillerToolImpl.cxx.

{
  CHECK( AddVariable::configureD3PD (tree) );
  CHECK( m_converter.init (ti, fill_ti) );
 
  return StatusCode::SUCCESS;
}

configureImpl() [2/2]

StatusCode D3PD::BlockFillerToolImpl::configureImpl ( IAddVariable * tree, const std::type_info & ti, const std::vector< const std::type_info * > & tis, size_t & which )

protectedinherited

Configure during initialization: type-check.

Parameters

	tree	Our parent for tuple making.
	ti	Gives the type of the object being passed to fillUntyped.
	tis	List of possible input types that we can accept.
[out]	which	Index of the accepted type.

This is the common implementation for the configureD3PD method of IBlockFillerTool. It checks that the type of the object coming as input is compatible with what the user code is expecting, and raises an error otherwise.

This version allows for one of a set of types to match. If successful, WHICH is set to the index (0-based) of the matching type.

Definition at line 91 of file BlockFillerToolImpl.cxx.

{
  CHECK( AddVariable::configureD3PD (tree) );
  CHECK( m_converter.init (ti, tis, which) );
  return StatusCode::SUCCESS;
}

convert()

StatusCode D3PD::BlockFillerToolImpl::convert ( void const *& p ) const

protectedinherited

Do type conversion.

Parameters

p[in,out]

Pointer to convert.

On entry, p is a pointer to an object of the type that was passed into configureImpl as ti. Convert the pointer to point to an object of the type that was given as fill_ti. If the conversion fails, the pointer is set to 0 (and FAILURE is returned).

Definition at line 107 of file BlockFillerToolImpl.cxx.

{
  p = m_converter.convertUntyped (p);
  if (!p) {
    REPORT_MESSAGE (MSG::ERROR)
      << "Pointer conversion from " << m_converter.srcName() << " to "
      << m_converter.dstName() << "failed.";
    return StatusCode::FAILURE;
  }
  return StatusCode::SUCCESS;
}

fill() [1/4]

virtual StatusCode D3PD::BlockFillerTool< Types< xAOD::Electron, xAOD::Photon > >::fill ( const Types< xAOD::Electron, xAOD::Photon > & p )

pure virtualinherited

Fill one block — type-safe version.

Parameters

p	The input object.

This is called once per object. The caller is responsible for arranging that all the pointers for booked variables are set appropriately upon entry.

fill() [2/4]

StatusCode D3PD::egammaTraversedMaterialFillerTool::fill ( const xAOD::Egamma & eg, const Trk::TrackParameters & parameters )

private

Common part.

Parameters

eg	The input egamma object.
parameters	Track parameters to extrapolate.

Definition at line 135 of file egammaTraversedMaterialFillerTool.cxx.

  {
 
    SG::ReadCondHandle<CaloDetDescrManager> caloMgrHandle{ m_caloMgrKey };
    const CaloDetDescrManager* caloDDMgr = *caloMgrHandle;
 
    if (parameters.pT() < m_minPt)
    {
      ATH_MSG_DEBUG("Momentum too low");
      return StatusCode::SUCCESS;
    }
    
    // Define surface to extrapolate to (PS barrel, endcap or strips)
    const xAOD::CaloCluster *cl = eg.caloCluster();
    if (!cl)
    {
      ATH_MSG_DEBUG("Invalid pointer to cluster object");
      return StatusCode::SUCCESS;
    }
    
    CaloCell_ID::CaloSample sample = CaloCell_ID::EME1;
    if (fabs(cl->eta()) < 1.5)
      sample = CaloCell_ID::PreSamplerB;
    else //if (fabs(cl->eta()) < 1.8)
      sample = CaloCell_ID::PreSamplerE;
    
    // create a surface at the entrance of the sample (0 is the offset)
    std::unique_ptr<Trk::Surface> surface
      (m_caloSurfaceBuilder->CreateUserSurface(sample, 0., cl->eta(), caloDDMgr));
    if (!surface)
    {
      ATH_MSG_DEBUG("Could not create surface at entrance of sample " << sample);
      return StatusCode::SUCCESS;
    }
 
    // Extrapolate to surface
    typedef std::vector<const Trk::TrackStateOnSurface*> tsos_vec_t;
    std::unique_ptr<const tsos_vec_t> v
      (m_extrapolator->extrapolateM (
          Gaudi::Hive::currentContext(),
          parameters,
          *surface,
          Trk::alongMomentum,
          true,
          Trk::muon));
    if (!v)
    {
      ATH_MSG_DEBUG("Extrapolation failed");
      return StatusCode::SUCCESS;
    } 
    
    // Sum the amount of material traversed
    for (const Trk::TrackStateOnSurface* tsos : *v) {
      if (tsos->materialEffectsOnTrack())
      {
        //ATH_MSG_INFO("Material effects");
        //tsos->materialEffectsOnTrack()->dump( msg(MSG::INFO) );
        *m_materialTraversed += tsos->materialEffectsOnTrack()->thicknessInX0();
      }
      delete tsos;
    }
    return StatusCode::SUCCESS;
  }

fill() [3/4]

StatusCode D3PD::egammaTraversedMaterialFillerTool::fill ( const xAOD::Electron & p )

overridevirtual

Fill one block — type-safe version.

Parameters

p	The input object.

This is called once per object. The caller is responsible for arranging that all the pointers for booked variables are set appropriately upon entry.

Definition at line 90 of file egammaTraversedMaterialFillerTool.cxx.

  {
    const xAOD::TrackParticle* trackParticle = p.trackParticle();
    if (trackParticle)
      CHECK( fill (p, trackParticle->perigeeParameters()) );
    return StatusCode::SUCCESS;
  }

fill() [4/4]

StatusCode D3PD::egammaTraversedMaterialFillerTool::fill ( const xAOD::Photon & p )

overridevirtual

Fill one block — type-safe version.

Parameters

p	The input object.

This is called once per object. The caller is responsible for arranging that all the pointers for booked variables are set appropriately upon entry.

Definition at line 107 of file egammaTraversedMaterialFillerTool.cxx.

  {
    const xAOD::Vertex* vx = p.vertex();
    if (!vx || vx->nTrackParticles() < 1) return StatusCode::SUCCESS;
 
    // Set as parameters the ones of the highest pT track at the conv. vertex
    const Trk::TrackParameters* parameters =
      &vx->trackParticle(0)->perigeeParameters();
 
    if (vx->nTrackParticles() > 1 && parameters) {
      const Trk::TrackParameters* p2 =
        &vx->trackParticle(1)->perigeeParameters();
      if (p2 && p2->pT() > parameters->pT()) parameters = p2;
    }
 
    if(parameters){
    CHECK( fill (p, *parameters) );
    }
    return StatusCode::SUCCESS;
  }

fillAgain()

virtual StatusCode D3PD::BlockFillerTool< Types< xAOD::Electron, xAOD::Photon > >::fillAgain ( const Types< xAOD::Electron, xAOD::Photon > & p )

virtualinherited

Fill one block, after AGAIN has been returned (type-safe).

Parameters

p	The input object.

Once fill returns AGAIN, the parent should call fillAgain with the same arguments. This continues until fillAgain returns something other than AGAIN.

By default, this just calls fill().

fillUntyped()

virtual StatusCode D3PD::BlockFillerTool< Types< xAOD::Electron, xAOD::Photon > >::fillUntyped ( const void * p, bool again = false )

virtualinherited

Fill one block.

Parameters

p	The input object.
again	Set if this is a subsequent call requested by an AGAIN return

This is called once per object. The type of the object at which p points is given by the ti argument to configureD3PD. The caller is responsible for arranging that all the pointers for booked variables are set appropriately upon entry.

If the return status is the special code AGAIN (defined above), then this filler tool wants to make multiple entries. The parent should set up to capture a new ‘row’ and run through the list of block filler tools again, but for this tool call fillAgainUntyped instead of fillUntyped. This should be repeated as long as fillAgainUntyped returns AGAIN.

Once fillUntyped returns AGAIN, the parent should call fillUntyped with the same p argument and again set to true. This continues until fillUntyped returns something other than AGAIN.

Not all parents may support this. In that case, returning AGAIN will be treated as an error.

initialize()

StatusCode D3PD::egammaTraversedMaterialFillerTool::initialize ( )

overridevirtual

Definition at line 61 of file egammaTraversedMaterialFillerTool.cxx.

  {
    CHECK( m_extrapolator.retrieve() );
    CHECK( m_caloSurfaceBuilder.retrieve() );
    CHECK(m_caloMgrKey.initialize());   
    return StatusCode::SUCCESS;
  }

Member Data Documentation

m_blockName

std::string D3PD::BlockFillerToolImpl::m_blockName

privateinherited

Property: the name of this block.

Definition at line 118 of file BlockFillerToolImpl.h.

m_caloMgrKey

SG::ReadCondHandleKey<CaloDetDescrManager> D3PD::egammaTraversedMaterialFillerTool::m_caloMgrKey

private

Initial value:

{
    this,
    "CaloDetDescrManager",
    "CaloDetDescrManager"
  }

Definition at line 99 of file egammaTraversedMaterialFillerTool.h.

                                                       {
    this,
    "CaloDetDescrManager",
    "CaloDetDescrManager"
  };

m_caloSurfaceBuilder

ToolHandle<ICaloSurfaceBuilder> D3PD::egammaTraversedMaterialFillerTool::m_caloSurfaceBuilder

private

Property: CaloSurfaceBuilder tool.

Definition at line 97 of file egammaTraversedMaterialFillerTool.h.

m_converter

TypeConverter D3PD::BlockFillerToolImpl::m_converter

privateinherited

Helper to do type conversions.

Definition at line 121 of file BlockFillerToolImpl.h.

m_extrapolator

ToolHandle<Trk::IExtrapolator> D3PD::egammaTraversedMaterialFillerTool::m_extrapolator

private

Property: The extrapolator tool.

Definition at line 94 of file egammaTraversedMaterialFillerTool.h.

m_materialTraversed

float* D3PD::egammaTraversedMaterialFillerTool::m_materialTraversed

private

Variable: Material traversed between vertex (conversion vertex) and the entrance of the calorimeter (in X0)

Definition at line 91 of file egammaTraversedMaterialFillerTool.h.

m_metadata

ObjectMetadata D3PD::AddVariable::m_metadata

protectedinherited

Metadata about the variables created by this object.

Definition at line 129 of file AddVariable.h.

m_minPt

float D3PD::egammaTraversedMaterialFillerTool::m_minPt

private

Property: Minimum track pT to do the extrapolation.

Definition at line 106 of file egammaTraversedMaterialFillerTool.h.

m_prefix

std::string D3PD::BlockFillerToolImpl::m_prefix

privateinherited

Property: the variable prefix for this block.

Definition at line 112 of file BlockFillerToolImpl.h.

m_suffix

std::string D3PD::BlockFillerToolImpl::m_suffix

privateinherited

Property: the variable prefix for this block.

Definition at line 115 of file BlockFillerToolImpl.h.

m_tree

IAddVariable* D3PD::AddVariable::m_tree

privateinherited

Reference to the block name.

The parent IAddVariable instance.

Definition at line 143 of file AddVariable.h.

s_emptyString

const std::string D3PD::AddVariable::s_emptyString

staticprivateinherited

Used to provide a default value for blockName.

Definition at line 41 of file AddVariable.h.

---

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

• egammaTraversedMaterialFillerTool.h
• egammaTraversedMaterialFillerTool.cxx