PuppiAlgo Class Reference

#include <PuppiAlgo.h>

Public Member Functions
void	add (const PuppiCandidate &iParticle, const double &iVal, const unsigned int iAlgo)
int	algoId (unsigned int iAlgo) const
const std::vector< float > &	alphas ()
double	compute (std::vector< double > const &iVals, double iChi2) const
void	computeMedRMS (const unsigned int &iAlgo, const double &iPVFrac)
double	coneSize (unsigned int iAlgo) const
int	etaBins () const
double	etaMax (int i) const
double	etaMin (int i) const
void	fixAlgoEtaBin (int i_eta)
bool	isCharged (unsigned int iAlgo) const
double	median () const
double	neutralPt (int iNPV) const
int	numAlgos () const
double	ptMin () const
	PuppiAlgo (edm::ParameterSet &iConfig)
void	reset ()
double	rms () const
	~PuppiAlgo ()

Private Attributes
double	cur_Med
double	cur_NeutralPtMin
double	cur_NeutralPtSlope
double	cur_PtMin
double	cur_RMS
std::vector< bool >	fAdjust
std::vector< int >	fAlgoId
std::vector< bool >	fCharged
std::vector< int >	fCombId
std::vector< double >	fConeSize
std::vector< double >	fEtaMax
double	fEtaMaxExtrap
std::vector< double >	fEtaMin
std::vector< double >	fMean
std::vector< double >	fMedEtaSF
std::vector< double >	fMedian
std::vector< std::vector< double > >	fMedian_perEta
unsigned int	fNAlgos
std::vector< int >	fNCount
std::vector< double >	fNeutralPtMin
std::vector< double >	fNeutralPtSlope
std::vector< double >	fPtMin
std::vector< float >	fPups
std::vector< float >	fPupsPV
std::vector< double >	fRMS
std::vector< std::vector< double > >	fRMS_perEta
std::vector< double >	fRMSEtaSF
std::vector< double >	fRMSPtMin
std::vector< double >	fRMSScaleFactor

Detailed Description

Definition at line 9 of file PuppiAlgo.h.

Constructor & Destructor Documentation

PuppiAlgo::PuppiAlgo

(

edm::ParameterSet &

iConfig

)

Definition at line 10 of file PuppiAlgo.cc.

