#include <L1Trigger/L1TTrackMatch/plugins/L1GTTInputProducer.cc>

Inheritance diagram for L1GTTInputProducer:

Public Member Functions
	L1GTTInputProducer (const edm::ParameterSet &)

	~L1GTTInputProducer () override

Public Member Functions inherited from edm::global::EDProducer<>
	EDProducer ()=default

	EDProducer (const EDProducer &)=delete

bool	hasAbilityToProduceInBeginLumis () const final

bool	hasAbilityToProduceInBeginProcessBlocks () const final

bool	hasAbilityToProduceInBeginRuns () const final

bool	hasAbilityToProduceInEndLumis () const final

bool	hasAbilityToProduceInEndProcessBlocks () const final

bool	hasAbilityToProduceInEndRuns () const final

EDProducer &	operator= (const EDProducer &)=delete

bool	wantsGlobalLuminosityBlocks () const noexcept final

bool	wantsGlobalRuns () const noexcept final

bool	wantsInputProcessBlocks () const noexcept final

bool	wantsProcessBlocks () const noexcept final

bool	wantsStreamLuminosityBlocks () const noexcept final

bool	wantsStreamRuns () const noexcept final

Public Member Functions inherited from edm::global::EDProducerBase
	EDProducerBase ()

ModuleDescription const &	moduleDescription () const

	~EDProducerBase () override

Public Member Functions inherited from edm::ProducerBase
void	callWhenNewProductsRegistered (std::function< void(BranchDescription const &)> const &func)

std::vector< edm::ProductResolverIndex > const &	indiciesForPutProducts (BranchType iBranchType) const

	ProducerBase ()

std::vector< edm::ProductResolverIndex > const &	putTokenIndexToProductResolverIndex () const

std::vector< bool > const &	recordProvenanceList () const

void	registerProducts (ProducerBase , ProductRegistry , ModuleDescription const &)

std::function< void(BranchDescription const &)>	registrationCallback () const
	used by the fwk to register list of products More...

void	resolvePutIndicies (BranchType iBranchType, ModuleToResolverIndicies const &iIndicies, std::string const &moduleLabel)

TypeLabelList const &	typeLabelList () const
	used by the fwk to register the list of products of this module More...

	~ProducerBase () noexcept(false) override

Public Member Functions inherited from edm::EDConsumerBase
std::vector< ConsumesInfo >	consumesInfo () const

void	convertCurrentProcessAlias (std::string const &processName)
	Convert "@currentProcess" in InputTag process names to the actual current process name. More...

	EDConsumerBase ()

	EDConsumerBase (EDConsumerBase const &)=delete

	EDConsumerBase (EDConsumerBase &&)=default

ESResolverIndex const *	esGetTokenIndices (edm::Transition iTrans) const

std::vector< ESResolverIndex > const &	esGetTokenIndicesVector (edm::Transition iTrans) const

std::vector< ESRecordIndex > const &	esGetTokenRecordIndicesVector (edm::Transition iTrans) const

ProductResolverIndexAndSkipBit	indexFrom (EDGetToken, BranchType, TypeID const &) const

void	itemsMayGet (BranchType, std::vector< ProductResolverIndexAndSkipBit > &) const

void	itemsToGet (BranchType, std::vector< ProductResolverIndexAndSkipBit > &) const

std::vector< ProductResolverIndexAndSkipBit > const &	itemsToGetFrom (BranchType iType) const

void	labelsForToken (EDGetToken iToken, Labels &oLabels) const

void	modulesWhoseProductsAreConsumed (std::array< std::vector< ModuleDescription const > , NumBranchTypes > &modulesAll, std::vector< ModuleProcessName > &modulesInPreviousProcesses, ProductRegistry const &preg, std::map< std::string, ModuleDescription const *> const &labelsToDesc, std::string const &processName) const

EDConsumerBase const &	operator= (EDConsumerBase const &)=delete

EDConsumerBase &	operator= (EDConsumerBase &&)=default

bool	registeredToConsume (ProductResolverIndex, bool, BranchType) const

void	selectInputProcessBlocks (ProductRegistry const &productRegistry, ProcessBlockHelperBase const &processBlockHelperBase)

ProductResolverIndexAndSkipBit	uncheckedIndexFrom (EDGetToken) const

void	updateLookup (BranchType iBranchType, ProductResolverIndexHelper const &, bool iPrefetchMayGet)

void	updateLookup (eventsetup::ESRecordsToProductResolverIndices const &)

virtual	~EDConsumerBase () noexcept(false)

Static Public Member Functions
static void	fillDescriptions (edm::ConfigurationDescriptions &descriptions)

Static Public Member Functions inherited from edm::global::EDProducerBase
static const std::string &	baseType ()

static void	fillDescriptions (ConfigurationDescriptions &descriptions)

static void	prevalidate (ConfigurationDescriptions &descriptions)

Private Types
enum	ConversionBitWidths { kEtaMagSize = 3, kEtaFracSize = 5, kEtaInputSize = 16, kPTMagSize = 7, kPTFracSize = 3, kPTInputSize = 15, kEtaOutputSize = kEtaMagSize + kEtaFracSize, kPTOutputSize = kPTMagSize + kPTFracSize }

typedef TTTrack_TrackWord::tanl_t	in_eta_t

typedef TTTrack_TrackWord::rinv_t	in_pt_t

typedef TTTrack< Ref_Phase2TrackerDigi_ >	L1Track

