EcalTimeMapDigitizer Class Reference

#include <EcalTimeMapDigitizer.h>

Classes
struct	time_average

Public Types
typedef EcalTimeDigi	Digi
typedef time_average	TimeSamples
typedef std::vector< unsigned int >	VecInd

Public Member Functions
void	add (const std::vector< PCaloHit > &hits, int bunchCrossing)
void	blankOutUsedSamples ()
	EcalTimeMapDigitizer (EcalSubdetector myDet, ComponentShapeCollection *componentShapes)
void	finalizeHits ()
int	getTimeLayerId ()
void	initializeMap ()
int	maxBunch () const
int	minBunch () const
void	run (EcalTimeDigiCollection &output)
void	setEventSetup (const edm::EventSetup &eventSetup)
void	setGeometry (const CaloSubdetectorGeometry *geometry)
void	setTimeLayerId (const int &layerId)
EcalSubdetector	subdetector ()
virtual	~EcalTimeMapDigitizer ()

Private Member Functions
TimeSamples *	findSignal (const DetId &detId)
VecInd &	index ()
const VecInd &	index () const
const TimeSamples *	operator[] (unsigned int i) const
TimeSamples *	operator[] (unsigned int i)
unsigned int	samplesSize () const
unsigned int	samplesSizeAll () const
const ComponentShapeCollection *	shapes () const
double	timeOfFlight (const DetId &detId, int layer) const
TimeSamples *	vSam (unsigned int i)
TimeSamples *	vSamAll (unsigned int i)
const TimeSamples *	vSamAll (unsigned int i) const

Private Attributes
ComponentShapeCollection *	m_ComponentShapes
const CaloSubdetectorGeometry *	m_geometry
VecInd	m_index
EcalSubdetector	m_subDet
int	m_timeLayerId
std::vector< TimeSamples >	m_vSam

Static Private Attributes
static const int	BUNCHSPACE = 25
static const int	m_maxBunch = 5
static const int	m_minBunch = -4
static const float	MIN_ENERGY_THRESHOLD

Detailed Description

Definition at line 20 of file EcalTimeMapDigitizer.h.

Member Typedef Documentation

Digi

typedef EcalTimeDigi EcalTimeMapDigitizer::Digi

Definition at line 75 of file EcalTimeMapDigitizer.h.

TimeSamples

typedef time_average EcalTimeMapDigitizer::TimeSamples

Definition at line 73 of file EcalTimeMapDigitizer.h.

VecInd

typedef std::vector<unsigned int> EcalTimeMapDigitizer::VecInd

Definition at line 77 of file EcalTimeMapDigitizer.h.

Constructor & Destructor Documentation

EcalTimeMapDigitizer()

EcalTimeMapDigitizer::EcalTimeMapDigitizer ( EcalSubdetector  myDet, ComponentShapeCollection *  componentShapes  )

explicit

Definition at line 29 of file EcalTimeMapDigitizer.cc.

