CosmicGenerator Class Reference

Cosmic generator. More...

#include <CosmicGenerator.h>

Inheritance diagram for CosmicGenerator:

Collaboration diagram for CosmicGenerator:

Public Member Functions
	CosmicGenerator (const std::string &name, ISvcLocator *pSvcLocator)
virtual	~CosmicGenerator ()=default
virtual StatusCode	genInitialize ()
	For initializing the generator, if required.
virtual StatusCode	callGenerator ()
	For calling the generator on each iteration of the event loop.
virtual StatusCode	genFinalize ()
	For finalising the generator, if required.
virtual StatusCode	fillEvt (HepMC::GenEvent *evt)
	For filling the HepMC event object.
CLHEP::HepLorentzVector	generateVertex (void)
CLHEP::HepLorentzVector	generateVertexReweighted (void)
virtual StatusCode	sysInitialize () override
	Override sysInitialize.
virtual const DataObjIDColl &	extraOutputDeps () const override
	Return the list of extra output dependencies.
ServiceHandle< StoreGateSvc > &	evtStore ()
	The standard StoreGateSvc (event store) Returns (kind of) a pointer to the StoreGateSvc.
const ServiceHandle< StoreGateSvc > &	detStore () const
	The standard StoreGateSvc/DetectorStore Returns (kind of) a pointer to the StoreGateSvc.
virtual StatusCode	sysStart () override
	Handle START transition.
virtual std::vector< Gaudi::DataHandle * >	inputHandles () const override
	Return this algorithm's input handles.
virtual std::vector< Gaudi::DataHandle * >	outputHandles () const override
	Return this algorithm's output handles.
Gaudi::Details::PropertyBase &	declareProperty (Gaudi::Property< T, V, H > &t)
void	updateVHKA (Gaudi::Details::PropertyBase &)
MsgStream &	msg () const
bool	msgLvl (const MSG::Level lvl) const
Event loop algorithm methods: not to be overloaded
StatusCode	initialize ()
StatusCode	execute ()
StatusCode	finalize ()
Gen-specific event loop methods: to be overloaded
virtual StatusCode	genuserInitialize ()
	For initialization of user code, if required. Called after genInitialize.
Event collection accessors (const and non-const)
HepMC::GenEvent *event	ATLAS_NOT_CONST_THREAD_SAFE ()
	Access the current signal event (first in the McEventCollection)
McEventCollection *events	ATLAS_NOT_CONST_THREAD_SAFE ()
	Access the current event's McEventCollection.
const HepMC::GenEvent *	event_const () const
	Access the current signal event (const)
const McEventCollection *	events_const () const
	Access the current event's McEventCollection (const)
const McEventCollection *	events_const (const EventContext &ctx) const
Particle data accessors
const ServiceHandle< IPartPropSvc >	partPropSvc () const
	Access the particle property service.
const HepPDT::ParticleDataTable &	particleTable () const
	Get a particle data table.
const HepPDT::ParticleDataTable &	pdt () const
	Shorter alias to get a particle data table.
const HepPDT::ParticleData *	particleData (int pid) const
	Access an element in the particle data table.

Static Public Attributes
static CLHEP::HepRandomEngine *	COSMIC_RANDOM_ENGINE {}
	Static pointer to random number generator for use by.

Protected Member Functions
void	renounceArray (SG::VarHandleKeyArray &handlesArray)
	remove all handles from I/O resolution
std::enable_if_t< std::is_void_v< std::result_of_t< decltype(&T::renounce)(T)> > &&!std::is_base_of_v< SG::VarHandleKeyArray, T > &&std::is_base_of_v< Gaudi::DataHandle, T >, void >	renounce (T &h)
void	extraDeps_update_handler (Gaudi::Details::PropertyBase &ExtraDeps)
	Add StoreName to extra input/output deps as needed.

Protected Attributes
Properties
std::string	m_mcEventKey {}
	StoreGate key for the MC event collection (defaults to GEN_EVENT)
BooleanProperty	m_mkMcEvent {this, "MakeMcEvent", false, "Create a new MC event collection if it doesn't exist"}
	Flag to determine if a new MC event collection should be made if it doesn't exist.

Private Types
typedef ServiceHandle< StoreGateSvc >	StoreGateSvc_t

Private Member Functions
bool	exzCut (const CLHEP::Hep3Vector &pos, const CLHEP::HepLorentzVector &p)
double	pathLengthInRock (double xgen, double ygen, double zgen, double theta, double phi)
bool	pointsAtPixels (double xgen, double ygen, double zgen, double theta, double phi)
Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T, V, H > &hndl, const SG::VarHandleKeyType &)
	specialization for handling Gaudi::Property<SG::VarHandleKey>

Private Attributes
int	m_events {0}
int	m_rejected {0}
int	m_accepted {0}
std::vector< int >	m_pdgCode
IntegerProperty	m_dsid {this, "Dsid", 999999, "Dataset ID number"}
FloatProperty	m_emin {this, "emin", 10.*m_GeV}
FloatProperty	m_emax {this, "emax", 100.*m_GeV}
FloatProperty	m_ctcut {this, "ctcut", 0.35}
FloatProperty	m_xlow {this, "xvert_low", 0.*m_mm}
FloatProperty	m_xhig {this, "xvert_hig", 10.*m_mm}
FloatProperty	m_zlow {this, "zvert_low", 0.*m_mm}
FloatProperty	m_zhig {this, "zvert_hig", 10.*m_mm}
FloatProperty	m_yval {this, "yvert_val", 81.*m_mm}
FloatProperty	m_IPx {this, "IPx", 0.f}
FloatProperty	m_IPy {this, "IPy", 0.f}
FloatProperty	m_IPz {this, "IPz", 0.f}
FloatProperty	m_radius {this, "Radius", 0.f}
FloatProperty	m_zpos {this, "Zposition", 14500.f}
FloatProperty	m_tmin {this, "tmin", 0.f}
FloatProperty	m_tmax {this, "tmax", 0.f}
BooleanProperty	m_cavOpt {this, "OptimizeForCavern", false}
IntegerProperty	m_srOneOpt {this, "OptimizeForSR1", 0}
BooleanProperty	m_srOnePixECOpt {this, "OptimizeForSR1PixelEndCap", false}
BooleanProperty	m_swapYZAxis {this, "SwapYZAxis", false}
BooleanProperty	m_muonECOpt {this, "OptimizeForMuonEndCap", false}
IntegerProperty	m_printEvent {this, "PrintEvent", 10}
IntegerProperty	m_printMod {this, "PrintMod", 100}
FloatProperty	m_thetamin {this, "ThetaMin", 0.f}
FloatProperty	m_thetamax {this, "ThetaMax", 1.f}
FloatProperty	m_phimin {this, "PhiMin", -1.*M_PI}
FloatProperty	m_phimax {this, "PhiMax", M_PI}
bool	m_readfile {false}
StringProperty	m_infile {this, "eventfile", "NONE"}
std::ifstream	m_ffile
std::vector< CLHEP::HepLorentzVector >	m_fourPos
std::vector< CLHEP::HepLorentzVector >	m_fourMom
CLHEP::Hep3Vector	m_center
std::vector< HepMC::Polarization >	m_polarization
BooleanProperty	m_exzCut {this, "ExzCut", false}
FloatProperty	m_rmax {this, "RMax", 10000000.f}
BooleanProperty	m_doPathlengthCut {this, "doPathLengthCut", false}
BooleanProperty	m_doAimedAtPixelsCut {this, "doAimedAtPixelsCut", false}
BooleanProperty	m_doReweighting {this, "doReweighting", false}
DoubleProperty	m_energyCutThreshold {this, "energyCutThreshold", 1.0}
DoubleProperty	m_ysurface {this, "ysurface", 81.*m_mm}
DoubleProperty	m_rvertmax {this, "rvert_max", 300.*m_mm}
DoubleProperty	m_pixelplanemaxx {this, "pixelplane_maxx", 1150.}
DoubleProperty	m_pixelplanemaxz {this, "pixelplane_maxz", 1650.}
DataObjIDColl	m_extendedExtraObjects
StoreGateSvc_t	m_evtStore
	Pointer to StoreGate (event store by default)
StoreGateSvc_t	m_detStore
	Pointer to StoreGate (detector store by default)
std::vector< SG::VarHandleKeyArray * >	m_vhka
bool	m_varHandleArraysDeclared

Static Private Attributes
static constexpr float	m_GeV = 1000.f
static constexpr float	m_mm = 10.f

Features for derived classes to use internally
ServiceHandle< IAthRNGSvc >	m_rndmSvc {this, "RndmSvc", "AthRNGSvc"}
	Data members.
ServiceHandle< IIncidentSvc >	m_incidentSvc {this, "IncidentSvc", "IncidentSvc"}
	Handle on the incident service.
IntegerProperty	m_randomSeed {this, "RandomSeed", 1234567, "Random seed for the built-in random engine"}
	Seed for random number engine.
BooleanProperty	m_isAfterburner {this, "IsAfterburner", false, "Set true if generator modifies existing events rather than creating new ones"}
	Flag for normal vs. afterburner generators.
CLHEP::HepRandomEngine *	getRandomEngine (const std::string &streamName, const EventContext &ctx) const
CLHEP::HepRandomEngine *	getRandomEngine (const std::string &streamName, unsigned long int randomSeedOffset, const EventContext &ctx) const
CLHEP::HepRandomEngine *	getRandomEngineDuringInitialize (const std::string &streamName, unsigned long int randomSeedOffset, unsigned int conditionsRun=1, unsigned int lbn=1) const

