#include <EcalCoder.h>

Public Types
enum	{ NBITS = 12, MAXADC = 4095, ADCGAINSWITCH = 4079, NGAINS = 3 }

typedef CaloTSamples< float, 10 >	EcalSamples

typedef CorrelatedNoisifier < EcalCorrMatrix >	Noisifier

Public Member Functions
virtual void	analogToDigital (const EcalSamples &clf, EcalDataFrame &df) const
	from EcalSamples to EcalDataFrame More...

	EcalCoder (bool addNoise, Noisifier ebCorrNoise0, Noisifier eeCorrNoise0=0, Noisifier ebCorrNoise1=0, Noisifier eeCorrNoise1=0, Noisifier ebCorrNoise2=0, Noisifier eeCorrNoise2=0)
	ctor More...

void	setFullScaleEnergy (double EBscale, double EEscale)

void	setGainRatios (const EcalGainRatios *gainRatios)

void	setIntercalibConstants (const EcalIntercalibConstantsMC *ical)

void	setPedestals (const EcalPedestals *pedestals)
	can be fetched every event from the EventSetup More...

virtual	~EcalCoder ()
	dtor More...

Private Member Functions
void	encode (const EcalSamples &ecalSamples, EcalDataFrame &df) const
	produce the pulse-shape More...

void	findGains (const DetId &detId, double theGains[]) const

void	findIntercalibConstant (const DetId &detId, double &icalconst) const

void	findPedestal (const DetId &detId, int gainId, double &pedestal, double &width) const
	not yet implemented More...

double	fullScaleEnergy (const DetId &did) const
	limit on the energy scale due to the electronics range More...

Private Attributes
bool	m_addNoise

const Noisifier *	m_ebCorrNoise [3]

const Noisifier *	m_eeCorrNoise [3]

const EcalGainRatios *	m_gainRatios

const EcalIntercalibConstantsMC *	m_intercals

double	m_maxEneEB

double	m_maxEneEE

const EcalPedestals *	m_peds

Detailed Description

Definition at line 22 of file EcalCoder.h.

Member Typedef Documentation

typedef CaloTSamples<float,10> EcalCoder::EcalSamples

Definition at line 26 of file EcalCoder.h.

Definition at line 28 of file EcalCoder.h.

Member Enumeration Documentation

anonymous enum

Enumerator
NBITS
MAXADC
ADCGAINSWITCH
NGAINS

Definition at line 30 of file EcalCoder.h.

            { NBITS         =   12 , // number of available bits
          MAXADC        = 4095 , // 2^12 -1,  adc max range
          ADCGAINSWITCH = 4079 , // adc gain switch
          NGAINS        =    3   // number of electronic gains
       };

Constructor & Destructor Documentation

EcalCoder::EcalCoder	(	bool	addNoise,
		EcalCoder::Noisifier *	ebCorrNoise0,
		EcalCoder::Noisifier *	eeCorrNoise0 = `0`,
		EcalCoder::Noisifier *	ebCorrNoise1 = `0`,
		EcalCoder::Noisifier *	eeCorrNoise1 = `0`,
		EcalCoder::Noisifier *	ebCorrNoise2 = `0`,
		EcalCoder::Noisifier *	eeCorrNoise2 = `0`
	)

ctor

Definition at line 12 of file EcalCoder.cc.

References m_ebCorrNoise, and m_eeCorrNoise.

                                                    :
    m_peds        (           0 ) ,
    m_gainRatios  (           0 ) ,
    m_intercals   (           0 ) ,
    m_maxEneEB    (      1668.3 ) , // 4095(MAXADC)*12(gain 2)*0.035(GeVtoADC)*0.97
    m_maxEneEE    (      2859.9 ) , // 4095(MAXADC)*12(gain 2)*0.060(GeVtoADC)*0.97
    m_addNoise    ( addNoise    )
 {
    m_ebCorrNoise[0] = ebCorrNoise0 ;
    assert( 0 != m_ebCorrNoise[0] ) ;
    m_eeCorrNoise[0] = eeCorrNoise0 ;
    m_ebCorrNoise[1] = ebCorrNoise1 ;
    m_eeCorrNoise[1] = eeCorrNoise1 ;
    m_ebCorrNoise[2] = ebCorrNoise2 ;
    m_eeCorrNoise[2] = eeCorrNoise2 ;
 }  

