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)
void	finalizeHits ()
int	getTimeLayerId ()
void	initializeMap ()
int	maxBunch () const
int	minBunch () const
void	run (EcalTimeDigiCollection &output)
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
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
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 =5e-5

Detailed Description

Definition at line 19 of file EcalTimeMapDigitizer.h.

Member Typedef Documentation

typedef EcalTimeDigi EcalTimeMapDigitizer::Digi

Definition at line 82 of file EcalTimeMapDigitizer.h.

typedef time_average EcalTimeMapDigitizer::TimeSamples

Definition at line 80 of file EcalTimeMapDigitizer.h.

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

Definition at line 84 of file EcalTimeMapDigitizer.h.

Constructor & Destructor Documentation

EcalTimeMapDigitizer::EcalTimeMapDigitizer ( EcalSubdetector  myDet )

explicit

Definition at line 27 of file EcalTimeMapDigitizer.cc.

References gather_cfg::cout, DetId::det(), EBDetId::detIdFromDenseIndex(), EEDetId::detIdFromDenseIndex(), EcalBarrel, EcalEndcap, mps_fire::i, EBDetId::kSizeForDenseIndexing, EEDetId::kSizeForDenseIndexing, m_maxBunch, m_minBunch, m_subDet, m_vSam, findQualityFiles::size, and DetId::subdetId().

                                                               :
  m_subDet(myDet),
  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;
  DetId detId(0);

  //Initialize the map
  if (myDet==EcalBarrel)
    {
      size=EBDetId::kSizeForDenseIndexing;
      detId=EBDetId::detIdFromDenseIndex( 0 ) ;
    }
  else if (myDet==EcalEndcap)
    {
      size=EEDetId::kSizeForDenseIndexing;
      detId=EEDetId::detIdFromDenseIndex( 0 ) ;
    }
  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 ) ;

   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) );
     m_vSam.emplace_back(TimeSamples(CaloGenericDetId( detId.det(), detId.subdetId(), 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 ( )

virtual

Definition at line 81 of file EcalTimeMapDigitizer.cc.

{
}

Member Function Documentation

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

Definition at line 86 of file EcalTimeMapDigitizer.cc.

References EcalTimeMapDigitizer::time_average::average_time, gather_cfg::cout, findSignal(), edm::isNotFinite(), PCaloHit::kEcalDepthMask, PCaloHit::kEcalDepthOffset, m_maxBunch, m_minBunch, m_timeLayerId, MIN_ENERGY_THRESHOLD, EcalTimeMapDigitizer::time_average::nhits, mps_fire::result, ntuplemaker::time, timeOfFlight(), and EcalTimeMapDigitizer::time_average::tot_energy.

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;

      //Just consider only the hits belonging to the specified time layer
      int depth2 = (((*it).depth() >> PCaloHit::kEcalDepthOffset) & 
            PCaloHit::kEcalDepthMask);
      
      if (depth2 != m_timeLayerId) continue;

      if ((*it).energy()<MIN_ENERGY_THRESHOLD) //apply a minimal cut on the hit energy
    continue;
      
       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 ) ) ;

       //here fill the result for the given bunch crossing
       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
    }
  }
}

void EcalTimeMapDigitizer::blankOutUsedSamples

(

)

Definition at line 145 of file EcalTimeMapDigitizer.cc.

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

Referenced by initializeMap(), and subdetector().

{
   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.erase( m_index.begin() ,    // done and make ready to start over
          m_index.end()    ) ;
}

void EcalTimeMapDigitizer::finalizeHits

(

)

Definition at line 164 of file EcalTimeMapDigitizer.cc.

References EcalTimeMapDigitizer::time_average::average_time, EcalTimeMapDigitizer::time_average::calculateAverage(), gather_cfg::cout, mps_fire::i, 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

}

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

private

Definition at line 127 of file EcalTimeMapDigitizer.cc.

References m_index, mps_fire::result, vSamAll(), and EcalTimeMapDigitizer::time_average::zero().

Referenced by add(), and subdetector().

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

int EcalTimeMapDigitizer::getTimeLayerId ( )

inline

Definition at line 102 of file EcalTimeMapDigitizer.h.

References m_timeLayerId.

{ return m_timeLayerId; };

EcalTimeMapDigitizer::VecInd & EcalTimeMapDigitizer::index ( )

private

Definition at line 328 of file EcalTimeMapDigitizer.cc.

References m_index.

Referenced by BeautifulSoup.PageElement::insert(), and subdetector().

{
  return m_index ; 
}

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

private

Definition at line 334 of file EcalTimeMapDigitizer.cc.

References m_index.

Referenced by BeautifulSoup.PageElement::insert().

{
  return m_index ; 
}

void EcalTimeMapDigitizer::initializeMap

(

)

Definition at line 187 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();
}

int EcalTimeMapDigitizer::maxBunch

(

)

const

Definition at line 322 of file EcalTimeMapDigitizer.cc.

References m_maxBunch.

Referenced by subdetector().

{
  return m_maxBunch ; 
}

int EcalTimeMapDigitizer::minBunch

(

)

const

Definition at line 316 of file EcalTimeMapDigitizer.cc.

References m_minBunch.

Referenced by subdetector().

{
  return m_minBunch ; 
}

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

private

Definition at line 286 of file EcalTimeMapDigitizer.cc.

