BetafuncEvtVtxGenerator Class Reference

#include <BetafuncEvtVtxGenerator.h>

Inheritance diagram for BetafuncEvtVtxGenerator:

Public Member Functions
void	beginLuminosityBlock (edm::LuminosityBlock const &, edm::EventSetup const &) override
	BetafuncEvtVtxGenerator (const edm::ParameterSet &p)
	BetafuncEvtVtxGenerator (const BetafuncEvtVtxGenerator &p)=delete
double	BetaFunction (double z, double z0) const
	beta function More...
void	betastar (double m=0)
	set beta_star More...
void	emittance (double m=0)
	emittance (no the normalized) More...
TMatrixD const *	GetInvLorentzBoost () const override
HepMC::FourVector	newVertex (CLHEP::HepRandomEngine *) const override
	return a new event vertex More...
BetafuncEvtVtxGenerator &	operator= (const BetafuncEvtVtxGenerator &rhs)=delete
void	sigmaZ (double s=1.0)
	set resolution in Z in cm More...
void	X0 (double m=0)
	set mean in X in cm More...
void	Y0 (double m=0)
	set mean in Y in cm More...
void	Z0 (double m=0)
	set mean in Z in cm More...
	~BetafuncEvtVtxGenerator () 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	setBoost (double alpha, double phi)
void	update (const edm::EventSetup &iEventSetup)

Private Attributes
edm::ESGetToken< SimBeamSpotObjects, SimBeamSpotObjectsRcd >	beamToken_
TMatrixD	boost_
double	fbetastar
double	femittance
double	fSigmaZ
double	fTimeOffset
double	fX0
double	fY0
double	fZ0
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 32 of file BetafuncEvtVtxGenerator.h.

Constructor & Destructor Documentation

BetafuncEvtVtxGenerator() [1/2]

BetafuncEvtVtxGenerator::BetafuncEvtVtxGenerator

(

const edm::ParameterSet &

p

)

Definition at line 33 of file BetafuncEvtVtxGenerator.cc.