EcalCoder::~EcalCoder ( )

virtual

dtor

Definition at line 35 of file EcalCoder.cc.

36 {

37 }

Member Function Documentation

void EcalCoder::analogToDigital	(	const EcalSamples &	clf,
		EcalDataFrame &	df
	)		const

virtual

from EcalSamples to EcalDataFrame

Definition at line 73 of file EcalCoder.cc.

References encode(), EcalDataFrame::setSize(), and CaloTSamplesBase< Ttype >::size().

Referenced by EcalElectronicsSim::analogToDigital().

 {
    df.setSize( clf.size() ) ;
    encode( clf, df );
 /*   std::cout<<"   **Id=" ;
    if( CaloGenericDetId( clf.id() ).isEB() )
    {
       std::cout<<EBDetId( clf.id() ) ;
    }
    else
    {
       std::cout<<EEDetId( clf.id() ) ;
    }
    std::cout<<", size="<<df.size();
    for( int i ( 0 ) ; i != df.size() ; ++i )
    {
       std::cout<<", "<<df[i];
    }
    std::cout<<std::endl ;*/
 }

void EcalCoder::encode	(	const EcalSamples &	ecalSamples,
		EcalDataFrame &	df
	)		const

private

produce the pulse-shape

Definition at line 96 of file EcalCoder.cc.

References ecalMGPA::adc(), ADCGAINSWITCH, run_regression::done, EcalBarrel, findGains(), findIntercalibConstant(), findPedestal(), fullScaleEnergy(), ecalMGPA::gainId(), EcalMGPASample::gainId(), i, CaloTSamplesBase< Ttype >::id(), CastorSimpleRecAlgoImpl::isSaturated(), j, LogDebug, m_addNoise, m_ebCorrNoise, m_eeCorrNoise, m_peds, MAXADC, NGAINS, CorrelatedNoisifier< M >::noisify(), EcalDataFrame::sample(), EcalDataFrame::setSample(), CaloTSamplesBase< Ttype >::size(), mathSSE::sqrt(), and funct::true.

