BaseEvtVtxGenerator Class Reference

#include <BaseEvtVtxGenerator.h>

Inheritance diagram for BaseEvtVtxGenerator:

Public Member Functions
	BaseEvtVtxGenerator (const edm::ParameterSet &)
virtual TMatrixD *	GetInvLorentzBoost ()=0
virtual HepMC::FourVector *	lastVertex ()
virtual HepMC::FourVector *	newVertex ()=0
virtual void	produce (edm::Event &, const edm::EventSetup &) override
virtual	~BaseEvtVtxGenerator ()
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
bool	registeredToConsume (ProductHolderIndex, bool, BranchType) const
bool	registeredToConsumeMany (TypeID const &, BranchType) const
void	updateLookup (BranchType iBranchType, ProductHolderIndexHelper const &)
virtual	~EDConsumerBase ()

Protected Member Functions
CLHEP::HepRandomEngine &	getEngine ()
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)

Protected Attributes
TMatrixD *	boost_
double	fTimeOffset
HepMC::FourVector *	fVertex

Private Attributes
CLHEP::HepRandomEngine *	fEngine
edm::InputTag	sourceLabel

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)

Detailed Description

Definition at line 26 of file BaseEvtVtxGenerator.h.

Constructor & Destructor Documentation

BaseEvtVtxGenerator::BaseEvtVtxGenerator ( const edm::ParameterSet &  pset )

explicit

Definition at line 29 of file BaseEvtVtxGenerator.cc.

References edm::hlt::Exception, fEngine, edm::RandomNumberGenerator::getEngine(), and edm::Service< T >::isAvailable().

    : fVertex(0), boost_(0), fTimeOffset(0), fEngine(0),
      sourceLabel(pset.getParameter<edm::InputTag>("src"))
{
   
/* No longer needed...

   // 1st of all, check on module_label - must be VtxSmeared !
   if ( pset.getParameter<string>("@module_label") != "VtxSmeared" )
   {
      throw cms::Exception("Configuration")
        << "Module has an invalid module label. "
           "The label of this module MUST be VtxSmeared.";
   }
*/
      
   Service<RandomNumberGenerator> rng;

   if ( ! rng.isAvailable()) {

     throw cms::Exception("Configuration")
       << "The BaseEvtVtxGenerator requires the RandomNumberGeneratorService\n"
          "which is not present in the configuration file.  You must add the service\n"
          "in the configuration file or remove the modules that require it.";
   }

   CLHEP::HepRandomEngine& engine = rng->getEngine();
   fEngine = &engine;

      
   produces<bool>(); 
}

BaseEvtVtxGenerator::~BaseEvtVtxGenerator ( )

virtual

Definition at line 62 of file BaseEvtVtxGenerator.cc.

References boost_, and fVertex.

{
   delete fVertex ;
   if (boost_ != 0 ) delete boost_;
   // no need since now it's done in HepMCProduct
   // delete fEvt ;
}

Member Function Documentation

CLHEP::HepRandomEngine & BaseEvtVtxGenerator::getEngine ( )

protected

Definition at line 94 of file BaseEvtVtxGenerator.cc.

References fEngine.

Referenced by BetafuncEvtVtxGenerator::BetafuncEvtVtxGenerator(), FlatEvtVtxGenerator::FlatEvtVtxGenerator(), GaussEvtVtxGenerator::GaussEvtVtxGenerator(), and BeamProfileVtxGenerator::setType().

{
   return *fEngine;
}

virtual TMatrixD* BaseEvtVtxGenerator::GetInvLorentzBoost ( )

pure virtual

Implemented in BetafuncEvtVtxGenerator, BeamProfileVtxGenerator, FlatEvtVtxGenerator, and GaussEvtVtxGenerator.

Referenced by produce().

virtual HepMC::FourVector* BaseEvtVtxGenerator::lastVertex ( )

inlinevirtual

This method - and the comment - is a left-over from COBRA-OSCAR time : return the last generated event vertex. If no vertex has been generated yet, a NULL pointer is returned.

Definition at line 42 of file BaseEvtVtxGenerator.h.

References fVertex.

{ return fVertex; }

virtual HepMC::FourVector* BaseEvtVtxGenerator::newVertex ( )

pure virtual

Implemented in BetafuncEvtVtxGenerator, BeamProfileVtxGenerator, FlatEvtVtxGenerator, and GaussEvtVtxGenerator.

Referenced by produce().

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

overridevirtual

Implements edm::EDProducer.

Definition at line 70 of file BaseEvtVtxGenerator.cc.

References edm::Event::getByLabel(), GetInvLorentzBoost(), newVertex(), edm::Event::put(), reco::return(), and sourceLabel.

{
   
   
   Handle<HepMCProduct> HepMCEvt ;
   
   evt.getByLabel( sourceLabel, HepMCEvt ) ;
   
   // generate new vertex & apply the shift 
   //
   HepMCEvt->applyVtxGen( newVertex() ) ;

   //HepMCEvt->LorentzBoost( 0., 142.e-6 );
   HepMCEvt->boostToLab( GetInvLorentzBoost(), "vertex" );
   HepMCEvt->boostToLab( GetInvLorentzBoost(), "momentum" );
   
   // OK, create a (pseudo)product and put in into edm::Event
   //
   auto_ptr<bool> NewProduct(new bool(true)) ;      
   evt.put( NewProduct ) ;
      
   return ;
}

Member Data Documentation

TMatrixD* BaseEvtVtxGenerator::boost_

protected

Definition at line 57 of file BaseEvtVtxGenerator.h.

Referenced by BetafuncEvtVtxGenerator::GetInvLorentzBoost(), BetafuncEvtVtxGenerator::update(), and ~BaseEvtVtxGenerator().

CLHEP::HepRandomEngine* BaseEvtVtxGenerator::fEngine

private

Definition at line 62 of file BaseEvtVtxGenerator.h.

Referenced by BaseEvtVtxGenerator(), and getEngine().

double BaseEvtVtxGenerator::fTimeOffset

protected

Definition at line 58 of file BaseEvtVtxGenerator.h.

HepMC::FourVector* BaseEvtVtxGenerator::fVertex

protected

Definition at line 56 of file BaseEvtVtxGenerator.h.

Referenced by lastVertex(), FlatEvtVtxGenerator::newVertex(), GaussEvtVtxGenerator::newVertex(), BeamProfileVtxGenerator::newVertex(), BetafuncEvtVtxGenerator::newVertex(), and ~BaseEvtVtxGenerator().

edm::InputTag BaseEvtVtxGenerator::sourceLabel

private

Definition at line 63 of file BaseEvtVtxGenerator.h.

Referenced by produce().