HGCalTriggerCellBestChoiceCodecImpl Class Reference

#include <HGCalTriggerCellBestChoiceCodecImpl.h>

Public Types
typedef HGCalTriggerCellBestChoiceDataPayload	data_type

Public Member Functions
uint32_t	adcnBits () const
double	adcsaturation () const
void	bestChoiceSelect (data_type &)
size_t	dataLength () const
data_type	decode (const std::vector< bool > &, const uint32_t, const HGCalTriggerGeometryBase &) const
std::vector< bool >	encode (const data_type &, const HGCalTriggerGeometryBase &) const
	HGCalTriggerCellBestChoiceCodecImpl (const edm::ParameterSet &conf)
void	linearize (const std::vector< HGCalDataFrame > &, std::vector< std::pair< DetId, uint32_t > > &)
double	linLSB () const
uint32_t	linnBits () const
size_t	nCellsInModule () const
size_t	nData () const
uint32_t	tdcnBits () const
double	tdcOnsetfC () const
double	tdcsaturation () const
std::vector< double >	ThicknessCorrections () const
uint32_t	triggerCellSaturationBits () const
void	triggerCellSums (const HGCalTriggerGeometryBase &, const std::vector< std::pair< DetId, uint32_t > > &, data_type &)
uint32_t	triggerCellTruncationBits () const

Private Attributes
double	adcLSB_
uint32_t	adcnBits_
double	adcsaturation_
size_t	dataLength_
double	linLSB_
uint32_t	linMax_
uint32_t	linnBits_
size_t	nCellsInModule_
size_t	nData_
double	tdcLSB_
uint32_t	tdcnBits_
double	tdcOnsetfC_
double	tdcsaturation_
std::vector< double >	thickness_corrections_
uint32_t	triggerCellSaturationBits_
uint32_t	triggerCellTruncationBits_

Detailed Description

Definition at line 27 of file HGCalTriggerCellBestChoiceCodecImpl.h.

Member Typedef Documentation

typedef HGCalTriggerCellBestChoiceDataPayload HGCalTriggerCellBestChoiceCodecImpl::data_type

Definition at line 30 of file HGCalTriggerCellBestChoiceCodecImpl.h.

Constructor & Destructor Documentation

HGCalTriggerCellBestChoiceCodecImpl::HGCalTriggerCellBestChoiceCodecImpl

(

const edm::ParameterSet &

conf

)

Definition at line 6 of file HGCalTriggerCellBestChoiceCodecImpl.cc.

References adcLSB_, adcnBits_, adcsaturation_, dataLength_, encode(), linMax_, linnBits_, nCellsInModule_, nData_, funct::pow(), tdcLSB_, tdcnBits_, tdcsaturation_, triggerCellSaturationBits_, and triggerCellTruncationBits_.

                                                                 :
    nData_(conf.getParameter<uint32_t>("NData")),
    dataLength_(conf.getParameter<uint32_t>("DataLength")),
    nCellsInModule_(conf.getParameter<uint32_t>("MaxCellsInModule")), 
    linLSB_(conf.getParameter<double>("linLSB")),
    linnBits_(conf.getParameter<uint32_t>("linnBits")),
    adcsaturation_(conf.getParameter<double>("adcsaturation")),
    adcnBits_(conf.getParameter<uint32_t>("adcnBits")),
    tdcsaturation_(conf.getParameter<double>("tdcsaturation")), 
    tdcnBits_(conf.getParameter<uint32_t>("tdcnBits")), 
    tdcOnsetfC_(conf.getParameter<double>("tdcOnsetfC")),
    triggerCellTruncationBits_(conf.getParameter<uint32_t>("triggerCellTruncationBits")),
    thickness_corrections_(conf.getParameter<std::vector<double>>("ThicknessCorrections"))
{
  // Cannot have more selected cells than the max number of cells
  if(nData_>nCellsInModule_) nData_ = nCellsInModule_;
  adcLSB_ =  adcsaturation_/pow(2.,adcnBits_);
  tdcLSB_ =  tdcsaturation_/pow(2.,tdcnBits_);
  linMax_ = (0x1<<linnBits_)-1;
  triggerCellSaturationBits_ = triggerCellTruncationBits_ + dataLength_;
}

