CaloDepthTool Class Reference

Implementation of the ICaloDepthTool interface.Given a Track direction, checks if it is in the Calorimeter acceptance and provides various radii to be compared/used in the extrapolation. More...

#include <CaloDepthTool.h>

Inheritance diagram for CaloDepthTool:

Collaboration diagram for CaloDepthTool:

Public Types
enum class	DepthChoice {   egparam , cscopt , cscopt2 , TBparam ,   entrance , middle , flat }

Public Member Functions
	CaloDepthTool (const std::string &type, const std::string &name, const IInterface *parent)
	Standard constructor.
virtual	~CaloDepthTool ()
	Destructor.
virtual StatusCode	initialize () override
	Tool Initialize.
virtual StatusCode	finalize () override
	Tool Finalize.
double	radius (const CaloCell_ID::SUBCALO subcalo, const int sampling_or_module, const bool barrel, const double eta, const double phi, const CaloDetDescrManager *caloDD) const
	get radius
double	radius (const CaloCell_ID::CaloSample sample, const double eta, const double phi, const CaloDetDescrManager *caloDD) const
	get radius
ServiceHandle< StoreGateSvc > &	evtStore ()
	The standard StoreGateSvc (event store) Returns (kind of) a pointer to the StoreGateSvc.
const ServiceHandle< StoreGateSvc > &	detStore () const
	The standard StoreGateSvc/DetectorStore Returns (kind of) a pointer to the StoreGateSvc.
virtual StatusCode	sysInitialize () override
	Perform system initialization for an algorithm.
virtual StatusCode	sysStart () override
	Handle START transition.
virtual std::vector< Gaudi::DataHandle * >	inputHandles () const override
	Return this algorithm's input handles.
virtual std::vector< Gaudi::DataHandle * >	outputHandles () const override
	Return this algorithm's output handles.
Gaudi::Details::PropertyBase &	declareProperty (Gaudi::Property< T, V, H > &t)
void	updateVHKA (Gaudi::Details::PropertyBase &)
MsgStream &	msg () const
bool	msgLvl (const MSG::Level lvl) const

Static Public Member Functions
static const InterfaceID &	interfaceID ()
	Query interface.
static double	deta (const CaloCell_ID::SUBCALO subcalo, const int sampling_or_module, const bool barrel, const double eta, const CaloDetDescrManager *caloDD)
	How far are you (in eta) from a given sample or - if you are in - how far are you from the edge ?
static double	deta (const CaloCell_ID::CaloSample sample, const double eta, const CaloDetDescrManager *caloDD)
	How far are you (in eta) from a given sample or - if you are in - how far are you from the edge ?
static double	entrance (const CaloCell_ID::SUBCALO subcalo, const int sampling_or_module, const bool barrel, const double eta, const double phi, const CaloDetDescrManager *caloDD)
	For a given direction, return the entrance of the given CaloCell_ID::CaloSample.
static double	entrance (const CaloCell_ID::CaloSample sample, const double eta, const double phi, const CaloDetDescrManager *caloDD)
	For a given direction, return the entrance of the given CaloCell_ID::CaloSample.
static double	middle (const CaloCell_ID::SUBCALO subcalo, const int sampling_or_module, const bool barrel, const double eta, const double phi, const CaloDetDescrManager *caloDD)
	For a given direction, return the middle of the given CaloCell_ID::CaloSample.
static double	middle (const CaloCell_ID::CaloSample sample, const double eta, const double phi, const CaloDetDescrManager *caloDD)
	For a given direction, return the middle of the given CaloCell_ID::CaloSample.
static double	exit (const CaloCell_ID::SUBCALO subcalo, const int sampling_or_module, const bool barrel, const double eta, const double phi, const CaloDetDescrManager *caloDD)
	For a given direction, return the exit of the given CaloCell_ID::CaloSample.
static double	exit (const CaloCell_ID::CaloSample sample, const double eta, const double phi, const CaloDetDescrManager *caloDD)
	For a given direction, return the exit of the given CaloCell_ID::CaloSample.
static double	flat (const CaloCell_ID::SUBCALO subcalo, const int sampling_or_module, const bool barrel, const int side, const CaloDetDescrManager *caloDD)
	If the direction is not specified, returns a "flat" aproximation (truely valid for strips only).
static double	flat (const CaloCell_ID::CaloSample sample, const int side, const CaloDetDescrManager *caloDD)
	If the direction is not specified, returns a "flat" aproximation (truely valid for strips only).
static double	depth (const CaloCell_ID::SUBCALO subcalo, const int sampling_or_module, const bool barrel, const int side, const CaloDetDescrManager *caloDD)
	If the direction is not specified, returns a "flat" aproximation (truely valid for strips only).
static double	depth (const CaloCell_ID::CaloSample sample, const int side, const CaloDetDescrManager *caloDD)
	If the direction is not specified, returns a "flat" aproximation (truely valid for strips only).
static double	get_entrance_radius (CaloCell_ID::CaloSample sample, double eta, double phi, const CaloDetDescrManager *caloDD)
	will look for the corresponding CaloDetDescrElement and return its entrance radius
static double	get_entrance_z (CaloCell_ID::CaloSample sample, double eta, double phi, const CaloDetDescrManager *caloDD)
	will look for the corresponding CaloDetDescrElement and return its entrance z
static double	cscopt2_parametrized (const CaloCell_ID::CaloSample sample, const double eta, const double phi, const CaloDetDescrManager *caloDD)
	Same as cscopt with the outermost EMB2 point excluded.

Protected Member Functions
	CaloDepthTool ()
	CaloDepthTool (const CaloDepthTool &)
CaloDepthTool &	operator= (const CaloDepthTool &)
void	renounceArray (SG::VarHandleKeyArray &handlesArray)
	remove all handles from I/O resolution