References mps_fire::i, and m_vSam.

Referenced by subdetector().

{
   return &m_vSam[ i ] ;
}

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

private

Definition at line 292 of file EcalTimeMapDigitizer.cc.

References mps_fire::i, and m_vSam.

{
   return &m_vSam[ i ] ;
}

void EcalTimeMapDigitizer::run

(

EcalTimeDigiCollection &

output

)

Definition at line 197 of file EcalTimeMapDigitizer.cc.

References EcalTimeMapDigitizer::time_average::average_time, edm::SortedCollection< T, SORT >::back(), gather_cfg::cout, finalizeHits(), mps_fire::i, m_index, m_minBunch, EcalTimeMapDigitizer::time_average::nhits, edm::SortedCollection< T, SORT >::push_back(), edm::SortedCollection< T, SORT >::reserve(), edm::SortedCollection< T, SORT >::size(), 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) );

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

      for ( unsigned int j ( 0 ) ; j !=  vSamAll( m_index[i] )->time_average_capacity; ++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;
        }
    }

      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

}

unsigned int EcalTimeMapDigitizer::samplesSize ( ) const

private

Definition at line 274 of file EcalTimeMapDigitizer.cc.

References m_vSam.

Referenced by subdetector().

{
   return m_vSam.size() ;
}

unsigned int EcalTimeMapDigitizer::samplesSizeAll ( ) const

private

Definition at line 280 of file EcalTimeMapDigitizer.cc.

References m_vSam.

Referenced by subdetector().

{
   return m_vSam.size() ;
}

void EcalTimeMapDigitizer::setGeometry

(

const CaloSubdetectorGeometry *

geometry

)

Definition at line 138 of file EcalTimeMapDigitizer.cc.

References geometry, and m_geometry.

Referenced by EcalTimeDigiProducer::updateGeometry().

{
   m_geometry = geometry ;
}

void EcalTimeMapDigitizer::setTimeLayerId ( const int &  layerId )

inline

Definition at line 100 of file EcalTimeMapDigitizer.h.

References m_timeLayerId.

Referenced by EcalTimeDigiProducer::EcalTimeDigiProducer().

{ m_timeLayerId = layerId; };

EcalSubdetector EcalTimeMapDigitizer::subdetector ( )

inline

Definition at line 104 of file EcalTimeMapDigitizer.h.

References blankOutUsedSamples(), findSignal(), mps_fire::i, index(), m_subDet, maxBunch(), minBunch(), operator[](), samplesSize(), samplesSizeAll(), vSam(), and vSamAll().

{ return m_subDet; };

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

private

Definition at line 263 of file EcalTimeMapDigitizer.cc.

References CaloSubdetectorGeometry::getGeometry(), m_geometry, and PV3DBase< T, PVType, FrameType >::mag().

Referenced by add().

{
  //not using the layer yet
   const CaloCellGeometry* cellGeometry ( m_geometry->getGeometry( detId ) ) ;
   assert( nullptr != cellGeometry ) ;
   GlobalPoint layerPos = (dynamic_cast<const TruncatedPyramid*>(cellGeometry))->getPosition( double(layer)+0.5 ); //depth in mm in the middle of the layer position
   return layerPos.mag()*cm/c_light ;
}

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

private

Definition at line 298 of file EcalTimeMapDigitizer.cc.

References mps_fire::i, and m_vSam.

Referenced by subdetector().

{
   return &m_vSam[ i ] ;
}

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

private

Definition at line 304 of file EcalTimeMapDigitizer.cc.

References mps_fire::i, and m_vSam.

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

{
   return &m_vSam[ i ] ;
}

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

private

Definition at line 310 of file EcalTimeMapDigitizer.cc.

References mps_fire::i, and m_vSam.

{
   return &m_vSam[ i ] ;
}

Member Data Documentation

const int EcalTimeMapDigitizer::BUNCHSPACE =25

staticprivate

Definition at line 140 of file EcalTimeMapDigitizer.h.

const CaloSubdetectorGeometry* EcalTimeMapDigitizer::m_geometry

private

Definition at line 149 of file EcalTimeMapDigitizer.h.

Referenced by setGeometry(), and timeOfFlight().

VecInd EcalTimeMapDigitizer::m_index

private

Definition at line 155 of file EcalTimeMapDigitizer.h.

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

const int EcalTimeMapDigitizer::m_maxBunch =5

staticprivate

Definition at line 145 of file EcalTimeMapDigitizer.h.

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

const int EcalTimeMapDigitizer::m_minBunch =-4

staticprivate

Definition at line 144 of file EcalTimeMapDigitizer.h.

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

EcalSubdetector EcalTimeMapDigitizer::m_subDet

private

Definition at line 137 of file EcalTimeMapDigitizer.h.

Referenced by EcalTimeMapDigitizer(), and subdetector().

int EcalTimeMapDigitizer::m_timeLayerId

private

Definition at line 147 of file EcalTimeMapDigitizer.h.

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

std::vector<TimeSamples> EcalTimeMapDigitizer::m_vSam

private

Definition at line 153 of file EcalTimeMapDigitizer.h.

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

const float EcalTimeMapDigitizer::MIN_ENERGY_THRESHOLD =5e-5

staticprivate

Definition at line 142 of file EcalTimeMapDigitizer.h.

Referenced by add().