CMS 3D CMS Logo

List of all members | Public Member Functions | Static Public Member Functions | Private Attributes
edm::ThinningProducer< Collection, Selector > Class Template Reference

#include <ThinningProducer.h>

Inheritance diagram for edm::ThinningProducer< Collection, Selector >:
edm::stream::EDProducer<> edm::stream::EDProducerBase edm::ProducerBase edm::EDConsumerBase edm::ProductRegistryHelper

Public Member Functions

virtual void produce (Event &event, EventSetup const &eventSetup) override
 
virtual void registerThinnedAssociations (ProductRegistry const &productRegistry, ThinnedAssociationsHelper &thinnedAssociationsHelper) override
 
 ThinningProducer (ParameterSet const &pset)
 
virtual ~ThinningProducer ()
 
- 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)
 
std::vector< edm::ProductResolverIndex > const & indiciesForPutProducts (BranchType iBranchType) const
 
 ProducerBase ()
 
void registerProducts (ProducerBase *, ProductRegistry *, ModuleDescription const &)
 
std::function< void(BranchDescription const &)> registrationCallback () const
 used by the fwk to register list of products More...
 
void resolvePutIndicies (BranchType iBranchType, std::unordered_multimap< std::string, edm::ProductResolverIndex > const &iIndicies, std::string const &moduleLabel)
 
virtual ~ProducerBase () noexcept(false)
 
- Public Member Functions inherited from edm::EDConsumerBase
std::vector< ConsumesInfoconsumesInfo () const
 
 EDConsumerBase ()
 
 EDConsumerBase (EDConsumerBase const &)=delete
 
 EDConsumerBase (EDConsumerBase &&)=default
 
ProductResolverIndexAndSkipBit indexFrom (EDGetToken, BranchType, TypeID const &) const
 
void itemsMayGet (BranchType, std::vector< ProductResolverIndexAndSkipBit > &) const
 
void itemsToGet (BranchType, std::vector< ProductResolverIndexAndSkipBit > &) const
 
std::vector< ProductResolverIndexAndSkipBit > const & itemsToGetFrom (BranchType iType) const
 
void labelsForToken (EDGetToken iToken, Labels &oLabels) const
 
void modulesWhoseProductsAreConsumed (std::vector< ModuleDescription const * > &modules, ProductRegistry const &preg, std::map< std::string, ModuleDescription const * > const &labelsToDesc, std::string const &processName) const
 
EDConsumerBase const & operator= (EDConsumerBase const &)=delete
 
EDConsumerBaseoperator= (EDConsumerBase &&)=default
 
bool registeredToConsume (ProductResolverIndex, bool, BranchType) const
 
bool registeredToConsumeMany (TypeID const &, BranchType) const
 
void updateLookup (BranchType iBranchType, ProductResolverIndexHelper const &, bool iPrefetchMayGet)
 
virtual ~EDConsumerBase () noexcept(false)
 

Static Public Member Functions

static void fillDescriptions (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 Attributes

edm::InputTag inputTag_
 
edm::EDGetTokenT< Collection > inputToken_
 
edm::propagate_const< std::unique_ptr< Selector > > selector_
 

Additional Inherited Members

- 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, GlobalCacheLuminosityBlockContext
 
typedef CacheTypes::LuminosityBlockSummaryCache LuminosityBlockSummaryCache
 
typedef CacheTypes::RunCache RunCache
 
typedef RunContextT< RunCache, GlobalCacheRunContext
 
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
 
- 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<typename Collection, typename Selector>
class edm::ThinningProducer< Collection, Selector >

Author
W. David Dagenhart, created 11 June 2014

Definition at line 30 of file ThinningProducer.h.

Constructor & Destructor Documentation

template<typename Collection , typename Selector >
edm::ThinningProducer< Collection, Selector >::ThinningProducer ( ParameterSet const &  pset)
explicit

Definition at line 49 of file ThinningProducer.h.

References edm::ParameterSet::getParameter(), edm::ThinningProducer< Collection, Selector >::inputTag_, edm::ThinningProducer< Collection, Selector >::inputToken_, and edm::ThinningProducer< Collection, Selector >::~ThinningProducer().

49  :
51 
52  inputTag_ = pset.getParameter<InputTag>("inputTag");
53  inputToken_ = consumes<Collection>(inputTag_);
54 
55  produces<Collection>();
56  produces<ThinnedAssociation>();
57  }
edm::propagate_const< std::unique_ptr< Selector > > selector_
ConsumesCollector consumesCollector()
Use a ConsumesCollector to gather consumes information from helper functions.
edm::EDGetTokenT< Collection > inputToken_
template<typename Collection , typename Selector >
edm::ThinningProducer< Collection, Selector >::~ThinningProducer ( )
virtual