typedef ap_uint< 1 >	out_charge_t

typedef ap_fixed< kEtaOutputSize, kEtaMagSize, AP_RND_CONV, AP_SAT >	out_eta_t

typedef ap_ufixed< kPTOutputSize, kPTMagSize, AP_RND_CONV, AP_SAT >	out_pt_t

typedef std::vector< L1Track >	TTTrackCollection

typedef edm::View< L1Track >	TTTrackCollectionView

Private Member Functions
void	generate_eta_lut ()

void	generate_pt_lut ()

bool	getEtaBits (const L1Track &track, out_eta_t &etaBits, double &expected, double &maxErrPerc, double &maxErrEpsilon) const

bool	getPtBits (const L1Track &track, out_pt_t &ptBits, out_charge_t &chargeBit, double &expected, double &maxErrPerc, double &maxErrEpsilon, double &minErrPerc, double &minExpected) const

double	indexTanLambda2Eta (unsigned int indexTanLambda) const

double	inverseRT2InversePT (unsigned int indexRT) const

void	produce (edm::StreamID, edm::Event &, const edm::EventSetup &) const override

template<typename T >
int	sgn (T val) const

double	unpackSignedValue (unsigned int bits, unsigned int nBits, double lsb) const

Private Attributes
int	debug_

std::vector< out_eta_t >	eta_lut_

const edm::EDGetTokenT< TTTrackCollectionView >	l1TracksToken_

const std::string	outputCollectionName_

std::vector< out_pt_t >	pt_lut_

bool	setTrackWordBits_

Static Private Attributes
static constexpr double	kEtaErrThresh = 0.0485

static constexpr unsigned int	kEtaLutSize = (1 << (ConversionBitWidths::kEtaOutputSize - 1))

static constexpr double	kPTErrThresh = 5

static constexpr unsigned int	kPtLutSize = (1 << ConversionBitWidths::kPTOutputSize)

static constexpr double	kSynchrotron = (1.0 / (0.3 * 3.8))

static constexpr unsigned int	Npars4 = 4

static constexpr unsigned int	Npars5 = 5

Additional Inherited Members
Public Types inherited from edm::global::EDProducerBase
typedef EDProducerBase	ModuleType

Public Types inherited from edm::ProducerBase
template<typename T >
using	BranchAliasSetterT = ProductRegistryHelper::BranchAliasSetterT< T >

using	ModuleToResolverIndicies = std::unordered_multimap< std::string, std::tuple< edm::TypeID const , const char , edm::ProductResolverIndex > >

typedef ProductRegistryHelper::TypeLabelList	TypeLabelList

Public Types inherited from edm::EDConsumerBase
typedef ProductLabels	Labels

Protected Member Functions inherited from edm::ProducerBase
template<Transition Tr = Transition::Event>
auto	produces (std::string instanceName) noexcept
	declare what type of product will make and with which optional label More...

template<Transition B>
BranchAliasSetter	produces (const TypeID &id, std::string instanceName=std::string(), bool recordProvenance=true)

template<BranchType B>
BranchAliasSetter	produces (const TypeID &id, std::string instanceName=std::string(), bool recordProvenance=true)

BranchAliasSetter	produces (const TypeID &id, std::string instanceName=std::string(), bool recordProvenance=true)

template<typename ProductType , Transition B>
BranchAliasSetterT< ProductType >	produces (std::string instanceName)

template<class ProductType >
BranchAliasSetterT< ProductType >	produces ()

template<typename ProductType , BranchType B>
BranchAliasSetterT< ProductType >	produces (std::string instanceName)

template<typename ProductType , BranchType B>
BranchAliasSetterT< ProductType >	produces ()

template<class ProductType >
BranchAliasSetterT< ProductType >	produces (std::string instanceName)

template<typename ProductType , Transition B>
BranchAliasSetterT< ProductType >	produces ()

template<Transition Tr = Transition::Event>
auto	produces () noexcept

ProducesCollector	producesCollector ()

Protected Member Functions inherited from edm::EDConsumerBase
template<typename ProductType , BranchType B = InEvent>
EDGetTokenT< ProductType >	consumes (edm::InputTag const &tag)

template<BranchType B = InEvent>
EDConsumerBaseAdaptor< B >	consumes (edm::InputTag tag) noexcept

EDGetToken	consumes (const TypeToGet &id, edm::InputTag const &tag)

template<BranchType B>
EDGetToken	consumes (TypeToGet const &id, edm::InputTag const &tag)

ConsumesCollector	consumesCollector ()
	Use a ConsumesCollector to gather consumes information from helper functions. More...

template<typename ESProduct , typename ESRecord , Transition Tr = Transition::Event>
auto	esConsumes ()

template<typename ESProduct , typename ESRecord , Transition Tr = Transition::Event>
auto	esConsumes (ESInputTag const &tag)

template<Transition Tr = Transition::Event>
constexpr auto	esConsumes ()

template<Transition Tr = Transition::Event>
auto	esConsumes (ESInputTag tag)

template<Transition Tr = Transition::Event>
ESGetTokenGeneric	esConsumes (eventsetup::EventSetupRecordKey const &iRecord, eventsetup::DataKey const &iKey)
	Used with EventSetupRecord::doGet. More...

template<typename ProductType , BranchType B = InEvent>
EDGetTokenT< ProductType >	mayConsume (edm::InputTag const &tag)

EDGetToken	mayConsume (const TypeToGet &id, edm::InputTag const &tag)