References cms::cuda::assert(), gather_cfg::cout, EBDetId::detIdFromDenseIndex(), EEDetId::detIdFromDenseIndex(), EcalBarrel, EcalEndcap, mps_fire::i, EBDetId::kSizeForDenseIndexing, EEDetId::kSizeForDenseIndexing, m_index, m_maxBunch, m_minBunch, m_subDet, m_vSam, and findQualityFiles::size.

    : m_subDet(myDet), m_ComponentShapes(componentShapes), m_geometry(nullptr) {
  //    edm::Service<edm::RandomNumberGenerator> rng ;
  //    if ( !rng.isAvailable() )
  //    {
  //       throw cms::Exception("Configuration")
  //     << "EcalTimeMapDigitizer requires the RandomNumberGeneratorService\n"
  //     "which is not present in the configuration file.  You must add the service\n"
  //     "in the configuration file or remove the modules that require it.";
  //    }
  //    m_RandPoisson = new CLHEP::RandPoissonQ( rng->getEngine() ) ;
  //    m_RandGauss   = new CLHEP::RandGaussQ(   rng->getEngine() ) ;

  unsigned int size = 0;

  //Initialize the map
  if (myDet == EcalBarrel) {
    size = EBDetId::kSizeForDenseIndexing;
  } else if (myDet == EcalEndcap) {
    size = EEDetId::kSizeForDenseIndexing;
  } else
    edm::LogError("TimeDigiError") << "[EcalTimeMapDigitizer]::ERROR::This subdetector " << myDet
                                   << " is not implemented";

  assert(m_maxBunch - m_minBunch + 1 <= 10);
  assert(m_minBunch <= 0);

  m_vSam.reserve(size);
  m_index.reserve(size);

  for (unsigned int i(0); i != size; ++i) {
    //       m_vSam.emplace_back(CaloGenericDetId( detId.det(), detId.subdetId(), i ) ,
    //            m_maxBunch-m_minBunch+1, abs(m_minBunch) );
    if (myDet == EcalBarrel) {
      m_vSam.push_back(TimeSamples((DetId)(EBDetId::detIdFromDenseIndex(i))));
    } else {
      m_vSam.push_back(TimeSamples((DetId)(EEDetId::detIdFromDenseIndex(i))));
    }
  }

  edm::LogInfo("TimeDigiInfo") << "[EcalTimeDigitizer]::Subdetector " << m_subDet << "::Reserved size for time digis "
                               << m_vSam.size();

#ifdef ecal_time_debug
  std::cout << "[EcalTimeDigitizer]::Subdetector " << m_subDet << "::Reserved size for time digis " << m_vSam.size()
            << std::endl;
#endif
}

~EcalTimeMapDigitizer()

EcalTimeMapDigitizer::~EcalTimeMapDigitizer ( )

virtual

Definition at line 78 of file EcalTimeMapDigitizer.cc.

{}

Member Function Documentation

add()

void EcalTimeMapDigitizer::add	(	const std::vector< PCaloHit > &	hits,
		int	bunchCrossing
	)

Definition at line 80 of file EcalTimeMapDigitizer.cc.

References ComponentShapeCollection::at(), newFWLiteAna::bin, gather_cfg::cout, hcalRecHitTable_cff::detId, findSignal(), hfClusterShapes_cfi::hits, edm::isNotFinite(), ALPAKA_ACCELERATOR_NAMESPACE::vertexFinder::it, m_ComponentShapes, m_maxBunch, m_minBunch, m_timeLayerId, ComponentShapeCollection::maxDepthBin(), MIN_ENERGY_THRESHOLD, mps_fire::result, shapes(), hcalRecHitTable_cff::time, timeOfFlight(), and ComponentShapeCollection::toDepthBin().