References cur_Med, cur_NeutralPtMin, cur_NeutralPtSlope, cur_PtMin, cur_RMS, fAdjust, fAlgoId, fCharged, fCombId, fConeSize, fEtaMax, fEtaMaxExtrap, fEtaMin, fMean, fMedEtaSF, fMedian, fMedian_perEta, fNAlgos, fNCount, fNeutralPtMin, fNeutralPtSlope, fPtMin, fRMS, fRMS_perEta, fRMSEtaSF, fRMSPtMin, fRMSScaleFactor, and edm::ParameterSet::getParameter().

                                             {
    fEtaMin             = iConfig.getParameter<std::vector< double > >("etaMin");
    fEtaMax             = iConfig.getParameter<std::vector< double > >("etaMax");
    fPtMin              = iConfig.getParameter<std::vector< double > >("ptMin");
    fNeutralPtMin       = iConfig.getParameter<std::vector< double > >("MinNeutralPt");      // Weighted Neutral Pt Cut
    fNeutralPtSlope     = iConfig.getParameter<std::vector< double > >("MinNeutralPtSlope"); // Slope vs #pv
    fRMSEtaSF           = iConfig.getParameter<std::vector< double > >("RMSEtaSF");
    fMedEtaSF           = iConfig.getParameter<std::vector< double > >("MedEtaSF");
    fEtaMaxExtrap       = iConfig.getParameter<double>("EtaMaxExtrap");
    
    std::vector<edm::ParameterSet> lAlgos = iConfig.getParameter<std::vector<edm::ParameterSet> >("puppiAlgos");
    fNAlgos = lAlgos.size();
    //Uber Configurable Puppi
    std::vector<double> tmprms;
    std::vector<double> tmpmed;

    for(unsigned int i0 = 0; i0 < lAlgos.size(); i0++)  {
        int    pAlgoId      = lAlgos[i0].getParameter<int >  ("algoId");
        bool   pCharged     = lAlgos[i0].getParameter<bool>  ("useCharged");
        bool   pWeight0     = lAlgos[i0].getParameter<bool>  ("applyLowPUCorr");
        int    pComb        = lAlgos[i0].getParameter<int>   ("combOpt");           // 0=> add in chi2/1=>Multiply p-values
        double pConeSize    = lAlgos[i0].getParameter<double>("cone");              // Min Pt when computing pt and rms
        double pRMSPtMin    = lAlgos[i0].getParameter<double>("rmsPtMin");          // Min Pt when computing pt and rms
        double pRMSSF       = lAlgos[i0].getParameter<double>("rmsScaleFactor");    // Additional Tuning parameter for Jokers
        fAlgoId        .push_back(pAlgoId);
        fCharged       .push_back(pCharged);
        fAdjust        .push_back(pWeight0);
        fCombId        .push_back(pComb);
        fConeSize      .push_back(pConeSize);
        fRMSPtMin      .push_back(pRMSPtMin);
        fRMSScaleFactor.push_back(pRMSSF);
        double pRMS  = 0;
        double pMed  = 0;
        double pMean = 0;
        int    pNCount = 0;
        fRMS   .push_back(pRMS);
        fMedian.push_back(pMed);
        fMean  .push_back(pMean);
        fNCount.push_back(pNCount);

        tmprms.clear();
        tmpmed.clear();
        for (unsigned int j0 = 0; j0 < fEtaMin.size(); j0++){
            tmprms.push_back(pRMS);
            tmpmed.push_back(pMed);
        }
        fRMS_perEta.push_back(tmprms);
        fMedian_perEta.push_back(tmpmed);
    }

    cur_PtMin = -99.;
    cur_NeutralPtMin = -99.;
    cur_NeutralPtSlope = -99.;
    cur_RMS = -99.;
    cur_Med = -99.;
}

PuppiAlgo::~PuppiAlgo

(

)

Definition at line 66 of file PuppiAlgo.cc.

References fPups, and fPupsPV.

                      {
    fPups  .clear();
    fPupsPV.clear();
}

Member Function Documentation

void PuppiAlgo::add	(	const PuppiCandidate &	iParticle,
		const double &	iVal,
		const unsigned int	iAlgo
	)

Definition at line 89 of file PuppiAlgo.cc.

References funct::abs(), PuppiCandidate::eta(), Exception, fEtaMaxExtrap, fNCount, fPups, fPupsPV, fRMSPtMin, and PuppiCandidate::puppi_register().

Referenced by counter.Counter::register(), SequenceTypes.Task::remove(), and SequenceTypes.Task::replace().

                                                                                               {
    if(iParticle.pt() < fRMSPtMin[iAlgo]) return;
    // Change from SRR : Previously used fastjet::PseudoJet::user_index to decide the particle type.
    // In CMSSW we use the user_index to specify the index in the input collection, so I invented
    // a new mechanism using the fastjet UserInfo functionality. Of course, it's still just an integer
    // but that interface could be changed (or augmented) if desired / needed.
    int puppi_register = iParticle.puppi_register();
    if ( puppi_register == std::numeric_limits<int>::lowest() ) {
        throw cms::Exception("PuppiRegisterNotSet") << "The puppi register is not set. This must be set before use.\n";
    }

    // if(fCharged[iAlgo] && std::abs(puppi_register)  < 1) return;
    // if(fCharged[iAlgo] && (std::abs(puppi_register) >=1 && std::abs(puppi_register) <=2)) fPupsPV.push_back(iVal);
    //if(fCharged[iAlgo] && std::abs(puppi_register) < 3) return;
    // fPups.push_back(iVal); //original
    // fNCount[iAlgo]++;

    // added by Nhan -- for all eta regions, compute mean/RMS from the central charged PU
    //std::cout << "std::abs(puppi_register) = " << std::abs(puppi_register) << std::endl;
    if ((std::abs(iParticle.eta()) < fEtaMaxExtrap) && (std::abs(puppi_register) >= 3)){
        fPups.push_back(iVal);
        // fPupsPV.push_back(iVal);        
        fNCount[iAlgo]++;
    }
    // for the low PU case, correction.  for checking that the PU-only median will be below the PV particles
    if(std::abs(iParticle.eta()) < fEtaMaxExtrap && (std::abs(puppi_register) >=1 && std::abs(puppi_register) <=2)) fPupsPV.push_back(iVal);

}