Referenced by analogToDigital().

 {
    assert( 0 != m_peds ) ;
 
    const unsigned int csize ( ecalSamples.size() ) ;
 
   
    DetId detId = ecalSamples.id();             
    double Emax = fullScaleEnergy(detId);       
 
    //....initialisation
    if ( ecalSamples[5] > 0. ) LogDebug("EcalCoder") << "Input caloSample" << "\n" << ecalSamples;
   
    double LSB[NGAINS+1];
    double pedestals[NGAINS+1];
    double widths[NGAINS+1];
    double gains[NGAINS+1];
    int    maxADC[NGAINS+1];
    double trueRMS[NGAINS+1];
 
    double icalconst = 1. ;
    findIntercalibConstant( detId, icalconst );
 
    for( unsigned int igain ( 0 ); igain <= NGAINS ; ++igain ) 
    {
       // fill in the pedestal and width
       findPedestal( detId ,
             igain , 
             pedestals[igain] , 
             widths[igain]      ) ;
 
       if( 0 < igain ) 
      trueRMS[igain] = std::sqrt( widths[igain]*widths[igain] - 1./12. ) ;
 
       // set nominal value first
       findGains( detId , 
          gains  );               
 
       LSB[igain] = 0.;
       if ( igain > 0 ) LSB[igain]= Emax/(MAXADC*gains[igain]);
       maxADC[igain] = ADCGAINSWITCH;                   // saturation at 4080 for middle and high gains x6 & x12
       if ( igain == NGAINS ) maxADC[igain] = MAXADC;   // saturation at 4095 for low gain x1 
    }
 
    CaloSamples noiseframe[] = { CaloSamples( detId , csize ) ,
                 CaloSamples( detId , csize ) ,
                 CaloSamples( detId , csize )   } ;
 
    const Noisifier* noisy[3] = { ( 0 == m_eeCorrNoise[0]          ||
                    EcalBarrel == detId.subdetId()    ?
                    m_ebCorrNoise[0] :
                    m_eeCorrNoise[0]                  ) ,
                  ( EcalBarrel == detId.subdetId() ?
                    m_ebCorrNoise[1] :
                    m_eeCorrNoise[1]                  ) ,
                  ( EcalBarrel == detId.subdetId() ?
                    m_ebCorrNoise[2] :
                    m_eeCorrNoise[2]                  )   } ;
 
    if( m_addNoise )
    {
       noisy[0]->noisify( noiseframe[0] ) ; // high gain
       if( 0 == noisy[1] ) noisy[0]->noisify( noiseframe[1] ,
                          &noisy[0]->vecgau() ) ; // med 
       if( 0 == noisy[2] ) noisy[0]->noisify( noiseframe[2] ,
                          &noisy[0]->vecgau() ) ; // low
    }
 
    int wait = 0 ;
    int gainId = 0 ;
    bool isSaturated = 0;
 
    for( unsigned int i ( 0 ) ; i != csize ; ++i )
    {    
       bool done ( false ) ;
       int adc = MAXADC ;
       if( 0 == wait ) gainId = 1 ;
 
       // see which gain bin it fits in
       int igain ( gainId - 1 ) ;
       do
       {
      ++igain ;
 
 //   if( igain != gainId ) std::cout <<"$$$$ Gain switch from " << gainId
 //                   <<" to "<< igain << std::endl ;
 
      if( 1 != igain                    &&   // not high gain
          m_addNoise                    &&   // want to add noise
          0 != noisy[igain-1]           &&   // exists
          noiseframe[igain-1].isBlank()    ) // not already done
      {
         noisy[igain-1]->noisify( noiseframe[igain-1] ,
                      &noisy[0]->vecgau()   ) ;
 //      std::cout<<"....noisifying gain level = "<<igain<<std::endl ;
      }
     
      // noiseframe filled with zeros if !m_addNoise
      const double signal ( pedestals[igain] +
                    ecalSamples[i] /( LSB[igain]*icalconst ) +
                    trueRMS[igain]*noiseframe[igain-1][i]      ) ;
      
      const int isignal ( signal ) ;
      const int tmpadc ( signal - (double)isignal < 0.5 ?
                 isignal : isignal + 1 ) ;
      // LogDebug("EcalCoder") << "DetId " << detId.rawId() << " gain " << igain << " caloSample " 
      //                       <<  ecalSamples[i] << " pededstal " << pedestals[igain] 
      //                       << " noise " << widths[igain] << " conversion factor " << LSB[igain] 
      //                       << " result (ped,tmpadc)= " << ped << " " << tmpadc;
          
      if( tmpadc <= maxADC[igain] ) 
      {
         adc = tmpadc;
         done = true ;
      }
       }
       while( !done       &&
          igain < 3    ) ;
 
       if (igain == 1 ) 
       {
          wait = 0 ;
          gainId = igain ;
       }
       else 
       {
          if (igain == gainId) --wait ;
          else 
      {
         wait = 5 ;
         gainId = igain ;
      }
       }
 
 
       // change the gain for saturation
       int storeGainId = gainId;
       if ( gainId == 3 && adc == MAXADC ) 
       {
      storeGainId = 0;
      isSaturated = true;
       }
       // LogDebug("EcalCoder") << " Writing out frame " << i << " ADC = " << adc << " gainId = " << gainId << " storeGainId = " << storeGainId ; 
      
       df.setSample( i, EcalMGPASample( adc, storeGainId ) );   
    }
    // handle saturation properly according to IN-2007/056
    // N.B. - FIXME 
    // still missing the possibility for a signal to pass the saturation threshold
    // again within the 5 subsequent samples (higher order effect).
 
    if ( isSaturated ) 
    {
       for (unsigned int i = 0 ; i < ecalSamples.size() ; ++i) 
       {
      if ( df.sample(i).gainId() == 0 ) 
      {
         unsigned int hyst = i+1+2;
         for ( unsigned int j = i+1; j < hyst && j < ecalSamples.size(); ++j ) 
         {
            df.setSample(j, EcalMGPASample(MAXADC, 0));   
         }
      }
       }
    }
 }