template<BranchType B>
EDGetToken	mayConsume (const TypeToGet &id, edm::InputTag const &tag)

void	resetItemsToGetFrom (BranchType iType)

Detailed Description

Description: Takes in L1TTracks and outputs the same tracks, but with modifications to the underlying track word. The modifications convert from Rinv –> pt and tanL –> eta.

Implementation: [Notes on implementation]

Definition at line 50 of file L1GTTInputProducer.cc.

Member Typedef Documentation

◆ in_eta_t

typedef TTTrack_TrackWord::tanl_t L1GTTInputProducer::in_eta_t

private

Definition at line 85 of file L1GTTInputProducer.cc.

◆ in_pt_t

typedef TTTrack_TrackWord::rinv_t L1GTTInputProducer::in_pt_t

private

Definition at line 87 of file L1GTTInputProducer.cc.

◆ L1Track

typedef TTTrack<Ref_Phase2TrackerDigi_> L1GTTInputProducer::L1Track

private

Definition at line 81 of file L1GTTInputProducer.cc.

◆ out_charge_t

typedef ap_uint<1> L1GTTInputProducer::out_charge_t

private

Definition at line 88 of file L1GTTInputProducer.cc.

◆ out_eta_t

typedef ap_fixed<kEtaOutputSize, kEtaMagSize, AP_RND_CONV, AP_SAT> L1GTTInputProducer::out_eta_t

private

Definition at line 84 of file L1GTTInputProducer.cc.

◆ out_pt_t

typedef ap_ufixed<kPTOutputSize, kPTMagSize, AP_RND_CONV, AP_SAT> L1GTTInputProducer::out_pt_t

private

Definition at line 86 of file L1GTTInputProducer.cc.

◆ TTTrackCollection

typedef std::vector<L1Track> L1GTTInputProducer::TTTrackCollection

private

Definition at line 82 of file L1GTTInputProducer.cc.

◆ TTTrackCollectionView

typedef edm::View<L1Track> L1GTTInputProducer::TTTrackCollectionView

private

Definition at line 83 of file L1GTTInputProducer.cc.

Member Enumeration Documentation

◆ ConversionBitWidths

enum L1GTTInputProducer::ConversionBitWidths

private

Enumerator
kEtaMagSize
kEtaFracSize
kEtaInputSize
kPTMagSize
kPTFracSize
kPTInputSize
kEtaOutputSize
kPTOutputSize

Definition at line 61 of file L1GTTInputProducer.cc.

                            {
     kEtaMagSize = 3,     // eta output magnitude size; MAG + FRAC should be <= kEtaInputSize
     kEtaFracSize = 5,    // eta output fraction size; MAG + FRAC should be <= kEtaInputSize
     kEtaInputSize = 16,  // size of tan(lambda)
 
     kPTMagSize = 7,     // magnitude output size; MAG + FRAC should be <= kPTInputSize
     kPTFracSize = 3,    // fraction output size; MAG + FRAC should be <= kPTInputSize
     kPTInputSize = 15,  // size of 1/R
 
     kEtaOutputSize = kEtaMagSize + kEtaFracSize,  // total bit width for eta
     kPTOutputSize = kPTMagSize + kPTFracSize,     // total bit width for pT
   };

Constructor & Destructor Documentation

◆ L1GTTInputProducer()

L1GTTInputProducer::L1GTTInputProducer ( const edm::ParameterSet & iConfig )

explicit

Definition at line 124 of file L1GTTInputProducer.cc.

References generate_eta_lut(), generate_pt_lut(), and outputCollectionName_.

     : l1TracksToken_(consumes<TTTrackCollectionView>(iConfig.getParameter<edm::InputTag>("l1TracksInputTag"))),
       outputCollectionName_(iConfig.getParameter<std::string>("outputCollectionName")),
       setTrackWordBits_(iConfig.getParameter<bool>("setTrackWordBits")),
       debug_(iConfig.getParameter<int>("debug")) {
   // Generate the required luts
   generate_eta_lut();
   generate_pt_lut();
 
   // Define EDM output to be written to file (if required)
   produces<TTTrackCollection>(outputCollectionName_);
   produces<std::vector<double>>("L1GTTInputTrackPtExpected");
   produces<std::vector<double>>("L1GTTInputTrackEtaExpected");
 }

◆ ~L1GTTInputProducer()

L1GTTInputProducer::~L1GTTInputProducer ( )

override

Definition at line 139 of file L1GTTInputProducer.cc.

139 {}

Member Function Documentation

◆ fillDescriptions()

void L1GTTInputProducer::fillDescriptions ( edm::ConfigurationDescriptions & descriptions )

static

Definition at line 531 of file L1GTTInputProducer.cc.

References edm::ConfigurationDescriptions::addWithDefaultLabel(), submitPVResolutionJobs::desc, ProducerED_cfi::InputTag, and AlCaHLTBitMon_QueryRunRegistry::string.

                                                                                     {
   // L1GTTInputProducer
   edm::ParameterSetDescription desc;
   desc.add<int>("debug", 0)->setComment("Verbosity levels: 0, 1, 2, 3");
   desc.add<edm::InputTag>("l1TracksInputTag", edm::InputTag("TTTracksFromTrackletEmulation", "Level1TTTracks"));
   desc.add<std::string>("outputCollectionName", "Level1TTTracksConverted");
   desc.add<bool>("setTrackWordBits", true)
       ->setComment(
           "flag indicated whether the TTTrack_TrackWord should be set from float parameters or skipped (if TrackWord "
           "set by e.g. GTTFileReader decoding)");
   descriptions.addWithDefaultLabel(desc);
 }