Utility event-mangling functions
Todo Replace with HepMC units when available
ServiceHandle< IPartPropSvc >	m_ppSvc {this, "PartPropSvc", "PartPropSvc"}
	Handle on the particle property service.
SG::ReadHandleKey< McEventCollection >	m_mcevents_const { this, "McEventKey", "GEN_EVENT", "StoreGate key of the MC event collection" }
	Const handle to the MC event collection.
void	GeVToMeV (HepMC::GenEvent *evt)
	Scale event energies/momenta by x 1000.
void	MeVToGeV (HepMC::GenEvent *evt)
	Scale event energies/momenta by x 1/1000.
void	cmTomm (HepMC::GenEvent *evt)
	Scale event lengths by x 10.
void	mmTocm (HepMC::GenEvent *evt)
	Scale event lengths by x 1/10.

Detailed Description

Cosmic generator.

The output will be stored in the transient event store so it can be passed to the simulation.

Author

W. Seligman: Initial Code 08-Nov-2002, based on work by M. Shapiro and I. Hinchliffe

Modification for increasing efficiency of muon hitting the detector: H. Ma. March 17, 2006 Property: ExzCut:
if true, the method exzCut(...) will be called to apply a energy dependent position cut on the surface. This rejects low energy muons at large distance. Property: RMax Used by exzCut to reject non-projective muons, which are too far out on the surface

Modifications to accomodate Pixel EndCap C Cosmic Test needs Marian Zdrazil June 7, 2006 mzdra.nosp@m.zil@.nosp@m.lbl.g.nosp@m.ov

Modifications to accomodate replacement of Pixel EndCap C by a Pixel EndCap A Marian Zdrazil November 24, 2006 mzdra.nosp@m.zil@.nosp@m.lbl.g.nosp@m.ov

It is easier and actually more useful to leave the EndCap A in the vertical position (the way it is positioned in the ATLAS detector) instead of rotating it clockwise by 90deg which corresponds to the placement during the Pixel EndCap A cosmic test in SR1 in November 2006. This is why we will generate cosmic muons coming from the positive Z-axis direction better than rotating the whole setup in PixelGeoModel.

Modifications July 3rd 2007, Rob McPherson

• Fix mu+/mu- bug (always present in Athena versions)
• Fix sign of Py (since tag CosmicGenerator-00-00-21, muons only upward-going)

Optimize selection of events passed to Geant4 for full simulation:

• cut on energy based on pathlength in rock
• reweighting of generated cosmic rays
• geometrical cut in plane of pixel detector Juerg Beringer November 2007 JBeri.nosp@m.nger.nosp@m.@lgl..nosp@m.gov Robert Cahn November 2007 RNCah.nosp@m.n@lb.nosp@m.l.gov

Definition at line 75 of file CosmicGenerator.h.

Member Typedef Documentation

StoreGateSvc_t

typedef ServiceHandle<StoreGateSvc> AthCommonDataStore< AthCommonMsg< Algorithm > >::StoreGateSvc_t

privateinherited

Definition at line 388 of file AthCommonDataStore.h.

Constructor & Destructor Documentation

CosmicGenerator()

CosmicGenerator::CosmicGenerator	(	const std::string &	name,
		ISvcLocator *	pSvcLocator )

Definition at line 80 of file CosmicGenerator.cxx.

  : GenModule(name,pSvcLocator)
//--------------------------------------------------------------------------
{
}

~CosmicGenerator()

virtual CosmicGenerator::~CosmicGenerator ( )

virtualdefault

Member Function Documentation

ATLAS_NOT_CONST_THREAD_SAFE() [1/2]

HepMC::GenEvent *event GenBase::ATLAS_NOT_CONST_THREAD_SAFE ( )

inlineinherited

Access the current signal event (first in the McEventCollection)

Note

This function will make a new McEventCollection if there is not already a valid one and MakeMcEvent=True.

Definition at line 76 of file GenBase.h.

                                                      {
    if (events()->empty())
      ATH_MSG_ERROR("McEventCollection is empty during first event access");
    return *(events()->begin());
  }

ATLAS_NOT_CONST_THREAD_SAFE() [2/2]

McEventCollection *events GenBase::ATLAS_NOT_CONST_THREAD_SAFE ( )

inherited

Access the current event's McEventCollection.

Note

This function will make a new McEventCollection if there is not already a valid one and MakeMcEvent=True.

callGenerator()

StatusCode CosmicGenerator::callGenerator ( )

virtual

For calling the generator on each iteration of the event loop.

Reimplemented from GenModule.