References beamToken_, Exception, fbetastar, femittance, fSigmaZ, fTimeOffset, fX0, fY0, fZ0, AlCaHLTBitMon_ParallelJobs::p, readDB_, and setBoost().

                                                                         : BaseEvtVtxGenerator(p), boost_(4, 4) {
  readDB_ = p.getParameter<bool>("readDB");
  if (!readDB_) {
    fX0 = p.getParameter<double>("X0") * cm;
    fY0 = p.getParameter<double>("Y0") * cm;
    fZ0 = p.getParameter<double>("Z0") * cm;
    fSigmaZ = p.getParameter<double>("SigmaZ") * cm;
    fbetastar = p.getParameter<double>("BetaStar") * cm;
    femittance = p.getParameter<double>("Emittance") * cm;              // this is not the normalized emittance
    fTimeOffset = p.getParameter<double>("TimeOffset") * ns * c_light;  // HepMC distance units are in mm

    setBoost(p.getParameter<double>("Alpha") * radian, p.getParameter<double>("Phi") * radian);
    if (fSigmaZ <= 0) {
      throw cms::Exception("Configuration") << "Error in BetafuncEvtVtxGenerator: "
                                            << "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>();
  }
}

BetafuncEvtVtxGenerator() [2/2]

BetafuncEvtVtxGenerator::BetafuncEvtVtxGenerator ( const BetafuncEvtVtxGenerator &  p )

delete

Copy constructor

~BetafuncEvtVtxGenerator()

BetafuncEvtVtxGenerator::~BetafuncEvtVtxGenerator ( )

overridedefault

Member Function Documentation

beginLuminosityBlock()

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

override

Definition at line 57 of file BetafuncEvtVtxGenerator.cc.

References update().

                                                                                                              {
  update(iEventSetup);
}

BetaFunction()

double BetafuncEvtVtxGenerator::BetaFunction	(	double	z,
		double	z0
	)		const

beta function

Definition at line 97 of file BetafuncEvtVtxGenerator.cc.

References fbetastar, femittance, mathSSE::sqrt(), z, and HLTMuonOfflineAnalyzer_cfi::z0.

Referenced by newVertex().

                                                                      {
  return sqrt(femittance * (fbetastar + (((z - z0) * (z - z0)) / fbetastar)));
}

betastar()

void BetafuncEvtVtxGenerator::betastar ( double  m = 0 )

inline

set beta_star

Definition at line 62 of file BetafuncEvtVtxGenerator.h.

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

{ fbetastar = m; }

emittance()

void BetafuncEvtVtxGenerator::emittance ( double  m = 0 )

inline

emittance (no the normalized)

Definition at line 64 of file BetafuncEvtVtxGenerator.h.

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

{ femittance = m; }

fillDescriptions()

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

static

Definition at line 145 of file BetafuncEvtVtxGenerator.cc.

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

                                                                                         {
  edm::ParameterSetDescription desc;
  desc.add<double>("X0", 0.0)->setComment("in cm");
  desc.add<double>("Y0", 0.0)->setComment("in cm");
  desc.add<double>("Z0", 0.0)->setComment("in cm");
  desc.add<double>("SigmaZ", 0.0)->setComment("in cm");
  desc.add<double>("BetaStar", 0.0)->setComment("in cm");
  desc.add<double>("Emittance", 0.0)->setComment("in cm");
  desc.add<double>("Alpha", 0.0)->setComment("in radians");
  desc.add<double>("Phi", 0.0)->setComment("in radians");
  desc.add<double>("TimeOffset", 0.0)->setComment("in ns");
  desc.add<edm::InputTag>("src");
  desc.add<bool>("readDB");
  descriptions.add("BetafuncEvtVtxGenerator", desc);
}

GetInvLorentzBoost()

TMatrixD const * BetafuncEvtVtxGenerator::GetInvLorentzBoost ( ) const

overridevirtual

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 143 of file BetafuncEvtVtxGenerator.cc.

References boost_.

{ return &boost_; }

newVertex()

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

overridevirtual

return a new event vertex

Implements BaseEvtVtxGenerator.

Definition at line 75 of file BetafuncEvtVtxGenerator.cc.

References BetaFunction(), fSigmaZ, fTimeOffset, fX0, fY0, fZ0, mathSSE::sqrt(), X, beamSpotPI::Y, and beamSpotPI::Z.

                                                                                     {
  double X, Y, Z;

  double tmp_sigz = CLHEP::RandGaussQ::shoot(engine, 0., fSigmaZ);
  Z = tmp_sigz + fZ0;

  double tmp_sigx = BetaFunction(Z, fZ0);
  // need sqrt(2) for beamspot width relative to single beam width
  tmp_sigx /= sqrt(2.0);
  X = CLHEP::RandGaussQ::shoot(engine, 0., tmp_sigx) + fX0;  // + Z*fdxdz ;

  double tmp_sigy = BetaFunction(Z, fZ0);
  // need sqrt(2) for beamspot width relative to single beam width
  tmp_sigy /= sqrt(2.0);
  Y = CLHEP::RandGaussQ::shoot(engine, 0., tmp_sigy) + fY0;  // + Z*fdydz;

  double tmp_sigt = CLHEP::RandGaussQ::shoot(engine, 0., fSigmaZ);
  double T = tmp_sigt + fTimeOffset;

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

operator=()

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

delete

Copy assignment operator

setBoost()

void BetafuncEvtVtxGenerator::setBoost ( double  alpha, double  phi  )

private

Definition at line 101 of file BetafuncEvtVtxGenerator.cc.

References simBeamSpotPI::alpha, boost_, funct::cos(), phi, funct::sin(), and funct::tan().

Referenced by BetafuncEvtVtxGenerator(), and update().

                                                               {
  //boost_.ResizeTo(4,4);
  //boost_ = new TMatrixD(4,4);
  TMatrixD tmpboost(4, 4);

  //if ( (alpha_ == 0) && (phi_==0) ) { boost_->Zero(); return boost_; }

  // Lorentz boost to frame where the collision is head-on
  // phi is the half crossing angle in the plane ZS
  // alpha is the angle to the S axis from the X axis in the XY plane

  tmpboost(0, 0) = 1. / cos(phi);
  tmpboost(0, 1) = -cos(alpha) * sin(phi);
  tmpboost(0, 2) = -tan(phi) * sin(phi);
  tmpboost(0, 3) = -sin(alpha) * sin(phi);
  tmpboost(1, 0) = -cos(alpha) * tan(phi);
  tmpboost(1, 1) = 1.;
  tmpboost(1, 2) = cos(alpha) * tan(phi);
  tmpboost(1, 3) = 0.;
  tmpboost(2, 0) = 0.;
  tmpboost(2, 1) = -cos(alpha) * sin(phi);
  tmpboost(2, 2) = cos(phi);
  tmpboost(2, 3) = -sin(alpha) * sin(phi);
  tmpboost(3, 0) = -sin(alpha) * tan(phi);
  tmpboost(3, 1) = 0.;
  tmpboost(3, 2) = sin(alpha) * tan(phi);
  tmpboost(3, 3) = 1.;

  tmpboost.Invert();
  boost_ = tmpboost;
  //boost_->Print();
}

sigmaZ()

void BetafuncEvtVtxGenerator::sigmaZ

(

double

s = 1.0

)

set resolution in Z in cm

Definition at line 134 of file BetafuncEvtVtxGenerator.cc.

References Exception, fSigmaZ, and alignCSCRings::s.

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

update()

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

private

Definition at line 61 of file BetafuncEvtVtxGenerator.cc.

References SimBeamSpotObjects::alpha(), beamToken_, SimBeamSpotObjects::betaStar(), edm::ESWatcher< T >::check(), SimBeamSpotObjects::emittance(), fbetastar, femittance, fSigmaZ, fTimeOffset, fX0, fY0, fZ0, edm::EventSetup::getHandle(), parameterWatcher_, SimBeamSpotObjects::phi(), readDB_, setBoost(), SimBeamSpotObjects::sigmaZ(), SimBeamSpotObjects::timeOffset(), SimBeamSpotObjects::x(), SimBeamSpotObjects::y(), and SimBeamSpotObjects::z().

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_);
    fX0 = beamhandle->x() * cm;
    fY0 = beamhandle->y() * cm;
    fZ0 = beamhandle->z() * cm;
    fSigmaZ = beamhandle->sigmaZ() * cm;
    fTimeOffset = beamhandle->timeOffset() * ns * c_light;  // HepMC distance units are in mm
    fbetastar = beamhandle->betaStar() * cm;
    femittance = beamhandle->emittance() * cm;
    setBoost(beamhandle->alpha() * radian, beamhandle->phi() * radian);
  }
}

