GaussEvtVtxGenerator Class Reference

#include <GaussEvtVtxGenerator.h>

Inheritance diagram for GaussEvtVtxGenerator:

Public Member Functions
void	beginLuminosityBlock (edm::LuminosityBlock const &, edm::EventSetup const &) override
	GaussEvtVtxGenerator (const edm::ParameterSet &p)
	GaussEvtVtxGenerator (const GaussEvtVtxGenerator &p)=delete
TMatrixD const *	GetInvLorentzBoost () const override
void	meanX (double m=0)
	set mean in X in cm More...
void	meanY (double m=0)
	set mean in Y in cm More...
void	meanZ (double m=0)
	set mean in Z in cm More...
HepMC::FourVector	newVertex (CLHEP::HepRandomEngine *) const override
	return a new event vertex More...
GaussEvtVtxGenerator &	operator= (const GaussEvtVtxGenerator &rhs)=delete
void	sigmaX (double s=1.0)
	set resolution in X in cm More...
void	sigmaY (double s=1.0)
	set resolution in Y in cm More...
void	sigmaZ (double s=1.0)
	set resolution in Z in cm More...
	~GaussEvtVtxGenerator () override=default
Public Member Functions inherited from BaseEvtVtxGenerator
	BaseEvtVtxGenerator (const edm::ParameterSet &)
void	produce (edm::Event &, const edm::EventSetup &) override
	~BaseEvtVtxGenerator () override
Public Member Functions inherited from edm::stream::EDProducer<>
	EDProducer ()=default
	EDProducer (const EDProducer &)=delete
bool	hasAbilityToProduceInBeginLumis () const final
bool	hasAbilityToProduceInBeginProcessBlocks () const final
bool	hasAbilityToProduceInBeginRuns () const final
bool	hasAbilityToProduceInEndLumis () const final
bool	hasAbilityToProduceInEndProcessBlocks () const final
bool	hasAbilityToProduceInEndRuns () const final
const EDProducer &	operator= (const EDProducer &)=delete

Static Public Member Functions
static void	fillDescriptions (edm::ConfigurationDescriptions &descriptions)

Private Member Functions
void	update (const edm::EventSetup &iEventSetup)

Private Attributes
edm::ESGetToken< SimBeamSpotObjects, SimBeamSpotObjectsRcd >	beamToken_
double	fMeanX
double	fMeanY
double	fMeanZ
double	fSigmaX
double	fSigmaY
double	fSigmaZ
double	fTimeOffset
edm::ESWatcher< SimBeamSpotObjectsRcd >	parameterWatcher_
bool	readDB_

Additional Inherited Members
Public Types inherited from edm::stream::EDProducer<>
using	CacheTypes = CacheContexts< T... >
using	GlobalCache = typename CacheTypes::GlobalCache
using	HasAbility = AbilityChecker< T... >
using	InputProcessBlockCache = typename CacheTypes::InputProcessBlockCache
using	LuminosityBlockCache = typename CacheTypes::LuminosityBlockCache
using	LuminosityBlockContext = LuminosityBlockContextT< LuminosityBlockCache, RunCache, GlobalCache >
using	LuminosityBlockSummaryCache = typename CacheTypes::LuminosityBlockSummaryCache
using	RunCache = typename CacheTypes::RunCache
using	RunContext = RunContextT< RunCache, GlobalCache >
using	RunSummaryCache = typename CacheTypes::RunSummaryCache

Detailed Description

Definition at line 21 of file GaussEvtVtxGenerator.h.

Constructor & Destructor Documentation

GaussEvtVtxGenerator() [1/2]

GaussEvtVtxGenerator::GaussEvtVtxGenerator

(

const edm::ParameterSet &

p

)

Definition at line 13 of file GaussEvtVtxGenerator.cc.

References beamToken_, Exception, fMeanX, fMeanY, fMeanZ, fSigmaX, fSigmaY, fSigmaZ, fTimeOffset, AlCaHLTBitMon_ParallelJobs::p, and readDB_.

                                                                   : BaseEvtVtxGenerator(p) {
  readDB_ = p.getParameter<bool>("readDB");
  if (!readDB_) {
    fMeanX = p.getParameter<double>("MeanX") * cm;
    fMeanY = p.getParameter<double>("MeanY") * cm;
    fMeanZ = p.getParameter<double>("MeanZ") * cm;
    fSigmaX = p.getParameter<double>("SigmaX") * cm;
    fSigmaY = p.getParameter<double>("SigmaY") * cm;
    fSigmaZ = p.getParameter<double>("SigmaZ") * cm;
    fTimeOffset = p.getParameter<double>("TimeOffset") * ns * c_light;  // HepMC distance units are in mm

    if (fSigmaX < 0) {
      throw cms::Exception("Configuration") << "Error in GaussEvtVtxGenerator: "
                                            << "Illegal resolution in X (SigmaX is negative)";
    }
    if (fSigmaY < 0) {
      throw cms::Exception("Configuration") << "Error in GaussEvtVtxGenerator: "
                                            << "Illegal resolution in Y (SigmaY is negative)";
    }
    if (fSigmaZ < 0) {
      throw cms::Exception("Configuration") << "Error in GaussEvtVtxGenerator: "
                                            << "Illegal resolution in Z (SigmaZ is negative)";
    }
  }
  if (readDB_) {
    // NOTE: this is currently watching LS transitions, while it should watch Run transitions,
    // even though in reality there is no Run Dependent MC (yet) in CMS
    beamToken_ = esConsumes<SimBeamSpotObjects, SimBeamSpotObjectsRcd, edm::Transition::BeginLuminosityBlock>();
  }
}