std::enable_if_t< std::is_void_v< std::result_of_t< decltype(&T::renounce)(T)> > &&!std::is_base_of_v< SG::VarHandleKeyArray, T > &&std::is_base_of_v< Gaudi::DataHandle, T >, void >	renounce (T &h)
void	extraDeps_update_handler (Gaudi::Details::PropertyBase &ExtraDeps)
	Add StoreName to extra input/output deps as needed.

Private Types
typedef ServiceHandle< StoreGateSvc >	StoreGateSvc_t

Private Member Functions
Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T, V, H > &hndl, const SG::VarHandleKeyType &)
	specialization for handling Gaudi::Property<SG::VarHandleKey>

Static Private Member Functions
static double	egparametrized (const CaloCell_ID::SUBCALO subcalo, const int sampling_or_module, const bool barrel, const double eta, const double phi, const CaloDetDescrManager *caloDD)
	Methods taken from the old egammaqdepth class : return the parametrised depth used in DC1 and DC2.
static double	egparametrized (const CaloCell_ID::CaloSample sample, const double eta, const double phi, const CaloDetDescrManager *caloDD)
	Methods taken from the old egammaqdepth class : return the parametrised depth used in DC1 and DC2.
static double	TBparametrized (const CaloCell_ID::SUBCALO subcalo, const int sampling_or_module, const bool barrel, const double eta, const double phi, const CaloDetDescrManager *caloDD)
	Parametrisation taken from the old egammaqdepth class, but adapted for TestBeam.
static double	TBparametrized (const CaloCell_ID::CaloSample sample, const double eta, const double phi, const CaloDetDescrManager *caloDD)
	Parametrisation taken from the old egammaqdepth class, but adapted for TestBeam.
static double	cscopt_parametrized (const CaloCell_ID::CaloSample sample, const double eta, const double phi, const CaloDetDescrManager *caloDD)
	Layers 1 and 2 depths set to give the best eta resolution.
static double	get_middle_radius (CaloCell_ID::CaloSample sample, double eta, double phi, const CaloDetDescrManager *caloDD)
	will look for the corresponding CaloDetDescrElement and return its middle radius
static double	get_middle_z (CaloCell_ID::CaloSample sample, double eta, double phi, const CaloDetDescrManager *caloDD)
	will look for the corresponding CaloDetDescrElement and return its middle z
static double	get_exit_radius (CaloCell_ID::CaloSample sample, double eta, double phi, const CaloDetDescrManager *caloDD)
	will look for the corresponding CaloDetDescrElement and return its middle radius
static double	get_exit_z (CaloCell_ID::CaloSample sample, double eta, double phi, const CaloDetDescrManager *caloDD)
	will look for the corresponding CaloDetDescrElement and return its middle z

Private Attributes
Gaudi::Property< std::string >	m_depth_choice { this, "DepthChoice", "", "depth choice" }
	Depth choice related code User passes a string but we convert to an enum at init to avoid string comparisons.
DepthChoice	m_depthChoice = DepthChoice::entrance
const CaloCell_ID *	m_calo_id
	ID Helper.
CaloPhiRange	m_range
	Phi range helper object.
StoreGateSvc_t	m_evtStore
	Pointer to StoreGate (event store by default)
StoreGateSvc_t	m_detStore
	Pointer to StoreGate (detector store by default)
std::vector< SG::VarHandleKeyArray * >	m_vhka
bool	m_varHandleArraysDeclared

Detailed Description

Implementation of the ICaloDepthTool interface.Given a Track direction, checks if it is in the Calorimeter acceptance and provides various radii to be compared/used in the extrapolation.

This tool extends the functionality of the old egammaUtils/egammaqdepth class

In all the methods, radius stands for r in the (cylindric) barrel, for z in the (disk) endcap.

The generic method radius() uses the default choosen by joboption, and if the result is 0 because the eta/phi direction is outside the Sample acceptance, returns the egparametrised depth as backup solution.

Definition at line 45 of file CaloDepthTool.h.

Member Typedef Documentation

StoreGateSvc_t

typedef ServiceHandle<StoreGateSvc> AthCommonDataStore< AthCommonMsg< AlgTool > >::StoreGateSvc_t

privateinherited

Definition at line 388 of file AthCommonDataStore.h.

Member Enumeration Documentation

DepthChoice

enum class CaloDepthTool::DepthChoice

strong

Enumerator
egparam
cscopt
cscopt2
TBparam
entrance
middle
flat

Definition at line 238 of file CaloDepthTool.h.

  {
    egparam,
    cscopt,
    cscopt2,
    TBparam,
    entrance,
    middle,
    flat
  };

Constructor & Destructor Documentation

CaloDepthTool() [1/3]

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

Standard constructor.

Definition at line 49 of file CaloDepthTool.cxx.

  : AthAlgTool(type, name, parent)
  , m_calo_id(nullptr)
{
  declareInterface<CaloDepthTool>(this);
}

~CaloDepthTool()

CaloDepthTool::~CaloDepthTool ( )

virtualdefault

Destructor.

CaloDepthTool() [2/3]

CaloDepthTool::CaloDepthTool ( )

protected

CaloDepthTool() [3/3]

CaloDepthTool::CaloDepthTool ( const CaloDepthTool & )

protected

Member Function Documentation

cscopt2_parametrized()

double CaloDepthTool::cscopt2_parametrized ( const CaloCell_ID::CaloSample sample, const double eta, const double phi, const CaloDetDescrManager * caloDD )

static

Same as cscopt with the outermost EMB2 point excluded.

This improves the fit. From CSC12 E=100 GeV photons.

Definition at line 323 of file CaloDepthTool.cxx.