int PuppiAlgo::algoId ( unsigned int  iAlgo ) const

inline

Definition at line 28 of file PuppiAlgo.h.

References fAlgoId.

{ return fAlgoId.at(iAlgo); }

const std::vector<float>& PuppiAlgo::alphas ( )

inline

Definition at line 20 of file PuppiAlgo.h.

References fPups.

{ return fPups; }

double PuppiAlgo::compute	(	std::vector< double > const &	iVals,
		double	iChi2
	)		const

Definition at line 187 of file PuppiAlgo.cc.

References cur_Med, cur_RMS, fAlgoId, fCombId, fNAlgos, and fNCount.

                                                                           {

    if(fAlgoId[0] == -1) return 1;
    double lVal  = 0.;
    double lPVal = 1.;
    int    lNDOF = 0;
    for(unsigned int i0 = 0; i0 < fNAlgos; i0++) {
        if(fNCount[i0] == 0) return 1.;   //in the NoPU case return 1.
        if(fCombId[i0] == 1 && i0 > 0) {  //Compute the previous p-value so that p-values can be multiplieed
            double pPVal = ROOT::Math::chisquared_cdf(lVal,lNDOF);
            lPVal *= pPVal;
            lNDOF = 0;
            lVal  = 0;
        }
        double pVal = iVals[i0];
        //Special Check for any algo with log(0)
        if(fAlgoId[i0] == 0 && iVals[i0] == 0) pVal = cur_Med;
        if(fAlgoId[i0] == 3 && iVals[i0] == 0) pVal = cur_Med;
        if(fAlgoId[i0] == 5 && iVals[i0] == 0) pVal = cur_Med;
        lVal += (pVal-cur_Med)*(fabs(pVal-cur_Med))/cur_RMS/cur_RMS;
        lNDOF++;
        if(i0 == 0 && iChi2 != 0) lNDOF++;      //Add external Chi2 to first element
        if(i0 == 0 && iChi2 != 0) lVal+=iChi2;  //Add external Chi2 to first element
    }
    //Top it off with the last calc
    lPVal *= ROOT::Math::chisquared_cdf(lVal,lNDOF);
    return lPVal;

}

void PuppiAlgo::computeMedRMS	(	const unsigned int &	iAlgo,
		const double &	iPVFrac
	)

Definition at line 123 of file PuppiAlgo.cc.