Referenced by EcalTimeDigiProducer::accumulateCaloHits(), and counter.Counter::register().

                                                                                 {
  if (bunchCrossing >= m_minBunch && bunchCrossing <= m_maxBunch) {
    for (std::vector<PCaloHit>::const_iterator it = hits.begin(), itEnd = hits.end(); it != itEnd; ++it) {
      //here goes the map logic

      if (edm::isNotFinite((*it).time()))
        continue;

      if ((*it).energy() < MIN_ENERGY_THRESHOLD)  //apply a minimal cut on the hit energy
        continue;

      //Old behavior: Just consider only the hits belonging to the specified time layer
      //int depth2 = (((*it).depth() >> PCaloHit::kEcalDepthOffset) & PCaloHit::kEcalDepthMask);
      //I think things make more sense if we allow all depths -- JCH

      const DetId detId((*it).id());

      double time = (*it).time();

      //time of flight is not corrected here for the vertex position
      const double jitter(time - timeOfFlight(detId, m_timeLayerId));

      TimeSamples& result(*findSignal(detId));

      if (nullptr != m_ComponentShapes) {
        // for now we have waveform_granularity = 1., 10 BX, and waveform capacity 250 -- we want to start at 25*bunchCrossing and go to the end of waveform capacity
        double binTime(0);
        for (unsigned int bin(0); bin != result.waveform_capacity; ++bin) {
          if (ComponentShapeCollection::toDepthBin((*it).depth()) <= ComponentShapeCollection::maxDepthBin()) {
            result.waveform[bin] +=
                (*(shapes()->at((*it).depth())))(binTime - jitter - 25 * (bunchCrossing - m_minBunch)) * (*it).energy();
          }
#ifdef waveform_debug
          else {
            std::cout << "strange depth found: " << ComponentShapeCollection::toDepthBin((*it).depth()) << std::endl;
          }  // note: understand what these depths mean
#endif
          binTime += result.waveform_granularity;
        }
      }

      //here fill the result for the given bunch crossing

      // i think this is obsolete now that there is a real MTD
      //if (depth2 != m_timeLayerId)
      //  continue;
      result.average_time[bunchCrossing - m_minBunch] += jitter * (*it).energy();
      result.tot_energy[bunchCrossing - m_minBunch] += (*it).energy();
      result.nhits[bunchCrossing - m_minBunch]++;

#ifdef ecal_time_debug
      std::cout << (*it).id() << "\t" << (*it).depth() << "\t" << jitter << "\t" << (*it).energy() << "\t"
                << result.average_time[bunchCrossing - m_minBunch] << "\t" << result.nhits[bunchCrossing - m_minBunch]
                << "\t" << timeOfFlight(detId, m_timeLayerId) << std::endl;
#endif
    }
  }
}

blankOutUsedSamples()

void EcalTimeMapDigitizer::blankOutUsedSamples

(

)

Definition at line 149 of file EcalTimeMapDigitizer.cc.

References gather_cfg::cout, mps_fire::i, m_index, EcalTimeMapDigitizer::time_average::setZero(), findQualityFiles::size, and vSamAll().

Referenced by initializeMap().

{
  const unsigned int size(m_index.size());

  for (unsigned int i(0); i != size; ++i) {
#ifdef ecal_time_debug
    std::cout << "Zeroing " << m_index[i] << std::endl;
#endif
    vSamAll(m_index[i])->setZero();
  }

  m_index.clear();  // done and make ready to start over
}

finalizeHits()

void EcalTimeMapDigitizer::finalizeHits

(

)

Definition at line 163 of file EcalTimeMapDigitizer.cc.

References EcalTimeMapDigitizer::time_average::average_time, EcalTimeMapDigitizer::time_average::calculateAverage(), gather_cfg::cout, mps_fire::i, dqmiolumiharvest::j, m_index, EcalTimeMapDigitizer::time_average::nhits, findQualityFiles::size, EcalTimeMapDigitizer::time_average::time_average_capacity, EcalTimeMapDigitizer::time_average::tot_energy, and vSamAll().

Referenced by run().

                                        {
  //Getting the size from the actual hits
  const unsigned int size(m_index.size());

  //Here just averaging the MC truth
  for (unsigned int i(0); i != size; ++i) {
#ifdef ecal_time_debug
    std::cout << "Averaging " << m_index[i] << std::endl;
#endif
    vSamAll(m_index[i])->calculateAverage();
#ifdef ecal_time_debug
    for (unsigned int j(0); j != vSamAll(m_index[i])->time_average_capacity; ++j)
      std::cout << j << "\t" << vSamAll(m_index[i])->average_time[j] << "\t" << vSamAll(m_index[i])->nhits[j] << "\t"
                << vSamAll(m_index[i])->tot_energy[j] << std::endl;
#endif
  }

  //Noise can be added here
}

findSignal()

EcalTimeMapDigitizer::TimeSamples * EcalTimeMapDigitizer::findSignal ( const DetId &  detId )

private

Definition at line 139 of file EcalTimeMapDigitizer.cc.

References hcalRecHitTable_cff::detId, m_index, mps_fire::result, and vSamAll().

Referenced by add().

                                                                                    {
  const unsigned int di(CaloGenericDetId(detId).denseIndex());
  TimeSamples* result(vSamAll(di));
  if (result->zero())
    m_index.push_back(di);
  return result;
}