Member Function Documentation

template<typename Collection , typename Selector >
void edm::ThinningProducer< Collection, Selector >::fillDescriptions ( ConfigurationDescriptions descriptions)
static

Definition at line 65 of file ThinningProducer.h.

References edm::ParameterSetDescription::add(), edm::ConfigurationDescriptions::addDefault(), edm::ThinningProducer< Collection, Selector >::produce(), and edm::ParameterSetDescription::setComment().

Referenced by edm::ThinningProducer< Collection, Selector >::~ThinningProducer().

65  {
67  desc.setComment("Produces thinned collections and associations to them");
68  desc.add<edm::InputTag>("inputTag");
69  Selector::fillDescription(desc);
70  descriptions.addDefault(desc);
71  }
template<typename Collection , typename Selector >
void edm::ThinningProducer< Collection, Selector >::produce ( Event event,
EventSetup const &  eventSetup 
)
overridevirtual

Implements edm::stream::EDProducerBase.

Definition at line 75 of file ThinningProducer.h.

References event(), edm::OrphanHandleBase::id(), edm::HandleBase::id(), genParticles_cff::inputCollection, edm::ThinningProducer< Collection, Selector >::inputToken_, eostools::move(), edm::ThinningProducer< Collection, Selector >::registerThinnedAssociations(), and edm::ThinningProducer< Collection, Selector >::selector_.

Referenced by JSONExport.JsonExport::export(), HTMLExport.HTMLExport::export(), HTMLExport.HTMLExportStatic::export(), and edm::ThinningProducer< Collection, Selector >::fillDescriptions().

75  {
76 
78  event.getByToken(inputToken_, inputCollection);
79 
80  edm::Event const& constEvent = event;
81  selector_->preChoose(inputCollection, constEvent, eventSetup);
82 
83  auto thinnedCollection = std::make_unique<Collection>();
84  auto thinnedAssociation = std::make_unique<ThinnedAssociation>();
85 
86  unsigned int iIndex = 0;
87  for(auto iter = inputCollection->begin(), iterEnd = inputCollection->end();
88  iter != iterEnd; ++iter, ++iIndex) {
89  if(selector_->choose(iIndex, *iter)) {
90  thinnedCollection->push_back(*iter);
91  thinnedAssociation->push_back(iIndex);
92  }
93  }
94  OrphanHandle<Collection> orphanHandle = event.put(std::move(thinnedCollection));
95 
96  thinnedAssociation->setParentCollectionID(inputCollection.id());
97  thinnedAssociation->setThinnedCollectionID(orphanHandle.id());
98  event.put(std::move(thinnedAssociation));
99  }
ProductID id() const
Definition: HandleBase.cc:15
edm::propagate_const< std::unique_ptr< Selector > > selector_
edm::EDGetTokenT< Collection > inputToken_
How EventSelector::AcceptEvent() decides whether to accept an event for output otherwise it is excluding the probing of A single or multiple positive and the trigger will pass if any such matching triggers are PASS or EXCEPTION[A criterion thatmatches no triggers at all is detected and causes a throw.] A single negative with an expectation of appropriate bit checking in the decision and the trigger will pass if any such matching triggers are FAIL or EXCEPTION A wildcarded negative criterion that matches more than one trigger in the trigger but the state exists so we define the behavior If all triggers are the negative crieriion will lead to accepting the event(this again matches the behavior of"!*"before the partial wildcard feature was incorporated).The per-event"cost"of each negative criterion with multiple relevant triggers is about the same as!*was in the past
def move(src, dest)
Definition: eostools.py:510
template<typename Collection , typename Selector >
void edm::ThinningProducer< Collection, Selector >::registerThinnedAssociations ( ProductRegistry const &  productRegistry,
ThinnedAssociationsHelper thinnedAssociationsHelper 
)
overridevirtual

