SimplePlan1RechitCombiner Class Reference

#include <SimplePlan1RechitCombiner.h>

Inheritance diagram for SimplePlan1RechitCombiner:

Public Member Functions
void	add (const HBHERecHit &rh) override
void	clear () override
void	combine (HBHERecHitCollection *toFill) override
void	setTopo (const HcalTopology *topo) override
	SimplePlan1RechitCombiner ()
	~SimplePlan1RechitCombiner () override
Public Member Functions inherited from AbsPlan1RechitCombiner
virtual	~AbsPlan1RechitCombiner ()

Protected Member Functions
virtual void	combineAuxInfo (const std::vector< const HBHERecHit * > &rechits, HBHERecHit *rh) const
virtual HBHERecHit	makeRechit (HcalDetId idToMake, const std::vector< const HBHERecHit * > &rechits) const
virtual HcalDetId	mapRechit (HcalDetId from) const

Protected Attributes
const HcalTopology *	topo_

Private Types
typedef std::pair< HcalDetId, const HBHERecHit * >	MapItem

Private Attributes
std::vector< const HBHERecHit * >	ptrbuf_
std::vector< MapItem >	rechitMap_

Additional Inherited Members
Protected Types inherited from AbsPlan1RechitCombiner
typedef std::pair< float, float >	FPair
Static Protected Member Functions inherited from AbsPlan1RechitCombiner
static float	energyWeightedAverage (const FPair *data, unsigned len, float valueToReturnOnFailure)

Detailed Description

Definition at line 7 of file SimplePlan1RechitCombiner.h.

Member Typedef Documentation

typedef std::pair<HcalDetId, const HBHERecHit*> SimplePlan1RechitCombiner::MapItem

private

Definition at line 36 of file SimplePlan1RechitCombiner.h.

Constructor & Destructor Documentation

SimplePlan1RechitCombiner::SimplePlan1RechitCombiner

(

)

Definition at line 14 of file SimplePlan1RechitCombiner.cc.

    : topo_(nullptr)
{
}

SimplePlan1RechitCombiner::~SimplePlan1RechitCombiner ( )

inlineoverride

Definition at line 12 of file SimplePlan1RechitCombiner.h.

References add(), clear(), combine(), combineAuxInfo(), makeRechit(), mapRechit(), TrackInfoProducer_cfi::rechits, and setTopo().

{}

Member Function Documentation

void SimplePlan1RechitCombiner::add ( const HBHERecHit &  rh )

overridevirtual

Implements AbsPlan1RechitCombiner.

Definition at line 29 of file SimplePlan1RechitCombiner.cc.

References HBHERecHit::auxPhase1(), CaloRecHitAuxSetter::getBit(), HBHERecHit::id(), mapRechit(), HBHERecHitAuxSetter::OFF_DROPPED, and rechitMap_.

Referenced by counter.Counter::register(), and ~SimplePlan1RechitCombiner().

{
    if (!CaloRecHitAuxSetter::getBit(rh.auxPhase1(), HBHERecHitAuxSetter::OFF_DROPPED))
        rechitMap_.push_back(MapItem(mapRechit(rh.id()), &rh));
}

void SimplePlan1RechitCombiner::clear ( void  )

overridevirtual

Implements AbsPlan1RechitCombiner.

Definition at line 24 of file SimplePlan1RechitCombiner.cc.

References rechitMap_.

Referenced by ~SimplePlan1RechitCombiner().

{
    rechitMap_.clear();
}

void SimplePlan1RechitCombiner::combine ( HBHERecHitCollection *  toFill )

overridevirtual

Implements AbsPlan1RechitCombiner.

Definition at line 35 of file SimplePlan1RechitCombiner.cc.

References plotBeamSpotDB::first, mps_fire::i, HBHERecHit::id(), makeRechit(), ptrbuf_, edm::SortedCollection< T, SORT >::push_back(), DetId::rawId(), rechitMap_, and edm::second().

Referenced by ~SimplePlan1RechitCombiner().

{
    if (!rechitMap_.empty())
    {
        std::sort(rechitMap_.begin(), rechitMap_.end());

        HcalDetId oldId(rechitMap_[0].first);
        ptrbuf_.clear();
        ptrbuf_.push_back(rechitMap_[0].second);

        const std::size_t nInput = rechitMap_.size();
        for (std::size_t i = 1; i < nInput; ++i)
        {
            if (rechitMap_[i].first != oldId)
            {
                const HBHERecHit& rh = makeRechit(oldId, ptrbuf_);
                if (rh.id().rawId())
                    toFill->push_back(rh);
                oldId = rechitMap_[i].first;
                ptrbuf_.clear();
            }
            ptrbuf_.push_back(rechitMap_[i].second);
        }

        const HBHERecHit& rh = makeRechit(oldId, ptrbuf_);
        if (rh.id().rawId())
            toFill->push_back(rh);
    }
}