{
  double radius = s_default;
 
  float aeta = static_cast<float>(std::abs(eta));
 
  if (sample == CaloCell_ID::PreSamplerB) {
    radius = 1422.3 * Gaudi::Units::millimeter;
  } else if (sample == CaloCell_ID::EMB1) {
    if (aeta < 0.8)
      radius = (1558.859292 - 4.990838 * aeta - 21.144279 * aeta * aeta) *
               Gaudi::Units::millimeter;
    else
      radius = (1522.775373 + 27.970192 * aeta - 21.104108 * aeta * aeta) *
               Gaudi::Units::millimeter;
  } else if (sample == CaloCell_ID::EMB2) {
    radius = (1698.990944 - 49.431767 * aeta - 24.504976 * aeta * aeta) *
             Gaudi::Units::millimeter;
  } else if (sample == CaloCell_ID::EMB3) {
    if (aeta < 0.8)
      radius = (1833.88 - 106.25 * aeta) * Gaudi::Units::millimeter;
    else
      radius = (2038.40 - 286. * aeta) * Gaudi::Units::millimeter;
  }
 
  else if (sample == CaloCell_ID::PreSamplerE) {
    radius = 3600. * Gaudi::Units::millimeter;
    if (eta < 0.)
      radius = -radius;
  } else if (sample == CaloCell_ID::EME1) {
    if (aeta < 1.5)
      radius = (12453.297448 - 5735.787116 * aeta) * Gaudi::Units::millimeter;
    else
      radius = 3790.671754 * Gaudi::Units::millimeter;
    if (eta < 0.)
      radius = -radius;
  } else if (sample == CaloCell_ID::EME2) {
    if (aeta < 1.5)
      radius = (8027.574119 - 2717.653528 * aeta) * Gaudi::Units::millimeter;
    else
      radius = (3473.473909 + 453.941515 * aeta - 119.101945 * aeta * aeta) *
               Gaudi::Units::millimeter;
    if (eta < 0.)
      radius = -radius;
  } else if (sample == CaloCell_ID::EME3) {
    radius = 4150. * Gaudi::Units::millimeter;
    if (eta < 0.)
      radius = -radius;
  }
 
  // This was not in the egamma parametrization,
  // but it does not cost much to add it :
  else {
    if (eta > 0.)
      radius = flat(sample, 1, caloDD);
    else
      radius = flat(sample, -1, caloDD);
  }
 
  return radius;
}

cscopt_parametrized()

double CaloDepthTool::cscopt_parametrized ( const CaloCell_ID::CaloSample sample, const double eta, const double phi, const CaloDetDescrManager * caloDD )

staticprivate

Layers 1 and 2 depths set to give the best eta resolution.

From CSC12 E=100 GeV photons.

Definition at line 253 of file CaloDepthTool.cxx.

{
  double radius = s_default;
 
  float aeta = static_cast<float>(std::abs(eta));
 
  if (sample == CaloCell_ID::PreSamplerB) {
    radius = 1422.3 * Gaudi::Units::millimeter;
  } else if (sample == CaloCell_ID::EMB1) {
    if (aeta < 0.8)
      radius = (1558.859292 - 4.990838 * aeta - 21.144279 * aeta * aeta) *
               Gaudi::Units::millimeter;
    else
      radius = (1522.775373 + 27.970192 * aeta - 21.104108 * aeta * aeta) *
               Gaudi::Units::millimeter;
  } else if (sample == CaloCell_ID::EMB2) {
    radius = (1689.621619 + 2.682993 * aeta - 70.165741 * aeta * aeta) *
             Gaudi::Units::millimeter;
  } else if (sample == CaloCell_ID::EMB3) {
    if (aeta < 0.8)
      radius = (1833.88 - 106.25 * aeta) * Gaudi::Units::millimeter;
    else
      radius = (2038.40 - 286. * aeta) * Gaudi::Units::millimeter;
  }
 
  else if (sample == CaloCell_ID::PreSamplerE) {
    radius = 3600. * Gaudi::Units::millimeter;
    if (eta < 0.)
      radius = -radius;
  } else if (sample == CaloCell_ID::EME1) {
    if (aeta < 1.5)
      radius = (12453.297448 - 5735.787116 * aeta) * Gaudi::Units::millimeter;
    else
      radius = 3790.671754 * Gaudi::Units::millimeter;
    if (eta < 0.)
      radius = -radius;
  } else if (sample == CaloCell_ID::EME2) {
    if (aeta < 1.5)
      radius = (8027.574119 - 2717.653528 * aeta) * Gaudi::Units::millimeter;
    else
      radius = (3473.473909 + 453.941515 * aeta - 119.101945 * aeta * aeta) *
               Gaudi::Units::millimeter;
    if (eta < 0.)
      radius = -radius;
  } else if (sample == CaloCell_ID::EME3) {
    radius = 4150. * Gaudi::Units::millimeter;
    if (eta < 0.)
      radius = -radius;
  }
 
  // This was not in the egamma parametrization,
  // but it does not cost much to add it :
  else {
    if (eta > 0.)
      radius = flat(sample, 1, caloDD);
    else
      radius = flat(sample, -1, caloDD);
  }
 
  return radius;
}

declareGaudiProperty()

Gaudi::Details::PropertyBase & AthCommonDataStore< AthCommonMsg< AlgTool > >::declareGaudiProperty ( Gaudi::Property< T, V, H > & hndl, const SG::VarHandleKeyType &  )

inlineprivateinherited

specialization for handling Gaudi::Property<SG::VarHandleKey>

Definition at line 156 of file AthCommonDataStore.h.

  {
    return *AthCommonDataStore<PBASE>::declareProperty(hndl.name(),
                                                       hndl.value(), 
                                                       hndl.documentation());
 
  }

declareProperty()

Gaudi::Details::PropertyBase & AthCommonDataStore< AthCommonMsg< AlgTool > >::declareProperty ( Gaudi::Property< T, V, H > & t )

inlineinherited

Definition at line 145 of file AthCommonDataStore.h.

                                                                     {
    typedef typename SG::HandleClassifier<T>::type htype;
    return AthCommonDataStore<PBASE>::declareGaudiProperty(t, htype());
  }

depth() [1/2]

double CaloDepthTool::depth ( const CaloCell_ID::CaloSample sample, const int side, const CaloDetDescrManager * caloDD )

static

If the direction is not specified, returns a "flat" aproximation (truely valid for strips only).

Definition at line 618 of file CaloDepthTool.cxx.