◆ generate_eta_lut()

void L1GTTInputProducer::generate_eta_lut ( )

private

generate_lut: calculate the lut and write it to a file

argument:None
return (void): None
method: 1) iterates through all possibilities of the input value 2) finds values of eta from input values 3) stores the values of eta in an array (lut) 4) writes out the array into a file (eta_lut.h)

Definition at line 155 of file L1GTTInputProducer.cc.

References debug_, eta_lut_, mps_fire::i, indexTanLambda2Eta(), kEtaInputSize, kEtaLutSize, kEtaOutputSize, dqm-mbProfile::log, and funct::pow().

Referenced by L1GTTInputProducer().

                                           {
   // initialize lut array
   eta_lut_.reserve(kEtaLutSize);
 
   // iterate through all values in the lut
   for (unsigned int i = 0; i < kEtaLutSize; i++) {
     // -1 to ignore sign bit for input
     unsigned int index = ((i + 0.5) * pow(2, (int)(kEtaInputSize - kEtaOutputSize)));
     double newValue = indexTanLambda2Eta(index);  // map out the index to the represented eta
     out_eta_t out_eta = newValue;                 // cast it to fxp
     eta_lut_[i] = out_eta;                        // add value for the lut
   }
 
   if (debug_ >= 3) {
     edm::LogInfo log("L1GTTInputProducer");
     log << "generate_eta_lut::The eta_lut_[" << kEtaLutSize << "] values are ... \n";
     for (unsigned int i = 0; i < kEtaLutSize; i++) {
       log << "\t" << i << "\t" << eta_lut_[i] << "\n";
     }
   }
 }

◆ generate_pt_lut()

void L1GTTInputProducer::generate_pt_lut ( )

private

Definition at line 177 of file L1GTTInputProducer.cc.

References debug_, mps_fire::i, inverseRT2InversePT(), kPTInputSize, kPtLutSize, kPTOutputSize, dqm-mbProfile::log, funct::pow(), and pt_lut_.

Referenced by L1GTTInputProducer().

                                          {
   // initialize lut array
   pt_lut_.reserve(kPtLutSize);  // generate lut
 
   // iterate through all values in the lut
   for (unsigned int i = 0; i < kPtLutSize; i++) {
     unsigned int index = (i + 0.5) * pow(2, (int)(kPTInputSize - 1 - kPTOutputSize));
     double newValue = inverseRT2InversePT(index);  //map out the index to the represented 1/pT
     out_pt_t out_pt = 1.0 / newValue;              // take the reciprocal and cast as an AP fixed-point (1/pt ==> pt)
     pt_lut_[i] = out_pt;                           // setting the i-th value for the lut
   }
 
   if (debug_ >= 3) {
     edm::LogInfo log("L1GTTInputProducer");
     log << "generate_pt_lut::The pt_lut_[" << kPtLutSize << "] values are ... \n";
     for (unsigned int i = 0; i < kPtLutSize; i++) {
       log << "\t" << i << "\t" << pt_lut_[i] << "\n";
     }
   }
 }

◆ getEtaBits()

bool L1GTTInputProducer::getEtaBits	(	const L1Track &	track,
		out_eta_t &	etaBits,
		double &	expected,
		double &	maxErrPerc,
		double &	maxErrEpsilon
	)		const

private

Definition at line 248 of file L1GTTInputProducer.cc.

References funct::abs(), debug_, dumpMFGeometry_cfg::delta, eta_lut_, indexTanLambda2Eta(), kEtaErrThresh, kEtaInputSize, kEtaOutputSize, ALPAKA_ACCELERATOR_NAMESPACE::pixelClustering::pixelStatus::mask, funct::pow(), Validation_hcalonly_cfi::sign, HLT_2024v14_cff::track, and relativeConstraints::value.