getTimeLayerId()

int EcalTimeMapDigitizer::getTimeLayerId ( )

inline

Definition at line 97 of file EcalTimeMapDigitizer.h.

References m_timeLayerId.

{ return m_timeLayerId; };

index() [1/2]

EcalTimeMapDigitizer::VecInd & EcalTimeMapDigitizer::index ( )

private

Definition at line 290 of file EcalTimeMapDigitizer.cc.

References m_index.

{ return m_index; }

index() [2/2]

const EcalTimeMapDigitizer::VecInd & EcalTimeMapDigitizer::index ( ) const

private

Definition at line 292 of file EcalTimeMapDigitizer.cc.

References m_index.

{ return m_index; }

initializeMap()

void EcalTimeMapDigitizer::initializeMap

(

)

Definition at line 183 of file EcalTimeMapDigitizer.cc.

References blankOutUsedSamples(), and gather_cfg::cout.

Referenced by EcalTimeDigiProducer::initializeEvent().

                                         {
#ifdef ecal_time_debug
  std::cout << "[EcalTimeMapDigitizer]::Zeroing the used samples" << std::endl;
#endif
  blankOutUsedSamples();
}

maxBunch()

int EcalTimeMapDigitizer::maxBunch

(

)

const

Definition at line 288 of file EcalTimeMapDigitizer.cc.

References m_maxBunch.

{ return m_maxBunch; }

minBunch()

int EcalTimeMapDigitizer::minBunch

(

)

const

Definition at line 286 of file EcalTimeMapDigitizer.cc.

References m_minBunch.

{ return m_minBunch; }

operator[]() [1/2]

const EcalTimeMapDigitizer::TimeSamples * EcalTimeMapDigitizer::operator[] ( unsigned int  i ) const

private

Definition at line 276 of file EcalTimeMapDigitizer.cc.

References mps_fire::i, and m_vSam.

{ return &m_vSam[i]; }

operator[]() [2/2]

EcalTimeMapDigitizer::TimeSamples * EcalTimeMapDigitizer::operator[] ( unsigned int  i )

private

Definition at line 278 of file EcalTimeMapDigitizer.cc.

References mps_fire::i, and m_vSam.

{ return &m_vSam[i]; }

run()

void EcalTimeMapDigitizer::run

(

EcalTimeDigiCollection &

output

)

Definition at line 201 of file EcalTimeMapDigitizer.cc.

References EcalTimeMapDigitizer::time_average::average_time, gather_cfg::cout, finalizeHits(), mps_fire::i, dqmiolumiharvest::j, m_ComponentShapes, m_index, m_minBunch, nhits, EcalTimeMapDigitizer::time_average::time_average_capacity, and vSamAll().

Referenced by EcalTimeDigiProducer::finalizeEvent().

                                                             {
#ifdef ecal_time_debug
  std::cout << "[EcalTimeMapDigitizer]::Finalizing hits and fill output collection" << std::endl;
#endif

  //Do the time averages and add noise if simulated
  finalizeHits();

  //Until we do now simulated noise we can get the size from the index vector
  const unsigned int ssize(m_index.size());

  output.reserve(ssize);

  for (unsigned int i(0); i != ssize; ++i) {
#ifdef ecal_time_debug
    std::cout << "----- in digi loop " << i << std::endl;
#endif

    output.push_back(Digi(vSamAll(m_index[i])->id));
    if (nullptr != m_ComponentShapes)
      output.back().setWaveform(vSamAll(m_index[i])->waveform);

    unsigned int nTimeHits = 0;
    unsigned int nTimeHitsMax = vSamAll(m_index[i])->time_average_capacity;
    float timeHits[nTimeHitsMax];
    unsigned int timeBX[nTimeHitsMax];

    for (unsigned int j(0); j != nTimeHitsMax; ++j)  //here sampling on the OOTPU
    {
      if (vSamAll(m_index[i])->nhits[j] > 0) {
        timeHits[nTimeHits] = vSamAll(m_index[i])->average_time[j];
        timeBX[nTimeHits] = m_minBunch + j;
        nTimeHits++;
      }
    }

    output.back().setSize(nTimeHits);

    for (unsigned int j(0); j != nTimeHits; ++j)  //filling the !zero hits
    {
      output.back().setSample(j, timeHits[j]);
      if (timeBX[j] == 0) {
#ifdef ecal_time_debug
        std::cout << "setting interesting sample " << j << std::endl;
#endif
        output.back().setSampleOfInterest(j);
      }
    }

#ifdef ecal_time_debug
    std::cout << "digi " << output.back().id().rawId() << "\t" << output.back().size();
    if (output.back().sampleOfInterest() > 0)
      std::cout << "\tBX0 time " << output.back().sample(output.back().sampleOfInterest()) << std::endl;
    else
      std::cout << "\tNo in time hits" << std::endl;
#endif
  }
#ifdef ecal_time_debug
  std::cout << "[EcalTimeMapDigitizer]::Output collection size " << output.size() << std::endl;
#endif
}

