PuppiProducer Class Reference

#include <PuppiProducer.h>

Inheritance diagram for PuppiProducer:

Public Types
typedef edm::View < reco::Candidate >	CandidateView
typedef math::XYZTLorentzVector	LorentzVector
typedef std::vector < LorentzVector >	LorentzVectorCollection
typedef std::vector < reco::PFCandidate >	PFInputCollection
typedef std::vector < reco::PFCandidate >	PFOutputCollection
typedef edm::View < reco::PFCandidate >	PFView
typedef reco::VertexCollection	VertexCollection
Public Types inherited from edm::stream::EDProducer<>
typedef CacheContexts< T...>	CacheTypes
typedef CacheTypes::GlobalCache	GlobalCache
typedef AbilityChecker< T...>	HasAbility
typedef CacheTypes::LuminosityBlockCache	LuminosityBlockCache
typedef LuminosityBlockContextT < LuminosityBlockCache, RunCache, GlobalCache >	LuminosityBlockContext
typedef CacheTypes::LuminosityBlockSummaryCache	LuminosityBlockSummaryCache
typedef CacheTypes::RunCache	RunCache
typedef RunContextT< RunCache, GlobalCache >	RunContext
typedef CacheTypes::RunSummaryCache	RunSummaryCache
Public Types inherited from edm::stream::EDProducerBase
typedef EDProducerAdaptorBase	ModuleType
Public Types inherited from edm::ProducerBase
typedef ProductRegistryHelper::TypeLabelList	TypeLabelList
Public Types inherited from edm::EDConsumerBase
typedef ProductLabels	Labels

Public Member Functions
	PuppiProducer (const edm::ParameterSet &)
	~PuppiProducer ()
Public Member Functions inherited from edm::stream::EDProducer<>
	EDProducer ()=default
Public Member Functions inherited from edm::stream::EDProducerBase
	EDProducerBase ()
ModuleDescription const &	moduleDescription () const
virtual	~EDProducerBase ()
Public Member Functions inherited from edm::ProducerBase
void	callWhenNewProductsRegistered (std::function< void(BranchDescription const &)> const &func)
	ProducerBase ()
void	registerProducts (ProducerBase *, ProductRegistry *, ModuleDescription const &)
std::function< void(BranchDescription const &)>	registrationCallback () const
	used by the fwk to register list of products More...
virtual	~ProducerBase ()
Public Member Functions inherited from edm::EDConsumerBase
std::vector< ConsumesInfo >	consumesInfo () const
	EDConsumerBase ()
ProductHolderIndexAndSkipBit	indexFrom (EDGetToken, BranchType, TypeID const &) const
void	itemsMayGet (BranchType, std::vector< ProductHolderIndexAndSkipBit > &) const
void	itemsToGet (BranchType, std::vector< ProductHolderIndexAndSkipBit > &) const
std::vector < ProductHolderIndexAndSkipBit > const &	itemsToGetFromEvent () const
void	labelsForToken (EDGetToken iToken, Labels &oLabels) const
void	modulesDependentUpon (const std::string &iProcessName, std::vector< const char * > &oModuleLabels) const
void	modulesWhoseProductsAreConsumed (std::vector< ModuleDescription const * > &modules, ProductRegistry const &preg, std::map< std::string, ModuleDescription const * > const &labelsToDesc, std::string const &processName) const
bool	registeredToConsume (ProductHolderIndex, bool, BranchType) const
bool	registeredToConsumeMany (TypeID const &, BranchType) const
void	updateLookup (BranchType iBranchType, ProductHolderIndexHelper const &)
virtual	~EDConsumerBase ()

Static Public Member Functions
static void	fillDescriptions (edm::ConfigurationDescriptions &descriptions)
Static Public Member Functions inherited from edm::stream::EDProducerBase
static const std::string &	baseType ()
static void	fillDescriptions (ConfigurationDescriptions &descriptions)
static void	prevalidate (ConfigurationDescriptions &descriptions)

Private Member Functions
virtual void	beginJob ()
virtual void	beginLuminosityBlock (edm::LuminosityBlock &, edm::EventSetup const &)
virtual void	beginRun (edm::Run &, edm::EventSetup const &)
virtual void	endJob ()
virtual void	endLuminosityBlock (edm::LuminosityBlock &, edm::EventSetup const &)
virtual void	endRun (edm::Run &, edm::EventSetup const &)
virtual void	produce (edm::Event &, const edm::EventSetup &)