{
  // FIXME : tiles is hardcoded !!!
  double radius = 1970.;
 
  if (sample == CaloCell_ID::TileBar0)
    return false;
  if (sample == CaloCell_ID::TileBar1)
    return false;
  if (sample == CaloCell_ID::TileBar2)
    return false;
  if (sample == CaloCell_ID::TileGap1)
    return false;
  if (sample == CaloCell_ID::TileGap2)
    return false;
  if (sample == CaloCell_ID::TileExt0)
    return false;
  if (sample == CaloCell_ID::TileExt1)
    return false;
  if (sample == CaloCell_ID::TileExt2)
    return false;
 
  radius = s_default;
 
  for (const CaloDetDescriptor* reg : caloDD->calo_descriptors_range()) {
    if (reg) {
      if (reg->getSampling(0) == sample && reg->calo_sign() * side > 0) {
        std::vector<double> depth;
        reg->get_depth_out(depth);
        for (unsigned int j = 0; j < depth.size(); j++)
          if (radius > depth[j])
            radius = depth[j];
      }
    }
  }
 
  return radius;
}

depth() [2/2]

double CaloDepthTool::depth ( const CaloCell_ID::SUBCALO subcalo, const int sampling_or_module, const bool barrel, const int side, const CaloDetDescrManager * caloDD )

static

If the direction is not specified, returns a "flat" aproximation (truely valid for strips only).

Definition at line 605 of file CaloDepthTool.cxx.

{
  CaloCell_ID::CaloSample sample;
  CaloDetDescrManager::build_sample(
    subcalo, barrel, sampling_or_module, sample);
  return depth(sample, side, caloDD);
}

deta() [1/2]

double CaloDepthTool::deta ( const CaloCell_ID::CaloSample sample, const double eta, const CaloDetDescrManager * caloDD )

static

How far are you (in eta) from a given sample or - if you are in - how far are you from the edge ?

This method will return the distance to the closest edge. If you are outside the sample volume, it will always be a positive number. If you are inside the sample volume, the distance will be multiplied by -1 : i.e.always a negative number.

Definition at line 155 of file CaloDepthTool.cxx.

{
  double deta = 99999.;
  /*bool result =*/caloDD->is_in(eta, 0., sample, deta);
  return deta;
}

deta() [2/2]

double CaloDepthTool::deta ( const CaloCell_ID::SUBCALO subcalo, const int sampling_or_module, const bool barrel, const double eta, const CaloDetDescrManager * caloDD )

static

How far are you (in eta) from a given sample or - if you are in - how far are you from the edge ?

This method will return the distance to the closest edge. If you are outside the sample volume, it will always be a positive number. If you are inside the sample volume, the distance will be multiplied by -1 : i.e.always a negative number.

Definition at line 142 of file CaloDepthTool.cxx.

{
  CaloCell_ID::CaloSample sample;
  CaloDetDescrManager::build_sample(
    subcalo, barrel, sampling_or_module, sample);
  return deta(sample, eta, caloDD);
}

detStore()

const ServiceHandle< StoreGateSvc > & AthCommonDataStore< AthCommonMsg< AlgTool > >::detStore ( ) const

inlineinherited

The standard StoreGateSvc/DetectorStore Returns (kind of) a pointer to the StoreGateSvc.

Definition at line 95 of file AthCommonDataStore.h.

{ return m_detStore; }

egparametrized() [1/2]

double CaloDepthTool::egparametrized ( const CaloCell_ID::CaloSample sample, const double eta, const double phi, const CaloDetDescrManager * caloDD )

staticprivate

Methods taken from the old egammaqdepth class : return the parametrised depth used in DC1 and DC2.

Only LAREM is foreseen

Definition at line 183 of file CaloDepthTool.cxx.

{
  double radius = s_default;
 
  // note that only LAREM was foreseen in egammaqdepth
  // here we go ... cut and paste the code as is, including hardcoded
  // parametrisation :-(
 
  float aeta = static_cast<float>(std::abs(eta));
 
  if (sample == CaloCell_ID::PreSamplerB) {
    radius = 1422.3 * Gaudi::Units::millimeter;
  } else if (sample == CaloCell_ID::EMB1) {
    if (aeta < 0.8)
      radius = (1567.8 - 18.975 * aeta - 17.668 * aeta * aeta) *
               Gaudi::Units::millimeter;
    else
      radius = (1503.2 + 71.716 * aeta - 41.008 * aeta * aeta) *
               Gaudi::Units::millimeter;
  } else if (sample == CaloCell_ID::EMB2) {
    if (aeta < 0.8)
      radius = (1697.1 - 15.311 * aeta - 64.153 * aeta * aeta) *
               Gaudi::Units::millimeter;
    else
      radius = (1739.1 - 75.648 * aeta - 18.501 * aeta * aeta) *
               Gaudi::Units::millimeter;
  } else if (sample == CaloCell_ID::EMB3) {
    if (aeta < 0.8)
      radius = (1833.88 - 106.25 * aeta) * Gaudi::Units::millimeter;
    else
      radius = (2038.40 - 286. * aeta) * Gaudi::Units::millimeter;
  }
 
  else if (sample == CaloCell_ID::PreSamplerE) {
    radius = 3600. * Gaudi::Units::millimeter;
    if (eta < 0.)
      radius = -radius;
  } else if (sample == CaloCell_ID::EME1) {
    radius = 3760. * Gaudi::Units::millimeter;
    if (eta < 0.)
      radius = -radius;
  } else if (sample == CaloCell_ID::EME2) {
    radius = 3880. * Gaudi::Units::millimeter;
    if (eta < 0.)
      radius = -radius;
  } else if (sample == CaloCell_ID::EME3) {
    radius = 4150. * Gaudi::Units::millimeter;
    if (eta < 0.)
      radius = -radius;
  }
 
  // This was not in the egamma parametrization, but it does not cost much to
  // add it :
  else {
    if (eta > 0.)
      radius = flat(sample, 1, caloDD);
    else
      radius = flat(sample, -1, caloDD);
  }
 
  return radius;
}

