d4/d67/IBeamIntensity_8h_source.html

/* -*- C++ -*- */


/*

  Copyright (C) 2002-2026 CERN for the benefit of the ATLAS collaboration

*/


#ifndef PILEUPTOOLS_IBEAMINTENSITY_H

#define PILEUPTOOLS_IBEAMINTENSITY_H


#include "GaudiKernel/IService.h"


class EventContext;


class IBeamIntensity : virtual public IService {

public:

  virtual float normFactor(int bunchXing) const = 0;


  virtual float largestElementInPattern() const = 0;


  virtual void selectT0(const EventContext& ctx) =0;


  virtual unsigned int getCurrentT0BunchCrossing() const =0;


  virtual unsigned int getBeamPatternLength() const =0;


  DeclareInterfaceID(IBeamIntensity, 1, 0 );

};


#endif // PILEUPTOOLS_IBEAMINTENSITY_H

IBeamIntensity
Definition IBeamIntensity.h:19

IBeamIntensity::getCurrentT0BunchCrossing
virtual unsigned int getCurrentT0BunchCrossing() const =0
return the bunch crossing selected to be the current t0 bunch crossing

IBeamIntensity::DeclareInterfaceID
DeclareInterfaceID(IBeamIntensity, 1, 0)
Creates the InterfaceID and interfaceID() method.

IBeamIntensity::selectT0
virtual void selectT0(const EventContext &ctx)=0
randomly select in which bunch the current t0 is wrto the beam intensity distribution.

IBeamIntensity::getBeamPatternLength
virtual unsigned int getBeamPatternLength() const =0
return the length of the beam pattern

IBeamIntensity::largestElementInPattern
virtual float largestElementInPattern() const =0
the largest element in the beam intensity pattern.

IBeamIntensity::normFactor
virtual float normFactor(int bunchXing) const =0
a scale factor (average value 1.0) for the beam intensity at a given xing.