PAT Cleaner module for PAT Objects. More...

#include "PhysicsTools/PatAlgos/interface/PATCleaner.h"

Inheritance diagram for pat::PATCleaner< PATObjType >:

Public Member Functions
	PATCleaner (const edm::ParameterSet &iConfig)

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

virtual	~PATCleaner ()

Public Member Functions inherited from edm::EDProducer
	EDProducer ()

ModuleDescription const &	moduleDescription () const

virtual	~EDProducer ()

Public Member Functions inherited from edm::ProducerBase
	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
	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

bool	registeredToConsume (ProductHolderIndex, bool, BranchType) const

bool	registeredToConsumeMany (TypeID const &, BranchType) const

void	updateLookup (BranchType iBranchType, ProductHolderIndexHelper const &)

virtual	~EDConsumerBase ()

Private Types
typedef pat::helper::OverlapTest	OverlapTest

typedef StringCutObjectSelector < PATObjType >	Selector

Private Attributes
bool	doFinalCut_

bool	doPreselection_

Selector	finalCut_

boost::ptr_vector< OverlapTest >	overlapTests_

Selector	preselectionCut_

edm::InputTag	src_

edm::EDGetTokenT< edm::View < PATObjType > >	srcToken_

Additional Inherited Members
Public Types inherited from edm::EDProducer
typedef EDProducer	ModuleType

Public Types inherited from edm::ProducerBase
typedef ProductRegistryHelper::TypeLabelList	TypeLabelList

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

static void	fillDescriptions (ConfigurationDescriptions &descriptions)

static void	prevalidate (ConfigurationDescriptions &descriptions)

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

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

template<class PATObjType>
class pat::PATCleaner< PATObjType >

PAT Cleaner module for PAT Objects.

      The same module is used for all collections.

Author: Giovanni Petrucciani

Version

Id:: PATCleaner.h,v 1.3 2010/10/20 23:08:30 wmtan Exp

Definition at line 40 of file PATCleaner.h.

Member Typedef Documentation

template<class PATObjType >

typedef pat::helper::OverlapTest pat::PATCleaner< PATObjType >::OverlapTest

private

Definition at line 56 of file PATCleaner.h.

template<class PATObjType >

typedef StringCutObjectSelector<PATObjType> pat::PATCleaner< PATObjType >::Selector

private

Definition at line 48 of file PATCleaner.h.

Constructor & Destructor Documentation

template<class PATObjType >

pat::PATCleaner< PATObjType >::PATCleaner ( const edm::ParameterSet & iConfig )

explicit

Definition at line 64 of file PATCleaner.h.

References algorithm(), edm::EDConsumerBase::consumesCollector(), edm::ParameterSet::empty(), edm::hlt::Exception, edm::ParameterSet::getParameter(), edm::ParameterSet::getParameterNamesForType(), pat::PATCleaner< PATObjType >::overlapTests_, pat::PATCleaner< PATObjType >::src_, and AlCaHLTBitMon_QueryRunRegistry::string.

                                                                      :
     src_(iConfig.getParameter<edm::InputTag>("src")),
     srcToken_(consumes<edm::View<PATObjType> >(src_)),
     preselectionCut_(iConfig.getParameter<std::string>("preselection")),
     finalCut_(iConfig.getParameter<std::string>("finalCut"))
 {
     // pick parameter set for overlaps
     edm::ParameterSet overlapPSet = iConfig.getParameter<edm::ParameterSet>("checkOverlaps");
     // get all the names of the tests (all nested PSets in this PSet)
     std::vector<std::string> overlapNames = overlapPSet.getParameterNamesForType<edm::ParameterSet>();
     // loop on them
     for (std::vector<std::string>::const_iterator itn = overlapNames.begin(); itn != overlapNames.end(); ++itn) {
         // retrieve configuration
         edm::ParameterSet cfg = overlapPSet.getParameter<edm::ParameterSet>(*itn);
         // skip empty parameter sets
         if (cfg.empty()) continue;
         // get the name of the algorithm to use
         std::string algorithm = cfg.getParameter<std::string>("algorithm");
         // create the appropriate OverlapTest
         if (algorithm == "byDeltaR") {
             overlapTests_.push_back(new pat::helper::BasicOverlapTest(*itn, cfg, consumesCollector()));
         } else if (algorithm == "bySuperClusterSeed") {
             overlapTests_.push_back(new pat::helper::OverlapBySuperClusterSeed(*itn, cfg, consumesCollector()));
         } else {
             throw cms::Exception("Configuration") << "PATCleaner for " << src_ << ": unsupported algorithm '" << algorithm << "'\n";
         }
     }
 
 
     produces<std::vector<PATObjType> >();
 }