Definition at line 214 of file CosmicGenerator.cxx.

                                          {
//---------------------------------------------------------------------------
 
  ++m_events;
  ATH_MSG_DEBUG( "Event #" << m_events);
 
  assert(COSMIC_RANDOM_ENGINE != 0);
  //Re-seed the random number stream
  long seeds[7];
  const EventContext& ctx = Gaudi::Hive::currentContext();
  ATHRNG::calculateSeedsMC21(seeds, "COSMICS",  ctx.eventID().event_number(), m_dsid, m_randomSeed);
  COSMIC_RANDOM_ENGINE->setSeeds(seeds, 0); // NOT THREAD-SAFE
  CLHEP::HepRandomEngine* engine = COSMIC_RANDOM_ENGINE;
 
  // clear up the vectors
  m_fourPos.clear();
  m_fourMom.clear();
  m_polarization.clear();
  m_pdgCode.clear();
 
 
  if(m_readfile)
    {
      if(!m_ffile.eof())
        {
          CosmicEventParser evt;
          m_ffile >> evt;
 
          ATH_MSG_VERBOSE( evt );
 
          HepMC::Polarization thePolarization(0.0,0.0);
          m_polarization.push_back(thePolarization);
 
          //
          // units are already converted to MeV's and mm.
          //
          m_fourPos.push_back(evt.Vertex());
          m_fourMom.push_back(evt.Momentum());
          m_pdgCode.push_back(evt.pdgID());
 
        }
      else
        {
          ATH_MSG_FATAL( "End of file reached - stop " );
          exit(1);
          return StatusCode::FAILURE;
        }
    }
  else
    {
 
      bool accepted=false;
      CLHEP::HepLorentzVector pp;
      CosmicGun* gun = CosmicGun::GetCosmicGun();
      CLHEP::HepLorentzVector vert;
      CLHEP::Hep3Vector vert3;
      double theta1;
      double phi1;
      double mag1;
 
      while(!accepted){
 
        if (m_doReweighting && m_cavOpt) {
          // The code here doesn't make sense without the sphere cut in the
          // cavern optimization that is selected by OptimizeForCavern=True
          vert = generateVertexReweighted();
          vert3 = CLHEP::Hep3Vector(vert.x(),vert.y(),vert.z());
 
          double vert_radius=sqrt(vert3.x()*vert3.x() + vert3.z()*vert3.z());
 
          pp = gun->GenerateEvent();
 
          theta1=pp.theta();
          phi1=pp.phi();
          mag1=pp.rho();
 
          if (vert_radius>m_radius) {
            phi1=atan2(vert.z(),vert.x())+M_PI;
            float delta_phi=std::asin(m_radius/vert_radius);
            phi1=phi1+CLHEP::RandFlat::shoot(engine, -delta_phi, delta_phi);
          }
          pp.setX(mag1*sin(theta1)*std::cos(phi1));
          pp.setY(mag1*sin(theta1)*std::sin(phi1));
 
        } else {
          vert = generateVertex();
          vert3 = CLHEP::Hep3Vector(vert.x(),vert.y(),vert.z());
 
          pp = gun->GenerateEvent();
 
          theta1=pp.theta();
          phi1=pp.phi();
          mag1=pp.rho();
        }
 
        CLHEP::Hep3Vector pp_corr(mag1*sin(theta1)*std::cos(phi1),
                           -mag1*std::cos(theta1),
                           mag1*std::sin(theta1)*std::sin(phi1));
        CLHEP::Hep3Vector direction(pp_corr.x(),pp_corr.y(), pp_corr.z());
 
        // if optimization activated, check for the direction of the generated muon
        if(m_cavOpt) {
 
          CLHEP::Hep3Vector center_dir=m_center-vert3;
          double beta=direction.angle(center_dir);
          double alpha=std::asin(m_radius/center_dir.r());
 
          if(std::abs(beta)<alpha) {
 
            if(m_exzCut) {
              // Old optimization code - is it still useful?
              CLHEP::HepLorentzVector pp2(pp_corr.x(),pp_corr.y(), pp_corr.z(), pp.e());
              if( exzCut(vert3,pp2) ) {
                accepted=true;
              }
            } else {
 
              accepted = true;
 
              ATH_MSG_DEBUG( "x0 = " << vert3.x()
                  << ", y0 = " << vert3.y()
                  << ", z0 = " << vert3.z()
                  << ", theta = " << pp.theta()
                  << ", phi = " << pp.phi()
                  << ", energy = " << pp.e()*m_GeV );
 
              if (m_doPathlengthCut) {
                double path = pathLengthInRock(vert3.x(),vert3.y(),vert3.z(),pp.theta(),pp.phi());
                double energyLoss =  2.33e-3 * 244. * path; //FIXME Hardcoded values!
                ATH_MSG_DEBUG( "Energy loss is " << energyLoss
                    << " --> " << (energyLoss>pp.e()*m_GeV ? "REJECTED" : "ACCEPTED") << " by pathlength cut");
                if (energyLoss-m_energyCutThreshold > pp.e()*m_GeV) accepted = false;
              }
 
              if (m_doAimedAtPixelsCut) {
                bool aimedAtPixels = pointsAtPixels(vert3.x(),vert3.y(),vert3.z(),pp.theta(),pp.phi());
                ATH_MSG_DEBUG( (aimedAtPixels ? "AIMED AT PIXELS" : "NOT AIMED AT PIXELS") );
                if (!aimedAtPixels) accepted = false;
              }
 
              // FOR DEBUGGING ONLY
              if (accepted) {
                ATH_MSG_VERBOSE("The following event has been accepted for simulation:");
                ATH_MSG_VERBOSE( "x0 = " << vert3.x() << ", y0 = " << vert3.y() << ", z0 = " << vert3.z()
                              << ", theta = " << pp.theta() << ", phi = " << pp.phi() << ", energy = " << pp.e()*m_GeV );
 
                if (m_doPathlengthCut) {
                  double path = pathLengthInRock(vert3.x(),vert3.y(),vert3.z(),pp.theta(),pp.phi());
                  double energyLoss =  2.33e-3 * 244. * path;
                  ATH_MSG_VERBOSE( "Energy loss is " << energyLoss
                      << " --> " << (energyLoss>pp.e()*m_GeV ? "REJECTED" : "ACCEPTED") << " by pathlength cut" );
                }
              
                if (m_doAimedAtPixelsCut) {
                  bool aimedAtPixels = pointsAtPixels(vert3.x(),vert3.y(),vert3.z(),pp.theta(),pp.phi());
                  ATH_MSG_VERBOSE( (aimedAtPixels ? "AIMED AT PIXELS" : "NOT AIMED AT PIXELS") );
                }
 
              }
 
            }
          }
 
          if(accepted) {
            m_accepted++;
          } else {
            ATH_MSG_VERBOSE("Rejected muon due to cavern optimization request!");
            m_rejected++;
          }
        }
        else if(m_srOneOpt == 1) {
          CLHEP::Hep3Vector srOneVec(direction.x(), direction.y(), direction.z());
          if(mag1 < 0) // Check if momentum vector is flipped.
            srOneVec *= -1;
 
          if( (srOneVec.phi() >= -2.25) && (srOneVec.phi() <= -1.7) &&
              (srOneVec.theta() >= 0.85) && (srOneVec.theta() <= 2.25) ) { //FIXME Hardcoded values!
            accepted = true;
            m_accepted++;
            ATH_MSG_DEBUG("Muon accepted by SR1 SCT/TRT optimization!");
          } else {
            ATH_MSG_DEBUG("Rejected muon due to SR1 SCT/TRT optimization request!");
            m_rejected++;
          }
        }
        else if(m_srOneOpt == 2) {
          CLHEP::Hep3Vector srOneVec(direction.x(), direction.y(), direction.z());
          if(mag1 < 0) // Check if momentum vector is flipped.
            srOneVec *= -1;
 
          if( (srOneVec.phi() >= -1.68) && (srOneVec.phi() <= -1.08) &&
              (srOneVec.theta() >= 0.29) && (srOneVec.theta() <= 0.72) ) { //FIXME Hardcoded values!
            accepted = true;
            m_accepted++;
            ATH_MSG_DEBUG("Muon accepted by SR1 SCT/TRT EndCapC optimization!");
          } else {
            ATH_MSG_DEBUG("Rejected muon due to SR1 SCT/TRT EndcapC optimization request!");
            m_rejected++;
          }
        }
 
        else if(m_srOnePixECOpt) {
          CLHEP::Hep3Vector srOneVec(direction.x(), direction.y(), direction.z());
          if(mag1 < 0) // Check if momentum vector is flipped.
            srOneVec *= -1;
 
          if( (srOneVec.phi() >= m_phimin) && (srOneVec.phi() <= m_phimax) &&
              (srOneVec.theta() >= m_thetamin) && (srOneVec.theta() <= m_thetamax) ) {
            accepted = true;
            m_accepted++;
            ATH_MSG_DEBUG("Muon accepted by SR1 Pixel EndCap optimization!");
          } else {
            ATH_MSG_DEBUG("Rejected muon due to SR1 Pixel EndCap optimization request!");
            m_rejected++;
          }
        }
 
        else if (m_muonECOpt) {
          double coor_x, coor_y, coor_z;
          coor_z = m_zpos; // defined in jobOpt.
          coor_x = direction.x()*(coor_z - vert.z())/direction.z() +vert.x();
          coor_y = direction.y()*(coor_z - vert.z())/direction.z() +vert.y();
          if( ((coor_x)*(coor_x) + (coor_y)*(coor_y)) <= m_radius*m_radius ) {
            accepted = true;
            m_accepted++;
          } else {
            coor_z = -m_zpos;
            coor_x = direction.x()*(coor_z - vert.z())/direction.z() +vert.x();
            coor_y = direction.y()*(coor_z - vert.z())/direction.z() +vert.y();
            if( ((coor_x)*(coor_x) + (coor_y)*(coor_y)) <= m_radius*m_radius ) {
              accepted = true;
              m_accepted++;
            } else {
              ATH_MSG_DEBUG("Rejected muon due to Muon EndCap optimization request!");
              m_rejected++;
            }
          }
        }
 
        else accepted=true; // if no opt required accept the first muon
      }
 
      pp.setX(pp.x()*m_GeV);
      pp.setY(pp.y()*m_GeV);
      pp.setZ(pp.z()*m_GeV);
      pp.setT(pp.t()*m_GeV);
 
      // Get the mass of the particle to be generated
      int charge = gun->GetMuonCharge();
      // m_pdgCode.push_back(charge*13);
      m_pdgCode.push_back(charge*-13);
 
      const HepPDT::ParticleData* particle = particleData(std::abs(m_pdgCode.back()));
      if (particle==nullptr){
        ATH_MSG_FATAL( "Particle with PDG ID=" << std::abs(m_pdgCode.back()) << " returned a nullptr" );
        return StatusCode::FAILURE;
      }
 
      double mass = particle->mass().value();
 
      // Compute the kinematic values.  First, the vertex 4-vector:
      double x = vert.x();
      double y = vert.y();
      double z = vert.z();
      double t = vert.t();
 
      // Do we need to swap Y- and Z-axis for the PixelEndCap A Cosmic test ?
      // if not...do nothing...if so, invert position of y- and z- coordinate
      //
      // but not only that...change also the direction of the incoming cosmic muon(s),
      // they must go towards the pixel endcap A, i.e. y -> -y
      //
      if(!m_swapYZAxis)
        m_fourPos.push_back(CLHEP::HepLorentzVector(x,y,z,t));
      else
        m_fourPos.push_back(CLHEP::HepLorentzVector(x,z,y,t));
 
      // Set the polarization.  Realistically, this is going to be zero
      // for most studies.
      HepMC::Polarization thePolarization(0.0);
      m_polarization.push_back(thePolarization);
 
 
      // The method of calculating e, theta, and phi depends on the user's
      // commands.  Let the KinematicManager handle it.
      double e     = pp.e();
      double theta = pp.theta();
      double phi   = pp.phi();
 
      // At this point, we have e, theta, and phi.  Put them together to
      // get the four-momentum.
 
      double p2 = e*e - mass*mass;
      if ( p2 < 0 )
        {
          ATH_MSG_ERROR( "Event #" << m_events
              << " E=" << e << ", mass=" << mass
              << " -- you have generated a tachyon! Increase energy or change particle ID." );
          return StatusCode::FAILURE;
        }
 
      double p = std::sqrt(p2);
      double px = p*std::sin(theta)*std::cos(phi);
      double pz = p*std::sin(theta)*std::sin(phi);
      double py = -p*std::cos(theta);
 
      // Do we need to swap Y- and Z-axis for the PixelEndCap C Cosmic test ?
      // if not...do nothing...if so, invert position of y- and z- coordinate
      //
      // well and don't forget about the direction of the incoming cosmic muon(s) either
      // that means:  y -> -y
      //
      if(!m_swapYZAxis) {
        // Line below corrupted py sign and forces muons to be upwards, not downwards.
        // m_fourMom.push_back(CLHEP::HepLorentzVector(px,-py,pz,pp.e()));
        m_fourMom.push_back(CLHEP::HepLorentzVector(px,py,pz,pp.e()));
      }
      else
        m_fourMom.push_back(CLHEP::HepLorentzVector(px,pz,-py,pp.e()));
 
      ATH_MSG_DEBUG(
             "  (x,y,z,t) = ("
          << m_fourPos.back().x() << ","
          << m_fourPos.back().y() << ","
          << m_fourPos.back().z() << ","
          << m_fourPos.back().t() << "), (Px,Py,Pz,E) = ("
          << m_fourMom.back().px() << ","
          << m_fourMom.back().py() << ","
          << m_fourMom.back().pz() << ","
          << m_fourMom.back().e()  << ")" );
      ATH_MSG_DEBUG(
             "  (theta,phi) = (" << theta << "," << phi << "), "
          << "polarization(theta,phi) = ("<< m_polarization.back().theta() << ","<< m_polarization.back().phi()  << ")" );
    }
  return StatusCode::SUCCESS;
 
}

cmTomm()

void GenBase::cmTomm ( HepMC::GenEvent * evt )

protectedinherited

Scale event lengths by x 10.

