Trk::EstimatedBremOnTrack Class Reference

class holding information about momentum reduction and an additional noise term due to significant energy loss (bremsstrahlung) More...

#include <EstimatedBremOnTrack.h>

Inheritance diagram for Trk::EstimatedBremOnTrack:

Collaboration diagram for Trk::EstimatedBremOnTrack:

Public Types
enum	MaterialEffectsDerivedType { ESTIMATED_BREM_ON_TRACK = 0 , MATERIAL_EFFECTS_ON_TRACK , NTYPES }
enum	MaterialEffectsType {   ScatteringEffects = 0 , EnergyLossEffects = 1 , MaterialThickness = 2 , BremPoint = 3 ,   UsesMeasurement = 4 , FittedMaterialEffects = 5 , Unknown = 6 , NumberOfMaterialEffectsTypes = 7 }

Public Member Functions
	EstimatedBremOnTrack ()=default
	default constructor for POOL
	EstimatedBremOnTrack (double thicknessInX0, double retainedEnFraction, double sigmaRetainedEnFraction, double sigmaQoverPsquared, const Surface &sf, const SearchDirection searchDirection=bothway)
	Full constructor.
	EstimatedBremOnTrack (const EstimatedBremOnTrack &ebrot)=default
	Copy constructor.
EstimatedBremOnTrack &	operator= (const EstimatedBremOnTrack &rhs)=default
	Assignment operator.
	EstimatedBremOnTrack (EstimatedBremOnTrack &&ebrot) noexcept=default
	Move constructor.
EstimatedBremOnTrack &	operator= (EstimatedBremOnTrack &&rhs) noexcept=default
	Move Assignment operator.
virtual	~EstimatedBremOnTrack ()=default
	Destructor.
MaterialEffectsBase::MaterialEffectsDerivedType	derivedType () const override final
	actual type
virtual EstimatedBremOnTrack *	clone () const override final
	Virtual constructor.
std::unique_ptr< EstimatedBremOnTrack >	uniqueClone () const
	NVI uniqueClone.
double	retainedEnFraction () const
	returns \( z \)
double	sigmaRetainedEnFraction () const
	return \( \sigma(z) \)
double	sigmaQoverPsquared () const
	returns the additional noise term \( Q=\sigma^2(q/p) \)
SearchDirection	searchDirection () const
	returns if the brem was discovered with a particular search direction
virtual MsgStream &	dump (MsgStream &sl) const override final
	Interface method for output.
virtual std::ostream &	dump (std::ostream &sl) const override final
	Interface method for output.
double	thicknessInX0 () const
	returns the actually traversed material \( t/X_0 \).
const Surface &	associatedSurface () const
	returns the surface to which these m.eff. are associated.
bool	type (const MaterialEffectsType &type) const
	returns the flags (bits) which types of ME are present
std::string	dumpType () const
	returns a string with the type of the object
const Surface *	surfacePtr ()
	return the ptr we hold useful for tests
const Surface *	release () noexcept
	release ala unique_ptr release
void	destroySurface () noexcept
	destroySurface deletes the ptr if not null and the surface has not a associatedDetectorElement Usefull also for testing

Static Public Member Functions
static const Surface *	cloneHelper (const Surface *input)
	Helper for cloning or not when we need depending on if we have an associatedDetectorElement.

Protected Member Functions
virtual void	setValues (const Surface *assocSurface)
	allows POOL converter to recreate transient links to DetStore

Protected Attributes
const Surface *	m_associatedSurface

Private Attributes
double	m_retainedEnFraction { 0.0 }
	\( z \) - the momentum retained after energy loss
double	m_sigmaRetainedEnFraction { 0.0 }
	\( \sigma(z) \) - uncertainty on the momentum retained after Eloss
double	m_sigmaQoverPsquared { 0.0 }
	\( \sigma^2(q/p) \) - the applied straggling on the momentum correction
SearchDirection	m_bremSearchDirection { Trk::undefinedDirection }
	if brem was found in particular direction, outward, inward or global
double	m_tInX0 {}
	\( t/X_0 \) - the traversed thickness in RadiationLengths
long	m_typeFlags {}

Detailed Description

class holding information about momentum reduction and an additional noise term due to significant energy loss (bremsstrahlung)

Author

Wolfgang.Liebig http://consult.cern.ch/xwho/people/

Definition at line 29 of file EstimatedBremOnTrack.h.

Member Enumeration Documentation

MaterialEffectsDerivedType