egparametrized() [2/2]

double CaloDepthTool::egparametrized ( const CaloCell_ID::SUBCALO subcalo, const int sampling_or_module, const bool barrel, const double eta, const double phi, const CaloDetDescrManager * caloDD )

staticprivate

Methods taken from the old egammaqdepth class : return the parametrised depth used in DC1 and DC2.

Only LAREM is foreseen

Definition at line 169 of file CaloDepthTool.cxx.

{
  CaloCell_ID::CaloSample sample;
  CaloDetDescrManager::build_sample(
    subcalo, barrel, sampling_or_module, sample);
  return egparametrized(sample, eta, phi, caloDD);
}

entrance() [1/2]

double CaloDepthTool::entrance ( const CaloCell_ID::CaloSample sample, const double eta, const double phi, const CaloDetDescrManager * caloDD )

static

For a given direction, return the entrance of the given CaloCell_ID::CaloSample.

If the direction does not cross any CaloCell, the returned bool will be set to False.

Definition at line 447 of file CaloDepthTool.cxx.

{
  double radius = s_default;
 
  // FIXME : the calodetdescr manager misses 1 generic get_entrance method
  if (sample == CaloCell_ID::PreSamplerE || sample == CaloCell_ID::EME1 ||
      sample == CaloCell_ID::EME2 || sample == CaloCell_ID::EME3 ||
      sample == CaloCell_ID::HEC0 || sample == CaloCell_ID::HEC1 ||
      sample == CaloCell_ID::HEC2 || sample == CaloCell_ID::HEC3 ||
      sample == CaloCell_ID::FCAL0 || sample == CaloCell_ID::FCAL1 ||
      sample == CaloCell_ID::FCAL2)
    radius = get_entrance_z(sample, eta, phi, caloDD);
  else
    radius = get_entrance_radius(sample, eta, phi, caloDD);
 
  return radius;
}

entrance() [2/2]

double CaloDepthTool::entrance ( const CaloCell_ID::SUBCALO subcalo, const int sampling_or_module, const bool barrel, const double eta, const double phi, const CaloDetDescrManager * caloDD )

static

For a given direction, return the entrance of the given CaloCell_ID::CaloSample.

If the direction does not cross any CaloCell, the returned bool will be set to False.

Definition at line 433 of file CaloDepthTool.cxx.

{
  CaloCell_ID::CaloSample sample;
  CaloDetDescrManager::build_sample(
    subcalo, barrel, sampling_or_module, sample);
  return entrance(sample, eta, phi, caloDD);
}

evtStore()

ServiceHandle< StoreGateSvc > & AthCommonDataStore< AthCommonMsg< AlgTool > >::evtStore ( )

inlineinherited

The standard StoreGateSvc (event store) Returns (kind of) a pointer to the StoreGateSvc.

Definition at line 85 of file AthCommonDataStore.h.

{ return m_evtStore; }

exit() [1/2]

double CaloDepthTool::exit ( const CaloCell_ID::CaloSample sample, const double eta, const double phi, const CaloDetDescrManager * caloDD )

static

For a given direction, return the exit of the given CaloCell_ID::CaloSample.

If the direction does not cross any CaloCell, the returned bool will be set to False.

Definition at line 518 of file CaloDepthTool.cxx.

{
  double radius = s_default;
 
  if (sample == CaloCell_ID::PreSamplerE || sample == CaloCell_ID::EME1 ||
      sample == CaloCell_ID::EME2 || sample == CaloCell_ID::EME3 ||
      sample == CaloCell_ID::HEC0 || sample == CaloCell_ID::HEC1 ||
      sample == CaloCell_ID::HEC2 || sample == CaloCell_ID::HEC3 ||
      sample == CaloCell_ID::FCAL0 || sample == CaloCell_ID::FCAL1 ||
      sample == CaloCell_ID::FCAL2)
    radius = get_exit_z(sample, eta, phi, caloDD);
  else
    radius = get_exit_radius(sample, eta, phi, caloDD);
 
  return radius;
}

exit() [2/2]

double CaloDepthTool::exit ( const CaloCell_ID::SUBCALO subcalo, const int sampling_or_module, const bool barrel, const double eta, const double phi, const CaloDetDescrManager * caloDD )

static

For a given direction, return the exit of the given CaloCell_ID::CaloSample.

If the direction does not cross any CaloCell, the returned bool will be set to False.

Definition at line 504 of file CaloDepthTool.cxx.

{
  CaloCell_ID::CaloSample sample;
  CaloDetDescrManager::build_sample(
    subcalo, barrel, sampling_or_module, sample);
  return exit(sample, eta, phi, caloDD);
}

extraDeps_update_handler()

void AthCommonDataStore< AthCommonMsg< AlgTool > >::extraDeps_update_handler ( Gaudi::Details::PropertyBase & ExtraDeps )

protectedinherited

Add StoreName to extra input/output deps as needed.

use the logic of the VarHandleKey to parse the DataObjID keys supplied via the ExtraInputs and ExtraOuputs Properties to add the StoreName if it's not explicitly given

finalize()

StatusCode CaloDepthTool::finalize ( )

overridevirtual

Tool Finalize.

Definition at line 81 of file CaloDepthTool.cxx.

{
  return StatusCode::SUCCESS;
}

flat() [1/2]

double CaloDepthTool::flat ( const CaloCell_ID::CaloSample sample, const int side, const CaloDetDescrManager * caloDD )

static

If the direction is not specified, returns a "flat" aproximation (truely valid for strips only).

Definition at line 552 of file CaloDepthTool.cxx.