Member Function Documentation

uint32_t HGCalTriggerCellBestChoiceCodecImpl::adcnBits ( ) const

inline

Definition at line 52 of file HGCalTriggerCellBestChoiceCodecImpl.h.

Referenced by HGCalTriggerCellBestChoiceCodec::setDataPayloadImpl().

{return adcnBits_;}

double HGCalTriggerCellBestChoiceCodecImpl::adcsaturation ( ) const

inline

Definition at line 51 of file HGCalTriggerCellBestChoiceCodecImpl.h.

Referenced by HGCalTriggerCellBestChoiceCodec::setDataPayloadImpl().

{return adcsaturation_;}

void HGCalTriggerCellBestChoiceCodecImpl::bestChoiceSelect

(

data_type &

data

)

Definition at line 229 of file HGCalTriggerCellBestChoiceCodecImpl.cc.

References a, b, l1t::L1Candidate::hwPt(), nData_, and HGCalTriggerCellBestChoiceDataPayload::payload.

Referenced by HGCalTriggerCellBestChoiceCodec::setDataPayloadImpl(), and triggerCellSums().

{
    // sort, reverse order
    sort(data.payload.begin(), data.payload.end(),
            [](const l1t::HGCalTriggerCell& a, 
                const  l1t::HGCalTriggerCell& b) -> bool
            { 
                return a.hwPt() > b.hwPt(); 
            } 
            );
    // keep only the first trigger cells
    if(data.payload.size()>nData_) data.payload.resize(nData_);
}

size_t HGCalTriggerCellBestChoiceCodecImpl::dataLength ( ) const

inline

Definition at line 48 of file HGCalTriggerCellBestChoiceCodecImpl.h.

Referenced by HGCalTriggerCellBestChoiceCodec::setDataPayloadImpl().

{return dataLength_;}

HGCalTriggerCellBestChoiceCodecImpl::data_type HGCalTriggerCellBestChoiceCodecImpl::decode	(	const std::vector< bool > &	data,
		const uint32_t	module,
		const HGCalTriggerGeometryBase &	geometry
	)		const

Definition at line 97 of file HGCalTriggerCellBestChoiceCodecImpl.cc.

References dataLength_, PV3DBase< T, PVType, FrameType >::eta(), Exception, HGCalTriggerGeometryBase::getOrderedTriggerCellsFromModule(), HGCalTriggerGeometryBase::getTriggerCellPosition(), mps_fire::i, linearize(), nCellsInModule_, nData_, p4, HGCalTriggerCellBestChoiceDataPayload::payload, PV3DBase< T, PVType, FrameType >::phi(), point, HGCalTriggerCellBestChoiceDataPayload::reset(), and mps_fire::result.

Referenced by HGCalTriggerCellBestChoiceCodec::decodeImpl(), and encode().

{
    data_type result;
    result.reset();
    // TODO: could eventually reserve result memory to the max size of trigger cells
    if(data.size()!=nCellsInModule_+dataLength_*nData_)
    {
        throw cms::Exception("BadData") 
            << "decode: data length ("<<data.size()<<") inconsistent with codec parameters:\n"\
            << "      : Map size = "<<nCellsInModule_<<"\n"\
            << "      : Number of energy values = "<<nData_<<"\n"\
            << "      : Energy value length = "<<dataLength_<<"\n";
    }
    HGCalTriggerGeometryBase::geom_ordered_set trigger_cells_in_module = geometry.getOrderedTriggerCellsFromModule(module);
    size_t iselected = 0;
    size_t index = 0;
    for(const auto& triggercell : trigger_cells_in_module)
    {
        if(index>=nCellsInModule_)
        {
            throw cms::Exception("BadGeometry")
                << "Number of trigger cells in module too large for available data payload\n";
        }
        if(data[index])
        {
            uint32_t value = 0;
            for(size_t i=0;i<dataLength_;i++)
            {
                size_t ibit = nCellsInModule_+iselected*dataLength_+i; 
                if(data[ibit]) value |= (0x1<<i);
            }
            iselected++;
            // Build trigger cell
            if(value>0)
            {
                // Currently no hardware eta, phi and quality values
                result.payload.emplace_back(reco::LeafCandidate::LorentzVector(),
                        value, 0, 0, 0, triggercell); 
                GlobalPoint point = geometry.getTriggerCellPosition(triggercell);
                // 'value' is hardware, so p4 is meaningless, except for eta and phi
                math::PtEtaPhiMLorentzVector p4((double)value/cosh(point.eta()), point.eta(), point.phi(), 0.);
                result.payload.back().setP4(p4);
                result.payload.back().setPosition(point);
            }
        }
        index++;
    }
    return result;
}