enum Trk::MaterialEffectsBase::MaterialEffectsDerivedType

inherited

Enumerator
ESTIMATED_BREM_ON_TRACK
MATERIAL_EFFECTS_ON_TRACK
NTYPES

Definition at line 37 of file MaterialEffectsBase.h.

                                 {
    ESTIMATED_BREM_ON_TRACK = 0,
    MATERIAL_EFFECTS_ON_TRACK,
    NTYPES
  };

MaterialEffectsType

enum Trk::MaterialEffectsBase::MaterialEffectsType

inherited

Enumerator
ScatteringEffects	contains material effects due to multiple scattering
EnergyLossEffects	contains energy loss corrections
MaterialThickness	contains only thickness, needs M.E.Updator to calculate effects
BremPoint	contains q/p covariance noise term
UsesMeasurement	contains energy loss correction based on Calo measurement
FittedMaterialEffects	contains values obtained by fitting the scatterer or e-loss
Unknown	new category
NumberOfMaterialEffectsTypes

Definition at line 42 of file MaterialEffectsBase.h.

  {
    ScatteringEffects = 0,
    // trouble: avoid name clash Trk::Energyloss vs MET::EnergyLoss
    EnergyLossEffects = 1,
    MaterialThickness = 2,
    BremPoint = 3,
    UsesMeasurement = 4,
    FittedMaterialEffects = 5,
    Unknown = 6,
    NumberOfMaterialEffectsTypes = 7
    // WARNING need to edit MaterialEffectsOnTrack.cxx if these enums change
  };

Constructor & Destructor Documentation

EstimatedBremOnTrack() [1/4]

Trk::EstimatedBremOnTrack::EstimatedBremOnTrack ( )

default

default constructor for POOL

EstimatedBremOnTrack() [2/4]

Trk::EstimatedBremOnTrack::EstimatedBremOnTrack	(	double	thicknessInX0,
		double	retainedEnFraction,
		double	sigmaRetainedEnFraction,
		double	sigmaQoverPsquared,
		const Surface &	sf,
		const SearchDirection	searchDirection = bothway )

Full constructor.

Parameters

[in]	thicknessInX0	material thickness in terms of rad length, \( t/X_0 \)
[in]	retainedEnFraction	retained energy fraction after brem, \( z \)
[in]	sigmaRetainedEnFraction	error on estimated retained energy fraction, \( \sigma(z) \)
[in]	sigmaQoverPsquared	noise term added to cov matrix momentum parameter, \( \sigma^2(q/p) \)
[in]	sf	tracking surface with which material effects are associated
[in]	searchDirection	for progressive brem recovery or seeded tracks

Definition at line 15 of file EstimatedBremOnTrack.cxx.

  : Trk::MaterialEffectsBase(
      tInX0,
      sf,
      1 << static_cast<int>(Trk::MaterialEffectsBase::BremPoint))
  , m_retainedEnFraction(retainedEnFraction)
  , m_sigmaRetainedEnFraction(sEnFr)
  , m_sigmaQoverPsquared(sQoPs)
  , m_bremSearchDirection(searchDirection)
{}

EstimatedBremOnTrack() [3/4]

Trk::EstimatedBremOnTrack::EstimatedBremOnTrack ( const EstimatedBremOnTrack & ebrot )

default

Copy constructor.

EstimatedBremOnTrack() [4/4]

Trk::EstimatedBremOnTrack::EstimatedBremOnTrack ( EstimatedBremOnTrack && ebrot )

defaultnoexcept

Move constructor.

~EstimatedBremOnTrack()

virtual Trk::EstimatedBremOnTrack::~EstimatedBremOnTrack ( )

virtualdefault

Destructor.

Member Function Documentation

associatedSurface()

const Surface & Trk::MaterialEffectsBase::associatedSurface ( ) const

inherited

returns the surface to which these m.eff. are associated.

clone()

EstimatedBremOnTrack * Trk::EstimatedBremOnTrack::clone ( ) const

inlinefinaloverridevirtual

Virtual constructor.

Implements Trk::MaterialEffectsBase.

Definition at line 109 of file EstimatedBremOnTrack.h.

{
  return new EstimatedBremOnTrack(*this);
}

cloneHelper()

const Surface * Trk::SurfacePtrHolderImplDetEl< Surface >::cloneHelper ( const Surface * input )

inlinestaticinherited

Helper for cloning or not when we need depending on if we have an associatedDetectorElement.