Referenced by produce().

                                                                                                                  {
   // Conver the input to an ap_uint
   in_eta_t value = track.getTanlWord();
 
   // Get the expected outcome (floating point)
   out_eta_t maxValuePossible = pow(2, 15);  // saturate at max value possible for fxp
   expected = indexTanLambda2Eta(value);     // expected value for eta
   if (expected > maxValuePossible) {
     expected = maxValuePossible;
   }
 
   // Converted value (emulation)
   // Masking and shifting converts the efficient bit representation into an index
   // Start by setting up the masks
   in_eta_t indexTanLambda = value;
   in_eta_t mask = ~0;                                                      // mask (all 1's)
   bool sign = indexTanLambda.range(kEtaInputSize - 1, kEtaInputSize - 1);  // sign bit of indexTanLambda
   mask *= sign;  // all 0's for positive numbers, all 1's for negative numbers
 
   // Take the absolute value of indexTanLambda (2's complement)
   indexTanLambda ^= mask;
   indexTanLambda += sign;
 
   // Find the value for eta, not |eta|
   indexTanLambda =
       indexTanLambda >>
       (kEtaInputSize -
        kEtaOutputSize);  // Don't subtract 1 because we now want to take into account the sign bit of the output
   indexTanLambda =
       (indexTanLambda < (1 << (kEtaOutputSize - 1))) ? indexTanLambda : in_eta_t((1 << (kEtaOutputSize - 1)) - 1);
   etaBits = eta_lut_[indexTanLambda];
 
   // Reinacting the sign
   out_eta_t maskOut;
   maskOut.V = ~0;
   maskOut *= sign;
   etaBits ^= maskOut;
   etaBits.V += sign;
 
   // Compare the floating point calculation to the emulation
   double delta = std::abs(expected - etaBits.to_double());
   double perc_diff = (delta / std::abs(expected)) * 100.;  // calc percentage error
   if (delta > maxErrEpsilon) {
     maxErrPerc = perc_diff;
     maxErrEpsilon = delta;
   }
 
   if (delta >= kEtaErrThresh) {
     edm::LogError("L1GTTInputProducer") << "getEtaBits::MISMATCH!!!\n"
                                         << "\tTTTrack tanL = " << track.tanL() << "\n"
                                         << "\tTTTrack eta = " << track.momentum().eta() << "\n"
                                         << "\tTTTrack_TrackWord = " << track.getTrackWord().to_string(2) << "\n"
                                         << "\tTTTrack_TrackWord tanlWord = " << track.getTanlWord() << " ("
                                         << track.getTanlWord().to_string(2) << ")\n"
                                         << "\tin_eta_t value = " << value << " (" << value.to_string(2) << ")\n"
                                         << "\tExpected value = " << expected << "\n"
                                         << "\tCalculated eta = " << etaBits.to_double() << " (" << etaBits.to_string(2)
                                         << ") @ index " << indexTanLambda << "\n"
                                         << "\tDelta = " << delta << "\tpercentage error = " << perc_diff;
     return true;
   } else {
     if (debug_ >= 2) {
       edm::LogInfo("L1GTTInputProducer")
           << "getEtaBits::SUCCESS (TTTrack, floating eta calculation, bitwise calculation, initial index, lut index) = "
           << "(" << track.momentum().eta() << ", " << expected << ", " << etaBits << ", " << value << ", "
           << indexTanLambda << ")";
     }
   }
 
   return false;
 }

◆ getPtBits()

bool L1GTTInputProducer::getPtBits	(	const L1Track &	track,
		out_pt_t &	ptBits,
		out_charge_t &	chargeBit,
		double &	expected,
		double &	maxErrPerc,
		double &	maxErrEpsilon,
		double &	minErrPerc,
		double &	minExpected
	)		const

private

Definition at line 321 of file L1GTTInputProducer.cc.

References funct::abs(), ALCARECOTkAlJpsiMuMu_cff::charge, debug_, dumpMFGeometry_cfg::delta, inverseRT2InversePT(), kPTErrThresh, kPTInputSize, kPTOutputSize, ALPAKA_ACCELERATOR_NAMESPACE::pixelClustering::pixelStatus::mask, funct::pow(), pt_lut_, EcalSCDynamicDPhiParametersESProducer_cfi::saturation, sgn(), Validation_hcalonly_cfi::sign, HLT_2024v14_cff::track, and relativeConstraints::value.

Referenced by produce().

                                                               {
   // Convert the input to an ap_uint
   in_pt_t value = track.getRinvWord();
   in_pt_t value_initial = value;
 
   // Get the expected outcome (floating point)
   out_pt_t maxValuePossible = pow(2, 16);       // saturate at max value possible for fxp
   expected = 1.0 / inverseRT2InversePT(value);  // expected value for inverse
   bool saturation = true;
   if (std::abs(expected) > maxValuePossible) {
     expected = maxValuePossible;
   } else {
     saturation = false;
   }
 
   // Converted value (emulation)
   // Masking and shifting converts the efficient bit representation into an index
   // Start by setting up the masks
   in_pt_t mask = ~0;                                            // mask (all 1's)
   bool sign = value.range(kPTInputSize - 1, kPTInputSize - 1);  // sign bit of value
   mask *= sign;  // all 0's for positive numbers, all 1's for negative numbers
 
   // Take the absolute value of value (2's complement)
   value ^= mask;
   value += sign;
 
   // Shift the value so that the index changes when the LSB of the output changes
   value = value >> (kPTInputSize - 1 - (kPTOutputSize));
 
   // Get the pt from the LUT
   ptBits = pt_lut_[value];
 
   // Set the charge bit
   chargeBit = sign;
   double charge = 1. - (2 * chargeBit.to_uint());
 
   // Compare the floating point calculation to the emulation
   double delta = std::abs(expected - (charge * ptBits.to_double()));
   double perc_diff = (delta / std::abs(expected)) * 100.;
 
   if (delta > maxErrEpsilon) {
     maxErrPerc = perc_diff;
     maxErrEpsilon = delta;
   } else if (delta < minExpected && !saturation && minErrPerc > 100.0) {
     minErrPerc = perc_diff;
     minExpected = expected;
   }
 
   if (std::abs(perc_diff) >= kPTErrThresh && !saturation) {
     edm::LogError("L1GTTInputProducer") << "getPtBits::MISMATCH!!!\n"
                                         << "\tTTTrack Rinv = " << track.rInv() << "\n"
                                         << "\tTTTrack pt = " << track.momentum().transverse() << "\n"
                                         << "\tTTTrack_TrackWord = " << track.getTrackWord().to_string(2) << "\n"
                                         << "\tTTTrack_TrackWord RinvWord = " << track.getRinvWord() << " ("
                                         << track.getRinvWord().to_string(2) << ")\n"
                                         << "\tin_pt_t value = " << value_initial << " (" << value_initial.to_string(2)
                                         << ")\n"
                                         << "\tExpected value = " << expected << "\n"
                                         << "\tCalculated pt = " << ptBits.to_double() << " (" << ptBits.to_string(2)
                                         << ") @ index " << value << "\n"
                                         << "\tcharge = " << charge << " (bit = " << chargeBit << ")\n"
                                         << "\tDelta = " << delta << "\tpercentage error = " << perc_diff;
     return true;
   } else {
     if (debug_ >= 2) {
       edm::LogInfo("L1GTTInputProducer") << "getPtBits::SUCCESS (TTTrack, floating pt calculation, charge, bitwise "
                                             "calculation, initial index, lut index) = "
                                          << "(" << sgn(track.rInv()) * track.momentum().transverse() << ", " << expected
                                          << ", " << charge << ", " << ptBits << ", " << value_initial << ", " << value
                                          << ")";
     }
   }
 
   return false;
 }