Definition at line 78 of file GenBase.cxx.

                                       {
  for (HepMC::GenEvent::vertex_iterator vtx = evt->vertices_begin(); vtx != evt->vertices_end(); ++vtx) {
    const HepMC::FourVector fv((*vtx)->position().x() * 10,
                               (*vtx)->position().y() * 10,
                               (*vtx)->position().z() * 10,
                               (*vtx)->position().t() * 10);
    (*vtx)->set_position(fv);
  }
}

declareGaudiProperty()

Gaudi::Details::PropertyBase & AthCommonDataStore< AthCommonMsg< Algorithm > >::declareGaudiProperty ( Gaudi::Property< T, V, H > & hndl, const SG::VarHandleKeyType &  )

inlineprivateinherited

specialization for handling Gaudi::Property<SG::VarHandleKey>

Definition at line 156 of file AthCommonDataStore.h.

  {
    return *AthCommonDataStore<PBASE>::declareProperty(hndl.name(),
                                                       hndl.value(), 
                                                       hndl.documentation());
 
  }

declareProperty()

Gaudi::Details::PropertyBase & AthCommonDataStore< AthCommonMsg< Algorithm > >::declareProperty ( Gaudi::Property< T, V, H > & t )

inlineinherited

Definition at line 145 of file AthCommonDataStore.h.

                                                                     {
    typedef typename SG::HandleClassifier<T>::type htype;
    return AthCommonDataStore<PBASE>::declareGaudiProperty(t, htype());
  }

detStore()

const ServiceHandle< StoreGateSvc > & AthCommonDataStore< AthCommonMsg< Algorithm > >::detStore ( ) const

inlineinherited

The standard StoreGateSvc/DetectorStore Returns (kind of) a pointer to the StoreGateSvc.

Definition at line 95 of file AthCommonDataStore.h.

{ return m_detStore; }

event_const()

const HepMC::GenEvent * GenBase::event_const ( ) const

inlineinherited

Access the current signal event (const)

Definition at line 83 of file GenBase.h.

                                           {
    if (events_const()->empty())
      ATH_MSG_ERROR("Const McEventCollection is empty during first event access");
    return *(events_const()->begin());
  }

events_const() [1/2]

const McEventCollection * GenBase::events_const ( ) const

inlineinherited

Access the current event's McEventCollection (const)

Definition at line 96 of file GenBase.h.

                                                {
    return events_const( getContext() );
  }

events_const() [2/2]

const McEventCollection * GenBase::events_const ( const EventContext & ctx ) const

inlineinherited

Definition at line 99 of file GenBase.h.

                                                                         {
    SG::ReadHandle<McEventCollection> ret = SG::makeHandle(m_mcevents_const, ctx);
    if (!ret.isValid())
      ATH_MSG_ERROR("No McEventCollection found in StoreGate with key " << m_mcevents_const.key());
    return ret.cptr();
  }

evtStore()

ServiceHandle< StoreGateSvc > & AthCommonDataStore< AthCommonMsg< Algorithm > >::evtStore ( )

inlineinherited

The standard StoreGateSvc (event store) Returns (kind of) a pointer to the StoreGateSvc.

Definition at line 85 of file AthCommonDataStore.h.

{ return m_evtStore; }

execute()

StatusCode GenModule::execute ( )

virtualinherited

Todo

Remove hard-coded alg name checking (already incomplete)

Reimplemented from GenBase.

Definition at line 70 of file GenModule.cxx.

                              {
  // Examples of how to retrieve the random number engine for a given
  // stream.
  // NB getRandomEngine should only be called once per event for a
  // given stream, as it causes the stream to be re-seeded each time
  // it is called.
 
  // Example 1 - seeded based on the current event number (+ slot, run, streamName)
  //const EventContext& ctx = Gaudi::Hive::currentContext();
  //CLHEP::HepRandomEngine* rndmEngine = this->getRandomEngine("MyStream", ctx);
 
  // Example 2 - seeded based on the m_randomSeed property (+ slot, run, streamName)
  //const EventContext& ctx = Gaudi::Hive::currentContext();
  //CLHEP::HepRandomEngine* rndmEngine = this->getRandomEngine("MyStream", m_randomSeed.value(), ctx);
 
  // Call the code that generates an event
  CHECK(this->callGenerator());
 
  // Create the MC event and send the GeneratorEvent stored in it to fillEvt
  HepMC::GenEvent* evt = HepMC::newGenEvent(1,1);
  CHECK(this->fillEvt(evt));
  HepMC::fillBarcodesAttribute(evt);
 
  // Add the event to the MC event collection
  if (events()) {
    // If this is an "afterburner" generator, replace the last event rather than add a new one
    if (m_isAfterburner.value() || name() == "Tauola" || name() == "Photos") {
      events()->pop_back();
    }
    // Add the event to the end of the collection
    events()->push_back(evt);
    ATH_MSG_DEBUG("MC event added to McEventCollection");
 
    // remove the empty event in case of ParticleDecayer
    if (name() == "ParticleDecayer") {
      events()->pop_back();
    }
  }
 
  // Call the incident service to notify that an event has been made
  m_incidentSvc->fireIncident( Incident(name(), "McEventGenerated") );
  return StatusCode::SUCCESS;
}

extraDeps_update_handler()

void AthCommonDataStore< AthCommonMsg< Algorithm > >::extraDeps_update_handler ( Gaudi::Details::PropertyBase & ExtraDeps )

protectedinherited

Add StoreName to extra input/output deps as needed.

use the logic of the VarHandleKey to parse the DataObjID keys supplied via the ExtraInputs and ExtraOuputs Properties to add the StoreName if it's not explicitly given

extraOutputDeps()

const DataObjIDColl & AthAlgorithm::extraOutputDeps ( ) const

overridevirtualinherited

Return the list of extra output dependencies.

This list is extended to include symlinks implied by inheritance relations.

Definition at line 50 of file AthAlgorithm.cxx.

{
  // If we didn't find any symlinks to add, just return the collection
  // from the base class.  Otherwise, return the extended collection.
  if (!m_extendedExtraObjects.empty()) {
    return m_extendedExtraObjects;
  }
  return Algorithm::extraOutputDeps();
}

exzCut()

bool CosmicGenerator::exzCut ( const CLHEP::Hep3Vector & pos, const CLHEP::HepLorentzVector & p )

private

Definition at line 662 of file CosmicGenerator.cxx.

{
// p is in GeV...
 
        double r =0;
        bool cut = false;
        if(pos.z()<0){
          r = std::sqrt((std::pow(pos.x(),2)+std::pow(pos.z()+28000,2))) ; //FIXME Hardcoded values!
          double e = 0.45238*r+5000 ;  //FIXME Hardcoded values!
          cut = p.e()*m_GeV>e;
        }
        else
        {
          r = std::sqrt((std::pow(pos.x(),2)+std::pow(pos.z()-20000,2))) ; //FIXME Hardcoded values!
          if(r<15000) { //FIXME Hardcoded values!
            cut = true;
          } else
          {
          double e = 0.461538*(r-15000)+10000 ;  //FIXME Hardcoded values!
          cut = p.e()*m_GeV>e;
          ATH_MSG_VERBOSE("z>0 r , e, p.e = "<<r <<" " <<e <<" " <<p.e()*m_GeV);
          }
        }
 
        cut = cut && r < m_rmax ;
 
        return cut;
}

fillEvt()

StatusCode CosmicGenerator::fillEvt ( HepMC::GenEvent * evt )

virtual

For filling the HepMC event object.

Implements GenModule.

Definition at line 622 of file CosmicGenerator.cxx.

                                                        {
//---------------------------------------------------------------------------
 
 
  // loop over generated vertices
  if(m_fourMom.size()==m_fourPos.size()&&m_fourMom.size()==m_polarization.size()){
 
    for(std::size_t v=0;v<m_fourMom.size();++v){
 
      // Note: The vertex and particle are owned by the event, so the
      // event is responsible for those pointers.
 
      // Create the particle, and specify its polarization.
 
      HepMC::GenParticlePtr particle =  HepMC::newGenParticlePtr( HepMC::FourVector(m_fourMom[v].px(),m_fourMom[v].py(),m_fourMom[v].pz(),m_fourMom[v].e()), m_pdgCode[v], 1);
      HepMC::set_polarization(particle, m_polarization[v] );
 
      // Create the vertex, and add the particle to the vertex.
      HepMC::GenVertexPtr vertex = HepMC::newGenVertexPtr(HepMC::FourVector(m_fourPos[v].x(),m_fourPos[v].y(),m_fourPos[v].z(),m_fourPos[v].t()));
      vertex->add_particle_out( std::move(particle) );
 
      // Add the vertex to the event.
      event->add_vertex( std::move(vertex) );
 
    }
 
    event->set_event_number(m_events); // Set the event number
    if (event->weights().empty()){
      event->weights().push_back(1.0);
    }
    return StatusCode::SUCCESS;
  } else {
    ATH_MSG_ERROR("Wrong different number of vertexes/momenta/polaritazions!");
    return StatusCode::FAILURE;
  }
 
}

finalize()

StatusCode GenModule::finalize ( )

inlineinherited

Definition at line 55 of file GenModule.h.

{ return genFinalize(); }

generateVertex()

CLHEP::HepLorentzVector CosmicGenerator::generateVertex

(

void

)