samplesSize()

unsigned int EcalTimeMapDigitizer::samplesSize ( ) const

private

Definition at line 272 of file EcalTimeMapDigitizer.cc.

References m_vSam.

{ return m_vSam.size(); }

samplesSizeAll()

unsigned int EcalTimeMapDigitizer::samplesSizeAll ( ) const

private

Definition at line 274 of file EcalTimeMapDigitizer.cc.

References m_vSam.

{ return m_vSam.size(); }

setEventSetup()

void EcalTimeMapDigitizer::setEventSetup

(

const edm::EventSetup &

eventSetup

)

Definition at line 190 of file EcalTimeMapDigitizer.cc.

References options_cfi::eventSetup, Exception, m_ComponentShapes, and ComponentShapeCollection::setEventSetup().

Referenced by EcalTimeDigiProducer::accumulate(), and EcalTimeDigiProducer::initializeEvent().

                                                                        {
  if (nullptr != m_ComponentShapes)
    m_ComponentShapes->setEventSetup(eventSetup);
  else
    throw cms::Exception(
        "[EcalTimeMapDigitizer] setEventSetup was called, but this should only be called when componentWaveform is "
        "activated by cfg parameter");
}

setGeometry()

void EcalTimeMapDigitizer::setGeometry

(

const CaloSubdetectorGeometry *

geometry

)

Definition at line 147 of file EcalTimeMapDigitizer.cc.

References relativeConstraints::geometry, and m_geometry.

Referenced by EcalTimeDigiProducer::updateGeometry().

{ m_geometry = geometry; }

setTimeLayerId()

void EcalTimeMapDigitizer::setTimeLayerId ( const int &  layerId )

inline

Definition at line 95 of file EcalTimeMapDigitizer.h.

References m_timeLayerId.

Referenced by EcalTimeDigiProducer::EcalTimeDigiProducer().

{ m_timeLayerId = layerId; };

shapes()

const ComponentShapeCollection * EcalTimeMapDigitizer::shapes ( ) const

private

Definition at line 199 of file EcalTimeMapDigitizer.cc.

References m_ComponentShapes.

Referenced by add().

{ return m_ComponentShapes; }

subdetector()

EcalSubdetector EcalTimeMapDigitizer::subdetector ( )

inline

Definition at line 99 of file EcalTimeMapDigitizer.h.

References m_subDet.

{ return m_subDet; };

timeOfFlight()

double EcalTimeMapDigitizer::timeOfFlight ( const DetId &  detId, int  layer  ) const

private

Definition at line 263 of file EcalTimeMapDigitizer.cc.

References cms::cuda::assert(), hcalRecHitTable_cff::detId, CaloSubdetectorGeometry::getGeometry(), m_geometry, and PV3DBase< T, PVType, FrameType >::mag().