References MillePedeFileConverter_cfg::e, fAdjust, fEtaMin, fMean, fMedEtaSF, fMedian, fMedian_perEta, fNAlgos, fNCount, fPups, fPupsPV, fRMS, fRMS_perEta, fRMSEtaSF, fRMSScaleFactor, createfilelist::int, and mathSSE::sqrt().

                                                                             {

    //std::cout << "fNCount[iAlgo] = " << fNCount[iAlgo] << std::endl;
    if(iAlgo >= fNAlgos   ) return;
    if(fNCount[iAlgo] == 0) return;

    // sort alphas
    int lNBefore = 0;
    for(unsigned int i0 = 0; i0 < iAlgo; i0++) lNBefore += fNCount[i0];
    std::sort(fPups.begin()+lNBefore,fPups.begin()+lNBefore+fNCount[iAlgo]);
    
    // in case you have alphas == 0
    int lNum0 = 0;
    for(int i0 = lNBefore; i0 < lNBefore+fNCount[iAlgo]; i0++) {
        if(fPups[i0] == 0) lNum0 = i0-lNBefore;
    }

    // comput median, removed lCorr for now
    int lNHalfway = lNBefore + lNum0 + int( double( fNCount[iAlgo]-lNum0 )*0.50);
    fMedian[iAlgo] = fPups[lNHalfway];
    double lMed = fMedian[iAlgo];  //Just to make the readability easier
    
    int lNRMS = 0;
    for(int i0 = lNBefore; i0 < lNBefore+fNCount[iAlgo]; i0++) {
        fMean[iAlgo] += fPups[i0];
        if(fPups[i0] == 0) continue;
        // if(!fCharged[iAlgo] && fAdjust[iAlgo] && fPups[i0] > lMed) continue;
        if(fAdjust[iAlgo] && fPups[i0] > lMed) continue;
        lNRMS++;
        fRMS [iAlgo] += (fPups[i0]-lMed)*(fPups[i0]-lMed);
    }
    fMean[iAlgo]/=fNCount[iAlgo];
    if(lNRMS > 0) fRMS [iAlgo]/=lNRMS;
    if(fRMS[iAlgo] == 0) fRMS[iAlgo] = 1e-5;
    // here is the raw RMS
    fRMS [iAlgo] = sqrt(fRMS[iAlgo]);

    // some ways to do corrections to fRMS and fMedian
    fRMS [iAlgo] *= fRMSScaleFactor[iAlgo];

    if(fAdjust[iAlgo]){ 
        //Adjust the p-value to correspond to the median
        std::sort(fPupsPV.begin(),fPupsPV.end());
        int lNPV = 0; 
        for(unsigned int i0 = 0; i0 < fPupsPV.size(); i0++) if(fPupsPV[i0] <= lMed ) lNPV++;
        double lAdjust = double(lNPV)/double(lNPV+0.5*fNCount[iAlgo]);
        if(lAdjust > 0) {
          fMedian[iAlgo] -= sqrt(ROOT::Math::chisquared_quantile(lAdjust,1.)*fRMS[iAlgo]);
          fRMS[iAlgo]    -= sqrt(ROOT::Math::chisquared_quantile(lAdjust,1.)*fRMS[iAlgo]);
        }        
    }

    // fRMS_perEta[iAlgo]    *= cur_RMSEtaSF;
    // fMedian_perEta[iAlgo] *= cur_MedEtaSF;

    for (unsigned int j0 = 0; j0 < fEtaMin.size(); j0++){
        fRMS_perEta[iAlgo][j0] = fRMS[iAlgo]*fRMSEtaSF[j0];
        fMedian_perEta[iAlgo][j0] = fMedian[iAlgo]*fMedEtaSF[j0];
    }    

}

double PuppiAlgo::coneSize ( unsigned int  iAlgo ) const

inline

Definition at line 30 of file PuppiAlgo.h.

References fConeSize.

{ return fConeSize.at(iAlgo); }

int PuppiAlgo::etaBins ( ) const

inline

Definition at line 22 of file PuppiAlgo.h.

References fEtaMin.

{return fEtaMin.size(); }

double PuppiAlgo::etaMax ( int  i ) const

inline

Definition at line 24 of file PuppiAlgo.h.

References fEtaMax, and mps_fire::i.

{ return fEtaMax[i]; }

double PuppiAlgo::etaMin ( int  i ) const

inline

Definition at line 23 of file PuppiAlgo.h.

References fEtaMin, and mps_fire::i.

{ return fEtaMin[i]; }

void PuppiAlgo::fixAlgoEtaBin

(

int

i_eta

)

Definition at line 81 of file PuppiAlgo.cc.

