OOTPileupCorrData Class Reference

#include <OOTPileupCorrData.h>

Inheritance diagram for OOTPileupCorrData:

Public Member Functions
void	apply (const HcalDetId &id, const double *inputCharge, unsigned lenInputCharge, const BunchXParameter *bcParams, unsigned lenBcParams, unsigned firstTimeSlice, unsigned nTimeSlices, double *correctedCharge, unsigned lenCorrectedCharge, bool *pulseShapeCorrApplied, bool *leakCorrApplied, bool *readjustTiming) const override
void	apply (const HcalDetId &id, double *ts, const int tsTrig) const
const OOTPileupCorrDataFcn &	getCorrectionByID (const HcalDetId &id) const
bool	inputIsEnergy () const override
	OOTPileupCorrData (const std::vector< OOTPileupCorrDataFcn > &corrs, const std::vector< uint32_t > &iEtaLimits, double chargeLimit, int requireFirstTS, int requireNTS, bool readjustTiming)
	OOTPileupCorrData ()
	~OOTPileupCorrData () override
Public Member Functions inherited from AbsOOTPileupCorrection
bool	operator!= (const AbsOOTPileupCorrection &r) const
bool	operator== (const AbsOOTPileupCorrection &r) const
virtual	~AbsOOTPileupCorrection ()

Protected Member Functions
bool	isEqual (const AbsOOTPileupCorrection &otherBase) const override

Private Member Functions
template<class Archive >
void	load (Archive &ar, const unsigned)
template<class Archive >
void	save (Archive &ar, const unsigned) const
bool	validate () const

Private Attributes
double	chargeLimit_
std::vector< OOTPileupCorrDataFcn >	corrs_
std::vector< uint32_t >	iEtaLimits_
uint8_t	readjustTiming_
int32_t	requireFirstTS_
int32_t	requireNTS_

Friends
class	boost::serialization::access

Detailed Description

Definition at line 14 of file OOTPileupCorrData.h.

Constructor & Destructor Documentation

OOTPileupCorrData::OOTPileupCorrData	(	const std::vector< OOTPileupCorrDataFcn > &	corrs,
		const std::vector< uint32_t > &	iEtaLimits,
		double	chargeLimit,
		int	requireFirstTS,
		int	requireNTS,
		bool	readjustTiming
	)

Definition at line 7 of file OOTPileupCorrData.cc.

References Exception, and validate().

    : corrs_(corrs),
      iEtaLimits_(iEtaLimits),
      chargeLimit_(chargeLimit),
      requireFirstTS_(requireFirstTS),
      requireNTS_(requireNTS),
      readjustTiming_(readjustTiming)
{
    if (!validate()) throw cms::Exception(
        "Invalid OOTPileupCorrData constructor arguments");
}

OOTPileupCorrData::~OOTPileupCorrData ( )

inlineoverride

Definition at line 57 of file OOTPileupCorrData.h.

References apply().

{}

OOTPileupCorrData::OOTPileupCorrData ( )

inline

Definition at line 122 of file OOTPileupCorrData.h.

References validate().

{}

Member Function Documentation

void OOTPileupCorrData::apply ( const HcalDetId &  id, const double *  inputCharge, unsigned  lenInputCharge, const BunchXParameter *  bcParams, unsigned  lenBcParams, unsigned  firstTimeSlice, unsigned  nTimeSlices, double *  correctedCharge, unsigned  lenCorrectedCharge, bool *  pulseShapeCorrApplied, bool *  leakCorrApplied, bool *  readjustTiming  ) const

overridevirtual

Implements AbsOOTPileupCorrection.

Definition at line 40 of file OOTPileupCorrData.cc.

References Exception, mps_fire::i, readjustTiming_, requireFirstTS_, and requireNTS_.

Referenced by heavyIonTools.ConfigureHeavyIons::__call__(), editorTools.UserCodeTool::__call__(), HiCoreTools.RestrictInputToAOD::__call__(), coreTools.RunOnData::__call__(), trackTools.MakeAODTrackCandidates::__call__(), runJetUncertainties.RunJetUncertainties::__call__(), metTools.AddMETCollection::__call__(), heavyIonTools.ProductionDefaults::__call__(), editorTools.ChangeSource::__call__(), HiCoreTools.RemoveMCMatching::__call__(), cmsswVersionTools.PickRelValInputFiles::__call__(), coreTools.RemoveMCMatching::__call__(), trackTools.MakePATTrackCandidates::__call__(), trigTools.SwitchOnTrigger::__call__(), runMETCorrectionsAndUncertainties.RunMETCorrectionsAndUncertainties::__call__(), heavyIonTools.SelectionDefaults::__call__(), HiCoreTools.RemoveAllPATObjectsBut::__call__(), heavyIonTools.DisbaleMonteCarloDeps::__call__(), HiCoreTools.RemoveSpecificPATObjects::__call__(), trigTools.SwitchOnTriggerStandAlone::__call__(), trackTools.MakeTrackCandidates::__call__(), tauTools.AddTauCollection::__call__(), trigTools.SwitchOnTriggerMatching::__call__(), HiCoreTools.RemoveCleaning::__call__(), HiCoreTools.AddCleaning::__call__(), trigTools.SwitchOnTriggerMatchingStandAlone::__call__(), trigTools.SwitchOnTriggerMatchEmbedding::__call__(), jetTools.AddJetCollection::__call__(), jetTools.SwitchJetCollection::__call__(), jetTools.UpdateJetCollection::__call__(), jetTools.AddJetID::__call__(), jetTools.SetTagInfos::__call__(), and ~OOTPileupCorrData().