Referenced by add().

                                                                             {
  //not using the layer yet
  auto cellGeometry(m_geometry->getGeometry(detId));
  assert(nullptr != cellGeometry);
  GlobalPoint layerPos = (cellGeometry)->getPosition();
  //(cellGeometry)->getPosition(double(layer) + 0.5);  //depth in mm in the middle of the layer position // JCH : I am not sure this is doing what it's supposed to, probably unimplemented since CaloCellGeometry returns the same value regardless of this double
  return layerPos.mag() * cm / c_light;
}

vSam()

EcalTimeMapDigitizer::TimeSamples * EcalTimeMapDigitizer::vSam ( unsigned int  i )

private

Definition at line 280 of file EcalTimeMapDigitizer.cc.

References mps_fire::i, and m_vSam.

{ return &m_vSam[i]; }

vSamAll() [1/2]

EcalTimeMapDigitizer::TimeSamples * EcalTimeMapDigitizer::vSamAll ( unsigned int  i )

private

Definition at line 282 of file EcalTimeMapDigitizer.cc.

References mps_fire::i, and m_vSam.

Referenced by blankOutUsedSamples(), finalizeHits(), findSignal(), and run().

{ return &m_vSam[i]; }

vSamAll() [2/2]

const EcalTimeMapDigitizer::TimeSamples * EcalTimeMapDigitizer::vSamAll ( unsigned int  i ) const

private

Definition at line 284 of file EcalTimeMapDigitizer.cc.

References mps_fire::i, and m_vSam.

{ return &m_vSam[i]; }

Member Data Documentation

BUNCHSPACE

const int EcalTimeMapDigitizer::BUNCHSPACE = 25

staticprivate

Definition at line 133 of file EcalTimeMapDigitizer.h.

m_ComponentShapes

ComponentShapeCollection* EcalTimeMapDigitizer::m_ComponentShapes

private

Definition at line 142 of file EcalTimeMapDigitizer.h.

Referenced by add(), run(), setEventSetup(), and shapes().

m_geometry

const CaloSubdetectorGeometry* EcalTimeMapDigitizer::m_geometry

private

Definition at line 144 of file EcalTimeMapDigitizer.h.

Referenced by setGeometry(), and timeOfFlight().

m_index

VecInd EcalTimeMapDigitizer::m_index

private

Definition at line 152 of file EcalTimeMapDigitizer.h.

Referenced by blankOutUsedSamples(), EcalTimeMapDigitizer(), finalizeHits(), findSignal(), index(), and run().

m_maxBunch

const int EcalTimeMapDigitizer::m_maxBunch = 5

staticprivate

Definition at line 138 of file EcalTimeMapDigitizer.h.

Referenced by add(), EcalTimeMapDigitizer(), and maxBunch().

m_minBunch

const int EcalTimeMapDigitizer::m_minBunch = -4

staticprivate

Definition at line 137 of file EcalTimeMapDigitizer.h.

Referenced by add(), EcalTimeMapDigitizer(), minBunch(), and run().

m_subDet

EcalSubdetector EcalTimeMapDigitizer::m_subDet

private

Definition at line 130 of file EcalTimeMapDigitizer.h.

Referenced by EcalTimeMapDigitizer(), and subdetector().

m_timeLayerId

int EcalTimeMapDigitizer::m_timeLayerId

private

Definition at line 140 of file EcalTimeMapDigitizer.h.

Referenced by add(), getTimeLayerId(), and setTimeLayerId().

m_vSam

std::vector<TimeSamples> EcalTimeMapDigitizer::m_vSam

private

Definition at line 150 of file EcalTimeMapDigitizer.h.

Referenced by EcalTimeMapDigitizer(), operator[](), samplesSize(), samplesSizeAll(), vSam(), and vSamAll().

MIN_ENERGY_THRESHOLD

const float EcalTimeMapDigitizer::MIN_ENERGY_THRESHOLD

staticprivate

Initial value:

=
    5e-5

Definition at line 135 of file EcalTimeMapDigitizer.h.

Referenced by add().