Definition at line 132 of file CosmicGenerator.cxx.

                                                          {
 
  // Get the pointer to the engine of the stream named SINGLE. If the
  // stream does not exist is created automaticaly
  CLHEP::HepRandomEngine* engine = COSMIC_RANDOM_ENGINE;
 
  // Generate a random number according to the distribution.
 
  float x_val = CLHEP::RandFlat::shoot(engine, m_xlow, m_xhig);
  float z_val = CLHEP::RandFlat::shoot(engine, m_zlow, m_zhig);
 
  // Generate a random number for time offset
  float t_val = m_tmin;  // Assign defined value
  if(m_tmin < m_tmax){
    t_val = CLHEP::RandFlat::shoot(engine, m_tmin, m_tmax);
  }
  else if(m_tmin.value() == m_tmax.value()){
    t_val = m_tmin;
  }
  else ATH_MSG_FATAL("You specified m_tmin = " << m_tmin << " and m_tmax " << m_tmax);
  CLHEP::HepLorentzVector p(x_val,m_yval,z_val, t_val*CLHEP::c_light);
 
  return p;
 
}

generateVertexReweighted()

CLHEP::HepLorentzVector CosmicGenerator::generateVertexReweighted

(

void

)

Definition at line 158 of file CosmicGenerator.cxx.

                                                                    {
 
  // Get the pointer to the engine of the stream named SINGLE. If the
  // stream does not exist is created automaticaly
  CLHEP::HepRandomEngine* engine = COSMIC_RANDOM_ENGINE;
 
  // Generate non-uniform distribution of vertices to reflect azimuthal
  // angle subtended by the sphere of radiusm m_radius
  // Inside m_radius, the density of vertices is proportional to 2 pi r dr
  // Outside m_radius, the density is proportional to 2r arcsin (m_radius/r)
  // We approximate the latter by its maximum: m_radius * pi
  // We generate vertices out to m_rvertmax.
  // Integrating the approximated distribution gives
  // pi r**2 for r < m_radius and pi m_radius r for r> m_radius
  // So with ran in (0,1) we take r=max_r * ran for ran>m_radius/max_r
  // and r= sqrt(m_radius*max_r*ran) for ran<m_radius/max_r
  // for r>m_radius we use acceptance/rejection by comparing
  // m_radius * pi * new_ran with 2r arcsin (m_radius/r)
  int accept=0;
  float max_r = m_rvertmax;
  float r_val = 0.;
  while(accept==0){
    float ran_one = CLHEP::RandFlat::shoot(engine,0.,1.);
    if(ran_one>(m_radius/max_r)){
      r_val = ran_one*max_r;
      float ran_two = CLHEP::RandFlat::shoot(engine,0.,1.);
      if(m_radius*M_PI*ran_two<2*r_val*asin(m_radius/r_val)){
        accept=1;
      }
    }
    else
      {
        r_val = std::sqrt(m_radius*max_r*ran_one);
        accept=1;
      }
  }
  float ran_three= CLHEP::RandFlat::shoot(engine, 0.,2*M_PI);
  float x_val = r_val*cos(ran_three);
  float z_val = r_val*sin(ran_three);
 
  // Generate a random number for time offset
  float t_val = m_tmin;  // Assign defined value
  if(m_tmin < m_tmax){
    t_val = CLHEP::RandFlat::shoot(engine, m_tmin, m_tmax);
  }
  else if(m_tmin.value() == m_tmax.value()){
    t_val = m_tmin;
  }
  else ATH_MSG_FATAL( " You specified m_tmin = " << m_tmin << " and m_tmax " << m_tmax );
  CLHEP::HepLorentzVector p(x_val,m_yval,z_val, t_val*CLHEP::c_light);
 
  return p;
}

genFinalize()

StatusCode CosmicGenerator::genFinalize ( )

virtual

For finalising the generator, if required.

Reimplemented from GenModule.

Definition at line 554 of file CosmicGenerator.cxx.

                                        {
//---------------------------------------------------------------------------
  // Get the KinematicManager.
 
  if(m_cavOpt){
 
    ATH_MSG_INFO("********************************************");
    ATH_MSG_INFO("** you have run CosmicGenerator with some ");
    ATH_MSG_INFO("** optimizations for cavern simulation");
    ATH_MSG_INFO("** "<<m_accepted<<" muons were accepted");
    ATH_MSG_INFO("** "<<m_rejected<<" muons were rejected");
    ATH_MSG_INFO("********************************************");
 
  }
  if(m_srOneOpt == 1){
 
    ATH_MSG_INFO("**********************************************");
    ATH_MSG_INFO("** you have run CosmicGenerator with some ");
    ATH_MSG_INFO("** optimizations for SR1 SCT/TRT simulation");
    ATH_MSG_INFO("** "<<m_accepted<<" muons were accepted");
    ATH_MSG_INFO("** "<<m_rejected<<" muons were rejected");
    ATH_MSG_INFO("**********************************************");
 
  }
  if(m_srOneOpt == 2){
 
    ATH_MSG_INFO("**********************************************");
    ATH_MSG_INFO("** you have run CosmicGenerator with some ");
    ATH_MSG_INFO("** optimizations for SR1 SCT/TRT EndcapC simulation");
    ATH_MSG_INFO("** "<<m_accepted<<" muons were accepted");
    ATH_MSG_INFO("** "<<m_rejected<<" muons were rejected");
    ATH_MSG_INFO("**********************************************");
 
  }
 
  if(m_srOnePixECOpt){
 
    ATH_MSG_INFO("***************************************************");
    ATH_MSG_INFO("** you have run CosmicGenerator with some ");
    ATH_MSG_INFO("** optimizations for SR1 Pixel EndCap simulation");
    ATH_MSG_INFO("** "<<m_accepted<<" muons were accepted");
    ATH_MSG_INFO("** "<<m_rejected<<" muons were rejected");
    ATH_MSG_INFO("***************************************************");
 
    if(m_swapYZAxis){
      ATH_MSG_INFO("***************************************************");
      ATH_MSG_INFO(" You have swapped Y- and Z-axis, i.e. muons are    ");
      ATH_MSG_INFO(" not coming from the top any more !!!              ");
      ATH_MSG_INFO("***************************************************");
    }
 
  }
 
  if(m_muonECOpt) {
 
    ATH_MSG_INFO("***************************************************");
    ATH_MSG_INFO("** you have run CosmicGenerator with some "        );
    ATH_MSG_INFO("** filters for cosmic muon simulation"             );
    ATH_MSG_INFO("** "<<m_accepted<<" muons were accepted"           );
    ATH_MSG_INFO("** "<<m_rejected<<" muons were rejected"           );
    ATH_MSG_INFO("***************************************************");
  }
 
  return StatusCode::SUCCESS;
}

genInitialize()

StatusCode CosmicGenerator::genInitialize ( )

virtual

For initializing the generator, if required.

Reimplemented from GenModule.

Definition at line 88 of file CosmicGenerator.cxx.

                                          {
//---------------------------------------------------------------------------
 
  // Initialize event count.
 
  m_events = 0;
 
  m_accepted=0;
  m_rejected=0;
 
  if(m_infile.value()=="NONE") {
    COSMIC_RANDOM_ENGINE = getRandomEngineDuringInitialize("COSMICS", m_randomSeed, m_dsid); // NOT THREAD-SAFE
    CosmicGun* gun = CosmicGun::GetCosmicGun();
 
    gun->SetEnergyRange(m_emin/m_GeV,m_emax/m_GeV);
    gun->SetCosCut(m_ctcut);
    gun->PrintLevel(m_printEvent, m_printMod);
    float flux_withCT = gun->InitializeGenerator();
 
    ATH_MSG_INFO( "Initialisation cosmic gun done." );
    ATH_MSG_INFO( "Accepted diff  flux after E and cos(theta) cuts = " << flux_withCT << " /cm^2/s" );
    if (! m_doReweighting) {
      // The following is only correct w/o reweighting
        ATH_MSG_INFO( "Accepted total flux after E and cos(theta) cuts = " <<
                      flux_withCT*(m_xhig-m_xlow)/m_mm*(m_zhig-m_zlow)/m_mm << " /s" );
    }
 
  }
  else {
    ATH_MSG_INFO( "Cosmics are read from file " << m_infile );
    m_ffile.open(m_infile.value().c_str());
    if(!m_ffile) {
      ATH_MSG_FATAL( "Could not open input file - stop! " );
      return StatusCode::FAILURE;
    }
    m_readfile = true;
  }
 
  m_center=CLHEP::Hep3Vector(m_IPx, m_IPy, m_IPz);
 
  return StatusCode::SUCCESS;
 
}

genuserInitialize()

virtual StatusCode GenModule::genuserInitialize ( )

inlinevirtualinherited

For initialization of user code, if required. Called after genInitialize.

Reimplemented in Pythia8B_i.

Definition at line 64 of file GenModule.h.

{ return StatusCode::SUCCESS; }

getRandomEngine() [1/2]

CLHEP::HepRandomEngine * GenModule::getRandomEngine ( const std::string & streamName, const EventContext & ctx ) const

protectedinherited

Definition at line 34 of file GenModule.cxx.

{
  ATHRNG::RNGWrapper* rngWrapper = m_rndmSvc->getEngine(this, streamName);
  std::string rngName = name()+streamName;
  rngWrapper->setSeed( rngName, ctx );
  return rngWrapper->getEngine(ctx);
}

getRandomEngine() [2/2]

CLHEP::HepRandomEngine * GenModule::getRandomEngine ( const std::string & streamName, unsigned long int randomSeedOffset, const EventContext & ctx ) const

protectedinherited

Definition at line 44 of file GenModule.cxx.