{
    // Check the arguments
    if (inputCharge == nullptr || correctedCharge == nullptr ||
        lenCorrectedCharge < lenInputCharge ||
        pulseShapeCorrApplied == nullptr || leakCorrApplied == nullptr ||
        readjustTiming == nullptr)
        throw cms::Exception(
            "Invalid arguments in OOTPileupCorrData::apply");

    for (unsigned i=0; i<lenInputCharge; ++i)
        correctedCharge[i] = inputCharge[i];

    // Check whether the charge corrections should actually be applied
    const bool fixCharge = (requireFirstTS_ < 0 || 
                            requireFirstTS_ == static_cast<int32_t>(firstTimeSlice)) &&
                           (requireNTS_ < 0 ||
                            requireNTS_ == static_cast<int32_t>(nTimeSlices));
    if (fixCharge)
        apply(id, correctedCharge, firstTimeSlice);

    *pulseShapeCorrApplied = false;
    *leakCorrApplied = fixCharge;
    *readjustTiming = readjustTiming_;
}

void OOTPileupCorrData::apply ( const HcalDetId &  id, double *  ts, const int  tsTrig  ) const

inline

Definition at line 72 of file OOTPileupCorrData.h.

References funct::abs(), chargeLimit_, corrs_, iEtaLimits_, mitigatedMETSequence_cff::U, and eostools::which().

Referenced by heavyIonTools.ConfigureHeavyIons::__call__(), editorTools.UserCodeTool::__call__(), HiCoreTools.RestrictInputToAOD::__call__(), trackTools.MakeAODTrackCandidates::__call__(), coreTools.RunOnData::__call__(), runJetUncertainties.RunJetUncertainties::__call__(), metTools.AddMETCollection::__call__(), heavyIonTools.ProductionDefaults::__call__(), editorTools.ChangeSource::__call__(), HiCoreTools.RemoveMCMatching::__call__(), cmsswVersionTools.PickRelValInputFiles::__call__(), coreTools.RemoveMCMatching::__call__(), trackTools.MakePATTrackCandidates::__call__(), trigTools.SwitchOnTrigger::__call__(), runMETCorrectionsAndUncertainties.RunMETCorrectionsAndUncertainties::__call__(), heavyIonTools.SelectionDefaults::__call__(), HiCoreTools.RemoveAllPATObjectsBut::__call__(), heavyIonTools.DisbaleMonteCarloDeps::__call__(), HiCoreTools.RemoveSpecificPATObjects::__call__(), trigTools.SwitchOnTriggerStandAlone::__call__(), trackTools.MakeTrackCandidates::__call__(), tauTools.AddTauCollection::__call__(), trigTools.SwitchOnTriggerMatching::__call__(), HiCoreTools.RemoveCleaning::__call__(), HiCoreTools.AddCleaning::__call__(), trigTools.SwitchOnTriggerMatchingStandAlone::__call__(), trigTools.SwitchOnTriggerMatchEmbedding::__call__(), jetTools.AddJetCollection::__call__(), jetTools.SwitchJetCollection::__call__(), jetTools.UpdateJetCollection::__call__(), jetTools.AddJetID::__call__(), and jetTools.SetTagInfos::__call__().

    {
        if (ts[tsTrig] > chargeLimit_)
        {
            const unsigned nLimits(iEtaLimits_.size());
            if (nLimits)
            {
                const uint32_t uEta = std::abs(id.ieta());
                const uint32_t* limits(&iEtaLimits_[0]);
                unsigned which(0U);
                for (; which<nLimits; ++which)
                    if (uEta < limits[which])
                        break;
                corrs_[which].pucorrection(ts, tsTrig);
            }
        }
    }

const OOTPileupCorrDataFcn& OOTPileupCorrData::getCorrectionByID ( const HcalDetId &  id ) const

inline

Definition at line 90 of file OOTPileupCorrData.h.