std::vector< bool > HGCalTriggerCellBestChoiceCodecImpl::encode	(	const data_type &	data,
		const HGCalTriggerGeometryBase &	geometry
	)		const

Definition at line 32 of file HGCalTriggerCellBestChoiceCodecImpl.cc.

References dataLength_, decode(), Exception, HGCalTriggerGeometryBase::getModuleFromTriggerCell(), HGCalTriggerGeometryBase::getOrderedTriggerCellsFromModule(), mps_fire::i, nCellsInModule_, nData_, HGCalTriggerCellBestChoiceDataPayload::payload, mps_fire::result, triggerCellSaturationBits_, and triggerCellTruncationBits_.

Referenced by HGCalTriggerCellBestChoiceCodec::encodeImpl(), and HGCalTriggerCellBestChoiceCodecImpl().

{
    // First nCellsInModule_ bits are encoding the map of selected trigger cells
    // Followed by nData_ words of dataLength_ bits, corresponding to energy/transverse energy of
    // the selected trigger cells
    std::vector<bool> result(nCellsInModule_ + dataLength_*nData_, false);
    // No data: return vector of 0
    if(data.payload.empty()) return result;
    // All trigger cells are in the same module
    // Retrieve once the ordered list of trigger cells in this module
    uint32_t module = geometry.getModuleFromTriggerCell(data.payload.begin()->detId());
    HGCalTriggerGeometryBase::geom_ordered_set trigger_cells_in_module = geometry.getOrderedTriggerCellsFromModule(module);
    // Convert payload into a map for later search
    std::unordered_map<uint32_t, uint32_t> data_map; // (detid,energy)
    for(const auto& triggercell : data.payload)
    {
        data_map.emplace(triggercell.detId(), triggercell.hwPt());
    }
    // Loop on trigger cell ids in module and check if energy in the cell
    size_t index = 0; // index in module
    size_t idata = 0; // counter for the number of non-zero energy values
    for(const auto& triggercell_id : trigger_cells_in_module)
    {
        // Find if this trigger cell has data
        const auto& data_itr = data_map.find(triggercell_id);
        // if not data, increase index and skip
        if(data_itr==data_map.end())
        {
            index++;
            continue;
        }
        // else fill result vector with data
        // (set the corresponding adress bit and fill energy if >0)
        if(index>=nCellsInModule_) 
        {
            throw cms::Exception("BadGeometry")
                << "Number of trigger cells in module too large for available data payload\n";
        }
        uint32_t value = data_itr->second; 
        if(value>0)
        {
            if(idata>=nData_)
            {
                throw cms::Exception("BadData") 
                    << "encode: Number of non-zero trigger cells larger than codec parameter\n"\
                    << "      : Number of energy values = "<<nData_<<"\n";
            }
            // Set map bit to 1
            result[index] =  true;
            // Saturate and truncate energy values
            if(value+1>(0x1u<<triggerCellSaturationBits_)) value = (0x1<<triggerCellSaturationBits_)-1;
            for(size_t i=0; i<dataLength_; i++)
            {
                // remove the lowest bits (=triggerCellTruncationBits_)
                result[nCellsInModule_ + idata*dataLength_ + i] = static_cast<bool>(value & (0x1<<(i+triggerCellTruncationBits_)));
            }
            idata++;
        }
        index++;
    }
    return result;
}