Definition at line 213 of file SurfaceHolderImpl.h.

  {
    return (input && input->associatedDetectorElement() == nullptr
              ? input->clone()
              : input);
  }

derivedType()

MaterialEffectsBase::MaterialEffectsDerivedType Trk::EstimatedBremOnTrack::derivedType ( ) const

inlinefinaloverridevirtual

actual type

Implements Trk::MaterialEffectsBase.

Definition at line 66 of file EstimatedBremOnTrack.h.

                                     {
    return MaterialEffectsBase::ESTIMATED_BREM_ON_TRACK;
  }

destroySurface()

void Trk::SurfacePtrHolderImplDetEl< Surface >::destroySurface ( )

inlinenoexceptinherited

destroySurface deletes the ptr if not null and the surface has not a associatedDetectorElement Usefull also for testing

Definition at line 201 of file SurfaceHolderImpl.h.

  {
    if (m_associatedSurface &&
        m_associatedSurface->associatedDetectorElement() == nullptr) {
      delete m_associatedSurface;
    }
    //
    m_associatedSurface = nullptr;
  }

dump() [1/2]

MsgStream & Trk::EstimatedBremOnTrack::dump ( MsgStream & sl ) const

finaloverridevirtual

Interface method for output.

Reimplemented from Trk::MaterialEffectsBase.

Definition at line 34 of file EstimatedBremOnTrack.cxx.

{
  sl << "EstimatedBremOnTrack based on" << endmsg;
  Trk::MaterialEffectsBase::dump(sl);
  sl << "EstBremOT retained p fraction z: " << retainedEnFraction() << endmsg;
  sl << "EstBremOT sigma(z)             : " << sigmaRetainedEnFraction()
     << endmsg;
  sl << "EstBremOT q/p noise term to cov: " << sigmaQoverPsquared() << endmsg;
  sl << "EstBremOT brem search direction: " << searchDirection() << endmsg;
  return sl;
}

dump() [2/2]

std::ostream & Trk::EstimatedBremOnTrack::dump ( std::ostream & sl ) const

finaloverridevirtual

Interface method for output.

Reimplemented from Trk::MaterialEffectsBase.

Definition at line 47 of file EstimatedBremOnTrack.cxx.

{
  sl << "EstimatedBremOnTrack based on" << std::endl;
  Trk::MaterialEffectsBase::dump(sl);
  sl << "\t EstBremOT retained p fraction z: " << retainedEnFraction()
     << std::endl;
  sl << "\t EstBremOT sigma(z)             : " << sigmaRetainedEnFraction()
     << std::endl;
  sl << "\t EstBremOT q/p noise term to cov: " << sigmaQoverPsquared()
     << std::endl;
  sl << "\t EstBremOT brem search direction: " << searchDirection()
     << std::endl;
  return sl;
}

dumpType()

std::string Trk::MaterialEffectsBase::dumpType ( ) const

inherited

returns a string with the type of the object

Definition at line 16 of file MaterialEffectsBase.cxx.

{
  std::string type;
  for (int i = 0; i < NumberOfMaterialEffectsTypes; ++i) {
    if ((1 << i) & m_typeFlags) {
      switch (i) {
        case Trk::MaterialEffectsBase::ScatteringEffects:
          type += "Scattering ";
          break;
        case Trk::MaterialEffectsBase::EnergyLossEffects:
          type += "EnergyLoss ";
          break;
        case Trk::MaterialEffectsBase::MaterialThickness:
          type += "UpdatorInput ";
          break;
        case Trk::MaterialEffectsBase::BremPoint:
          type += "BremPoint ";
          break;
        case Trk::MaterialEffectsBase::UsesMeasurement:
          type += "UsesMeasurement ";
          break;
        case Trk::MaterialEffectsBase::FittedMaterialEffects:
          type += "FittedMaterialEffects ";
          break;
        default:
          type += "Unknown ";
          break;
      }
    }
  }
  return type;
}

operator=() [1/2]

EstimatedBremOnTrack & Trk::EstimatedBremOnTrack::operator= ( const EstimatedBremOnTrack & rhs )

default

Assignment operator.

operator=() [2/2]

EstimatedBremOnTrack & Trk::EstimatedBremOnTrack::operator= ( EstimatedBremOnTrack && rhs )

defaultnoexcept

Move Assignment operator.

release()

const Surface * Trk::SurfacePtrHolderImplDetEl< Surface >::release ( )

inlinenoexceptinherited

release ala unique_ptr release