{
  // FIXME : tiles is hardcoded !!!
  double radius = 2280.;
 
  if (sample == CaloCell_ID::TileBar0)
    return false;
  if (sample == CaloCell_ID::TileBar1)
    return false;
  if (sample == CaloCell_ID::TileBar2)
    return false;
  if (sample == CaloCell_ID::TileGap1)
    return false;
  if (sample == CaloCell_ID::TileGap2)
    return false;
  if (sample == CaloCell_ID::TileExt0)
    return false;
  if (sample == CaloCell_ID::TileExt1)
    return false;
  if (sample == CaloCell_ID::TileExt2)
    return false;
 
  radius = s_default;
  for (const CaloDetDescriptor* reg : caloDD->calo_descriptors_range()) {
    if (reg) {
      if (reg->getSampling(0) == sample && reg->calo_sign() * side > 0) {
        std::vector<double> depth;
        reg->get_depth_in(depth);
        for (unsigned int j = 0; j < depth.size(); j++)
          if (radius < depth[j])
            radius = depth[j];
      }
    }
  }
 
  // depth in are positive values, so should multiply by -1 for the HEC and FCAL
  // at eta<0. to get the corresponding z
 
  if (side < 0) {
    if (sample == CaloCell_ID::PreSamplerE || sample == CaloCell_ID::EME1 ||
        sample == CaloCell_ID::EME2 || sample == CaloCell_ID::EME3 ||
        sample == CaloCell_ID::HEC0 || sample == CaloCell_ID::HEC1 ||
        sample == CaloCell_ID::HEC2 || sample == CaloCell_ID::HEC3 ||
        sample == CaloCell_ID::FCAL0 || sample == CaloCell_ID::FCAL1 ||
        sample == CaloCell_ID::FCAL2)
      radius = -1. * radius;
  }
  return radius;
}

flat() [2/2]

double CaloDepthTool::flat ( const CaloCell_ID::SUBCALO subcalo, const int sampling_or_module, const bool barrel, const int side, const CaloDetDescrManager * caloDD )

static

If the direction is not specified, returns a "flat" aproximation (truely valid for strips only).

Definition at line 539 of file CaloDepthTool.cxx.

{
  CaloCell_ID::CaloSample sample;
  CaloDetDescrManager::build_sample(
    subcalo, barrel, sampling_or_module, sample);
  return flat(sample, side, caloDD);
}

get_entrance_radius()

double CaloDepthTool::get_entrance_radius ( CaloCell_ID::CaloSample sample, double eta, double phi, const CaloDetDescrManager * caloDD )

static

will look for the corresponding CaloDetDescrElement and return its entrance radius

Definition at line 660 of file CaloDepthTool.cxx.

{
  const CaloDetDescrElement* elt = caloDD->get_element(sample, eta, phi);
  if (!elt) {
    return s_default;
  }
 
  //Only for tile is dR the full radius of the layer  - for
  //other calorimeters it is half the radius
  if (elt->is_tile()) return (elt->r() - elt->dr()/2);
  else return (elt->r() - elt->dr());
}

get_entrance_z()

double CaloDepthTool::get_entrance_z ( CaloCell_ID::CaloSample sample, double eta, double phi, const CaloDetDescrManager * caloDD )

static

will look for the corresponding CaloDetDescrElement and return its entrance z

Definition at line 677 of file CaloDepthTool.cxx.

{
  const CaloDetDescrElement* elt = caloDD->get_element(sample, eta, phi);
  if (!elt) {
    return s_default;
  }
 
  //Only for tile is dZ the full Z length of the layer  - for
  //other calorimeters it is half of this
  if (elt->is_tile()) return (elt->z() - (elt->z() < 0 ? -elt->dz()/2 : elt->dz()/2));
  else return (elt->z() - (elt->z() < 0 ? -elt->dz() : elt->dz()));
}

get_exit_radius()

double CaloDepthTool::get_exit_radius ( CaloCell_ID::CaloSample sample, double eta, double phi, const CaloDetDescrManager * caloDD )

staticprivate

will look for the corresponding CaloDetDescrElement and return its middle radius

Definition at line 722 of file CaloDepthTool.cxx.

{
 
  const CaloDetDescrElement* elt = caloDD->get_element(sample, eta, phi);
  if (!elt) {
    return s_default;
  }
 
  //Only for tile is dR the full radius of the layer  - for
  //other calorimeters it is half the radius
  if (elt->is_tile()) return (elt->r() + elt->dr()/2);
  else return (elt->r() + elt->dr());
}

get_exit_z()

double CaloDepthTool::get_exit_z ( CaloCell_ID::CaloSample sample, double eta, double phi, const CaloDetDescrManager * caloDD )

staticprivate

will look for the corresponding CaloDetDescrElement and return its middle z

Definition at line 740 of file CaloDepthTool.cxx.

{
 
  const CaloDetDescrElement* elt = caloDD->get_element(sample, eta, phi);
  if (!elt) {
    return s_default;
  }
 
  //Only for tile is dZ the full Z length of the layer  - for
  //other calorimeters it is half of this
  if (elt->is_tile()) return (elt->z() + (elt->z() < 0 ? -elt->dz()/2 : elt->dz()/2));
  else return (elt->z() + (elt->z() < 0 ? -elt->dz() : elt->dz()));
}

get_middle_radius()

double CaloDepthTool::get_middle_radius ( CaloCell_ID::CaloSample sample, double eta, double phi, const CaloDetDescrManager * caloDD )

staticprivate

will look for the corresponding CaloDetDescrElement and return its middle radius

Definition at line 694 of file CaloDepthTool.cxx.

{
 
  const CaloDetDescrElement* elt = caloDD->get_element(sample, eta, phi);
  if (!elt) {
    return s_default;
  }
  return elt->r();
}

get_middle_z()

double CaloDepthTool::get_middle_z ( CaloCell_ID::CaloSample sample, double eta, double phi, const CaloDetDescrManager * caloDD )

staticprivate

will look for the corresponding CaloDetDescrElement and return its middle z

Definition at line 708 of file CaloDepthTool.cxx.

{
 
  const CaloDetDescrElement* elt = caloDD->get_element(sample, eta, phi);
  if (!elt) {
    return s_default;
  }
  return elt->z();
}

initialize()

StatusCode CaloDepthTool::initialize ( )

overridevirtual

Tool Initialize.