GaussEvtVtxGenerator() [2/2]

GaussEvtVtxGenerator::GaussEvtVtxGenerator ( const GaussEvtVtxGenerator &  p )

delete

Copy constructor

~GaussEvtVtxGenerator()

GaussEvtVtxGenerator::~GaussEvtVtxGenerator ( )

overridedefault

Member Function Documentation

beginLuminosityBlock()

void GaussEvtVtxGenerator::beginLuminosityBlock ( edm::LuminosityBlock const &  , edm::EventSetup const &  iEventSetup  )

override

Definition at line 44 of file GaussEvtVtxGenerator.cc.

References update().

                                                                                                           {
  update(iEventSetup);
}

fillDescriptions()

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

static

Definition at line 98 of file GaussEvtVtxGenerator.cc.

References edm::ConfigurationDescriptions::add(), and submitPVResolutionJobs::desc.

                                                                                      {
  edm::ParameterSetDescription desc;
  desc.add<double>("MeanX", 0.0)->setComment("in cm");
  desc.add<double>("MeanY", 0.0)->setComment("in cm");
  desc.add<double>("MeanZ", 0.0)->setComment("in cm");
  desc.add<double>("SigmaX", 0.0)->setComment("in cm");
  desc.add<double>("SigmaY", 0.0)->setComment("in cm");
  desc.add<double>("SigmaZ", 0.0)->setComment("in cm");
  desc.add<double>("TimeOffset", 0.0)->setComment("in ns");
  desc.add<edm::InputTag>("src");
  desc.add<bool>("readDB");
  descriptions.add("GaussEvtVtxGenerator", desc);
}

GetInvLorentzBoost()

TMatrixD const* GaussEvtVtxGenerator::GetInvLorentzBoost ( ) const

inlineoverridevirtual

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.

Implements BaseEvtVtxGenerator.

Definition at line 38 of file GaussEvtVtxGenerator.h.

{ return nullptr; }

meanX()

void GaussEvtVtxGenerator::meanX ( double  m = 0 )

inline

set mean in X in cm

Definition at line 48 of file GaussEvtVtxGenerator.h.

References fMeanX, and visualization-live-secondInstance_cfg::m.

{ fMeanX = m; }

meanY()

void GaussEvtVtxGenerator::meanY ( double  m = 0 )

inline

set mean in Y in cm

Definition at line 50 of file GaussEvtVtxGenerator.h.

References fMeanY, and visualization-live-secondInstance_cfg::m.

{ fMeanY = m; }

meanZ()

void GaussEvtVtxGenerator::meanZ ( double  m = 0 )

inline

set mean in Z in cm

Definition at line 52 of file GaussEvtVtxGenerator.h.

References fMeanZ, and visualization-live-secondInstance_cfg::m.

{ fMeanZ = m; }

newVertex()

HepMC::FourVector GaussEvtVtxGenerator::newVertex ( CLHEP::HepRandomEngine *  engine ) const

overridevirtual

return a new event vertex

Implements BaseEvtVtxGenerator.

Definition at line 61 of file GaussEvtVtxGenerator.cc.

References fMeanX, fMeanY, fMeanZ, fSigmaX, fSigmaY, fSigmaZ, fTimeOffset, X, beamSpotPI::Y, and beamSpotPI::Z.

                                                                                  {
  double X, Y, Z, T;
  X = CLHEP::RandGaussQ::shoot(engine, fMeanX, fSigmaX);
  Y = CLHEP::RandGaussQ::shoot(engine, fMeanY, fSigmaY);
  Z = CLHEP::RandGaussQ::shoot(engine, fMeanZ, fSigmaZ);
  T = CLHEP::RandGaussQ::shoot(engine, fTimeOffset, fSigmaZ);

  return HepMC::FourVector(X, Y, Z, T);
}

operator=()

GaussEvtVtxGenerator& GaussEvtVtxGenerator::operator= ( const GaussEvtVtxGenerator &  rhs )

delete

Copy assignment operator

sigmaX()

void GaussEvtVtxGenerator::sigmaX

(

double

s = 1.0

)

set resolution in X in cm

Definition at line 71 of file GaussEvtVtxGenerator.cc.

References Exception, fSigmaX, and alignCSCRings::s.

                                          {
  if (s >= 0) {
    fSigmaX = s;
  } else {
    throw cms::Exception("LogicError") << "Error in GaussEvtVtxGenerator::sigmaX: "
                                       << "Illegal resolution in X (negative)";
  }
}

sigmaY()

void GaussEvtVtxGenerator::sigmaY