void HGCalTriggerCellBestChoiceCodecImpl::linearize	(	const std::vector< HGCalDataFrame > &	dataframes,
		std::vector< std::pair< DetId, uint32_t > > &	linearized_dataframes
	)

Definition at line 150 of file HGCalTriggerCellBestChoiceCodecImpl.cc.

References adcLSB_, CustomPhysics_cfi::amplitude, data, DetId::Forward, DetId::Hcal, linLSB_, linMax_, ALCARECOPromptCalibProdSiPixelAli0T_cff::mode, tdcLSB_, tdcOnsetfC_, and triggerCellSums().

Referenced by decode(), and HGCalTriggerCellBestChoiceCodec::setDataPayloadImpl().

{
    double amplitude = 0.; 
    uint32_t amplitude_int = 0;
    const int kIntimeSample = 2;

    for(const auto& frame : dataframes) {//loop on DIGI
        if(frame.id().det()==DetId::Forward) {
            if (frame[kIntimeSample].mode()) {//TOT mode
                amplitude =( floor(tdcOnsetfC_/adcLSB_) + 1.0 )* adcLSB_ + double(frame[kIntimeSample].data()) * tdcLSB_;
            }
            else {//ADC mode
                amplitude = double(frame[kIntimeSample].data()) * adcLSB_;
            }

            amplitude_int = uint32_t (floor(amplitude/linLSB_+0.5));  
        }
        else if(frame.id().det()==DetId::Hcal) {
            // no linearization here. Take the raw ADC data
            amplitude_int = frame[kIntimeSample].data();
        }
        if (amplitude_int>linMax_) amplitude_int = linMax_;

        linearized_dataframes.push_back(std::make_pair (frame.id(), amplitude_int));
    }
}

double HGCalTriggerCellBestChoiceCodecImpl::linLSB ( ) const

inline

Definition at line 49 of file HGCalTriggerCellBestChoiceCodecImpl.h.

Referenced by HGCalTriggerCellBestChoiceCodec::setDataPayloadImpl().

{return linLSB_;}

uint32_t HGCalTriggerCellBestChoiceCodecImpl::linnBits ( ) const

inline

Definition at line 50 of file HGCalTriggerCellBestChoiceCodecImpl.h.

Referenced by HGCalTriggerCellBestChoiceCodec::setDataPayloadImpl().

{return linnBits_;}

size_t HGCalTriggerCellBestChoiceCodecImpl::nCellsInModule ( ) const

inline

Definition at line 46 of file HGCalTriggerCellBestChoiceCodecImpl.h.

Referenced by HGCalTriggerCellBestChoiceCodec::setDataPayloadImpl().

{return nCellsInModule_;}

size_t HGCalTriggerCellBestChoiceCodecImpl::nData ( ) const

inline

Definition at line 47 of file HGCalTriggerCellBestChoiceCodecImpl.h.

{return nData_;}

uint32_t HGCalTriggerCellBestChoiceCodecImpl::tdcnBits ( ) const

inline

Definition at line 54 of file HGCalTriggerCellBestChoiceCodecImpl.h.

Referenced by HGCalTriggerCellBestChoiceCodec::setDataPayloadImpl().

{return tdcnBits_;}

double HGCalTriggerCellBestChoiceCodecImpl::tdcOnsetfC ( ) const

inline

Definition at line 55 of file HGCalTriggerCellBestChoiceCodecImpl.h.

Referenced by HGCalTriggerCellBestChoiceCodec::setDataPayloadImpl().

{return tdcOnsetfC_;}

double HGCalTriggerCellBestChoiceCodecImpl::tdcsaturation ( ) const

inline

Definition at line 53 of file HGCalTriggerCellBestChoiceCodecImpl.h.

Referenced by HGCalTriggerCellBestChoiceCodec::setDataPayloadImpl().