References cur_Med, cur_NeutralPtMin, cur_NeutralPtSlope, cur_PtMin, cur_RMS, fMedian_perEta, fNeutralPtMin, fNeutralPtSlope, fPtMin, and fRMS_perEta.

                                       {
  cur_PtMin = fPtMin[i_eta]; 
  cur_NeutralPtMin = fNeutralPtMin[i_eta];
  cur_NeutralPtSlope = fNeutralPtSlope[i_eta];
  cur_RMS = fRMS_perEta[0][i_eta]; // 0 is number of algos within this eta bin
  cur_Med = fMedian_perEta[0][i_eta]; // 0 is number of algos within this eta bin
}

bool PuppiAlgo::isCharged ( unsigned int  iAlgo ) const

inline

Definition at line 29 of file PuppiAlgo.h.

References fCharged.

{ return fCharged.at(iAlgo); }

double PuppiAlgo::median ( ) const

inline

Definition at line 34 of file PuppiAlgo.h.

References cur_Med.

{return cur_Med;}

double PuppiAlgo::neutralPt ( int  iNPV ) const

inline

Definition at line 31 of file PuppiAlgo.h.

References cur_NeutralPtMin, and cur_NeutralPtSlope.

{ return cur_NeutralPtMin + iNPV * cur_NeutralPtSlope; }

int PuppiAlgo::numAlgos ( ) const

inline

Definition at line 27 of file PuppiAlgo.h.

References fNAlgos.

{ return fNAlgos;}

double PuppiAlgo::ptMin ( ) const

inline

Definition at line 25 of file PuppiAlgo.h.

References cur_PtMin.

{ return cur_PtMin; }

void PuppiAlgo::reset

(

void

)

Definition at line 70 of file PuppiAlgo.cc.

References fMean, fMedian, fNAlgos, fNCount, fPups, fPupsPV, and fRMS.

Referenced by MatrixReader.MatrixReader::__init__(), data_sources.json_list::next(), and MatrixReader.MatrixReader::showRaw().

                      {
    fPups  .clear();
    fPupsPV.clear();
    for(unsigned int i0 = 0; i0 < fNAlgos; i0++) {
        fMedian[i0] =  0;
        fRMS   [i0] =  0;
        fMean  [i0] =  0;
        fNCount[i0] =  0;
    }
}

double PuppiAlgo::rms ( ) const

inline

Definition at line 33 of file PuppiAlgo.h.

References cur_RMS.

{return cur_RMS;}

Member Data Documentation

double PuppiAlgo::cur_Med

private

Definition at line 52 of file PuppiAlgo.h.

Referenced by compute(), fixAlgoEtaBin(), median(), and PuppiAlgo().

double PuppiAlgo::cur_NeutralPtMin

private

Definition at line 49 of file PuppiAlgo.h.

Referenced by fixAlgoEtaBin(), neutralPt(), and PuppiAlgo().

double PuppiAlgo::cur_NeutralPtSlope

private

Definition at line 50 of file PuppiAlgo.h.

Referenced by fixAlgoEtaBin(), neutralPt(), and PuppiAlgo().

double PuppiAlgo::cur_PtMin

private

Definition at line 48 of file PuppiAlgo.h.

Referenced by fixAlgoEtaBin(), ptMin(), and PuppiAlgo().

double PuppiAlgo::cur_RMS

private

Definition at line 51 of file PuppiAlgo.h.

Referenced by compute(), fixAlgoEtaBin(), PuppiAlgo(), and rms().

std::vector<bool> PuppiAlgo::fAdjust

private

Definition at line 63 of file PuppiAlgo.h.

Referenced by computeMedRMS(), and PuppiAlgo().

std::vector<int> PuppiAlgo::fAlgoId

private

Definition at line 61 of file PuppiAlgo.h.

Referenced by algoId(), compute(), and PuppiAlgo().

std::vector<bool> PuppiAlgo::fCharged

private

Definition at line 62 of file PuppiAlgo.h.

Referenced by isCharged(), and PuppiAlgo().

std::vector<int> PuppiAlgo::fCombId

private

Definition at line 64 of file PuppiAlgo.h.

