EventShapeVarsProducer Class Reference

#include <EventShapeVarsProducer.h>

Inheritance diagram for EventShapeVarsProducer:

Public Member Functions
	EventShapeVarsProducer (const edm::ParameterSet &)
	~EventShapeVarsProducer () override
Public Member Functions inherited from edm::EDProducer
	EDProducer ()
SerialTaskQueue *	globalLuminosityBlocksQueue ()
SerialTaskQueue *	globalRunsQueue ()
ModuleDescription const &	moduleDescription () const
	~EDProducer () override
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 ()
std::vector< edm::ProductResolverIndex > const &	putTokenIndexToProductResolverIndex () const
std::vector< bool > const &	recordProvenanceList () const
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, ModuleToResolverIndicies const &iIndicies, std::string const &moduleLabel)
TypeLabelList const &	typeLabelList () const
	used by the fwk to register the list of products of this module More...
	~ProducerBase () noexcept(false) override
Public Member Functions inherited from edm::EDConsumerBase
std::vector< ConsumesInfo >	consumesInfo () const
void	convertCurrentProcessAlias (std::string const &processName)
	Convert "@currentProcess" in InputTag process names to the actual current process name. More...
	EDConsumerBase ()
	EDConsumerBase (EDConsumerBase &&)=default
	EDConsumerBase (EDConsumerBase const &)=delete
ESProxyIndex const *	esGetTokenIndices (edm::Transition iTrans) const
std::vector< ESProxyIndex > const &	esGetTokenIndicesVector (edm::Transition iTrans) const
std::vector< ESRecordIndex > const &	esGetTokenRecordIndicesVector (edm::Transition iTrans) const
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 &	operator= (EDConsumerBase &&)=default
EDConsumerBase const &	operator= (EDConsumerBase const &)=delete
bool	registeredToConsume (ProductResolverIndex, bool, BranchType) const
bool	registeredToConsumeMany (TypeID const &, BranchType) const
ProductResolverIndexAndSkipBit	uncheckedIndexFrom (EDGetToken) const
void	updateLookup (BranchType iBranchType, ProductResolverIndexHelper const &, bool iPrefetchMayGet)
void	updateLookup (eventsetup::ESRecordsToProxyIndices const &)
virtual	~EDConsumerBase () noexcept(false)

Private Member Functions
void	beginJob () override
void	endJob () override
void	produce (edm::Event &, const edm::EventSetup &) override

Private Attributes
unsigned	fwmax_
double	r_
edm::EDGetTokenT< edm::View< reco::Candidate > >	srcToken_

Additional Inherited Members
Public Types inherited from edm::EDProducer
typedef EDProducer	ModuleType
Public Types inherited from edm::ProducerBase
using	ModuleToResolverIndicies = std::unordered_multimap< std::string, std::tuple< edm::TypeID const *, const char *, edm::ProductResolverIndex > >
typedef ProductRegistryHelper::TypeLabelList	TypeLabelList
Public Types inherited from edm::EDConsumerBase
typedef ProductLabels	Labels
Static Public Member Functions inherited from edm::EDProducer
static const std::string &	baseType ()
static void	fillDescriptions (ConfigurationDescriptions &descriptions)
static void	prevalidate (ConfigurationDescriptions &descriptions)
static bool	wantsGlobalLuminosityBlocks ()
static bool	wantsGlobalRuns ()
static bool	wantsInputProcessBlocks ()
static bool	wantsProcessBlocks ()
static bool	wantsStreamLuminosityBlocks ()
static bool	wantsStreamRuns ()
Protected Member Functions inherited from edm::ProducerBase
template<class ProductType >
BranchAliasSetterT< ProductType >	produces ()
	declare what type of product will make and with which optional label More...
template<typename ProductType , BranchType B>
BranchAliasSetterT< ProductType >	produces ()
template<typename ProductType , Transition B>
BranchAliasSetterT< ProductType >	produces ()
BranchAliasSetter	produces (const TypeID &id, std::string instanceName=std::string(), bool recordProvenance=true)
template<BranchType B>
BranchAliasSetter	produces (const TypeID &id, std::string instanceName=std::string(), bool recordProvenance=true)
template<Transition B>
BranchAliasSetter	produces (const TypeID &id, std::string instanceName=std::string(), bool recordProvenance=true)
template<typename ProductType , Transition B>
BranchAliasSetterT< ProductType >	produces (std::string instanceName)
template<class ProductType >
BranchAliasSetterT< ProductType >	produces (std::string instanceName)
template<typename ProductType , BranchType B>
BranchAliasSetterT< ProductType >	produces (std::string instanceName)
ProducesCollector	producesCollector ()
Protected Member Functions inherited from edm::EDConsumerBase
EDGetToken	consumes (const TypeToGet &id, edm::InputTag const &tag)
template<typename ProductType , BranchType B = InEvent>
EDGetTokenT< ProductType >	consumes (edm::InputTag const &tag)
template<BranchType B = InEvent>
EDConsumerBaseAdaptor< B >	consumes (edm::InputTag tag) noexcept
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 ESProduct , typename ESRecord , Transition Tr = Transition::Event>
auto	esConsumes ()
template<Transition Tr = Transition::Event>
constexpr auto	esConsumes () noexcept
template<typename ESProduct , typename ESRecord , Transition Tr = Transition::Event>
auto	esConsumes (ESInputTag const &tag)
template<Transition Tr = Transition::Event>
auto	esConsumes (ESInputTag tag) noexcept
template<Transition Tr = Transition::Event>
ESGetTokenGeneric	esConsumes (eventsetup::EventSetupRecordKey const &iRecord, eventsetup::DataKey const &iKey)
	Used with EventSetupRecord::doGet. More...