{return tdcsaturation_;}

std::vector<double> HGCalTriggerCellBestChoiceCodecImpl::ThicknessCorrections ( ) const

inline

Definition at line 58 of file HGCalTriggerCellBestChoiceCodecImpl.h.

Referenced by HGCalTriggerCellBestChoiceCodec::setDataPayloadImpl().

{return thickness_corrections_;}

uint32_t HGCalTriggerCellBestChoiceCodecImpl::triggerCellSaturationBits ( ) const

inline

Definition at line 57 of file HGCalTriggerCellBestChoiceCodecImpl.h.

{return triggerCellSaturationBits_;}

void HGCalTriggerCellBestChoiceCodecImpl::triggerCellSums	(	const HGCalTriggerGeometryBase &	geometry,
		const std::vector< std::pair< DetId, uint32_t > > &	linearized_dataframes,
		data_type &	data
	)

Definition at line 181 of file HGCalTriggerCellBestChoiceCodecImpl.cc.

References bestChoiceSelect(), HGCalTopology::dddConstants(), DetId::det(), HGCalTriggerGeometryBase::eeTopology(), HGCalTriggerGeometryBase::fhTopology(), DetId::Forward, HGCalTriggerGeometryBase::getModuleFromTriggerCell(), HGCalTriggerGeometryBase::getOrderedTriggerCellsFromModule(), HGCalTriggerGeometryBase::getTriggerCellFromCell(), HGCEE, HGCHEF, HGCalTriggerCellBestChoiceDataPayload::payload, jets_cff::payload, DetId::subdetId(), thickness_corrections_, relativeConstraints::value, and HGCalDDDConstants::waferTypeL().

Referenced by linearize(), and HGCalTriggerCellBestChoiceCodec::setDataPayloadImpl().

{
    if(linearized_dataframes.empty()) return;
    std::map<HGCalDetId, uint32_t> payload;
    // sum energies in trigger cells
    for(const auto& frame : linearized_dataframes)
    {
        DetId cellid(frame.first);
        // find trigger cell associated to cell
        uint32_t tcid = geometry.getTriggerCellFromCell(cellid);
        HGCalDetId triggercellid( tcid );
        payload.insert( std::make_pair(triggercellid, 0) ); // do nothing if key exists already
        uint32_t value = frame.second; 
        // equalize value among cell thicknesses
        if(cellid.det()==DetId::Forward)
        {
            int thickness = 0;
            switch(cellid.subdetId())
            {
                case ForwardSubdetector::HGCEE:
                    thickness = geometry.eeTopology().dddConstants().waferTypeL(HGCalDetId(cellid).wafer())-1;
                    break;
                case ForwardSubdetector::HGCHEF:
                    thickness = geometry.fhTopology().dddConstants().waferTypeL(HGCalDetId(cellid).wafer())-1;
                    break;
                default:
                    break;
            };
            double thickness_correction = thickness_corrections_.at(thickness);
            value = (double)value*thickness_correction;
        }
        payload[triggercellid] += value; // 32 bits integer should be largely enough 

    }
    uint32_t module = geometry.getModuleFromTriggerCell(payload.begin()->first);
    HGCalTriggerGeometryBase::geom_ordered_set trigger_cells_in_module = geometry.getOrderedTriggerCellsFromModule(module);
    // fill data payload
    for(const auto& id_value : payload)
    {
        // Store only energy value and detid
        // No need position here
        data.payload.emplace_back(reco::LeafCandidate::LorentzVector(),
                        id_value.second, 0, 0, 0, id_value.first.rawId());
    }
}

uint32_t HGCalTriggerCellBestChoiceCodecImpl::triggerCellTruncationBits ( ) const

inline

Definition at line 56 of file HGCalTriggerCellBestChoiceCodecImpl.h.

Referenced by HGCalTriggerCellBestChoiceCodec::setDataPayloadImpl().

{return triggerCellTruncationBits_;}

Member Data Documentation

double HGCalTriggerCellBestChoiceCodecImpl::adcLSB_

private