void EcalCoder::findGains	(	const DetId &	detId,
		double	theGains[]
	)		const

private

Definition at line 323 of file EcalCoder.cc.

References EcalBarrel, EcalEndcap, EcalCondObjectContainer< T >::find(), EcalCondObjectContainer< T >::getMap(), m_gainRatios, DetId::rawId(), EcalCondObjectContainer< T >::size(), and DetId::subdetId().

Referenced by encode().

 {
   /*
     EcalGainRatios::EcalGainRatioMap::const_iterator grit=m_gainRatios->getMap().find(detId.rawId());
     EcalMGPAGainRatio mgpa;
     if( grit!=m_gainRatios->getMap().end() ){
     mgpa = grit->second;
     Gains[0] = 0.;
     Gains[3] = 1.;
     Gains[2] = mgpa.gain6Over1() ;
     Gains[1] = Gains[2]*(mgpa.gain12Over6()) ;
     LogDebug("EcalCoder") << "Gains for " << detId.rawId() << "\n" << " 1 = " << Gains[1] << "\n" << " 2 = " << Gains[2] << "\n" << " 3 = " << Gains[3];
     } else {
     edm::LogError("EcalCoder") << "Could not find gain ratios for " << detId.rawId() << " among the " << m_gainRatios->getMap().size();
     }
   */
 
    EcalGainRatioMap::const_iterator grit = m_gainRatios->getMap().find( detId );
    Gains[0] = 0.;
    Gains[3] = 1.;
    Gains[2] = (*grit).gain6Over1();
    Gains[1] = Gains[2]*( (*grit).gain12Over6() );   
    
   
    if ( (detId.subdetId() != EcalBarrel) && (detId.subdetId() != EcalEndcap) ) 
    { 
       edm::LogError("EcalCoder") << "Could not find gain ratios for " << detId.rawId() << " among the " << m_gainRatios->getMap().size();
    }   
   
 }

void EcalCoder::findIntercalibConstant	(	const DetId &	detId,
		double &	icalconst
	)		const

private

Definition at line 356 of file EcalCoder.cc.

References EcalCondObjectContainer< T >::end(), EcalCondObjectContainer< T >::find(), EcalCondObjectContainer< T >::getMap(), m_intercals, and DetId::rawId().

Referenced by encode().

 {
    EcalIntercalibConstantMC thisconst = 1.;
    // find intercalib constant for this xtal
    const EcalIntercalibConstantMCMap &icalMap = m_intercals->getMap();
    EcalIntercalibConstantMCMap::const_iterator icalit = icalMap.find(detId);
    if( icalit!=icalMap.end() )
    {
       thisconst = (*icalit);
       if ( icalconst == 0. ) { thisconst = 1.; }
    } 
    else
    {
       edm::LogError("EcalCoder") << "No intercalib const found for xtal " << detId.rawId() << "! something wrong with EcalIntercalibConstants in your DB? ";
    }
    icalconst = thisconst;
 }

void EcalCoder::findPedestal	(	const DetId &	detId,
		int	gainId,
		double &	pedestal,
		double &	width
	)		const

private

not yet implemented

Definition at line 265 of file EcalCoder.cc.

References EcalBarrel, EcalEndcap, EcalCondObjectContainer< T >::find(), EcalCondObjectContainer< T >::getMap(), LogDebug, m_peds, DetId::rawId(), EcalCondObjectContainer< T >::size(), DetId::subdetId(), and tablePrinter::width.

