StepArrayBM Class Reference

#include <StepArrayBM.h>

Inheritance diagram for StepArrayBM:

Collaboration diagram for StepArrayBM:

Public Member Functions
Constructor
	StepArrayBM (const std::string &name, ISvcLocator *svc)
virtual	~StepArrayBM ()
AthService methods
virtual StatusCode	initialize () override final

IBeamIntensity methods
unsigned int	m_maxBunchCrossingPerOrbit
	max bunch crossings per orbit
Gaudi::Hive::ContextSpecificData< unsigned int >	m_t0Offset
	offset of the t0 wrto our intensity pattern
Gaudi::Hive::ContextSpecificData< unsigned int >	m_signalOffset
	offset of the current xing wrto the signal pattern
Gaudi::Property< std::vector< float > >	m_intensityPatternProp
	user-defined intensity pattern
Gaudi::Property< std::vector< float > >	m_signalPatternProp
	user-defined signal pattern - non zero numbers means "Do Signal"
unsigned int	m_ipLength
	length of the intensity pattern
unsigned int	m_spLength
	length of the signal pattern
double *	m_intensityPattern
	normalized intensity pattern. C array to make clhep RandGeneral happy
bool *	m_signalPattern
	locally stored siganlPattern
float	m_largestElementInPattern
	The largest value in the pattern assuming that the pattern has mean value 1.0.
virtual float	normFactor (int iXing) const override final
virtual float	largestElementInPattern () const override final
virtual void	selectT0 (unsigned int run, unsigned long long event) override final
virtual unsigned int	getCurrentT0BunchCrossing () const override final
virtual unsigned int	getBeamPatternLength () const override final

Detailed Description

Definition at line 25 of file StepArrayBM.h.

Constructor & Destructor Documentation

StepArrayBM()

StepArrayBM::StepArrayBM	(	const std::string &	name,
		ISvcLocator *	svc )

Definition at line 12 of file StepArrayBM.cxx.

  : base_class(name,svc)
  , m_maxBunchCrossingPerOrbit(3564)
  , m_t0Offset(0)
  , m_signalOffset(0)
  , m_intensityPatternProp()
  , m_signalPatternProp()
  , m_ipLength(1)
  , m_spLength(1)
  , m_intensityPattern(new double[m_ipLength])
  , m_signalPattern(new bool[m_spLength])
  , m_largestElementInPattern(1.0)
{
  declareProperty("MaxBunchCrossingPerOrbit", m_maxBunchCrossingPerOrbit, "The number of slots in each LHC beam. Default: 3564.");
  declareProperty("IntensityPattern", m_intensityPatternProp,
                  "An array of floats containing the beam intensity distribution as a function of time in bins of 25ns. ArrayBM normalizes the distribution and uses it as a stencil to determine the relative intensity at each beam xing in the simulated range"
                  );
  declareProperty("SignalPattern", m_signalPatternProp, "An array of booleans to complement the IntensityPattern to indicate where the signal event should happen (i.e. which events to actually simulate). Default behaviour is to do EVERY bunch crossing."
                  );
  m_intensityPattern[0]=1.0;
  m_signalPattern[0]=true;
}

~StepArrayBM()

StepArrayBM::~StepArrayBM ( )

virtual

Definition at line 35 of file StepArrayBM.cxx.

{
  delete [] m_intensityPattern;
  delete [] m_signalPattern;
}

Member Function Documentation

getBeamPatternLength()

virtual unsigned int StepArrayBM::getBeamPatternLength ( ) const

inlinefinaloverridevirtual

Definition at line 52 of file StepArrayBM.h.

{ return m_ipLength; }

getCurrentT0BunchCrossing()

virtual unsigned int StepArrayBM::getCurrentT0BunchCrossing ( ) const

inlinefinaloverridevirtual

Definition at line 51 of file StepArrayBM.h.

{ return m_t0Offset; }

initialize()

StatusCode StepArrayBM::initialize ( )

finaloverridevirtual

Definition at line 41 of file StepArrayBM.cxx.