Private Attributes
float	fDZCut
std::string	fPFName
std::auto_ptr< PFOutputCollection >	fPuppiCandidates
std::unique_ptr< PuppiContainer >	fPuppiContainer
bool	fPuppiDiagnostics
std::string	fPuppiName
std::string	fPVName
std::vector< RecoObj >	fRecoObjCollection
bool	fUseDZ
edm::EDGetTokenT< CandidateView >	tokenPFCandidates_
edm::EDGetTokenT < VertexCollection >	tokenVertices_

Additional Inherited Members
Protected Member Functions inherited from edm::EDConsumerBase
template<typename ProductType , BranchType B = InEvent>
EDGetTokenT< ProductType >	consumes (edm::InputTag const &tag)
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 ProductType , BranchType B = InEvent>
void	consumesMany ()
void	consumesMany (const TypeToGet &id)
template<BranchType B>
void	consumesMany (const TypeToGet &id)
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)

Detailed Description

Definition at line 19 of file PuppiProducer.h.

Member Typedef Documentation

typedef edm::View<reco::Candidate> PuppiProducer::CandidateView

Definition at line 29 of file PuppiProducer.h.

typedef math::XYZTLorentzVector PuppiProducer::LorentzVector

Definition at line 26 of file PuppiProducer.h.

typedef std::vector<LorentzVector> PuppiProducer::LorentzVectorCollection

Definition at line 27 of file PuppiProducer.h.

typedef std::vector< reco::PFCandidate > PuppiProducer::PFInputCollection

Definition at line 30 of file PuppiProducer.h.

typedef std::vector< reco::PFCandidate > PuppiProducer::PFOutputCollection

Definition at line 31 of file PuppiProducer.h.

typedef edm::View<reco::PFCandidate> PuppiProducer::PFView

Definition at line 32 of file PuppiProducer.h.

typedef reco::VertexCollection PuppiProducer::VertexCollection

Definition at line 28 of file PuppiProducer.h.

Constructor & Destructor Documentation

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

explicit

Definition at line 31 of file PuppiProducer.cc.

References fDZCut, fPuppiContainer, fPuppiDiagnostics, fUseDZ, edm::ParameterSet::getParameter(), tokenPFCandidates_, and tokenVertices_.

                                                           {
  fPuppiDiagnostics = iConfig.getParameter<bool>("puppiDiagnostics");
  fUseDZ     = iConfig.getParameter<bool>("UseDeltaZCut");
  fDZCut     = iConfig.getParameter<double>("DeltaZCut");
  fPuppiContainer = std::unique_ptr<PuppiContainer> ( new PuppiContainer(iConfig) );

  tokenPFCandidates_
    = consumes<CandidateView>(iConfig.getParameter<edm::InputTag>("candName"));
  tokenVertices_
    = consumes<VertexCollection>(iConfig.getParameter<edm::InputTag>("vertexName"));
 

  produces<edm::ValueMap<float> > ();
  produces<edm::ValueMap<LorentzVector> > ();
  produces< edm::ValueMap<reco::CandidatePtr> >(); 
  
  produces<PFOutputCollection>();

  if (fPuppiDiagnostics){
    produces<double> ("PuppiNAlgos");
    produces<std::vector<double>> ("PuppiRawAlphas");
    produces<std::vector<double>> ("PuppiAlphas");
    produces<std::vector<double>> ("PuppiAlphasMed");
    produces<std::vector<double>> ("PuppiAlphasRms");
  }
}

PuppiProducer::~PuppiProducer

(

)

Definition at line 58 of file PuppiProducer.cc.

                             {
}

Member Function Documentation

void PuppiProducer::beginJob ( void  )

privatevirtual

Definition at line 226 of file PuppiProducer.cc.

                             {
}

void PuppiProducer::beginLuminosityBlock ( edm::LuminosityBlock &  , edm::EventSetup const &    )

privatevirtual

Definition at line 238 of file PuppiProducer.cc.

                                                                                  {
}

void PuppiProducer::beginRun ( edm::Run &  , edm::EventSetup const &    )

privatevirtual

Definition at line 232 of file PuppiProducer.cc.

                                                          {
}

void PuppiProducer::endJob ( void  )

privatevirtual

Definition at line 229 of file PuppiProducer.cc.

                           {
}

void PuppiProducer::endLuminosityBlock ( edm::LuminosityBlock &  , edm::EventSetup const &    )

privatevirtual