(

double

s = 1.0

)

set resolution in Y in cm

Definition at line 80 of file GaussEvtVtxGenerator.cc.

References Exception, fSigmaY, and alignCSCRings::s.

                                          {
  if (s >= 0) {
    fSigmaY = s;
  } else {
    throw cms::Exception("LogicError") << "Error in GaussEvtVtxGenerator::sigmaY: "
                                       << "Illegal resolution in Y (negative)";
  }
}

sigmaZ()

void GaussEvtVtxGenerator::sigmaZ

(

double

s = 1.0

)

set resolution in Z in cm

Definition at line 89 of file GaussEvtVtxGenerator.cc.

References Exception, fSigmaZ, and alignCSCRings::s.

                                          {
  if (s >= 0) {
    fSigmaZ = s;
  } else {
    throw cms::Exception("LogicError") << "Error in GaussEvtVtxGenerator::sigmaZ: "
                                       << "Illegal resolution in Z (negative)";
  }
}

update()

void GaussEvtVtxGenerator::update ( const edm::EventSetup &  iEventSetup )

private

Definition at line 48 of file GaussEvtVtxGenerator.cc.

References beamToken_, edm::ESWatcher< T >::check(), fMeanX, fMeanY, fMeanZ, fSigmaX, fSigmaY, fSigmaZ, fTimeOffset, edm::EventSetup::getHandle(), SimBeamSpotObjects::meanX(), SimBeamSpotObjects::meanY(), SimBeamSpotObjects::meanZ(), parameterWatcher_, readDB_, SimBeamSpotObjects::sigmaX(), SimBeamSpotObjects::sigmaY(), SimBeamSpotObjects::sigmaZ(), and SimBeamSpotObjects::timeOffset().

Referenced by progressbar.ProgressBar::__next__(), MatrixUtil.Matrix::__setitem__(), MatrixUtil.Steps::__setitem__(), beginLuminosityBlock(), progressbar.ProgressBar::finish(), and MatrixUtil.Steps::overwrite().

                                                                  {
  if (readDB_ && parameterWatcher_.check(iEventSetup)) {
    edm::ESHandle<SimBeamSpotObjects> beamhandle = iEventSetup.getHandle(beamToken_);
    fMeanX = beamhandle->meanX() * cm;
    fMeanY = beamhandle->meanY() * cm;
    fMeanZ = beamhandle->meanZ() * cm;
    fSigmaX = beamhandle->sigmaX() * cm;
    fSigmaY = beamhandle->sigmaY() * cm;
    fSigmaZ = beamhandle->sigmaZ() * cm;
    fTimeOffset = beamhandle->timeOffset() * ns * c_light;  // HepMC distance units are in mm
  }
}

Member Data Documentation

beamToken_

edm::ESGetToken<SimBeamSpotObjects, SimBeamSpotObjectsRcd> GaussEvtVtxGenerator::beamToken_

private

Definition at line 63 of file GaussEvtVtxGenerator.h.

Referenced by GaussEvtVtxGenerator(), and update().

fMeanX

double GaussEvtVtxGenerator::fMeanX

private

Definition at line 58 of file GaussEvtVtxGenerator.h.

Referenced by GaussEvtVtxGenerator(), meanX(), newVertex(), and update().

fMeanY

double GaussEvtVtxGenerator::fMeanY

private

Definition at line 58 of file GaussEvtVtxGenerator.h.

Referenced by GaussEvtVtxGenerator(), meanY(), newVertex(), and update().

fMeanZ

double GaussEvtVtxGenerator::fMeanZ

private

Definition at line 58 of file GaussEvtVtxGenerator.h.

Referenced by GaussEvtVtxGenerator(), meanZ(), newVertex(), and update().

fSigmaX

double GaussEvtVtxGenerator::fSigmaX

private

Definition at line 57 of file GaussEvtVtxGenerator.h.

Referenced by GaussEvtVtxGenerator(), newVertex(), sigmaX(), and update().

fSigmaY

double GaussEvtVtxGenerator::fSigmaY

private

Definition at line 57 of file GaussEvtVtxGenerator.h.

Referenced by GaussEvtVtxGenerator(), newVertex(), sigmaY(), and update().

fSigmaZ

double GaussEvtVtxGenerator::fSigmaZ

private

Definition at line 57 of file GaussEvtVtxGenerator.h.

Referenced by GaussEvtVtxGenerator(), newVertex(), sigmaZ(), and update().

fTimeOffset

double GaussEvtVtxGenerator::fTimeOffset

private

Definition at line 59 of file GaussEvtVtxGenerator.h.

Referenced by GaussEvtVtxGenerator(), newVertex(), and update().

parameterWatcher_

edm::ESWatcher<SimBeamSpotObjectsRcd> GaussEvtVtxGenerator::parameterWatcher_

private

Definition at line 62 of file GaussEvtVtxGenerator.h.

Referenced by update().

readDB_

bool GaussEvtVtxGenerator::readDB_

private

Definition at line 55 of file GaussEvtVtxGenerator.h.

Referenced by GaussEvtVtxGenerator(), and update().