{
  const std::vector<float>& rProp(m_intensityPatternProp.value());
  const std::vector<float>& sProp(m_signalPatternProp.value());
  std::vector<float>::const_iterator pBegin(rProp.begin());
  std::vector<float>::const_iterator pEnd(rProp.end());
  m_ipLength = rProp.size();
  //Consistency checks
  if (m_ipLength>m_maxBunchCrossingPerOrbit)
    {
      ATH_MSG_ERROR("IntensityPattern length (" << m_ipLength << "), exceeds the maximum number of bunch crossings per orbit (" << m_maxBunchCrossingPerOrbit << ").");
      return StatusCode::FAILURE;
    }
 
  // Normalise the pattern so that the non-zero elements average to 1.0
  float nonZeroElementCount(static_cast<float>(std::count_if(pBegin, pEnd, IsNonZero)));
  if(nonZeroElementCount<1.0)
    {
      ATH_MSG_ERROR("IntensityPattern has no non-zero elements!");
      return StatusCode::FAILURE;
    }
  float elementSum(static_cast<float>(std::accumulate(pBegin, pEnd,0.0)));
  float denominator(elementSum/nonZeroElementCount);
 
  // Normalise the pattern so that the highest element value is 1.0
  float maxElement(*(std::max_element(pBegin, pEnd)));
  float inv_maxElement = maxElement != 0 ? 1. / maxElement : 1;
 
  //copy normalized intensity pattern from the property, and match signal pattern if requested
  delete [] m_intensityPattern;
  m_intensityPattern = new double[m_ipLength];
 
  for (unsigned int i(0); i<m_ipLength; ++i)
    {
      if (rProp[i]<0.0)
        {
          ATH_MSG_ERROR("All IntensityPattern elements must be >=0. Please fix element #" << i );
          return StatusCode::FAILURE;
        }
      m_intensityPattern[i] = rProp[i] * inv_maxElement;
    }
 
  // Will be used to convert values in the m_intensityPattern
  // from having max value 1.0 to having mean value 1.0
  if (denominator != 0) {
    m_largestElementInPattern = (maxElement/denominator);
  }
 
  //FIXME add a check that entry 0 is zero? In data, BCID=1 is always the first filled bunch.
 
  //get the signal pattern from the property
  m_spLength = sProp.size();
  delete [] m_signalPattern;
  m_signalPattern = new bool[m_spLength];
  bool isOk=false;
  for (unsigned int i(0); i<m_spLength; ++i)
    {
      m_signalPattern[i] = (sProp[i]>0.0);
      if(m_signalPattern[i]) { isOk=true; }
    }
  if(!isOk)
    {
      ATH_MSG_ERROR("SignalPattern MUST have at least one non-zero value in it.");
      return StatusCode::FAILURE;
    }
 
  //start the t0Offset and signalOffset at the LAST entry in the arrays, so that the first event is for the FIRST entry in the arrays
  m_t0Offset = m_ipLength-1;
  m_signalOffset = m_spLength-1;
 
  return StatusCode::SUCCESS;
}

largestElementInPattern()

virtual float StepArrayBM::largestElementInPattern ( ) const

inlinefinaloverridevirtual

Definition at line 49 of file StepArrayBM.h.

{ return m_largestElementInPattern; }

normFactor()

virtual float StepArrayBM::normFactor ( int iXing ) const

inlinefinaloverridevirtual

Definition at line 39 of file StepArrayBM.h.

  {
    unsigned int index = static_cast<unsigned int>((((iXing + static_cast<int>(m_t0Offset)) % static_cast<int>(m_ipLength)) + static_cast<int>(m_ipLength) )  % static_cast<int>(m_ipLength));
    //The array itself has max-value 1.0, but we want it to have mean value 1.0 (for filled bunch crossings), so we multiple by the m_largestElementInPattern.
    ATH_MSG_VERBOSE("normFactor for BCID " << iXing
                    << " (offset " << m_t0Offset
                    << " index " << index
                    << ") is = " <<  m_largestElementInPattern*m_intensityPattern[ index ]);
    return m_largestElementInPattern*m_intensityPattern[ index ];
  }

selectT0()

void StepArrayBM::selectT0 ( unsigned int run, unsigned long long event )

finaloverridevirtual

Definition at line 114 of file StepArrayBM.cxx.

{
  //move to the next xing as dictated by the signalPattern, for each incremember, shift the t0Offset
  do {
    m_signalOffset = (m_signalOffset+1) % m_spLength;
    m_t0Offset = (unsigned int)((m_t0Offset+1) % m_ipLength);
  } while(!m_signalPattern[m_signalOffset]);
 
 
  //assert(m_intensityPattern[m_t0Offset % m_ipLength]>0.0); //commented out to allow events with no intensity
 
  ATH_MSG_DEBUG( "selectT0 offset for this event " << m_t0Offset );
}

Member Data Documentation

m_intensityPattern

double* StepArrayBM::m_intensityPattern

private

normalized intensity pattern. C array to make clhep RandGeneral happy

Definition at line 70 of file StepArrayBM.h.

m_intensityPatternProp

Gaudi::Property<std::vector<float> > StepArrayBM::m_intensityPatternProp

private

user-defined intensity pattern

Definition at line 62 of file StepArrayBM.h.

m_ipLength

unsigned int StepArrayBM::m_ipLength

private

length of the intensity pattern

Definition at line 66 of file StepArrayBM.h.

m_largestElementInPattern

float StepArrayBM::m_largestElementInPattern

private

The largest value in the pattern assuming that the pattern has mean value 1.0.

Multiplying by this converts values in the m_intensityPattern from having max value 1.0 to having mean value 1.0.

Definition at line 77 of file StepArrayBM.h.

m_maxBunchCrossingPerOrbit

unsigned int StepArrayBM::m_maxBunchCrossingPerOrbit

private

max bunch crossings per orbit

Definition at line 56 of file StepArrayBM.h.

m_signalOffset

Gaudi::Hive::ContextSpecificData<unsigned int> StepArrayBM::m_signalOffset

private

offset of the current xing wrto the signal pattern

Definition at line 60 of file StepArrayBM.h.

m_signalPattern

bool* StepArrayBM::m_signalPattern

private

locally stored siganlPattern

Definition at line 72 of file StepArrayBM.h.

m_signalPatternProp

Gaudi::Property<std::vector<float> > StepArrayBM::m_signalPatternProp

private

user-defined signal pattern - non zero numbers means "Do Signal"

Definition at line 64 of file StepArrayBM.h.

m_spLength

unsigned int StepArrayBM::m_spLength

private

length of the signal pattern

Definition at line 68 of file StepArrayBM.h.

m_t0Offset

Gaudi::Hive::ContextSpecificData<unsigned int> StepArrayBM::m_t0Offset

private

offset of the t0 wrto our intensity pattern

Definition at line 58 of file StepArrayBM.h.

---

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

• StepArrayBM.h
• StepArrayBM.cxx