Definition at line 241 of file PuppiProducer.cc.

                                                                                {
}

void PuppiProducer::endRun ( edm::Run &  , edm::EventSetup const &    )

privatevirtual

Definition at line 235 of file PuppiProducer.cc.

                                                        {
}

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

static

Definition at line 244 of file PuppiProducer.cc.

References edm::ConfigurationDescriptions::addDefault(), and edm::ParameterSetDescription::setUnknown().

                                                                               {
  //The following says we do not know what parameters are allowed so do no validation
  // Please change this to state exactly what you do use, even if it is no parameters
  edm::ParameterSetDescription desc;
  desc.setUnknown();
  descriptions.addDefault(desc);
}

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

privatevirtual

Implements edm::stream::EDProducerBase.

Definition at line 61 of file PuppiProducer.cc.

References edm::View< T >::begin(), RecoObj::charge, RecoObj::d0, pat::PackedCandidate::dxy(), RecoObj::dZ, pat::PackedCandidate::dz(), edm::View< T >::end(), RecoObj::eta, fDZCut, edm::helper::Filler< Map >::fill(), fPuppiCandidates, fPuppiContainer, fPuppiDiagnostics, fRecoObjCollection, pat::PackedCandidate::fromPV(), fUseDZ, edm::Event::getByToken(), reco::PFCandidate::gsfTrackRef(), i, RecoObj::id, edm::helper::Filler< Map >::insert(), edm::Ref< C, T, F >::isNonnull(), RecoObj::m, RecoObj::phi, edm::Handle< T >::product(), RecoObj::pt, edm::Event::put(), pat::PackedCandidate::PVLoose, pat::PackedCandidate::PVTight, pat::PackedCandidate::PVUsedInFit, RecoObj::rapidity, reco::LeafCandidate::setP4(), tokenPFCandidates_, tokenVertices_, reco::PFCandidate::trackRef(), reco::PFCandidate::translatePdgIdToType(), makeHLTPrescaleTable::values, pat::PackedCandidate::vertexRef(), and RecoObj::vtxId.