{
  ATHRNG::RNGWrapper* rngWrapper = m_rndmSvc->getEngine(this, streamName);
  rngWrapper->setSeed( streamName, ctx.slot(), randomSeedOffset, ctx.eventID().run_number() );
  return rngWrapper->getEngine(ctx);
}

getRandomEngineDuringInitialize()

CLHEP::HepRandomEngine * GenModule::getRandomEngineDuringInitialize ( const std::string & streamName, unsigned long int randomSeedOffset, unsigned int conditionsRun = 1, unsigned int lbn = 1 ) const

protectedinherited

Definition at line 53 of file GenModule.cxx.

{
  const size_t slot=0;
  EventContext ctx;
  ctx.setSlot( slot );
  ctx.setEventID (EventIDBase (conditionsRun,
               EventIDBase::UNDEFEVT,  // event
               EventIDBase::UNDEFNUM,  // timestamp
               EventIDBase::UNDEFNUM,  // timestamp ns
               lbn));
  Atlas::setExtendedEventContext(ctx,
                                 Atlas::ExtendedEventContext( evtStore()->hiveProxyDict(),
                                                              conditionsRun) );
  return getRandomEngine(streamName, randomSeedOffset, ctx);
}

GeVToMeV()

void GenBase::GeVToMeV ( HepMC::GenEvent * evt )

protectedinherited

Scale event energies/momenta by x 1000.

Todo

Add HepMC units awareness and do it differently when HepMC provides this functionality directly (and reference-based FourVector accessors)

Definition at line 58 of file GenBase.cxx.

                                         {
  for (HepMC::GenEvent::particle_iterator p = evt->particles_begin(); p != evt->particles_end(); ++p) {
    const HepMC::FourVector fv((*p)->momentum().px() * 1000,
                               (*p)->momentum().py() * 1000,
                               (*p)->momentum().pz() * 1000,
                               (*p)->momentum().e()  * 1000);
    (*p)->set_momentum(fv);
    (*p)->set_generated_mass(1000 * (*p)->generated_mass());
  }
}

initialize()

StatusCode GenModule::initialize ( )

virtualinherited

Reimplemented from GenBase.

Definition at line 21 of file GenModule.cxx.

                                 {
  // Base class initializations
  CHECK(GenBase::initialize());
  // Get the random number service
  CHECK(m_rndmSvc.retrieve());
  // Get the incident service
  CHECK(m_incidentSvc.retrieve());
  CHECK(genInitialize());
  CHECK(genuserInitialize());
  return StatusCode::SUCCESS;
}

inputHandles()

virtual std::vector< Gaudi::DataHandle * > AthCommonDataStore< AthCommonMsg< Algorithm > >::inputHandles ( ) const

overridevirtualinherited

Return this algorithm's input handles.

We override this to include handle instances from key arrays if they have not yet been declared. See comments on updateVHKA.

MeVToGeV()

void GenBase::MeVToGeV ( HepMC::GenEvent * evt )

protectedinherited

Scale event energies/momenta by x 1/1000.

Definition at line 68 of file GenBase.cxx.

                                         {
  for (HepMC::GenEvent::particle_iterator p = evt->particles_begin(); p != evt->particles_end(); ++p) {
    const HepMC::FourVector fv((*p)->momentum().px() / 1000,
                               (*p)->momentum().py() / 1000,
                               (*p)->momentum().pz() / 1000,
                               (*p)->momentum().e()  / 1000);
    (*p)->set_momentum(fv);
    (*p)->set_generated_mass((*p)->generated_mass() / 1000);
  }
}

mmTocm()

void GenBase::mmTocm ( HepMC::GenEvent * evt )

protectedinherited

Scale event lengths by x 1/10.

Definition at line 87 of file GenBase.cxx.

                                       {
  for (HepMC::GenEvent::vertex_iterator vtx = evt->vertices_begin(); vtx != evt->vertices_end(); ++vtx) {
    const HepMC::FourVector fv((*vtx)->position().x() / 10,
                               (*vtx)->position().y() / 10,
                               (*vtx)->position().z() / 10,
                               (*vtx)->position().t() / 10);
    (*vtx)->set_position(fv);
  }
}

msg()

MsgStream & AthCommonMsg< Algorithm >::msg ( ) const

inlineinherited

Definition at line 24 of file AthCommonMsg.h.

                                {
    return this->msgStream();
  }

msgLvl()

bool AthCommonMsg< Algorithm >::msgLvl ( const MSG::Level lvl ) const

inlineinherited

Definition at line 30 of file AthCommonMsg.h.

                                               {
    return this->msgLevel(lvl);
  }

outputHandles()

virtual std::vector< Gaudi::DataHandle * > AthCommonDataStore< AthCommonMsg< Algorithm > >::outputHandles ( ) const

overridevirtualinherited

Return this algorithm's output handles.

We override this to include handle instances from key arrays if they have not yet been declared. See comments on updateVHKA.

particleData()

const HepPDT::ParticleData * GenBase::particleData ( int pid ) const

inlineinherited

Access an element in the particle data table.

Definition at line 126 of file GenBase.h.

                                                        {
    return pdt().particle(HepPDT::ParticleID(std::abs(pid)));
  }

particleTable()

const HepPDT::ParticleDataTable & GenBase::particleTable ( ) const

inlineinherited

Get a particle data table.

Definition at line 118 of file GenBase.h.

                                                       {
    return *(m_ppSvc->PDT());
  }

partPropSvc()

const ServiceHandle< IPartPropSvc > GenBase::partPropSvc ( ) const

inlineinherited

Access the particle property service.

Definition at line 113 of file GenBase.h.

                                                        {
    return m_ppSvc;
  }

pathLengthInRock()

double CosmicGenerator::pathLengthInRock ( double xgen, double ygen, double zgen, double theta, double phi )

private

Definition at line 694 of file CosmicGenerator.cxx.

                                                                                                        {
  // y is vertical direction, z along beam, major shaft has z>0
 
  // Definition of shafts and cavern
  double p14_x = 1700; //FIXME Hardcoded values!
  double p14_z = 13500; //FIXME Hardcoded values!
  double p14_radius = 9000.; //FIXME Hardcoded values!
  double p16_x = 1700; //FIXME Hardcoded values!
  double p16_z = -20000; //FIXME Hardcoded values!
  double p16_radius = 6300.; //FIXME Hardcoded values!
  double y1 = 26400; //       ! mm cavern height above IP //FIXME Hardcoded values!
 
  // direction of trajectory
  // x=x0 - t sinth cosphi; y=y0 + t costh; z=z0 - t sinth sinphi
  double cosphi = std::cos(phi);
  double sinphi = std::sin(phi);
  double costh = std::cos(theta);
  double sinth = std::sin(theta);
 
  double y0 = m_ysurface;
  double t = (ygen-y0)/costh;
  double x0 = xgen + t*sinth*cosphi;   // x position at y=0
  double z0 = zgen + t*sinth*sinphi;   // z position at y=0
 
  // full path length ignoring shaft
  double full_distance = (y0-y1)/costh;
 
  // does trajectory intersect p14 cylinder?
  double z_mid14 = (x0-p14_x)*sinphi-(z0-p14_z)*cosphi;
  double min_dist14 = std::abs(z_mid14);  //minimum distance of line from center
  double shaft_distance14 = 0.;
  if (min_dist14<p14_radius) {
 
    // z values at intersections
    double z_plus14  = -cosphi*z_mid14+sinphi*std::sqrt(std::pow(p14_radius,2.)-std::pow(z_mid14,2.)) + p14_z;
    double z_minus14 = -cosphi*z_mid14-sinphi*std::sqrt(std::pow(p14_radius,2.)-std::pow(z_mid14,2.)) + p14_z;
 
    // y values at intersections
    double y_plus14  = y0-costh*(z_plus14-z0)/sinth/sinphi;
    double y_minus14 = y0-costh*(z_minus14-z0)/sinth/sinphi;
    double y_great14 = y_plus14>y_minus14 ? y_plus14 : y_minus14;
    double y_less14  = y_plus14>y_minus14 ? y_minus14 : y_plus14;
 
    // top intersection must occur above bottom of shaft
    if ( (y_great14>y1) && (y_less14<y0) ) {
      double y_top14    = y_great14<y0 ? y_great14 : y0;
      double y_bottom14 = y_less14>y1  ? y_less14 : y1;
      shaft_distance14 = (y_top14-y_bottom14)/costh;
    }
  }
 
  // does trajectory intersect p16 cylinder?
  double z_mid16 = (x0-p16_x)*sinphi-(z0-p16_z)*cosphi;
  double min_dist16 = std::abs(z_mid16);
  double shaft_distance16 = 0.;
  if (min_dist16<p16_radius) {
 
    // z values at intersections
    double z_plus16  = -cosphi*z_mid16+sinphi*std::sqrt(std::pow(p16_radius,2.)-std::pow(z_mid16,2.)) + p16_z;
    double z_minus16 = -cosphi*z_mid16-sinphi*std::sqrt(std::pow(p16_radius,2.)-std::pow(z_mid16,2.)) + p16_z;
 
    // determine y values at intersections
    double y_plus16  = y0-costh*(z_plus16-z0)/sinth/sinphi;
    double y_minus16 = y0-costh*(z_minus16-z0)/sinth/sinphi;
    double y_great16 = y_plus16>y_minus16 ? y_plus16 : y_minus16;
    double y_less16  = y_plus16>y_minus16 ? y_minus16 : y_plus16;
 
    // top intersection must occur above bottom of shaft
    if ( (y_great16>y1) && (y_less16<y0) ) {
      double y_top16    = y_great16<y0 ? y_great16 : y0;
      double y_bottom16 = y_less16>y1  ? y_less16 : y1;
      shaft_distance16 = (y_top16-y_bottom16)/costh;
    }
  }
 
  double rock_distance = full_distance - shaft_distance14-shaft_distance16;
  return rock_distance;
}