◆ indexTanLambda2Eta()

double L1GTTInputProducer::indexTanLambda2Eta ( unsigned int indexTanLambda ) const

private

indexTanLambda2Eta: calculates eta from tan(lambda)

argument: indexTanLambda (int): the index representation for tan(lambda)
formula: f(x) = -1*ln(tan((pi/2-atan(x))/2)), where x = tan(lambda)
return (double): eta

Definition at line 222 of file L1GTTInputProducer.cc.

References debug_, PVValHelper::eta, kEtaInputSize, dqm-mbProfile::log, M_PI, TTTrack_TrackWord::stepTanL, funct::tan(), theta(), and unpackSignedValue().

Referenced by generate_eta_lut(), and getEtaBits().

                                                                                {
   double tanl = unpackSignedValue(indexTanLambda, kEtaInputSize, TTTrack_TrackWord::stepTanL);
   double theta = (M_PI / 2.0) - atan(tanl);
   double eta = -1.0 * log(tan(theta / 2.0));
   if (debug_ >= 3) {
     edm::LogInfo("L1GTTInputProducer") << "indexTanLambda2Eta::tanl index = " << indexTanLambda << "\n"
                                        << "indexTanLambda2Eta::tanl value = " << tanl << "\n"
                                        << "indexTanLambda2Eta::theta = " << theta << "\n"
                                        << "indexTanLambda2Eta::eta = " << eta;
   }
   return eta;
 }

◆ inverseRT2InversePT()

double L1GTTInputProducer::inverseRT2InversePT ( unsigned int indexRT ) const

private

inverseRT2InversePT: calculates 1/pT from 1/rT

argument: indexRT (int): the index representation for 1/rT
formula: f(x) = 100.*(1/(0.3*3.8))*x , where x = 1/R
return (double): 1/pT

Definition at line 243 of file L1GTTInputProducer.cc.

References kPTInputSize, kSynchrotron, TTTrack_TrackWord::stepRinv, and unpackSignedValue().

Referenced by generate_pt_lut(), and getPtBits().

                                                                          {
   double inverseRT = unpackSignedValue(indexRT, kPTInputSize, TTTrack_TrackWord::stepRinv);
   return 100.0 * kSynchrotron * inverseRT;  // multiply by 100 to convert from cm to m
 }

◆ produce()

void L1GTTInputProducer::produce	(	edm::StreamID	,
		edm::Event &	iEvent,
		const edm::EventSetup &	iSetup
	)		const

overrideprivatevirtual

Implements edm::global::EDProducerBase.

Definition at line 405 of file L1GTTInputProducer.cc.