X0()

void BetafuncEvtVtxGenerator::X0 ( double  m = 0 )

inline

set mean in X in cm

Definition at line 55 of file BetafuncEvtVtxGenerator.h.

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

{ fX0 = m; }

Y0()

void BetafuncEvtVtxGenerator::Y0 ( double  m = 0 )

inline

set mean in Y in cm

Definition at line 57 of file BetafuncEvtVtxGenerator.h.

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

{ fY0 = m; }

Z0()

void BetafuncEvtVtxGenerator::Z0 ( double  m = 0 )

inline

set mean in Z in cm

Definition at line 59 of file BetafuncEvtVtxGenerator.h.

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

{ fZ0 = m; }

Member Data Documentation

beamToken_

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

private

Definition at line 86 of file BetafuncEvtVtxGenerator.h.

Referenced by BetafuncEvtVtxGenerator(), and update().

boost_

TMatrixD BetafuncEvtVtxGenerator::boost_

private

Definition at line 82 of file BetafuncEvtVtxGenerator.h.

Referenced by GetInvLorentzBoost(), and setBoost().

fbetastar

double BetafuncEvtVtxGenerator::fbetastar

private

Definition at line 78 of file BetafuncEvtVtxGenerator.h.

Referenced by BetafuncEvtVtxGenerator(), BetaFunction(), betastar(), and update().

femittance

double BetafuncEvtVtxGenerator::femittance

private

Definition at line 78 of file BetafuncEvtVtxGenerator.h.

Referenced by BetafuncEvtVtxGenerator(), BetaFunction(), emittance(), and update().

fSigmaZ

double BetafuncEvtVtxGenerator::fSigmaZ

private

Definition at line 76 of file BetafuncEvtVtxGenerator.h.

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

fTimeOffset

double BetafuncEvtVtxGenerator::fTimeOffset

private

Definition at line 80 of file BetafuncEvtVtxGenerator.h.

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

fX0

double BetafuncEvtVtxGenerator::fX0

private

Definition at line 75 of file BetafuncEvtVtxGenerator.h.

Referenced by BetafuncEvtVtxGenerator(), newVertex(), update(), and X0().

fY0

double BetafuncEvtVtxGenerator::fY0

private

Definition at line 75 of file BetafuncEvtVtxGenerator.h.

Referenced by BetafuncEvtVtxGenerator(), newVertex(), update(), and Y0().

fZ0

double BetafuncEvtVtxGenerator::fZ0

private

Definition at line 75 of file BetafuncEvtVtxGenerator.h.

Referenced by BetafuncEvtVtxGenerator(), newVertex(), update(), and Z0().

parameterWatcher_

edm::ESWatcher<SimBeamSpotObjectsRcd> BetafuncEvtVtxGenerator::parameterWatcher_

private

Definition at line 85 of file BetafuncEvtVtxGenerator.h.

Referenced by update().

readDB_

bool BetafuncEvtVtxGenerator::readDB_

private

Definition at line 73 of file BetafuncEvtVtxGenerator.h.

Referenced by BetafuncEvtVtxGenerator(), and update().