Definition at line 61 of file CaloDepthTool.cxx.

{
 
  ATH_CHECK(detStore()->retrieve(m_calo_id, "CaloCell_ID"));
 
  if (!m_depth_choice.empty()) {
 
    auto it = s_stringToEnum.find(m_depth_choice);
    if (it != s_stringToEnum.end()) {
      m_depthChoice = it->second;
    } else {
      ATH_MSG_FATAL(" invalid depth choice " << m_depth_choice);
      return StatusCode::FAILURE;
    }
 
  }
  return StatusCode::SUCCESS;
}

inputHandles()

virtual std::vector< Gaudi::DataHandle * > AthCommonDataStore< AthCommonMsg< AlgTool > >::inputHandles ( ) const

overridevirtualinherited

Return this algorithm's input handles.

We override this to include handle instances from key arrays if they have not yet been declared. See comments on updateVHKA.

interfaceID()

const InterfaceID & CaloDepthTool::interfaceID ( )

static

Query interface.

Definition at line 44 of file CaloDepthTool.cxx.

{
  return IID_CaloDepthTool;
}

middle() [1/2]

double CaloDepthTool::middle ( const CaloCell_ID::CaloSample sample, const double eta, const double phi, const CaloDetDescrManager * caloDD )

static

For a given direction, return the middle of the given CaloCell_ID::CaloSample.

If the direction does not cross any CaloCell, the returned bool will be set to False.

Definition at line 483 of file CaloDepthTool.cxx.

{
  double radius = s_default;
 
  if (sample == CaloCell_ID::PreSamplerE || sample == CaloCell_ID::EME1 ||
      sample == CaloCell_ID::EME2 || sample == CaloCell_ID::EME3 ||
      sample == CaloCell_ID::HEC0 || sample == CaloCell_ID::HEC1 ||
      sample == CaloCell_ID::HEC2 || sample == CaloCell_ID::HEC3 ||
      sample == CaloCell_ID::FCAL0 || sample == CaloCell_ID::FCAL1 ||
      sample == CaloCell_ID::FCAL2)
    radius = get_middle_z(sample, eta, phi, caloDD);
  else
    radius = get_middle_radius(sample, eta, phi, caloDD);
 
  return radius;
}

middle() [2/2]

double CaloDepthTool::middle ( const CaloCell_ID::SUBCALO subcalo, const int sampling_or_module, const bool barrel, const double eta, const double phi, const CaloDetDescrManager * caloDD )

static

For a given direction, return the middle of the given CaloCell_ID::CaloSample.

If the direction does not cross any CaloCell, the returned bool will be set to False.

Definition at line 469 of file CaloDepthTool.cxx.

{
  CaloCell_ID::CaloSample sample;
  CaloDetDescrManager::build_sample(
    subcalo, barrel, sampling_or_module, sample);
  return middle(sample, eta, phi, caloDD);
}

msg()

MsgStream & AthCommonMsg< AlgTool >::msg ( ) const

inlineinherited

Definition at line 24 of file AthCommonMsg.h.

                                {
    return this->msgStream();
  }

msgLvl()

bool AthCommonMsg< AlgTool >::msgLvl ( const MSG::Level lvl ) const

inlineinherited

Definition at line 30 of file AthCommonMsg.h.

                                               {
    return this->msgLevel(lvl);
  }

operator=()

CaloDepthTool & CaloDepthTool::operator= ( const CaloDepthTool & )

protected

outputHandles()

virtual std::vector< Gaudi::DataHandle * > AthCommonDataStore< AthCommonMsg< AlgTool > >::outputHandles ( ) const

overridevirtualinherited

Return this algorithm's output handles.

We override this to include handle instances from key arrays if they have not yet been declared. See comments on updateVHKA.

radius() [1/2]

double CaloDepthTool::radius	(	const CaloCell_ID::CaloSample	sample,
		const double	eta,
		const double	phi,
		const CaloDetDescrManager *	caloDD ) const

get radius

Generic method to be used in client code : the default choosen by joboption, and if the result is 0 because the eta/phi direction is outside the Sample acceptance, returns the egparametrised depth as backup solution.

Definition at line 103 of file CaloDepthTool.cxx.

{
  double radius = s_default;
 
  if (m_depthChoice == DepthChoice::egparam) {
    radius = egparametrized(sample, eta, phi, caloDD);
  } else if (m_depthChoice == DepthChoice::cscopt) {
    radius = cscopt_parametrized(sample, eta, phi, caloDD);
  } else if (m_depthChoice == DepthChoice::cscopt2) {
    radius = cscopt2_parametrized(sample, eta, phi, caloDD);
  } else if (m_depthChoice == DepthChoice::TBparam) {
    radius = TBparametrized(sample, eta, phi, caloDD);
  } else if (m_depthChoice == DepthChoice::entrance) {
    radius = entrance(sample, eta, phi, caloDD);
  } else if (m_depthChoice == DepthChoice::middle) {
    radius = middle(sample, eta, phi, caloDD);
  } else if (m_depthChoice == DepthChoice::flat) {
    if (eta >= 0) {
      radius = flat(sample, 1, caloDD);
    } else {
      radius = flat(sample, -1, caloDD);
    }
  } else {
    radius = entrance(sample, eta, phi, caloDD);
  }
 
  // outside DD, use parametrised radius as default
  // it is OK, but choice should be left to the user
  if (std::abs(radius) < 10.) {
    radius = egparametrized(sample, eta, phi, caloDD);
  }
 
  return radius;
}

radius() [2/2]

double CaloDepthTool::radius	(	const CaloCell_ID::SUBCALO	subcalo,
		const int	sampling_or_module,
		const bool	barrel,
		const double	eta,
		const double	phi,
		const CaloDetDescrManager *	caloDD ) const

get radius

Generic method to be used in client code : the default choosen by joboption, and if the result is 0 because the eta/phi direction is outside the Sample acceptance, returns the egparametrised depth as backup solution.

Definition at line 89 of file CaloDepthTool.cxx.