void SimplePlan1RechitCombiner::combineAuxInfo ( const std::vector< const HBHERecHit * > &  rechits, HBHERecHit *  rh  ) const

protectedvirtual

Definition at line 119 of file SimplePlan1RechitCombiner.cc.

References HBHERecHit::auxPhase1(), constexpr, SoftLeptonByDistance_cfi::distance, CaloRecHit::flags(), flags, getBit(), CaloRecHitAuxSetter::getField(), HcalCaloFlagLabels::HBHEPulseFitBit, mps_fire::i, HBHERecHitAuxSetter::MASK_CAPID, HBHERecHitAuxSetter::MASK_NSAMPLES, HBHERecHitAuxSetter::MASK_SOI, HBHERecHitAuxSetter::OFF_ADC, HBHERecHitAuxSetter::OFF_CAPID, HBHERecHitAuxSetter::OFF_CAPID_ERR, HBHERecHitAuxSetter::OFF_COMBINED, HBHERecHitAuxSetter::OFF_LINK_ERR, HBHERecHitAuxSetter::OFF_NSAMPLES, HBHERecHitAuxSetter::OFF_SOI, HBHERecHitAuxSetter::OFF_TDC_TIME, CaloRecHitAuxSetter::orBit(), HBHERecHit::setAuxHBHE(), HBHERecHit::setAuxPhase1(), setBit(), CaloRecHitAuxSetter::setField(), CaloRecHit::setFlags(), and mitigatedMETSequence_cff::U.

Referenced by makeRechit(), and ~SimplePlan1RechitCombiner().

{
    using namespace CaloRecHitAuxSetter;
    using namespace HcalPhase1FlagLabels;

    // The number of rechits should be not larger than the
    // number of half-bytes in a 32-bit word
    constexpr unsigned MAXLEN = 8U;

    const unsigned nRecHits = rechits.size();
    assert(nRecHits);
    assert(nRecHits <= MAXLEN);

    uint32_t flags = 0, auxPhase1 = 0;
    unsigned tripleFitCount = 0;
    unsigned soiVote[HBHERecHitAuxSetter::MASK_SOI + 1U] = {0};
    unsigned capidVote[HBHERecHitAuxSetter::MASK_CAPID + 1U] = {0};

    // Combine various status bits
    for (unsigned i=0; i<nRecHits; ++i)
    {
        const HBHERecHit& rh(*rechits[i]);
        const uint32_t rhflags = rh.flags();
        const uint32_t rhAuxPhase1 = rh.auxPhase1();

        orBit(&auxPhase1, HBHERecHitAuxSetter::OFF_LINK_ERR,
              getBit(rhAuxPhase1, HBHERecHitAuxSetter::OFF_LINK_ERR));
        orBit(&auxPhase1, HBHERecHitAuxSetter::OFF_CAPID_ERR,
              getBit(rhAuxPhase1, HBHERecHitAuxSetter::OFF_CAPID_ERR));

        const unsigned soi = getField(rhAuxPhase1, HBHERecHitAuxSetter::MASK_SOI,
                                      HBHERecHitAuxSetter::OFF_SOI);
        soiVote[soi]++;

        const unsigned capid = getField(rhAuxPhase1, HBHERecHitAuxSetter::MASK_CAPID,
                                        HBHERecHitAuxSetter::OFF_CAPID);
        capidVote[capid]++;

        if (getBit(rhflags, HBHEStatusFlag::HBHEPulseFitBit))
            ++tripleFitCount;

        // Status flags are simply ORed for now. Might want
        // to rethink this in the future.
        flags |= rhflags;
    }

    unsigned* pmaxsoi = std::max_element(soiVote, soiVote+sizeof(soiVote)/sizeof(soiVote[0]));
    const unsigned soi = std::distance(&soiVote[0], pmaxsoi);
    setField(&auxPhase1, HBHERecHitAuxSetter::MASK_SOI, HBHERecHitAuxSetter::OFF_SOI, soi);

    unsigned* pmaxcapid = std::max_element(capidVote, capidVote+sizeof(capidVote)/sizeof(capidVote[0]));
    const unsigned capid = std::distance(&capidVote[0], pmaxcapid);
    setField(&auxPhase1, HBHERecHitAuxSetter::MASK_CAPID, HBHERecHitAuxSetter::OFF_CAPID, capid);

    // A number that can be later used to calculate chi-square NDoF
    setField(&auxPhase1, HBHERecHitAuxSetter::MASK_NSAMPLES,
             HBHERecHitAuxSetter::OFF_ADC, tripleFitCount);

    // How many rechits were combined?
    setField(&auxPhase1, HBHERecHitAuxSetter::MASK_NSAMPLES,
             HBHERecHitAuxSetter::OFF_NSAMPLES, nRecHits);

    // Should combine QIE11 data only
    setBit(&auxPhase1, HBHERecHitAuxSetter::OFF_TDC_TIME, true);

    // Indicate that this rechit is combined
    setBit(&auxPhase1, HBHERecHitAuxSetter::OFF_COMBINED, true);

    // Copy the aux words into the rechit
    rh->setFlags(flags);
    rh->setAuxPhase1(auxPhase1);

    // Sort the depth values of the combined rechits
    // in the increasing order
    unsigned depthValues[MAXLEN];
    for (unsigned i=0; i<nRecHits; ++i)
        depthValues[i] = rechits[i]->id().depth();
    if (nRecHits > 1U)
        std::sort(depthValues, depthValues+nRecHits);

    // Pack the information about the depth of the rechits
    // that we are combining into the "auxHBHE" word
    uint32_t auxHBHE = 0;
    for (unsigned i=0; i<nRecHits; ++i)
        setField(&auxHBHE, 0xf, i*4, depthValues[i]);
    rh->setAuxHBHE(auxHBHE);
}