Referenced by compute(), and PuppiAlgo().

std::vector<double> PuppiAlgo::fConeSize

private

Definition at line 65 of file PuppiAlgo.h.

Referenced by coneSize(), and PuppiAlgo().

std::vector<double> PuppiAlgo::fEtaMax

private

Definition at line 38 of file PuppiAlgo.h.

Referenced by etaMax(), and PuppiAlgo().

double PuppiAlgo::fEtaMaxExtrap

private

Definition at line 46 of file PuppiAlgo.h.

Referenced by add(), and PuppiAlgo().

std::vector<double> PuppiAlgo::fEtaMin

private

Definition at line 39 of file PuppiAlgo.h.

Referenced by computeMedRMS(), etaBins(), etaMin(), and PuppiAlgo().

std::vector<double> PuppiAlgo::fMean

private

Definition at line 68 of file PuppiAlgo.h.

Referenced by computeMedRMS(), PuppiAlgo(), and reset().

std::vector<double> PuppiAlgo::fMedEtaSF

private

Definition at line 45 of file PuppiAlgo.h.

Referenced by computeMedRMS(), and PuppiAlgo().

std::vector<double> PuppiAlgo::fMedian

private

Definition at line 55 of file PuppiAlgo.h.

Referenced by computeMedRMS(), PuppiAlgo(), and reset().

std::vector< std::vector<double> > PuppiAlgo::fMedian_perEta

private

Definition at line 57 of file PuppiAlgo.h.

Referenced by computeMedRMS(), fixAlgoEtaBin(), and PuppiAlgo().

unsigned int PuppiAlgo::fNAlgos

private

Definition at line 37 of file PuppiAlgo.h.

Referenced by compute(), computeMedRMS(), numAlgos(), PuppiAlgo(), and reset().

std::vector<int> PuppiAlgo::fNCount

private

Definition at line 69 of file PuppiAlgo.h.

Referenced by add(), compute(), computeMedRMS(), PuppiAlgo(), and reset().

std::vector<double> PuppiAlgo::fNeutralPtMin

private

Definition at line 41 of file PuppiAlgo.h.

Referenced by fixAlgoEtaBin(), and PuppiAlgo().

std::vector<double> PuppiAlgo::fNeutralPtSlope

private

Definition at line 42 of file PuppiAlgo.h.

Referenced by fixAlgoEtaBin(), and PuppiAlgo().

std::vector<double> PuppiAlgo::fPtMin

private

Definition at line 40 of file PuppiAlgo.h.

Referenced by fixAlgoEtaBin(), and PuppiAlgo().

std::vector<float> PuppiAlgo::fPups

private

Definition at line 59 of file PuppiAlgo.h.

Referenced by add(), alphas(), computeMedRMS(), reset(), and ~PuppiAlgo().

std::vector<float> PuppiAlgo::fPupsPV

private

Definition at line 60 of file PuppiAlgo.h.

Referenced by add(), computeMedRMS(), reset(), and ~PuppiAlgo().

std::vector<double> PuppiAlgo::fRMS

private

Definition at line 54 of file PuppiAlgo.h.

Referenced by computeMedRMS(), PuppiAlgo(), and reset().

std::vector< std::vector<double> > PuppiAlgo::fRMS_perEta

private

Definition at line 56 of file PuppiAlgo.h.

Referenced by computeMedRMS(), fixAlgoEtaBin(), and PuppiAlgo().

std::vector<double> PuppiAlgo::fRMSEtaSF

private

Definition at line 44 of file PuppiAlgo.h.

Referenced by computeMedRMS(), and PuppiAlgo().

std::vector<double> PuppiAlgo::fRMSPtMin

private

Definition at line 66 of file PuppiAlgo.h.

Referenced by add(), and PuppiAlgo().

std::vector<double> PuppiAlgo::fRMSScaleFactor

private

Definition at line 67 of file PuppiAlgo.h.

Referenced by computeMedRMS(), and PuppiAlgo().