Definition at line 192 of file SurfaceHolderImpl.h.

  {
    const S* tmp = m_associatedSurface;
    m_associatedSurface = nullptr;
    return tmp;
  }

retainedEnFraction()

double Trk::EstimatedBremOnTrack::retainedEnFraction ( ) const

inline

returns \( z \)

Definition at line 115 of file EstimatedBremOnTrack.h.

{
  return m_retainedEnFraction;
}

searchDirection()

SearchDirection Trk::EstimatedBremOnTrack::searchDirection ( ) const

inline

returns if the brem was discovered with a particular search direction

Definition at line 133 of file EstimatedBremOnTrack.h.

{
  return m_bremSearchDirection;
}

setValues()

virtual void Trk::MaterialEffectsBase::setValues ( const Surface * assocSurface )

protectedvirtualinherited

allows POOL converter to recreate transient links to DetStore

sigmaQoverPsquared()

double Trk::EstimatedBremOnTrack::sigmaQoverPsquared ( ) const

inline

returns the additional noise term \( Q=\sigma^2(q/p) \)

Definition at line 127 of file EstimatedBremOnTrack.h.

{
  return m_sigmaQoverPsquared;
}

sigmaRetainedEnFraction()

double Trk::EstimatedBremOnTrack::sigmaRetainedEnFraction ( ) const

inline

return \( \sigma(z) \)

Definition at line 121 of file EstimatedBremOnTrack.h.

{
  return m_sigmaRetainedEnFraction;
}

surfacePtr()

const Surface * Trk::SurfacePtrHolderImplDetEl< Surface >::surfacePtr ( )

inlineinherited

return the ptr we hold useful for tests

Definition at line 190 of file SurfaceHolderImpl.h.

{ return m_associatedSurface; }

thicknessInX0()

double Trk::MaterialEffectsBase::thicknessInX0 ( ) const

inherited

returns the actually traversed material \( t/X_0 \).

Leave 0.0 for external ME.

type()

bool Trk::MaterialEffectsBase::type ( const MaterialEffectsType & type ) const

inherited

returns the flags (bits) which types of ME are present

Use this method to find out if the ME is of a certain type: i.e. if ( mefot->type(MaterialEffectsBase::EnergyLoss) { //etc }

Returns

true if the MaterialEffectsBase is of this type

uniqueClone()

std::unique_ptr< EstimatedBremOnTrack > Trk::EstimatedBremOnTrack::uniqueClone ( ) const

inline

NVI uniqueClone.

Definition at line 74 of file EstimatedBremOnTrack.h.

  {
    return std::unique_ptr<EstimatedBremOnTrack>(clone());
  }

Member Data Documentation

m_associatedSurface

const Surface* Trk::SurfacePtrHolderImplDetEl< Surface >::m_associatedSurface

protectedinherited

Definition at line 221 of file SurfaceHolderImpl.h.

m_bremSearchDirection

SearchDirection Trk::EstimatedBremOnTrack::m_bremSearchDirection { Trk::undefinedDirection }

private

if brem was found in particular direction, outward, inward or global

Definition at line 105 of file EstimatedBremOnTrack.h.

{ Trk::undefinedDirection };

m_retainedEnFraction

double Trk::EstimatedBremOnTrack::m_retainedEnFraction { 0.0 }

private

\( z \) - the momentum retained after energy loss

Definition at line 98 of file EstimatedBremOnTrack.h.

{ 0.0 };

m_sigmaQoverPsquared

double Trk::EstimatedBremOnTrack::m_sigmaQoverPsquared { 0.0 }

private

\( \sigma^2(q/p) \) - the applied straggling on the momentum correction

Definition at line 102 of file EstimatedBremOnTrack.h.

{ 0.0 };

m_sigmaRetainedEnFraction

double Trk::EstimatedBremOnTrack::m_sigmaRetainedEnFraction { 0.0 }

private

\( \sigma(z) \) - uncertainty on the momentum retained after Eloss

Definition at line 100 of file EstimatedBremOnTrack.h.

{ 0.0 };

m_tInX0

double Trk::MaterialEffectsBase::m_tInX0 {}

privateinherited

\( t/X_0 \) - the traversed thickness in RadiationLengths

Definition at line 139 of file MaterialEffectsBase.h.

{};

m_typeFlags

long Trk::MaterialEffectsBase::m_typeFlags {}

privateinherited

Definition at line 140 of file MaterialEffectsBase.h.

{};

---

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

• EstimatedBremOnTrack.h
• EstimatedBremOnTrack.cxx