Reimplemented from edm::stream::EDProducerBase.

Definition at line 103 of file ThinningProducer.h.

References edm::ThinnedAssociationsHelper::addAssociation(), edm::BranchDescription::branchID(), edm::ThinningProducer< Collection, Selector >::inputTag_, edm::InputTag::instance(), edm::InputTag::label(), edm::stream::EDProducerBase::moduleDescription(), edm::ModuleDescription::moduleLabel(), edm::BranchDescription::moduleLabel(), edm::BranchDescription::originalBranchID(), edm::InputTag::process(), edm::BranchDescription::processName(), edm::BranchDescription::produced(), edm::BranchDescription::productInstanceName(), edm::ProductRegistry::productList(), edm::TypeWithDict::typeInfo(), edm::BranchDescription::unwrappedType(), and edm::InputTag::willSkipCurrentProcess().

Referenced by edm::ThinningProducer< Collection, Selector >::produce().

104  {
105 
106  BranchID associationID;
107  BranchID thinnedCollectionID;
108 
109  // If the InputTag does not specify the process name, it is
110  // possible that there will be more than one match found below.
111  // For a particular event only one match is correct and the
112  // others will be false. It even possible for some events one
113  // match is correct and for others another is correct. This is
114  // a side effect of the lookup mechanisms when the process name
115  // is not specified.
116  // When using the registry this generates one would have to
117  // check the ProductIDs in ThinnedAssociation product to get
118  // the correct association. This ambiguity will probably be
119  // rare and possibly never occur in practice.
120  std::vector<BranchID> parentCollectionIDs;
121 
122  ProductRegistry::ProductList const& productList = productRegistry.productList();
123  for(auto const& product : productList) {
124  BranchDescription const& desc = product.second;
125  if(desc.unwrappedType().typeInfo() == typeid(Collection) ) {
126  if(desc.produced() &&
127  desc.moduleLabel() == moduleDescription().moduleLabel() &&
128  desc.productInstanceName().empty()) {
129 
130  thinnedCollectionID = desc.branchID();
131  }
132  if(desc.moduleLabel() == inputTag_.label() &&
133  desc.productInstanceName() == inputTag_.instance()) {
135  if(!desc.produced()) {
136  parentCollectionIDs.push_back(desc.branchID());
137  }
138  } else if (inputTag_.process().empty() || inputTag_.process() == desc.processName()) {
139  if(desc.produced()) {
140  parentCollectionIDs.push_back(desc.originalBranchID());
141  } else {
142  parentCollectionIDs.push_back(desc.branchID());
143  }
144  }
145  }
146  }
147  if(desc.produced() &&
148  desc.unwrappedType().typeInfo() == typeid(ThinnedAssociation) &&
149  desc.moduleLabel() == moduleDescription().moduleLabel() &&
150  desc.productInstanceName().empty()) {
151 
152  associationID = desc.branchID();
153  }
154  }
155  if(parentCollectionIDs.empty()) {
156  // This could happen if the input collection was dropped. Go ahead and add
157  // an entry and let the exception be thrown only if the module is run (when
158  // it cannot find the product).
159  thinnedAssociationsHelper.addAssociation(BranchID(), associationID, thinnedCollectionID);
160  } else {
161  for(auto const& parentCollectionID : parentCollectionIDs) {
162  thinnedAssociationsHelper.addAssociation(parentCollectionID, associationID, thinnedCollectionID);
163  }
164  }
165  }
std::map< BranchKey, BranchDescription > ProductList
std::string const & moduleLabel() const
ModuleDescription const & moduleDescription() const
bool willSkipCurrentProcess() const
Definition: InputTag.h:42
std::string const & label() const
Definition: InputTag.h:36
std::string const & process() const
Definition: InputTag.h:40
std::string const & instance() const
Definition: InputTag.h:37

Member Data Documentation

template<typename Collection , typename Selector >
edm::InputTag edm::ThinningProducer< Collection, Selector >::inputTag_
private
template<typename Collection , typename Selector >
edm::EDGetTokenT<Collection> edm::ThinningProducer< Collection, Selector >::inputToken_
private
template<typename Collection , typename Selector >
edm::propagate_const<std::unique_ptr<Selector> > edm::ThinningProducer< Collection, Selector >::selector_
private