template<class PATObjType >

virtual pat::PATCleaner< PATObjType >::~PATCleaner ( )

inlinevirtual

Definition at line 43 of file PATCleaner.h.

43 {}

Member Function Documentation

template<class PATObjType >

void pat::PATCleaner< PATObjType >::produce	(	edm::Event &	iEvent,
		const edm::EventSetup &	iSetup
	)

overridevirtual

Implements edm::EDProducer.

Definition at line 98 of file PATCleaner.h.

References edm::Event::getByToken(), getGTfromDQMFile::obj, convertSQLitetoXML_cfg::output, analyzePatCleaning_cfg::overlaps, and edm::Event::put().

                                                                                   {
 
   // Read the input. We use edm::View<> in case the input happes to be something different than a std::vector<>
   edm::Handle<edm::View<PATObjType> > candidates;
   iEvent.getByToken(srcToken_, candidates);
 
   // Prepare a collection for the output
   std::auto_ptr< std::vector<PATObjType> > output(new std::vector<PATObjType>());
 
   // initialize the overlap tests
   for (boost::ptr_vector<OverlapTest>::iterator itov = overlapTests_.begin(), edov = overlapTests_.end(); itov != edov; ++itov) {
     itov->readInput(iEvent,iSetup);
   }
 
   for (typename edm::View<PATObjType>::const_iterator it = candidates->begin(), ed = candidates->end(); it != ed; ++it) {
       // Apply a preselection to the inputs and copy them in the output
       if (!preselectionCut_(*it)) continue;
 
       // Add it to the list and take a reference to it, so it can be modified (e.g. to set the overlaps)
       // If at some point I'll decide to drop this item, I'll use pop_back to remove it
       output->push_back(*it);
       PATObjType &obj = output->back();
 
       // Look for overlaps
       bool badForOverlap = false;
       for (boost::ptr_vector<OverlapTest>::iterator itov = overlapTests_.begin(), edov = overlapTests_.end(); itov != edov; ++itov) {
         reco::CandidatePtrVector overlaps;
         bool hasOverlap = itov->fillOverlapsForItem(obj, overlaps);
         if (hasOverlap && itov->requireNoOverlaps()) {
             badForOverlap = true; // mark for discarding
             break; // no point in checking the others, as this item will be discarded
         }
         obj.setOverlaps(itov->name(), overlaps);
       }
       if (badForOverlap) { output->pop_back(); continue; }
 
       // Apply one final selection cut
       if (!finalCut_(obj)) output->pop_back();
   }
 
   iEvent.put(output);
 }

Member Data Documentation

template<class PATObjType >

bool pat::PATCleaner< PATObjType >::doFinalCut_

private

Definition at line 52 of file PATCleaner.h.

template<class PATObjType >

bool pat::PATCleaner< PATObjType >::doPreselection_

private

Definition at line 52 of file PATCleaner.h.

template<class PATObjType >

Selector pat::PATCleaner< PATObjType >::finalCut_

private

Definition at line 54 of file PATCleaner.h.

template<class PATObjType >

boost::ptr_vector<OverlapTest> pat::PATCleaner< PATObjType >::overlapTests_

private

Definition at line 58 of file PATCleaner.h.

Referenced by pat::PATCleaner< PATObjType >::PATCleaner().

template<class PATObjType >

Selector pat::PATCleaner< PATObjType >::preselectionCut_

private

Definition at line 53 of file PATCleaner.h.

template<class PATObjType >

edm::InputTag pat::PATCleaner< PATObjType >::src_

private

Definition at line 50 of file PATCleaner.h.

Referenced by pat::PATCleaner< PATObjType >::PATCleaner().

template<class PATObjType >

edm::EDGetTokenT<edm::View<PATObjType> > pat::PATCleaner< PATObjType >::srcToken_

private

Definition at line 51 of file PATCleaner.h.

Public Member Functions

Private Types

Private Attributes

Additional Inherited Members

Detailed Description

template<class PATObjType> class pat::PATCleaner< PATObjType >

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

template<class PATObjType>
class pat::PATCleaner< PATObjType >