pdt()

const HepPDT::ParticleDataTable & GenBase::pdt ( ) const

inlineinherited

Shorter alias to get a particle data table.

Definition at line 123 of file GenBase.h.

{ return particleTable(); }

pointsAtPixels()

bool CosmicGenerator::pointsAtPixels ( double xgen, double ygen, double zgen, double theta, double phi )

private

Definition at line 775 of file CosmicGenerator.cxx.

                                                                                                    {
  // y is vertical direction, z along beam, major shaft has z<0
  bool does = false;
 
  // direction of trajectory
  // x=xgen+ t sinth cosphi; y=ygen+t costh; z=zgen+t sinth sinphi
  double cosphi = std::cos(phi);
  double sinphi = std::sin(phi);
  double costh = std::cos(theta);
  double sinth = std::sin(theta);
  double t = ygen/costh;  //for parameterized trajectory
  double x_pos = xgen + t*sinth*cosphi; //x position at y=0
  double z_pos = zgen + t*sinth*sinphi; //z position at y=0
 
  ATH_MSG_VERBOSE("x_pos = " << x_pos << ", z_pos = " << z_pos);
 
  if((std::abs(x_pos)<m_pixelplanemaxx)&&(std::abs(z_pos)<m_pixelplanemaxz)){
    does=true;
  }
 
  return does;
}

renounce()

std::enable_if_t< std::is_void_v< std::result_of_t< decltype(&T::renounce)(T)> > &&!std::is_base_of_v< SG::VarHandleKeyArray, T > &&std::is_base_of_v< Gaudi::DataHandle, T >, void > AthCommonDataStore< AthCommonMsg< Algorithm > >::renounce ( T & h )

inlineprotectedinherited

Definition at line 380 of file AthCommonDataStore.h.

  {
    h.renounce();
    PBASE::renounce (h);
  }

renounceArray()

void AthCommonDataStore< AthCommonMsg< Algorithm > >::renounceArray ( SG::VarHandleKeyArray & handlesArray )

inlineprotectedinherited

remove all handles from I/O resolution

Definition at line 364 of file AthCommonDataStore.h.

                                                          {
    handlesArray.renounce();
  }

sysInitialize()

StatusCode AthAlgorithm::sysInitialize ( )

overridevirtualinherited

Override sysInitialize.

Override sysInitialize from the base class.

Loop through all output handles, and if they're WriteCondHandles, automatically register them and this Algorithm with the CondSvc

Scan through all outputHandles, and if they're WriteCondHandles, register them with the CondSvc

Reimplemented from AthCommonDataStore< AthCommonMsg< Algorithm > >.

Reimplemented in AthAnalysisAlgorithm, AthFilterAlgorithm, AthHistogramAlgorithm, and PyAthena::Alg.

Definition at line 66 of file AthAlgorithm.cxx.

                                       {
  StatusCode sc=AthCommonDataStore<AthCommonMsg<Algorithm>>::sysInitialize();
 
  if (sc.isFailure()) {
    return sc;
  }
  ServiceHandle<ICondSvc> cs("CondSvc",name());
  for (auto h : outputHandles()) {
    if (h->isCondition() && h->mode() == Gaudi::DataHandle::Writer) {
      // do this inside the loop so we don't create the CondSvc until needed
      if ( cs.retrieve().isFailure() ) {
        ATH_MSG_WARNING("no CondSvc found: won't autoreg WriteCondHandles");
        return StatusCode::SUCCESS;
      }
      if (cs->regHandle(this,*h).isFailure()) {
        sc = StatusCode::FAILURE;
        ATH_MSG_ERROR("unable to register WriteCondHandle " << h->fullKey()
                      << " with CondSvc");
      }
    }
  }
  return sc;
}

sysStart()

virtual StatusCode AthCommonDataStore< AthCommonMsg< Algorithm > >::sysStart ( )

overridevirtualinherited

Handle START transition.

We override this in order to make sure that conditions handle keys can cache a pointer to the conditions container.

updateVHKA()

void AthCommonDataStore< AthCommonMsg< Algorithm > >::updateVHKA ( Gaudi::Details::PropertyBase & )

inlineinherited

Definition at line 308 of file AthCommonDataStore.h.

                                               {
    // debug() << "updateVHKA for property " << p.name() << " " << p.toString() 
    //         << "  size: " << m_vhka.size() << endmsg;
    for (auto &a : m_vhka) {
      std::vector<SG::VarHandleKey*> keys = a->keys();
      for (auto k : keys) {
        k->setOwner(this);
      }
    }
  }

Member Data Documentation

COSMIC_RANDOM_ENGINE

CLHEP::HepRandomEngine * CosmicGenerator::COSMIC_RANDOM_ENGINE {}

static

Static pointer to random number generator for use by.

Definition at line 73 of file CosmicGenerator.h.

m_accepted

int CosmicGenerator::m_accepted {0}

private

Definition at line 103 of file CosmicGenerator.h.

{0};

m_cavOpt

BooleanProperty CosmicGenerator::m_cavOpt {this, "OptimizeForCavern", false}

private

Definition at line 122 of file CosmicGenerator.h.

{this, "OptimizeForCavern", false};

m_center

CLHEP::Hep3Vector CosmicGenerator::m_center

private

Definition at line 142 of file CosmicGenerator.h.

m_ctcut

FloatProperty CosmicGenerator::m_ctcut {this, "ctcut", 0.35}

private

Definition at line 109 of file CosmicGenerator.h.

{this, "ctcut", 0.35};

m_detStore

StoreGateSvc_t AthCommonDataStore< AthCommonMsg< Algorithm > >::m_detStore

privateinherited

Pointer to StoreGate (detector store by default)

Definition at line 393 of file AthCommonDataStore.h.

m_doAimedAtPixelsCut

BooleanProperty CosmicGenerator::m_doAimedAtPixelsCut {this, "doAimedAtPixelsCut", false}

private

Definition at line 160 of file CosmicGenerator.h.

{this, "doAimedAtPixelsCut", false};

m_doPathlengthCut

BooleanProperty CosmicGenerator::m_doPathlengthCut {this, "doPathLengthCut", false}

private

Definition at line 159 of file CosmicGenerator.h.

{this, "doPathLengthCut", false};

m_doReweighting

BooleanProperty CosmicGenerator::m_doReweighting {this, "doReweighting", false}

private

Definition at line 161 of file CosmicGenerator.h.

{this, "doReweighting", false};

m_dsid

IntegerProperty CosmicGenerator::m_dsid {this, "Dsid", 999999, "Dataset ID number"}

private

Definition at line 106 of file CosmicGenerator.h.

{this, "Dsid", 999999, "Dataset ID number"};

m_emax

FloatProperty CosmicGenerator::m_emax {this, "emax", 100.*m_GeV}

private

Definition at line 108 of file CosmicGenerator.h.

{this, "emax", 100.*m_GeV};

m_emin

FloatProperty CosmicGenerator::m_emin {this, "emin", 10.*m_GeV}

private

Definition at line 107 of file CosmicGenerator.h.

{this, "emin", 10.*m_GeV};

m_energyCutThreshold

DoubleProperty CosmicGenerator::m_energyCutThreshold {this, "energyCutThreshold", 1.0}

private

Definition at line 162 of file CosmicGenerator.h.

{this, "energyCutThreshold", 1.0};

m_events

int CosmicGenerator::m_events {0}

private

Definition at line 101 of file CosmicGenerator.h.

{0};

m_evtStore

StoreGateSvc_t AthCommonDataStore< AthCommonMsg< Algorithm > >::m_evtStore

privateinherited

Pointer to StoreGate (event store by default)

Definition at line 390 of file AthCommonDataStore.h.

m_extendedExtraObjects

DataObjIDColl AthAlgorithm::m_extendedExtraObjects

privateinherited

Definition at line 79 of file AthAlgorithm.h.

m_exzCut

BooleanProperty CosmicGenerator::m_exzCut {this, "ExzCut", false}

private

Definition at line 149 of file CosmicGenerator.h.

{this, "ExzCut", false};

m_ffile

std::ifstream CosmicGenerator::m_ffile

private

Definition at line 137 of file CosmicGenerator.h.

m_fourMom

std::vector<CLHEP::HepLorentzVector> CosmicGenerator::m_fourMom

private

Definition at line 141 of file CosmicGenerator.h.

m_fourPos

std::vector<CLHEP::HepLorentzVector> CosmicGenerator::m_fourPos

private

Definition at line 140 of file CosmicGenerator.h.

m_GeV

float CosmicGenerator::m_GeV = 1000.f

staticconstexprprivate

Definition at line 97 of file CosmicGenerator.h.

m_incidentSvc

ServiceHandle<IIncidentSvc> GenModule::m_incidentSvc {this, "IncidentSvc", "IncidentSvc"}

privateinherited

Handle on the incident service.

Definition at line 101 of file GenModule.h.

{this, "IncidentSvc", "IncidentSvc"};

m_infile

StringProperty CosmicGenerator::m_infile {this, "eventfile", "NONE"}

private

Definition at line 136 of file CosmicGenerator.h.