EDGetToken	mayConsume (const TypeToGet &id, edm::InputTag const &tag)
template<BranchType B>
EDGetToken	mayConsume (const TypeToGet &id, edm::InputTag const &tag)
template<typename ProductType , BranchType B = InEvent>
EDGetTokenT< ProductType >	mayConsume (edm::InputTag const &tag)

Detailed Description

Produce set of event shape variables. The values of different event shape variables are stored as doubles in the event. They can be retrieved with InputTags like "moduleName::instanceName", where moduleName corresponds to "eventShapeVarsProducer" per default and instance name specifies an individual event shape variable which you wish to retrieve from the event:

• thrust
• oblateness
• isotropy
• circularity
• sphericity
• aplanarity
• C
• D
• Fox-Wolfram moments

See https://arxiv.org/pdf/hep-ph/0603175v2.pdf#page=524 for an explanation of sphericity, aplanarity, the quantities C and D, thrust, oblateness, Fox-Wolfram moments.

Author

Christian Veelken, UC Davis

Definition at line 39 of file EventShapeVarsProducer.h.

Constructor & Destructor Documentation

EventShapeVarsProducer()

EventShapeVarsProducer::EventShapeVarsProducer ( const edm::ParameterSet &  cfg )

explicit

Definition at line 10 of file EventShapeVarsProducer.cc.

                                                                         {
  srcToken_ = consumes<edm::View<reco::Candidate>>(cfg.getParameter<edm::InputTag>("src"));
  r_ = cfg.exists("r") ? cfg.getParameter<double>("r") : 2.;
  fwmax_ = cfg.exists("fwmax") ? cfg.getParameter<unsigned>("fwmax") : 0;
 
  produces<double>("thrust");
  //produces<double>("oblateness");
  produces<double>("isotropy");
  produces<double>("circularity");
  produces<double>("sphericity");
  produces<double>("aplanarity");
  produces<double>("C");
  produces<double>("D");
  if (fwmax_ > 0)
    produces<std::vector<double>>("FWmoments");
}

References looper::cfg, fwmax_, r_, and srcToken_.

~EventShapeVarsProducer()

EventShapeVarsProducer::~EventShapeVarsProducer ( )

inlineoverride

Definition at line 42 of file EventShapeVarsProducer.h.

{}

Member Function Documentation

beginJob()

void EventShapeVarsProducer::beginJob ( void  )

inlineoverrideprivatevirtual

Reimplemented from edm::EDProducer.

Definition at line 49 of file EventShapeVarsProducer.h.

{}

endJob()

void EventShapeVarsProducer::endJob ( void  )

inlineoverrideprivatevirtual

Reimplemented from edm::EDProducer.

Definition at line 51 of file EventShapeVarsProducer.h.

{}

produce()

void EventShapeVarsProducer::produce ( edm::Event &  evt, const edm::EventSetup &    )

overrideprivatevirtual

Implements edm::EDProducer.

Definition at line 31 of file EventShapeVarsProducer.cc.

                                                                        {
  edm::Handle<edm::View<reco::Candidate>> objects;
  evt.getByToken(srcToken_, objects);
 
  Thrust thrustAlgo(objects->begin(), objects->end());
  put(evt, thrustAlgo.thrust(), "thrust");
  //put(evt, thrustAlgo.oblateness(), "oblateness");
 
  EventShapeVariables eventShapeVarsAlgo(*objects);
  eventShapeVarsAlgo.set_r(r_);
  put(evt, eventShapeVarsAlgo.isotropy(), "isotropy");
  put(evt, eventShapeVarsAlgo.circularity(), "circularity");
  put(evt, eventShapeVarsAlgo.sphericity(), "sphericity");
  put(evt, eventShapeVarsAlgo.aplanarity(), "aplanarity");
  put(evt, eventShapeVarsAlgo.C(), "C");
  put(evt, eventShapeVarsAlgo.D(), "D");
  if (fwmax_ > 0) {
    eventShapeVarsAlgo.setFWmax(fwmax_);
    auto vfw = std::make_unique<std::vector<double>>(eventShapeVarsAlgo.getFWmoments());
    evt.put(std::move(vfw), "FWmoments");
  }
}

References fwmax_, edm::Event::getByToken(), eostools::move(), hgcalPerformanceValidation::objects, put(), edm::Event::put(), r_, and srcToken_.

Member Data Documentation

fwmax_

unsigned EventShapeVarsProducer::fwmax_

private

Definition at line 47 of file EventShapeVarsProducer.h.

Referenced by EventShapeVarsProducer(), and produce().

r_

double EventShapeVarsProducer::r_

private

Definition at line 46 of file EventShapeVarsProducer.h.

Referenced by EventShapeVarsProducer(), and produce().

srcToken_

edm::EDGetTokenT<edm::View<reco::Candidate> > EventShapeVarsProducer::srcToken_

private

Definition at line 45 of file EventShapeVarsProducer.h.

Referenced by EventShapeVarsProducer(), and produce().