References debug_, Exception, getEtaBits(), getPtBits(), iEvent, kEtaErrThresh, kPTErrThresh, kPTInputSize, l1TracksToken_, eostools::move(), Npars4, Npars5, outputCollectionName_, setTrackWordBits_, and HLT_2024v14_cff::track.

                                                                                                  {
   auto vTTTrackOutput = std::make_unique<TTTrackCollection>();
   auto vPtOutput = std::make_unique<std::vector<double>>();
   auto vEtaOutput = std::make_unique<std::vector<double>>();
 
   edm::Handle<TTTrackCollectionView> l1TracksHandle;
   iEvent.getByToken(l1TracksToken_, l1TracksHandle);
 
   out_charge_t chargeBit = 0;
   out_pt_t ptBits = 0;
   out_eta_t etaBits = 0;
   in_pt_t ptBitsShifted = 0;
   in_eta_t etaBitsShifted = 0;
   unsigned int error_pt_c = 0;        // error counter
   unsigned int error_eta_c = 0;       // error counter
   double expectedPt = 0.0;            // expected value of the pt
   double expectedEta = 0.0;           // expected value of the eta
   double maxErrPercPt = 0.0;          // stores the maximum error percentage
   double maxErrPercEta = 0.0;         // stores the maximum error percentage
   double maxErrEpsilonPt = 0.0;       // keeps track of epsilon for max error
   double maxErrEpsilonEta = 0.0;      // keeps track of epsilon for max error
   double minErrPercPt = 10000000.0;   // stores the maximum error percentage
   double minExpectedPt = 10000000.0;  // keeps track of epsilon for max error
 
   unsigned int nOutput = l1TracksHandle->size();
   vTTTrackOutput->reserve(nOutput);
   vPtOutput->reserve(nOutput);
   vEtaOutput->reserve(nOutput);
   for (const auto& track : *l1TracksHandle) {
     if (setTrackWordBits_ && !(track.nFitPars() == Npars4 || track.nFitPars() == Npars5)) {
       throw cms::Exception("nFitPars unknown")
           << "L1GTTInputProducer::produce method is called with numFitPars_ = " << track.nFitPars()
           << ". The only possible values are 4/5.";
     }
 
     // Fill the vector of tracks
     vTTTrackOutput->push_back(track);
     auto& currentTrackRef = vTTTrackOutput->back();
     if (debug_ >= 2) {
       edm::LogInfo("L1GTTInputProducer") << "produce::word before anything with setTrackWordBits_ = "
                                          << setTrackWordBits_ << ": " << currentTrackRef.getTrackWord().to_string(2);
     }
 
     // Do an initial setting of the bits based on the floating point values
     if (setTrackWordBits_)
       currentTrackRef.setTrackWordBits();
     if (debug_ >= 2) {
       edm::LogInfo("L1GTTInputProducer") << "produce::word after initial setting of the track word "
                                          << currentTrackRef.getTrackWord().to_string(2);
     }
 
     // Do the conversions
     error_pt_c += getPtBits(
         currentTrackRef, ptBits, chargeBit, expectedPt, maxErrPercPt, maxErrEpsilonPt, minErrPercPt, minExpectedPt);
     error_eta_c += getEtaBits(currentTrackRef, etaBits, expectedEta, maxErrPercEta, maxErrEpsilonEta);
 
     // Assign the exat same bits to an ap_uint
     ptBitsShifted = ptBits.range();
     etaBitsShifted = etaBits.range();
 
     // Shift the bits so that the decimal is in the right spot for the GTT software
     ptBitsShifted = ptBitsShifted << 2;
     etaBitsShifted = etaBitsShifted << 8;
 
     // Set the MSB for the pt to the sign of the incoming word
     ptBitsShifted.set(kPTInputSize - 1, chargeBit);
 
     // Set the correct bits based on the converted quanteties and the existing track word components
     currentTrackRef.setTrackWord(currentTrackRef.getValidWord(),
                                  ptBitsShifted,
                                  currentTrackRef.getPhiWord(),
                                  etaBitsShifted,
                                  currentTrackRef.getZ0Word(),
                                  currentTrackRef.getD0Word(),
                                  currentTrackRef.getChi2RPhiWord(),
                                  currentTrackRef.getChi2RZWord(),
                                  currentTrackRef.getBendChi2Word(),
                                  currentTrackRef.getHitPatternWord(),
                                  currentTrackRef.getMVAQualityWord(),
                                  currentTrackRef.getMVAOtherWord());
     if (debug_ >= 2) {
       edm::LogInfo("L1GTTInputProducer") << "produce::charge after all conversions " << chargeBit << "\n"
                                          << "produce::ptBits after all conversions " << ptBits.to_string(2) << " ("
                                          << ptBitsShifted.to_string(2) << " = " << ptBitsShifted.to_uint() << ")\n"
                                          << "produce::etaBits after all conversions " << etaBits.to_string(2) << " ("
                                          << etaBitsShifted.to_string(2) << " = " << etaBitsShifted.to_uint() << ")\n"
                                          << "produce::word after all conversions "
                                          << vTTTrackOutput->back().getTrackWord().to_string(2);
     }
 
     // Fill the remaining outputs
     vPtOutput->push_back(expectedPt);
     vEtaOutput->push_back(expectedEta);
   }
 
   if (debug_ >= 1) {
     edm::LogInfo("L1GTTInputProducer") << "\nNumber of converted tracks: " << nOutput << "\n\n"
                                        << "q/r ==> pt conversion:\n"
                                        << "\tError Threshold: " << kPTErrThresh << "%\n"
                                        << "\tMax error: " << maxErrEpsilonPt
                                        << " GeV difference with percentage: " << maxErrPercPt << "% @ "
                                        << 100.0 * maxErrEpsilonPt / maxErrPercPt << " GeV"
                                        << "\n"
                                        << "\tError @ max range: " << minExpectedPt
                                        << " GeV with precentage: " << minErrPercPt << "%"
                                        << "\n"
                                        << "\tTotal number of errors: " << error_pt_c << "\n\n"
                                        << "tan(lambda) ==> eta conversion:\n"
                                        << "\tError Threshold: " << kEtaErrThresh << "\n"
                                        << "\tMax error: " << maxErrEpsilonEta << " with percentage: " << maxErrPercEta
                                        << "% @ " << 100.0 * maxErrEpsilonEta / maxErrPercEta << "\n"
                                        << "\tTotal number of errors: " << error_eta_c;
   }
 
   if (error_pt_c + error_eta_c) {
     edm::LogError("L1GTTInputProducer") << "produce::" << error_pt_c << "/" << error_eta_c
                                         << " pt/eta mismatches detected!!!";
   }
 
   // Put the outputs into the event
   iEvent.put(std::move(vTTTrackOutput), outputCollectionName_);
   iEvent.put(std::move(vPtOutput), "L1GTTInputTrackPtExpected");
   iEvent.put(std::move(vEtaOutput), "L1GTTInputTrackEtaExpected");
 }

◆ sgn()

template<typename T >

int L1GTTInputProducer::sgn ( T val ) const

inlineprivate

Definition at line 107 of file L1GTTInputProducer.cc.

References heppy_batch::val.

Referenced by getPtBits().

                        {
     return (T(0) < val) - (val < T(0));
   }  // From https://stackoverflow.com/questions/1903954/is-there-a-standard-sign-function-signum-sgn-in-c-c