{this, "eventfile", "NONE"};

m_IPx

FloatProperty CosmicGenerator::m_IPx {this, "IPx", 0.f}

private

Definition at line 115 of file CosmicGenerator.h.

{this, "IPx", 0.f};

m_IPy

FloatProperty CosmicGenerator::m_IPy {this, "IPy", 0.f}

private

Definition at line 116 of file CosmicGenerator.h.

{this, "IPy", 0.f};

m_IPz

FloatProperty CosmicGenerator::m_IPz {this, "IPz", 0.f}

private

Definition at line 117 of file CosmicGenerator.h.

{this, "IPz", 0.f};

m_isAfterburner

BooleanProperty GenModule::m_isAfterburner {this, "IsAfterburner", false, "Set true if generator modifies existing events rather than creating new ones"}

protectedinherited

Flag for normal vs. afterburner generators.

Definition at line 87 of file GenModule.h.

{this, "IsAfterburner", false, "Set true if generator modifies existing events rather than creating new ones"};

m_mcEventKey

std::string GenBase::m_mcEventKey {}

protectedinherited

StoreGate key for the MC event collection (defaults to GEN_EVENT)

Definition at line 137 of file GenBase.h.

{};

m_mcevents_const

SG::ReadHandleKey<McEventCollection> GenBase::m_mcevents_const { this, "McEventKey", "GEN_EVENT", "StoreGate key of the MC event collection" }

privateinherited

Const handle to the MC event collection.

Definition at line 163 of file GenBase.h.

{ this, "McEventKey", "GEN_EVENT", "StoreGate key of the MC event collection" };

m_mkMcEvent

BooleanProperty GenBase::m_mkMcEvent {this, "MakeMcEvent", false, "Create a new MC event collection if it doesn't exist"}

protectedinherited

Flag to determine if a new MC event collection should be made if it doesn't exist.

Definition at line 139 of file GenBase.h.

{this, "MakeMcEvent", false, "Create a new MC event collection if it doesn't exist"};

m_mm

float CosmicGenerator::m_mm = 10.f

staticconstexprprivate

Definition at line 98 of file CosmicGenerator.h.

m_muonECOpt

BooleanProperty CosmicGenerator::m_muonECOpt {this, "OptimizeForMuonEndCap", false}

private

Definition at line 126 of file CosmicGenerator.h.

{this, "OptimizeForMuonEndCap", false};

m_pdgCode

std::vector<int> CosmicGenerator::m_pdgCode

private

Definition at line 104 of file CosmicGenerator.h.

m_phimax

FloatProperty CosmicGenerator::m_phimax {this, "PhiMax", M_PI}

private

Definition at line 133 of file CosmicGenerator.h.

{this, "PhiMax", M_PI};

m_phimin

FloatProperty CosmicGenerator::m_phimin {this, "PhiMin", -1.*M_PI}

private

Definition at line 132 of file CosmicGenerator.h.

{this, "PhiMin", -1.*M_PI};

m_pixelplanemaxx

DoubleProperty CosmicGenerator::m_pixelplanemaxx {this, "pixelplane_maxx", 1150.}

private

Definition at line 165 of file CosmicGenerator.h.

{this, "pixelplane_maxx", 1150.};

m_pixelplanemaxz

DoubleProperty CosmicGenerator::m_pixelplanemaxz {this, "pixelplane_maxz", 1650.}

private

Definition at line 166 of file CosmicGenerator.h.

{this, "pixelplane_maxz", 1650.};

m_polarization

std::vector<HepMC::Polarization> CosmicGenerator::m_polarization

private

Definition at line 143 of file CosmicGenerator.h.

m_ppSvc

ServiceHandle<IPartPropSvc> GenBase::m_ppSvc {this, "PartPropSvc", "PartPropSvc"}

privateinherited

Handle on the particle property service.

Definition at line 160 of file GenBase.h.

{this, "PartPropSvc", "PartPropSvc"};

m_printEvent

IntegerProperty CosmicGenerator::m_printEvent {this, "PrintEvent", 10}

private

Definition at line 127 of file CosmicGenerator.h.

{this, "PrintEvent", 10};

m_printMod

IntegerProperty CosmicGenerator::m_printMod {this, "PrintMod", 100}

private

Definition at line 128 of file CosmicGenerator.h.

{this, "PrintMod", 100};

m_radius

FloatProperty CosmicGenerator::m_radius {this, "Radius", 0.f}

private

Definition at line 118 of file CosmicGenerator.h.

{this, "Radius", 0.f};

m_randomSeed

IntegerProperty GenModule::m_randomSeed {this, "RandomSeed", 1234567, "Random seed for the built-in random engine"}

protectedinherited

Seed for random number engine.

Definition at line 84 of file GenModule.h.

{this, "RandomSeed", 1234567, "Random seed for the built-in random engine"}; // FIXME make this into an unsigned long int?

m_readfile

bool CosmicGenerator::m_readfile {false}

private

Definition at line 135 of file CosmicGenerator.h.

{false};

m_rejected

int CosmicGenerator::m_rejected {0}

private

Definition at line 102 of file CosmicGenerator.h.

{0};

m_rmax

FloatProperty CosmicGenerator::m_rmax {this, "RMax", 10000000.f}

private

Definition at line 151 of file CosmicGenerator.h.

{this, "RMax", 10000000.f};

m_rndmSvc

ServiceHandle<IAthRNGSvc> GenModule::m_rndmSvc {this, "RndmSvc", "AthRNGSvc"}

privateinherited

Data members.

Definition at line 99 of file GenModule.h.

{this, "RndmSvc", "AthRNGSvc"};

m_rvertmax

DoubleProperty CosmicGenerator::m_rvertmax {this, "rvert_max", 300.*m_mm}

private

Definition at line 164 of file CosmicGenerator.h.

{this, "rvert_max", 300.*m_mm}; // replaces rectangle in case of reweighting

m_srOneOpt

IntegerProperty CosmicGenerator::m_srOneOpt {this, "OptimizeForSR1", 0}

private

Definition at line 123 of file CosmicGenerator.h.

{this, "OptimizeForSR1", 0}; // Not a bool??

m_srOnePixECOpt

BooleanProperty CosmicGenerator::m_srOnePixECOpt {this, "OptimizeForSR1PixelEndCap", false}

private

Definition at line 124 of file CosmicGenerator.h.

{this, "OptimizeForSR1PixelEndCap", false};

m_swapYZAxis

BooleanProperty CosmicGenerator::m_swapYZAxis {this, "SwapYZAxis", false}

private

Definition at line 125 of file CosmicGenerator.h.

{this, "SwapYZAxis", false};

m_thetamax

FloatProperty CosmicGenerator::m_thetamax {this, "ThetaMax", 1.f}

private

Definition at line 131 of file CosmicGenerator.h.

{this, "ThetaMax", 1.f};

m_thetamin

FloatProperty CosmicGenerator::m_thetamin {this, "ThetaMin", 0.f}

private

Definition at line 130 of file CosmicGenerator.h.

{this, "ThetaMin", 0.f};

m_tmax

FloatProperty CosmicGenerator::m_tmax {this, "tmax", 0.f}

private

Definition at line 121 of file CosmicGenerator.h.

{this, "tmax", 0.f};

m_tmin

FloatProperty CosmicGenerator::m_tmin {this, "tmin", 0.f}

private

Definition at line 120 of file CosmicGenerator.h.

{this, "tmin", 0.f};

m_varHandleArraysDeclared

bool AthCommonDataStore< AthCommonMsg< Algorithm > >::m_varHandleArraysDeclared

privateinherited

Definition at line 399 of file AthCommonDataStore.h.

m_vhka

std::vector<SG::VarHandleKeyArray*> AthCommonDataStore< AthCommonMsg< Algorithm > >::m_vhka

privateinherited

Definition at line 398 of file AthCommonDataStore.h.

m_xhig

FloatProperty CosmicGenerator::m_xhig {this, "xvert_hig", 10.*m_mm}

private

Definition at line 111 of file CosmicGenerator.h.

{this, "xvert_hig", 10.*m_mm};

m_xlow

FloatProperty CosmicGenerator::m_xlow {this, "xvert_low", 0.*m_mm}

private

Definition at line 110 of file CosmicGenerator.h.

{this, "xvert_low", 0.*m_mm};

m_ysurface

DoubleProperty CosmicGenerator::m_ysurface {this, "ysurface", 81.*m_mm}

private

Definition at line 163 of file CosmicGenerator.h.

{this, "ysurface", 81.*m_mm};

m_yval

FloatProperty CosmicGenerator::m_yval {this, "yvert_val", 81.*m_mm}

private

Definition at line 114 of file CosmicGenerator.h.

{this, "yvert_val", 81.*m_mm};

m_zhig

FloatProperty CosmicGenerator::m_zhig {this, "zvert_hig", 10.*m_mm}

private

Definition at line 113 of file CosmicGenerator.h.

{this, "zvert_hig", 10.*m_mm};

m_zlow

FloatProperty CosmicGenerator::m_zlow {this, "zvert_low", 0.*m_mm}

private

Definition at line 112 of file CosmicGenerator.h.

{this, "zvert_low", 0.*m_mm};

m_zpos

FloatProperty CosmicGenerator::m_zpos {this, "Zposition", 14500.f}

private

Definition at line 119 of file CosmicGenerator.h.

{this, "Zposition", 14500.f};

---

The documentation for this class was generated from the following files:

• CosmicGenerator.h
• CosmicGenerator.cxx