References funct::abs(), corrs_, iEtaLimits_, mitigatedMETSequence_cff::U, and eostools::which().

    {
        const unsigned nLimits = iEtaLimits_.size();
        unsigned which(0U);
        if (nLimits)
        {
        const uint32_t uEta = std::abs(id.ieta());
        const uint32_t* limits(&iEtaLimits_[0]);
        for (; which<nLimits; ++which)
            if (uEta < limits[which])
                break;
        }
        return corrs_.at(which);
    }

bool OOTPileupCorrData::inputIsEnergy ( ) const

inlineoverridevirtual

Implements AbsOOTPileupCorrection.

Definition at line 69 of file OOTPileupCorrData.h.

{return false;}

bool OOTPileupCorrData::isEqual ( const AbsOOTPileupCorrection &  otherBase ) const

inlineoverrideprotectedvirtual

Implements AbsOOTPileupCorrection.

Definition at line 107 of file OOTPileupCorrData.h.

References chargeLimit_, corrs_, iEtaLimits_, alignCSCRings::r, readjustTiming_, requireFirstTS_, and requireNTS_.

    {
        const OOTPileupCorrData& r = 
            static_cast<const OOTPileupCorrData&>(otherBase);
        return corrs_ == r.corrs_ &&
               iEtaLimits_ == r.iEtaLimits_ &&
               chargeLimit_ == r.chargeLimit_ &&
               requireFirstTS_ == r.requireFirstTS_ &&
               requireNTS_ == r.requireNTS_ &&
               readjustTiming_ == r.readjustTiming_;
    }

template<class Archive >

void OOTPileupCorrData::load ( Archive &  ar, const unsigned    )

inlineprivate

Definition at line 147 of file OOTPileupCorrData.h.

References Exception, readjustTiming_, and validate().

Referenced by MatrixToProcess.MatrixToProcess::getProcess(), MatrixToProcess.MatrixToProcess::listAll(), and ConfigBuilder.ConfigBuilder::prepare_FILTER().

    {
        boost::serialization::base_object<AbsOOTPileupCorrection>(*this);
        ar & corrs_ & iEtaLimits_ & chargeLimit_
           & requireFirstTS_ & requireNTS_ & readjustTiming_;
        if (!validate()) throw cms::Exception(
            "In OOTPileupCorrData::load: invalid data");
    }

template<class Archive >

void OOTPileupCorrData::save ( Archive &  ar, const unsigned    ) const

inlineprivate

Definition at line 137 of file OOTPileupCorrData.h.

References Exception, readjustTiming_, and validate().

Referenced by Vispa.Main.TabController.TabController::allowClose(), Vispa.Main.TabController.TabController::checkModificationTimestamp(), and SpecificationBuilder_cfi.Specification::saveAll().

    {
        if (!validate()) throw cms::Exception(
            "In OOTPileupCorrData::save: invalid data");
        boost::serialization::base_object<AbsOOTPileupCorrection>(*this);
        ar & corrs_ & iEtaLimits_ & chargeLimit_
           & requireFirstTS_ & requireNTS_ & readjustTiming_;
    }

bool OOTPileupCorrData::validate ( ) const

private

Definition at line 25 of file OOTPileupCorrData.cc.

References corrs_, mps_fire::i, and iEtaLimits_.

Referenced by load(), OOTPileupCorrData(), and save().

{
    const std::size_t nLimits(iEtaLimits_.size());
    if (!nLimits)
        return false;
    if (nLimits >= static_cast<std::size_t>(UINT_MAX))
        return false;
    for (std::size_t i=0; i<nLimits-1; ++i)
        if (!(iEtaLimits_[i] < iEtaLimits_[i+1]))
            return false;
    if (corrs_.size() != nLimits + 1)
        return false;
    return true;
}

Friends And Related Function Documentation

friend class boost::serialization::access

friend

Definition at line 134 of file OOTPileupCorrData.h.

Member Data Documentation

double OOTPileupCorrData::chargeLimit_

private

Definition at line 129 of file OOTPileupCorrData.h.

Referenced by apply(), and isEqual().

std::vector<OOTPileupCorrDataFcn> OOTPileupCorrData::corrs_

private

Definition at line 127 of file OOTPileupCorrData.h.

Referenced by apply(), getCorrectionByID(), isEqual(), and validate().

std::vector<uint32_t> OOTPileupCorrData::iEtaLimits_

private

Definition at line 128 of file OOTPileupCorrData.h.

Referenced by apply(), getCorrectionByID(), isEqual(), and validate().

uint8_t OOTPileupCorrData::readjustTiming_

private

Definition at line 132 of file OOTPileupCorrData.h.

Referenced by apply(), isEqual(), load(), and save().

int32_t OOTPileupCorrData::requireFirstTS_

private

Definition at line 130 of file OOTPileupCorrData.h.

Referenced by apply(), and isEqual().

int32_t OOTPileupCorrData::requireNTS_

private

Definition at line 131 of file OOTPileupCorrData.h.

Referenced by apply(), and isEqual().