Referenced by encode().

 {
    /*
      EcalPedestalsMapIterator mapItr 
      = m_peds->m_pedestals.find(detId.rawId());
      // should I care if it doesn't get found?
      if(mapItr == m_peds->m_pedestals.end()) {
      edm::LogError("EcalCoder") << "Could not find pedestal for " << detId.rawId() << " among the " << m_peds->m_pedestals.size();
      } else {
      EcalPedestals::Item item = mapItr->second;
    */
    
    /*   
     EcalPedestals::Item const & item = (*m_peds)(detId);
     ped = item.mean(gainId);
     width = item.rms(gainId);
    */
 
    EcalPedestalsMap::const_iterator itped = m_peds->getMap().find( detId );
    ped   = (*itped).mean(gainId);
    width = (*itped).rms(gainId);
   
    if ( (detId.subdetId() != EcalBarrel) && (detId.subdetId() != EcalEndcap) ) 
    { 
       edm::LogError("EcalCoder") << "Could not find pedestal for " << detId.rawId() << " among the " << m_peds->getMap().size();
    } 
 
   /*
     switch(gainId) {
     case 0:
       ped = 0.;
       width = 0.;
     case 1:
       ped = item.mean_x12;
       width = item.rms_x12;
       break;
     case 2:
       ped = item.mean_x6;
       width = item.rms_x6;
       break;
     case 3:
       ped = item.mean_x1;
       width = item.rms_x1;
       break;
     default:
       edm::LogError("EcalCoder") << "Bad Pedestal " << gainId;
       break;
     }
   */
 
    LogDebug("EcalCoder") << "Pedestals for " << detId.rawId() << " gain range " << gainId << " : \n" << "Mean = " << ped << " rms = " << width;
 }

double EcalCoder::fullScaleEnergy ( const DetId & did ) const

private

limit on the energy scale due to the electronics range

Definition at line 67 of file EcalCoder.cc.

References EcalBarrel, m_maxEneEB, m_maxEneEE, and DetId::subdetId().

Referenced by encode().

 {
    return detId.subdetId() == EcalBarrel ? m_maxEneEB : m_maxEneEE ;
 }

void EcalCoder::setFullScaleEnergy	(	double	EBscale,
		double	EEscale
	)

Definition at line 40 of file EcalCoder.cc.

References m_maxEneEB, and m_maxEneEE.

Referenced by EcalDigiProducer::checkCalibrations().

 {
    m_maxEneEB = EBscale ;
    m_maxEneEE = EEscale ;
 }

void EcalCoder::setGainRatios ( const EcalGainRatios * gainRatios )

Definition at line 55 of file EcalCoder.cc.

References m_gainRatios.

Referenced by EcalDigiProducer::checkCalibrations().

 {
    m_gainRatios = gainRatios ; 
 }

void EcalCoder::setIntercalibConstants ( const EcalIntercalibConstantsMC * ical )

Definition at line 61 of file EcalCoder.cc.

References m_intercals.

Referenced by EcalDigiProducer::checkCalibrations().

 {
    m_intercals = ical ;
 }

void EcalCoder::setPedestals ( const EcalPedestals * pedestals )

can be fetched every event from the EventSetup

Definition at line 49 of file EcalCoder.cc.

References m_peds.

Referenced by EcalDigiProducer::checkCalibrations().

 {
    m_peds = pedestals ;
 }

Member Data Documentation

bool EcalCoder::m_addNoise

private

Definition at line 98 of file EcalCoder.h.

Referenced by encode().

const Noisifier* EcalCoder::m_ebCorrNoise[3]

private

Definition at line 100 of file EcalCoder.h.

Referenced by EcalCoder(), and encode().

const Noisifier* EcalCoder::m_eeCorrNoise[3]

private

Definition at line 101 of file EcalCoder.h.

Referenced by EcalCoder(), and encode().

const EcalGainRatios* EcalCoder::m_gainRatios

private

Definition at line 91 of file EcalCoder.h.

Referenced by findGains(), and setGainRatios().

const EcalIntercalibConstantsMC* EcalCoder::m_intercals

private

Definition at line 93 of file EcalCoder.h.

Referenced by findIntercalibConstant(), and setIntercalibConstants().

double EcalCoder::m_maxEneEB

private

Definition at line 95 of file EcalCoder.h.

Referenced by fullScaleEnergy(), and setFullScaleEnergy().

double EcalCoder::m_maxEneEE

private

Definition at line 96 of file EcalCoder.h.

Referenced by fullScaleEnergy(), and setFullScaleEnergy().

const EcalPedestals* EcalCoder::m_peds

private

Definition at line 89 of file EcalCoder.h.

Referenced by encode(), findPedestal(), and setPedestals().

Public Types

Public Member Functions

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation