IMaterialEffectsUpdator.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_IMATERIALEFFECTSUPDATOR_H
#define TRKEXINTERFACES_IMATERIALEFFECTSUPDATOR_H
 
// Gaudi
#include "GaudiKernel/IAlgTool.h"
// Trk
#include "TrkEventPrimitives/ParticleHypothesis.h"
#include "TrkEventPrimitives/PropDirection.h"
#include "TrkExUtils/MaterialUpdateMode.h"
#include "TrkParameters/TrackParameters.h"
#include <memory>
 
namespace Trk {
 
class Layer;
class MaterialProperties;
class MaterialEffectsOnTrack;

static const InterfaceID IID_IMaterialEffectsUpdator("IMaterialEffectsUpdator",
                                                     1,
                                                     0);

 
class IMaterialEffectsUpdator : virtual public IAlgTool
{
 
public:
  virtual ~IMaterialEffectsUpdator() {}

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

  class ICache
  {
  public:
    ICache()
      : validationLayer{ nullptr }
      , validationSteps{ 0 }
      , validationPhi{ 0. }
      , validationEta{ 0. }
      , accumulatedElossSigma{ 0. }
    {}
    ~ICache() = default;
    const Trk::Layer* validationLayer{ nullptr };
    int validationSteps{ 0 };   
    double validationPhi{ 0. }; 
    double validationEta{ 0. }; 
    double accumulatedElossSigma{ 0. };
  };

  virtual ICache getCache() const { return {}; }

  virtual std::unique_ptr<TrackParameters> update(
    ICache& icache,
    const TrackParameters* param,
    const Layer& sf,
    PropDirection dir = alongMomentum,
    ParticleHypothesis particle = pion,
    MaterialUpdateMode matupmode = addNoise
  ) const = 0;

  virtual std::unique_ptr<TrackParameters> update(
    ICache& icache,
    const TrackParameters* param,
    const MaterialEffectsOnTrack& meff,
    Trk::ParticleHypothesis particle = pion,
    MaterialUpdateMode matupmode = addNoise
  ) const = 0;

  virtual std::unique_ptr<TrackParameters> preUpdate(
    ICache& icache,
    const TrackParameters* param,
    const Layer& sf,
    PropDirection dir = alongMomentum,
    ParticleHypothesis particle = pion,
    MaterialUpdateMode matupmode = addNoise
  ) const = 0;

  virtual std::unique_ptr<TrackParameters> postUpdate(
    ICache& icache,
    const TrackParameters& param,
    const Layer& sf,
    PropDirection dir = alongMomentum,
    ParticleHypothesis particle = pion,
    MaterialUpdateMode matupmode = addNoise
  ) const = 0;

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

  virtual void validationAction(ICache& icache) const = 0;

  virtual void modelAction(ICache& icache,
                           const TrackParameters* param = nullptr) const = 0;

  virtual std::unique_ptr<TrackParameters> update(
    const TrackParameters* param,
    const Layer& sf,
    PropDirection dir = alongMomentum,
    ParticleHypothesis particle = pion,
    MaterialUpdateMode matupmode = addNoise
  ) const = 0;

  virtual std::unique_ptr<TrackParameters> update(
    const TrackParameters* param,
    const MaterialEffectsOnTrack& meff,
    ParticleHypothesis particle = pion,
    MaterialUpdateMode matupmode = addNoise
  ) const = 0;
  virtual std::unique_ptr<TrackParameters> preUpdate(
    const TrackParameters* param,
    const Layer& sf,
    PropDirection dir = alongMomentum,
    ParticleHypothesis particle = pion,
    MaterialUpdateMode matupmode = addNoise
  ) const = 0;

  virtual std::unique_ptr<TrackParameters> postUpdate(
    const TrackParameters& param,
    const Layer& sf,
    PropDirection dir = alongMomentum,
    ParticleHypothesis particle = pion,
    MaterialUpdateMode matupmode = addNoise
  ) const = 0;

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

  virtual void modelAction(const TrackParameters* param = nullptr) const = 0;
};
 
} // end of namespace
 
#endif // TRKEXINTERFACES_MATERIALEFFECTSUPDATOR_H