Referenced by JSONExport.JsonExport::export(), HTMLExport.HTMLExport::export(), and HTMLExport.HTMLExportStatic::export().

                                                                         {

  // Get PFCandidate Collection
  edm::Handle<CandidateView> hPFProduct;
  iEvent.getByToken(tokenPFCandidates_,hPFProduct);
  const CandidateView *pfCol = hPFProduct.product();

  // Get vertex collection w/PV as the first entry?
  edm::Handle<reco::VertexCollection> hVertexProduct;
  iEvent.getByToken(tokenVertices_,hVertexProduct);
  const reco::VertexCollection *pvCol = hVertexProduct.product();

  //Fill the reco objects
  fRecoObjCollection.clear();
  for(CandidateView::const_iterator itPF = pfCol->begin(); itPF!=pfCol->end(); itPF++) {
    RecoObj pReco;
    pReco.pt  = itPF->pt();
    pReco.eta = itPF->eta();
    pReco.phi = itPF->phi();
    pReco.m   = itPF->mass();
    pReco.rapidity = itPF->rapidity();
    pReco.charge = itPF->charge(); 
    const reco::Vertex *closestVtx = 0;
    double pDZ    = -9999; 
    double pD0    = -9999; 
    int    pVtxId = -9999; 
    bool lFirst = true;
    const pat::PackedCandidate *lPack = dynamic_cast<const pat::PackedCandidate*>(&(*itPF));
    if(lPack == 0 ) {
      const reco::PFCandidate *pPF = dynamic_cast<const reco::PFCandidate*>(&(*itPF));
      for(reco::VertexCollection::const_iterator iV = pvCol->begin(); iV!=pvCol->end(); ++iV) {
        if(lFirst) {
          if      ( pPF->trackRef().isNonnull()    ) pDZ = pPF->trackRef()   ->dz(iV->position());
          else if ( pPF->gsfTrackRef().isNonnull() ) pDZ = pPF->gsfTrackRef()->dz(iV->position());
          if      ( pPF->trackRef().isNonnull()    ) pD0 = pPF->trackRef()   ->d0();
          else if ( pPF->gsfTrackRef().isNonnull() ) pD0 = pPF->gsfTrackRef()->d0();
          lFirst = false;
          if(pDZ > -9999) pVtxId = 0;
        }
        if(iV->trackWeight(pPF->trackRef())>0) {
            closestVtx  = &(*iV);
            break;
          }
        pVtxId++;
      }
    } else if(lPack->vertexRef().isNonnull() )  {
        pDZ        = lPack->dz();
        pD0        = lPack->dxy();
        closestVtx = &(*(lPack->vertexRef()));
        pVtxId = (lPack->fromPV() != (pat::PackedCandidate::PVUsedInFit));
        if( (lPack->fromPV() == pat::PackedCandidate::PVLoose) || (lPack->fromPV() == pat::PackedCandidate::PVTight) ){
            pVtxId = 0;
        } 
    }
      pReco.dZ      = pDZ;
      pReco.d0      = pD0;
      
      if(closestVtx == 0) pReco.vtxId = -1;
      if(closestVtx != 0) pReco.vtxId = pVtxId;
      //if(closestVtx != 0) pReco.vtxChi2 = closestVtx->trackWeight(itPF->trackRef());
      //Set the id for Puppi Algo: 0 is neutral pfCandidate, id = 1 for particles coming from PV and id = 2 for charged particles from non-leading vertex
      pReco.id       = 0;
      
      if(closestVtx != 0 && pVtxId == 0 && fabs(pReco.charge) > 0) pReco.id = 1;
      if(closestVtx != 0 && pVtxId >  0 && fabs(pReco.charge) > 0) pReco.id = 2;
      //Add a dZ cut if wanted (this helps)
      if(fUseDZ && pDZ > -9999 && closestVtx == 0 && (fabs(pDZ) < fDZCut) && fabs(pReco.charge) > 0) pReco.id = 1;
      if(fUseDZ && pDZ > -9999 && closestVtx == 0 && (fabs(pDZ) > fDZCut) && fabs(pReco.charge) > 0) pReco.id = 2;
      
      //std::cout << "pVtxId = " << pVtxId << ", and charge = " << itPF->charge() << ", and closestVtx = " << closestVtx << ", and id = " << pReco.id << std::endl;
      //std::cout << "charge = " << itPF->charge() << ", pDZ = " << pDZ << ", pVtxId = " << pVtxId << ", closestVtx = " << closestVtx << ", fromPV() = " << lPack->fromPV() << ", pReco.id = " << pReco.id << std::endl;

      fRecoObjCollection.push_back(pReco);
  }

  fPuppiContainer->initialize(fRecoObjCollection);

  //Compute the weights
  const std::vector<double> lWeights = fPuppiContainer->puppiWeights();
  //Fill it into the event
  std::auto_ptr<edm::ValueMap<float> > lPupOut(new edm::ValueMap<float>());
  edm::ValueMap<float>::Filler  lPupFiller(*lPupOut);
  lPupFiller.insert(hPFProduct,lWeights.begin(),lWeights.end());
  lPupFiller.fill();

  // This is a dummy to access the "translate" method which is a
  // non-static member function even though it doesn't need to be. 
  // Will fix in the future. 
  static const reco::PFCandidate dummySinceTranslateIsNotStatic;

  //Fill a new PF Candidate Collection and write out the ValueMap of the new p4s.
  // Since the size of the ValueMap must be equal to the input collection, we need
  // to search the "puppi" particles to find a match for each input. If none is found,
  // the input is set to have a four-vector of 0,0,0,0
  const std::vector<fastjet::PseudoJet> lCandidates = fPuppiContainer->puppiParticles();
  fPuppiCandidates.reset( new PFOutputCollection );
  std::auto_ptr<edm::ValueMap<LorentzVector> > p4PupOut(new edm::ValueMap<LorentzVector>());
  LorentzVectorCollection puppiP4s;
  std::vector<reco::CandidatePtr> values(hPFProduct->size());
  //std::vector<int> values(hPFProduct->size());
  
  for ( auto i0 = hPFProduct->begin(),
      i0begin = hPFProduct->begin(),
      i0end = hPFProduct->end(); i0 != i0end; ++i0 ) {
    //for(unsigned int i0 = 0; i0 < lCandidates.size(); i0++) {
    //reco::PFCandidate pCand;
    auto id = dummySinceTranslateIsNotStatic.translatePdgIdToType(i0->pdgId());
    const reco::PFCandidate *pPF = dynamic_cast<const reco::PFCandidate*>(&(*i0));
    reco::PFCandidate pCand( pPF ? *pPF : reco::PFCandidate(i0->charge(), i0->p4(), id) );
    LorentzVector pVec = i0->p4();
    int val = i0 - i0begin;

    // Find the Puppi particle matched to the input collection using the "user_index" of the object. 
    auto puppiMatched = find_if( lCandidates.begin(), lCandidates.end(), [&val]( fastjet::PseudoJet const & i ){ return i.user_index() == val; } );
    if ( puppiMatched != lCandidates.end() ) {
      pVec.SetPxPyPzE(puppiMatched->px(),puppiMatched->py(),puppiMatched->pz(),puppiMatched->E());
    } else {
      pVec.SetPxPyPzE( 0, 0, 0, 0);
    }
    pCand.setP4(pVec);
    puppiP4s.push_back( pVec );
    fPuppiCandidates->push_back(pCand);
  }

  //Compute the modified p4s
  edm::ValueMap<LorentzVector>::Filler  p4PupFiller(*p4PupOut);
  p4PupFiller.insert(hPFProduct,puppiP4s.begin(), puppiP4s.end() );
  p4PupFiller.fill();
  
  iEvent.put(lPupOut);
  iEvent.put(p4PupOut);
  edm::OrphanHandle<reco::PFCandidateCollection> oh = iEvent.put( fPuppiCandidates );
  for(unsigned int ic=0, nc = oh->size(); ic < nc; ++ic) {
      reco::CandidatePtr pkref( oh, ic );
      values[ic] = pkref;
    
   }  
  std::auto_ptr<edm::ValueMap<reco::CandidatePtr> > pfMap_p(new edm::ValueMap<reco::CandidatePtr>());
  edm::ValueMap<reco::CandidatePtr>::Filler filler(*pfMap_p);
  filler.insert(hPFProduct, values.begin(), values.end());
  filler.fill();
  iEvent.put(pfMap_p);


  if (fPuppiDiagnostics){

    // all the different alphas per particle
    // THE alpha per particle
    std::auto_ptr<std::vector<double> > theAlphas(new std::vector<double>(fPuppiContainer->puppiAlphas()));
    std::auto_ptr<std::vector<double> > theAlphasMed(new std::vector<double>(fPuppiContainer->puppiAlphasMed()));
    std::auto_ptr<std::vector<double> > theAlphasRms(new std::vector<double>(fPuppiContainer->puppiAlphasRMS()));
    std::auto_ptr<std::vector<double> > alphas(new std::vector<double>(fPuppiContainer->puppiRawAlphas()));
    std::auto_ptr<double> nalgos(new double(fPuppiContainer->puppiNAlgos()));
    
    iEvent.put(alphas,"PuppiRawAlphas");
    iEvent.put(nalgos,"PuppiNAlgos");
    iEvent.put(theAlphas,"PuppiAlphas");
    iEvent.put(theAlphasMed,"PuppiAlphasMed");
    iEvent.put(theAlphasRms,"PuppiAlphasRms");
  }
  
}