{
  CaloCell_ID::CaloSample sample;
  CaloDetDescrManager::build_sample(
    subcalo, barrel, sampling_or_module, sample);
  return radius(sample, eta, phi, caloDD);
}

renounce()

std::enable_if_t< std::is_void_v< std::result_of_t< decltype(&T::renounce)(T)> > &&!std::is_base_of_v< SG::VarHandleKeyArray, T > &&std::is_base_of_v< Gaudi::DataHandle, T >, void > AthCommonDataStore< AthCommonMsg< AlgTool > >::renounce ( T & h )

inlineprotectedinherited

Definition at line 380 of file AthCommonDataStore.h.

  {
    h.renounce();
    PBASE::renounce (h);
  }

renounceArray()

void AthCommonDataStore< AthCommonMsg< AlgTool > >::renounceArray ( SG::VarHandleKeyArray & handlesArray )

inlineprotectedinherited

remove all handles from I/O resolution

Definition at line 364 of file AthCommonDataStore.h.

                                                          {
    handlesArray.renounce();
  }

sysInitialize()

virtual StatusCode AthCommonDataStore< AthCommonMsg< AlgTool > >::sysInitialize ( )

overridevirtualinherited

Perform system initialization for an algorithm.

We override this to declare all the elements of handle key arrays at the end of initialization. See comments on updateVHKA.

Reimplemented in asg::AsgMetadataTool, AthCheckedComponent< AthAlgTool >, AthCheckedComponent<::AthAlgTool >, and DerivationFramework::CfAthAlgTool.

sysStart()

virtual StatusCode AthCommonDataStore< AthCommonMsg< AlgTool > >::sysStart ( )

overridevirtualinherited

Handle START transition.

We override this in order to make sure that conditions handle keys can cache a pointer to the conditions container.

TBparametrized() [1/2]

double CaloDepthTool::TBparametrized ( const CaloCell_ID::CaloSample sample, const double eta, const double phi, const CaloDetDescrManager * caloDD )

staticprivate

Parametrisation taken from the old egammaqdepth class, but adapted for TestBeam.

Only LAREM is foreseen

Definition at line 403 of file CaloDepthTool.cxx.

{
  double radius = s_default;
 
  // release 10.0.1 : the analysis is not advanced enough to know what is
  // needed. right now, use the eg parametrisation everywhere possible, entrance
  // elsewere.
  if (sample == CaloCell_ID::PreSamplerB) {
    return egparametrized(sample, eta, phi, caloDD);
  } else if (sample == CaloCell_ID::EMB1) {
    return egparametrized(sample, eta, phi, caloDD);
  } else if (sample == CaloCell_ID::EMB2) {
    return egparametrized(sample, eta, phi, caloDD);
  } else if (sample == CaloCell_ID::EMB3) {
    return egparametrized(sample, eta, phi, caloDD);
  } else {
    return entrance(sample, eta, phi, caloDD);
  }
 
  return radius;
}

TBparametrized() [2/2]

double CaloDepthTool::TBparametrized ( const CaloCell_ID::SUBCALO subcalo, const int sampling_or_module, const bool barrel, const double eta, const double phi, const CaloDetDescrManager * caloDD )

staticprivate

Parametrisation taken from the old egammaqdepth class, but adapted for TestBeam.

Only LAREM is foreseen

Definition at line 389 of file CaloDepthTool.cxx.

{
  CaloCell_ID::CaloSample sample;
  CaloDetDescrManager::build_sample(
    subcalo, barrel, sampling_or_module, sample);
  return TBparametrized(sample, eta, phi, caloDD);
}

updateVHKA()

void AthCommonDataStore< AthCommonMsg< AlgTool > >::updateVHKA ( Gaudi::Details::PropertyBase & )

inlineinherited

Definition at line 308 of file AthCommonDataStore.h.

                                               {
    // debug() << "updateVHKA for property " << p.name() << " " << p.toString() 
    //         << "  size: " << m_vhka.size() << endmsg;
    for (auto &a : m_vhka) {
      std::vector<SG::VarHandleKey*> keys = a->keys();
      for (auto k : keys) {
        k->setOwner(this);
      }
    }
  }

Member Data Documentation

m_calo_id

const CaloCell_ID* CaloDepthTool::m_calo_id

private

ID Helper.

Definition at line 341 of file CaloDepthTool.h.

m_depth_choice

Gaudi::Property<std::string> CaloDepthTool::m_depth_choice { this, "DepthChoice", "", "depth choice" }

private

Depth choice related code User passes a string but we convert to an enum at init to avoid string comparisons.

Definition at line 336 of file CaloDepthTool.h.

{ this, "DepthChoice", "", "depth choice" };

m_depthChoice

DepthChoice CaloDepthTool::m_depthChoice = DepthChoice::entrance

private

Definition at line 338 of file CaloDepthTool.h.

m_detStore

StoreGateSvc_t AthCommonDataStore< AthCommonMsg< AlgTool > >::m_detStore

privateinherited

Pointer to StoreGate (detector store by default)

Definition at line 393 of file AthCommonDataStore.h.

m_evtStore

StoreGateSvc_t AthCommonDataStore< AthCommonMsg< AlgTool > >::m_evtStore

privateinherited

Pointer to StoreGate (event store by default)

Definition at line 390 of file AthCommonDataStore.h.

m_range

CaloPhiRange CaloDepthTool::m_range

private

Phi range helper object.

Definition at line 344 of file CaloDepthTool.h.

m_varHandleArraysDeclared

bool AthCommonDataStore< AthCommonMsg< AlgTool > >::m_varHandleArraysDeclared

privateinherited

Definition at line 399 of file AthCommonDataStore.h.

m_vhka

std::vector<SG::VarHandleKeyArray*> AthCommonDataStore< AthCommonMsg< AlgTool > >::m_vhka

privateinherited

Definition at line 398 of file AthCommonDataStore.h.

---

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

• CaloDepthTool.h
• CaloDepthTool.cxx