◆ unpackSignedValue()

double L1GTTInputProducer::unpackSignedValue	(	unsigned int	bits,
		unsigned int	nBits,
		double	lsb
	)		const

private

Definition at line 198 of file L1GTTInputProducer.cc.

References cms::cuda::assert(), ALPAKA_ACCELERATOR_NAMESPACE::pixelClustering::pixelStatus::bits, and l1tHGCalVFEProducer_cfi::lsb.

Referenced by indexTanLambda2Eta(), and inverseRT2InversePT().

                                                                                                     {
   // Check that none of the bits above the nBits-1 bit, in a range of [0, nBits-1], are set.
   // This makes sure that it isn't possible for the value represented by 'bits' to be
   //  any bigger than ((1 << nBits) - 1).
   assert((bits >> nBits) == 0);
 
   // Convert from twos compliment to C++ signed integer (normal digitized value)
   int digitizedValue = bits;
   if (bits & (1 << (nBits - 1))) {  // check if the 'bits' is negative
     digitizedValue -= (1 << nBits);
   }
 
   // Convert to floating point value
   return (double(digitizedValue) + 0.5) * lsb;
 }

Member Data Documentation

◆ debug_

int L1GTTInputProducer::debug_

private

Definition at line 116 of file L1GTTInputProducer.cc.

Referenced by generate_eta_lut(), generate_pt_lut(), getEtaBits(), getPtBits(), indexTanLambda2Eta(), and produce().

◆ eta_lut_

std::vector<out_eta_t> L1GTTInputProducer::eta_lut_

private

Definition at line 118 of file L1GTTInputProducer.cc.

Referenced by generate_eta_lut(), and getEtaBits().

◆ kEtaErrThresh

constexpr double L1GTTInputProducer::kEtaErrThresh = 0.0485

staticprivate

Definition at line 74 of file L1GTTInputProducer.cc.

Referenced by getEtaBits(), and produce().

◆ kEtaLutSize

constexpr unsigned int L1GTTInputProducer::kEtaLutSize = (1 << (ConversionBitWidths::kEtaOutputSize - 1))

staticprivate

Definition at line 79 of file L1GTTInputProducer.cc.

Referenced by generate_eta_lut().

◆ kPTErrThresh

constexpr double L1GTTInputProducer::kPTErrThresh = 5

staticprivate

Definition at line 76 of file L1GTTInputProducer.cc.

Referenced by getPtBits(), and produce().

◆ kPtLutSize

constexpr unsigned int L1GTTInputProducer::kPtLutSize = (1 << ConversionBitWidths::kPTOutputSize)

staticprivate

Definition at line 78 of file L1GTTInputProducer.cc.

Referenced by generate_pt_lut().

◆ kSynchrotron

constexpr double L1GTTInputProducer::kSynchrotron = (1.0 / (0.3 * 3.8))

staticprivate

Definition at line 77 of file L1GTTInputProducer.cc.

Referenced by inverseRT2InversePT().

◆ l1TracksToken_

const edm::EDGetTokenT<TTTrackCollectionView> L1GTTInputProducer::l1TracksToken_

private

Definition at line 113 of file L1GTTInputProducer.cc.

Referenced by produce().

◆ Npars4

constexpr unsigned int L1GTTInputProducer::Npars4 = 4

staticprivate

Definition at line 59 of file L1GTTInputProducer.cc.

Referenced by produce().

◆ Npars5

constexpr unsigned int L1GTTInputProducer::Npars5 = 5

staticprivate

Definition at line 60 of file L1GTTInputProducer.cc.

Referenced by produce().

◆ outputCollectionName_

const std::string L1GTTInputProducer::outputCollectionName_

private

Definition at line 114 of file L1GTTInputProducer.cc.

Referenced by L1GTTInputProducer(), and produce().

◆ pt_lut_

std::vector<out_pt_t> L1GTTInputProducer::pt_lut_

private

Definition at line 117 of file L1GTTInputProducer.cc.

Referenced by generate_pt_lut(), and getPtBits().

◆ setTrackWordBits_

bool L1GTTInputProducer::setTrackWordBits_

private

Definition at line 115 of file L1GTTInputProducer.cc.

Referenced by produce().

Public Member Functions

Static Public Member Functions

Private Types

Private Member Functions

Private Attributes

Static Private Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ in_eta_t

◆ in_pt_t

◆ L1Track

◆ out_charge_t

◆ out_eta_t

◆ out_pt_t

◆ TTTrackCollection

◆ TTTrackCollectionView

Member Enumeration Documentation

◆ ConversionBitWidths

Constructor & Destructor Documentation

◆ L1GTTInputProducer()

◆ ~L1GTTInputProducer()

Member Function Documentation

◆ fillDescriptions()

◆ generate_eta_lut()

◆ generate_pt_lut()

◆ getEtaBits()

◆ getPtBits()

◆ indexTanLambda2Eta()

◆ inverseRT2InversePT()

◆ produce()

◆ sgn()

◆ unpackSignedValue()

Member Data Documentation

◆ debug_

◆ eta_lut_

◆ kEtaErrThresh

◆ kEtaLutSize

◆ kPTErrThresh

◆ kPtLutSize

◆ kSynchrotron

◆ l1TracksToken_

◆ Npars4

◆ Npars5

◆ outputCollectionName_

◆ pt_lut_

◆ setTrackWordBits_