ITimedMatEffUpdator.h

Go to the documentation of this file.

/*
  Copyright (C) 2002-2020 CERN for the benefit of the ATLAS collaboration
*/

// IMaterialEffectsUpdator.h, (c) ATLAS Detector software
 
#ifndef TRKEXINTERFACES_ITIMEDMATEFFUPDATOR_H
#define TRKEXINTERFACES_ITIMEDMATEFFUPDATOR_H
 
// Gaudi
#include "GaudiKernel/IAlgTool.h"
// Trk
#include "HelperStructs.h"
#include "TrkDetDescrUtils/GeometrySignature.h"
#include "TrkEventPrimitives/ParticleHypothesis.h"
#include "TrkEventPrimitives/PropDirection.h"
#include "TrkExUtils/MaterialUpdateMode.h"
#include "TrkParameters/TrackParameters.h"
 
#include <memory>
 
namespace Trk {
 
class Layer;
class Material;
class MaterialProperties;
class MaterialEffectsOnTrack;

static const InterfaceID IID_ITimedMatEffUpdator("ITimedMatEffUpdator", 1, 0);

class ITimedMatEffUpdator : virtual public IAlgTool
{
public:
  virtual ~ITimedMatEffUpdator() = default;

  static const InterfaceID& interfaceID() { return IID_ITimedMatEffUpdator; }

  virtual std::unique_ptr<TrackParameters> update(
    const TrackParameters* parm,
    const Layer& sf,
    TimeLimit& time,
    PathLimit& path,
    Trk::GeometrySignature geoID,
    PropDirection dir = alongMomentum,
    ParticleHypothesis particle = pion) const = 0;

  virtual std::unique_ptr<TrackParameters> update(
    double /* time*/,
    const TrackParameters* parm,
    const MaterialEffectsOnTrack&,
    ParticleHypothesis particle = pion,
    MaterialUpdateMode matupmode = addNoise) const
  {
    (void)particle;
    (void)matupmode;
    return parm->uniqueClone();
  }

  virtual std::unique_ptr<TrackParameters> update(
    double time,
    const TrackParameters& parm,
    const MaterialProperties& mprop,
    double pathcorrection,
    PropDirection dir = alongMomentum,
    ParticleHypothesis particle = pion,
    MaterialUpdateMode matupmode = addNoise) const = 0;

  virtual std::unique_ptr<TrackParameters> interact(
    double time,
    const Amg::Vector3D& position,
    const Amg::Vector3D& momentum,
    ParticleHypothesis particle,
    int process,
    const Trk::Material* extMatProp = nullptr) const;

  virtual void recordBremPhoton(double,
                                double, // emitting electron momentum
                                double, // brem photon momentum
                                const Amg::Vector3D&,
                                Amg::Vector3D&,
                                Trk::ParticleHypothesis) const
  {}

  virtual void validationAction() const {}

  virtual void modelAction(const TrackParameters* parm = nullptr) const
  {
    if (parm)
      return;
  }
};
 
} // end of namespace
 
inline std::unique_ptr<Trk::TrackParameters>
Trk::ITimedMatEffUpdator::interact(double,
                                   const Amg::Vector3D&,
                                   const Amg::Vector3D&,
                                   ParticleHypothesis,
                                   int,
                                   const Trk::Material*) const
{
  return nullptr;
}
 
#endif // TRKEXINTERFACES_TIMEDMATEFFUPDATOR_H