Member Data Documentation

float PuppiProducer::fDZCut

private

Definition at line 51 of file PuppiProducer.h.

Referenced by produce(), and PuppiProducer().

std::string PuppiProducer::fPFName

private

Definition at line 47 of file PuppiProducer.h.

std::auto_ptr< PFOutputCollection > PuppiProducer::fPuppiCandidates

private

Definition at line 54 of file PuppiProducer.h.

Referenced by produce().

std::unique_ptr<PuppiContainer> PuppiProducer::fPuppiContainer

private

Definition at line 52 of file PuppiProducer.h.

Referenced by produce(), and PuppiProducer().

bool PuppiProducer::fPuppiDiagnostics

private

Definition at line 49 of file PuppiProducer.h.

Referenced by produce(), and PuppiProducer().

std::string PuppiProducer::fPuppiName

private

Definition at line 46 of file PuppiProducer.h.

std::string PuppiProducer::fPVName

private

Definition at line 48 of file PuppiProducer.h.

std::vector<RecoObj> PuppiProducer::fRecoObjCollection

private

Definition at line 53 of file PuppiProducer.h.

Referenced by produce().

bool PuppiProducer::fUseDZ

private

Definition at line 50 of file PuppiProducer.h.

Referenced by produce(), and PuppiProducer().

edm::EDGetTokenT< CandidateView > PuppiProducer::tokenPFCandidates_

private

Definition at line 44 of file PuppiProducer.h.

Referenced by produce(), and PuppiProducer().

edm::EDGetTokenT< VertexCollection > PuppiProducer::tokenVertices_

private

Definition at line 45 of file PuppiProducer.h.

Referenced by produce(), and PuppiProducer().