Definition at line 73 of file HGCalTriggerCellBestChoiceCodecImpl.h.

Referenced by HGCalTriggerCellBestChoiceCodecImpl(), and linearize().

uint32_t HGCalTriggerCellBestChoiceCodecImpl::adcnBits_

private

Definition at line 69 of file HGCalTriggerCellBestChoiceCodecImpl.h.

Referenced by HGCalTriggerCellBestChoiceCodecImpl().

double HGCalTriggerCellBestChoiceCodecImpl::adcsaturation_

private

Definition at line 68 of file HGCalTriggerCellBestChoiceCodecImpl.h.

Referenced by HGCalTriggerCellBestChoiceCodecImpl().

size_t HGCalTriggerCellBestChoiceCodecImpl::dataLength_

private

Definition at line 63 of file HGCalTriggerCellBestChoiceCodecImpl.h.

Referenced by decode(), encode(), and HGCalTriggerCellBestChoiceCodecImpl().

double HGCalTriggerCellBestChoiceCodecImpl::linLSB_

private

Definition at line 65 of file HGCalTriggerCellBestChoiceCodecImpl.h.

Referenced by linearize().

uint32_t HGCalTriggerCellBestChoiceCodecImpl::linMax_

private

Definition at line 67 of file HGCalTriggerCellBestChoiceCodecImpl.h.

Referenced by HGCalTriggerCellBestChoiceCodecImpl(), and linearize().

uint32_t HGCalTriggerCellBestChoiceCodecImpl::linnBits_

private

Definition at line 66 of file HGCalTriggerCellBestChoiceCodecImpl.h.

Referenced by HGCalTriggerCellBestChoiceCodecImpl().

size_t HGCalTriggerCellBestChoiceCodecImpl::nCellsInModule_

private

Definition at line 64 of file HGCalTriggerCellBestChoiceCodecImpl.h.

Referenced by decode(), encode(), and HGCalTriggerCellBestChoiceCodecImpl().

size_t HGCalTriggerCellBestChoiceCodecImpl::nData_

private

Definition at line 62 of file HGCalTriggerCellBestChoiceCodecImpl.h.

Referenced by bestChoiceSelect(), decode(), encode(), and HGCalTriggerCellBestChoiceCodecImpl().

double HGCalTriggerCellBestChoiceCodecImpl::tdcLSB_

private

Definition at line 74 of file HGCalTriggerCellBestChoiceCodecImpl.h.

Referenced by HGCalTriggerCellBestChoiceCodecImpl(), and linearize().

uint32_t HGCalTriggerCellBestChoiceCodecImpl::tdcnBits_

private

Definition at line 71 of file HGCalTriggerCellBestChoiceCodecImpl.h.

Referenced by HGCalTriggerCellBestChoiceCodecImpl().

double HGCalTriggerCellBestChoiceCodecImpl::tdcOnsetfC_

private

Definition at line 72 of file HGCalTriggerCellBestChoiceCodecImpl.h.

Referenced by linearize().

double HGCalTriggerCellBestChoiceCodecImpl::tdcsaturation_

private

Definition at line 70 of file HGCalTriggerCellBestChoiceCodecImpl.h.

Referenced by HGCalTriggerCellBestChoiceCodecImpl().

std::vector<double> HGCalTriggerCellBestChoiceCodecImpl::thickness_corrections_

private

Definition at line 77 of file HGCalTriggerCellBestChoiceCodecImpl.h.

Referenced by triggerCellSums().

uint32_t HGCalTriggerCellBestChoiceCodecImpl::triggerCellSaturationBits_

private

Definition at line 76 of file HGCalTriggerCellBestChoiceCodecImpl.h.

Referenced by encode(), and HGCalTriggerCellBestChoiceCodecImpl().

uint32_t HGCalTriggerCellBestChoiceCodecImpl::triggerCellTruncationBits_

private

Definition at line 75 of file HGCalTriggerCellBestChoiceCodecImpl.h.

Referenced by encode(), and HGCalTriggerCellBestChoiceCodecImpl().