HBHERecHit SimplePlan1RechitCombiner::makeRechit ( HcalDetId  idToMake, const std::vector< const HBHERecHit * > &  rechits  ) const

protectedvirtual

Definition at line 71 of file SimplePlan1RechitCombiner.cc.

References HBHERecHit::chi2(), combineAuxInfo(), constexpr, MillePedeFileConverter_cfg::e, HBHERecHit::eaux(), CaloRecHit::energy(), AbsPlan1RechitCombiner::energyWeightedAverage(), HBHERecHit::eraw(), mps_fire::i, HcalSpecialTimes::isSpecial(), HBHERecHit::setAuxEnergy(), HBHERecHit::setChiSquared(), HBHERecHit::setRawEnergy(), CaloRecHit::time(), HBHERecHit::timeFalling(), create_public_lumi_plots::times, mitigatedMETSequence_cff::U, and HcalSpecialTimes::UNKNOWN_T_NOTDC.

Referenced by combine(), and ~SimplePlan1RechitCombiner().

{
    constexpr unsigned MAXLEN = 8U; // Should be >= max # of Phase 1 HCAL depths
    constexpr float TIME_IF_NO_ENERGY = -999.f;

    const unsigned nRecHits = rechits.size();
    assert(nRecHits);
    assert(nRecHits <= MAXLEN);

    // Combine energies, times, and fit chi-square
    double energy = 0.0, eraw = 0.0, eaux = 0.0, chisq = 0.0;
    FPair times[MAXLEN], adctimes[MAXLEN];
    unsigned nADCTimes = 0;

    for (unsigned i=0; i<nRecHits; ++i)
    {
        const HBHERecHit& rh(*rechits[i]);
        const float e = rh.energy();
        energy += e;
        eraw += rh.eraw();
        eaux += rh.eaux();
        chisq += rh.chi2();
        times[i].first = rh.time();
        times[i].second = e;

        const float tADC = rh.timeFalling();
        if (!HcalSpecialTimes::isSpecial(tADC))
        {
            adctimes[nADCTimes].first = tADC;
            adctimes[nADCTimes].second = e;
            ++nADCTimes;
        }
    }

    HBHERecHit rh(idToMake, energy,
                  energyWeightedAverage(times, nRecHits, TIME_IF_NO_ENERGY),
                  energyWeightedAverage(adctimes, nADCTimes, HcalSpecialTimes::UNKNOWN_T_NOTDC));
    rh.setRawEnergy(eraw);
    rh.setAuxEnergy(eaux);
    rh.setChiSquared(chisq);

    // Combine the auxiliary information
    combineAuxInfo(rechits, &rh);

    return rh;
}

HcalDetId SimplePlan1RechitCombiner::mapRechit ( HcalDetId  from ) const

protectedvirtual

Definition at line 65 of file SimplePlan1RechitCombiner.cc.

References HcalTopology::mergedDepthDetId(), and topo_.

Referenced by add(), and ~SimplePlan1RechitCombiner().

{
    return topo_->mergedDepthDetId(from);
}

void SimplePlan1RechitCombiner::setTopo ( const HcalTopology *  topo )

overridevirtual

Implements AbsPlan1RechitCombiner.

Definition at line 19 of file SimplePlan1RechitCombiner.cc.

References topo_.

Referenced by ~SimplePlan1RechitCombiner().

{
    topo_ = topo;
}

Member Data Documentation

std::vector<const HBHERecHit*> SimplePlan1RechitCombiner::ptrbuf_

private

Definition at line 39 of file SimplePlan1RechitCombiner.h.

Referenced by combine().

std::vector<MapItem> SimplePlan1RechitCombiner::rechitMap_

private

Definition at line 38 of file SimplePlan1RechitCombiner.h.

Referenced by add(), clear(), and combine().

const HcalTopology* SimplePlan1RechitCombiner::topo_

protected

Definition at line 31 of file SimplePlan1RechitCombiner.h.

Referenced by mapRechit(), and setTopo().