Definition the tracker geometry (vectors of forward/barrel layers). More...

#include <Geometry.h>

Public Member Functions
const std::vector< std::unique_ptr< BarrelSimplifiedGeometry > > &	barrelLayers () const
	Return the vector of barrel layers. More...

const std::vector< std::unique_ptr< ForwardSimplifiedGeometry > > &	forwardLayers () const
	Return the vector of forward layers (disks). More...

	Geometry (const edm::ParameterSet &cfg)
	Constructor. More...

double	getMagneticFieldZ (const math::XYZTLorentzVector &position) const
	Initializes the tracker geometry. More...

double	getMaxRadius ()
	Upper bound of the radius of the whole tracker geometry. More...

double	getMaxZ ()
	Upper bound of the length/2 (0 to +Z) of the whole tracker geometry. More...

const BarrelSimplifiedGeometry *	nextLayer (const BarrelSimplifiedGeometry *layer) const
	Helps to navigate through the vector of barrel layers. More...

const ForwardSimplifiedGeometry *	nextLayer (const ForwardSimplifiedGeometry *layer) const
	Helps to navigate through the vector of forward layers. More...

const BarrelSimplifiedGeometry *	previousLayer (const BarrelSimplifiedGeometry *layer) const
	Helps to navigate through the vector of barrel layers. More...

const ForwardSimplifiedGeometry *	previousLayer (const ForwardSimplifiedGeometry *layer) const
	Helps to navigate through the vector of forward layers. More...

void	update (const edm::EventSetup &iSetup, const std::map< std::string, InteractionModel * > &interactionModelMap)
	Initializes the tracker geometry. More...

	~Geometry ()
	Default destructor. More...

Private Attributes
const bool	barrelBoundary_
	Upper bound of the length/2 (0 to +Z) of the whole tracker geometry. More...

const std::vector< edm::ParameterSet >	barrelLayerCfg_
	The config in which all parameters of the barrel layers are defined. More...

std::vector< std::unique_ptr< BarrelSimplifiedGeometry > >	barrelLayers_
	The vector of barrel layers (increasing radius) More...

unsigned long long	cacheIdentifierIdealMagneticField_
	Check interval of validity of the magnetic field. More...

unsigned long long	cacheIdentifierTrackerRecoGeometry_
	Check interval of validity of the tracker geometry. More...

const double	fixedMagneticFieldZ_
	Use a uniform magnetic field or non-uniform from MagneticFieldRecord. More...

const bool	forwardBoundary_
	Hack to interface "old" calo to "new" tracking. More...

const std::vector< edm::ParameterSet >	forwardLayerCfg_
	The config in which all parameters of the forward layers are defined. More...

std::vector< std::unique_ptr< ForwardSimplifiedGeometry > >	forwardLayers_
	The vector of forward layers (increasing Z-position) More...

const GeometricSearchTracker *	geometricSearchTracker_

const MagneticField *	magneticField_
	The tracker geometry. More...

const double	maxRadius_

const double	maxZ_
	Upper bound of the radius of the whole tracker geometry. More...

std::unique_ptr< MagneticField >	ownedMagneticField_
	Needed to create a uniform magnetic field if speciefied in config. More...

const std::string	trackerAlignmentLabel_
	The tracker alignment label. More...

const edm::ParameterSet	trackerBarrelBoundaryCfg_
	Hack to interface "old" calo to "new" tracking. More...

const edm::ParameterSet	trackerForwardBoundaryCfg_
	Hack to interface "old" calo to "new" tracking. More...

const bool	useFixedMagneticFieldZ_
	Needed to create a uniform magnetic field if speciefied in config. More...

const bool	useTrackerRecoGeometryRecord_
	Use GeometricSearchTracker (active layers/reco geometry). Can be used to get position/radius of tracker material that reflects active layers. More...

Friends
std::ostream &	operator<< (std::ostream &o, const fastsim::Geometry &geometry)
	Provides some basic output for e.g. debugging. More...

Detailed Description

Definition the tracker geometry (vectors of forward/barrel layers).

This class models the material budget of the tracker. Those are reflected by 2 vectors of forward (disks, ordered by increasing Z-position) and barrel layers respectively (cylinders, ordered by increasing radius). Furthermore, initiatilizes the magnetic field used for propagation of particles inside the tracker.

Definition at line 32 of file Geometry.h.

Constructor & Destructor Documentation

◆ Geometry()

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

Constructor.

Definition at line 23 of file Geometry.cc.

     : cacheIdentifierTrackerRecoGeometry_(0),
       cacheIdentifierIdealMagneticField_(0),
       geometricSearchTracker_(nullptr),
       magneticField_(nullptr),
       useFixedMagneticFieldZ_(cfg.exists("magneticFieldZ")),
       fixedMagneticFieldZ_(cfg.getUntrackedParameter<double>("magneticFieldZ", 0.)),
       useTrackerRecoGeometryRecord_(cfg.getUntrackedParameter<bool>("useTrackerRecoGeometryRecord", true)),
       trackerAlignmentLabel_(cfg.getUntrackedParameter<std::string>("trackerAlignmentLabel", "")),
       barrelLayerCfg_(cfg.getParameter<std::vector<edm::ParameterSet>>("BarrelLayers")),
       forwardLayerCfg_(cfg.getParameter<std::vector<edm::ParameterSet>>("EndcapLayers")),
       maxRadius_(cfg.getUntrackedParameter<double>("maxRadius", 500.)),
       maxZ_(cfg.getUntrackedParameter<double>("maxZ", 1200.)),
       barrelBoundary_(cfg.exists("trackerBarrelBoundary"))  // Hack to interface "old" calo to "new" tracking
       ,
       forwardBoundary_(cfg.exists("trackerForwardBoundary"))  // Hack to interface "old" calo to "new" tracking
       ,
       trackerBarrelBoundaryCfg_(barrelBoundary_
                                     ? cfg.getParameter<edm::ParameterSet>("trackerBarrelBoundary")
                                     : edm::ParameterSet())  // Hack to interface "old" calo to "new" tracking
       ,
       trackerForwardBoundaryCfg_(forwardBoundary_
                                      ? cfg.getParameter<edm::ParameterSet>("trackerForwardBoundary")
                                      : edm::ParameterSet())  // Hack to interface "old" calo to "new" tracking
       {};

◆ ~Geometry()

Geometry::~Geometry ( )

Default destructor.

Definition at line 21 of file Geometry.cc.

21 { ; }

Member Function Documentation

◆ barrelLayers()

const std::vector<std::unique_ptr<BarrelSimplifiedGeometry> >& fastsim::Geometry::barrelLayers ( ) const

inline

Return the vector of barrel layers.

Ordered by increasing radius (0 to +inf).

Returns: The barrel layers according to defined geometry.

Definition at line 62 of file Geometry.h.

62 { return barrelLayers_; }

References barrelLayers_.

◆ forwardLayers()

const std::vector<std::unique_ptr<ForwardSimplifiedGeometry> >& fastsim::Geometry::forwardLayers ( ) const

inline

Return the vector of forward layers (disks).

Ordered by increasing Z-position (-inf to +inf).

Returns: The forward layers according to defined geometry.

Definition at line 69 of file Geometry.h.

69 { return forwardLayers_; }

References forwardLayers_.

◆ getMagneticFieldZ()

double Geometry::getMagneticFieldZ ( const math::XYZTLorentzVector & position ) const

Initializes the tracker geometry.

Get the field from the MagneticFieldRecord (or set constant if defined in python config)

Parameters

position The position where you want to get the magnetic field (field only in Z direction).

Returns: The magnetic field (Z-direction) for a given position.

Definition at line 154 of file Geometry.cc.

                                                                                      {
   return magneticField_->inTesla(GlobalPoint(position.X(), position.Y(), position.Z())).z();
 }

References position.

Referenced by FastSimProducer::produce().

◆ getMaxRadius()

double fastsim::Geometry::getMaxRadius ( )

inline

Upper bound of the radius of the whole tracker geometry.

Necessary to initialize the magnetic field within this volume.

Returns: Upper bound of radius of the whole tracker geometry

Definition at line 76 of file Geometry.h.

76 { return maxRadius_; }

References maxRadius_.

◆ getMaxZ()

double fastsim::Geometry::getMaxZ ( )

inline

Upper bound of the length/2 (0 to +Z) of the whole tracker geometry.

Necessary to initialize the magnetic field within this volume.

Returns: Upper bound of length/2 of the whole tracker geometry

Definition at line 83 of file Geometry.h.

83 { return maxZ_; }

References maxZ_.

◆ nextLayer() [1/2]

const BarrelSimplifiedGeometry* fastsim::Geometry::nextLayer ( const BarrelSimplifiedGeometry * layer ) const

inline

Helps to navigate through the vector of barrel layers.

For a given layer, returns the next layer (as ordered in std::vector<...> barrelLayers_).

Parameters

layer A barrel layer

Returns: The next layer (increasing radius). Returns 0 if last layer reached.

Definition at line 94 of file Geometry.h.

                                                                                            {
       if (layer == nullptr) {
         return nullptr;
       }
       unsigned nextLayerIndex = layer->index() + 1;
       return nextLayerIndex < barrelLayers_.size() ? barrelLayers_[nextLayerIndex].get() : nullptr;
     }

References barrelLayers_, and fastsim::SimplifiedGeometry::index().

◆ nextLayer() [2/2]

const ForwardSimplifiedGeometry* fastsim::Geometry::nextLayer ( const ForwardSimplifiedGeometry * layer ) const

inline

Helps to navigate through the vector of forward layers.

For a given layer, returns the next layer (as ordered in std::vector<...> forwardLayers_).

Parameters

layer A forward layer

Returns: The next layer (increasing Z-position). Returns 0 if last layer reached.

Definition at line 108 of file Geometry.h.

                                                                                              {
       if (layer == nullptr) {
         return nullptr;
       }
       unsigned nextLayerIndex = layer->index() + 1;
       return nextLayerIndex < forwardLayers_.size() ? forwardLayers_[nextLayerIndex].get() : nullptr;
     }

References forwardLayers_, and fastsim::SimplifiedGeometry::index().

◆ previousLayer() [1/2]

const BarrelSimplifiedGeometry* fastsim::Geometry::previousLayer ( const BarrelSimplifiedGeometry * layer ) const

inline

Helps to navigate through the vector of barrel layers.

For a given layer, returns the previous layer (as ordered in std::vector<...> barrelLayers_).

Parameters

layer A barrel layer

Returns: The previous layer (decreasing radius). Returns 0 if first layer reached.

Definition at line 122 of file Geometry.h.

                                                                                                {
       if (layer == nullptr) {
         return barrelLayers_.back().get();
       }
       return layer->index() > 0 ? barrelLayers_[layer->index() - 1].get() : nullptr;
     }

References barrelLayers_, and fastsim::SimplifiedGeometry::index().

◆ previousLayer() [2/2]

const ForwardSimplifiedGeometry* fastsim::Geometry::previousLayer ( const ForwardSimplifiedGeometry * layer ) const

inline

Helps to navigate through the vector of forward layers.

For a given layer, returns the previous layer (as ordered in std::vector<...> forwardLayers_).

Parameters

layer A forward layer

Returns: The previous layer (decreasing Z-position). Returns 0 if first layer reached.

Definition at line 135 of file Geometry.h.

                                                                                                  {
       if (layer == nullptr) {
         return forwardLayers_.back().get();
       }
       return layer->index() > 0 ? forwardLayers_[layer->index() - 1].get() : nullptr;
     }

References forwardLayers_, and fastsim::SimplifiedGeometry::index().

◆ update()

void Geometry::update	(	const edm::EventSetup &	iSetup,
		const std::map< std::string, InteractionModel * > &	interactionModelMap
	)

Initializes the tracker geometry.

Calls SimplifiedGeometryFactory to initialize the vectors of barrel/forward layers and provides magnetic field and interaction models for those.

Parameters

iSetup	The Event Setup.
interactionModelMap	Map of all interaction models considered (for any layer)

See also: SimplifiedGeometryFactory

Definition at line 49 of file Geometry.cc.

                                                                                               {
   if (iSetup.get<TrackerRecoGeometryRecord>().cacheIdentifier() == cacheIdentifierTrackerRecoGeometry_ &&
       iSetup.get<IdealMagneticFieldRecord>().cacheIdentifier() == cacheIdentifierIdealMagneticField_) {
     return;
   }
  
   //----------------
   // find tracker reconstruction geometry
   //----------------
   if (iSetup.get<TrackerRecoGeometryRecord>().cacheIdentifier() != cacheIdentifierTrackerRecoGeometry_) {
     if (useTrackerRecoGeometryRecord_) {
       edm::ESHandle<GeometricSearchTracker> geometricSearchTrackerHandle;
       iSetup.get<TrackerRecoGeometryRecord>().get(trackerAlignmentLabel_, geometricSearchTrackerHandle);
       geometricSearchTracker_ = &(*geometricSearchTrackerHandle);
     }
   }
  
   //----------------
   // update magnetic field
   //----------------
   if (iSetup.get<IdealMagneticFieldRecord>().cacheIdentifier() != cacheIdentifierIdealMagneticField_) {
     if (useFixedMagneticFieldZ_)  // use constant magnetic field
     {
       ownedMagneticField_.reset(new UniformMagneticField(fixedMagneticFieldZ_));
       magneticField_ = ownedMagneticField_.get();
     } else  // get magnetic field from EventSetup
     {
       edm::ESHandle<MagneticField> magneticField;
       iSetup.get<IdealMagneticFieldRecord>().get(magneticField);
       magneticField_ = &(*magneticField);
     }
   }
  
   //---------------
   // layer factory
   //---------------
   SimplifiedGeometryFactory simplifiedGeometryFactory(
       geometricSearchTracker_, *magneticField_, interactionModelMap, maxRadius_, maxZ_);
  
   //---------------
   // update barrel layers
   //---------------
   barrelLayers_.clear();
   for (const edm::ParameterSet& layerCfg : barrelLayerCfg_) {
     barrelLayers_.push_back(simplifiedGeometryFactory.createBarrelSimplifiedGeometry(layerCfg));
   }
  
   // Hack to interface "old" calo to "new" tracking
   if (barrelBoundary_) {
     barrelLayers_.push_back(simplifiedGeometryFactory.createBarrelSimplifiedGeometry(trackerBarrelBoundaryCfg_));
     barrelLayers_.back()->setCaloType(SimplifiedGeometry::TRACKERBOUNDARY);
   }
  
   for (unsigned index = 0; index < barrelLayers_.size(); index++) {
     // set index
     barrelLayers_[index]->setIndex(index);
     // check order
     if (index > 0) {
       if (barrelLayers_[index]->getRadius() <= barrelLayers_[index - 1]->getRadius()) {
         throw cms::Exception("fastsim::Geometry")
             << "barrel layers must be ordered according to increading radius"
             << "\nbarrel layer " << index << " has radius smaller than or equal to radius of barrel layer " << index - 1
             << " (" << barrelLayers_[index]->getRadius() << "/" << barrelLayers_[index - 1]->getRadius() << ")";
       }
     }
   }
  
   //--------------
   // update forward layers
   //--------------
   forwardLayers_.clear();
   for (const edm::ParameterSet& layerCfg : forwardLayerCfg_) {
     forwardLayers_.push_back(simplifiedGeometryFactory.createForwardSimplifiedGeometry(
         fastsim::SimplifiedGeometryFactory::POSFWD, layerCfg));
     forwardLayers_.insert(forwardLayers_.begin(),
                           simplifiedGeometryFactory.createForwardSimplifiedGeometry(
                               fastsim::SimplifiedGeometryFactory::NEGFWD, layerCfg));
   }
  
   // Hack to interface "old" calo to "new" tracking
   if (forwardBoundary_) {
     forwardLayers_.push_back(simplifiedGeometryFactory.createForwardSimplifiedGeometry(
         fastsim::SimplifiedGeometryFactory::POSFWD, trackerForwardBoundaryCfg_));
     forwardLayers_.back()->setCaloType(SimplifiedGeometry::TRACKERBOUNDARY);
     forwardLayers_.insert(forwardLayers_.begin(),
                           simplifiedGeometryFactory.createForwardSimplifiedGeometry(
                               fastsim::SimplifiedGeometryFactory::NEGFWD, trackerForwardBoundaryCfg_));
     forwardLayers_.front()->setCaloType(SimplifiedGeometry::TRACKERBOUNDARY);
   }
  
   for (unsigned index = 0; index < forwardLayers_.size(); index++) {
     // set index
     forwardLayers_[index]->setIndex(index);
     // check order
     if (index > 0) {
       if (forwardLayers_[index]->getZ() <= forwardLayers_[index - 1]->getZ()) {
         throw cms::Exception("fastsim::Geometry")
             << "forward layers must be ordered according to increasing z"
             << "forward layer " << index << " has z smaller than or equal to z of forward layer " << index - 1;
       }
     }
   }
 }

References barrelBoundary_, barrelLayerCfg_, barrelLayers_, edm::eventsetup::EventSetupRecord::cacheIdentifier(), cacheIdentifierIdealMagneticField_, cacheIdentifierTrackerRecoGeometry_, fastsim::SimplifiedGeometryFactory::createBarrelSimplifiedGeometry(), fastsim::SimplifiedGeometryFactory::createForwardSimplifiedGeometry(), Exception, fixedMagneticFieldZ_, forwardBoundary_, forwardLayerCfg_, forwardLayers_, geometricSearchTracker_, edm::EventSetup::get(), get, HLT_2018_cff::magneticField, magneticField_, maxRadius_, maxZ_, fastsim::SimplifiedGeometryFactory::NEGFWD, ownedMagneticField_, fastsim::SimplifiedGeometryFactory::POSFWD, trackerAlignmentLabel_, trackerBarrelBoundaryCfg_, fastsim::SimplifiedGeometry::TRACKERBOUNDARY, trackerForwardBoundaryCfg_, useFixedMagneticFieldZ_, and useTrackerRecoGeometryRecord_.

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

Friends And Related Function Documentation

◆ operator<<

std::ostream& operator<<	(	std::ostream &	o,
		const fastsim::Geometry &	geometry
	)

friend

Provides some basic output for e.g. debugging.

Member Data Documentation

◆ barrelBoundary_

const bool fastsim::Geometry::barrelBoundary_

private

Upper bound of the length/2 (0 to +Z) of the whole tracker geometry.

Hack to interface "old" calo to "new" tracking

Definition at line 167 of file Geometry.h.

Referenced by update().

◆ barrelLayerCfg_

const std::vector<edm::ParameterSet> fastsim::Geometry::barrelLayerCfg_

private

The config in which all parameters of the barrel layers are defined.

Definition at line 161 of file Geometry.h.

Referenced by update().

◆ barrelLayers_

std::vector<std::unique_ptr<BarrelSimplifiedGeometry> > fastsim::Geometry::barrelLayers_

private

The vector of barrel layers (increasing radius)

Definition at line 144 of file Geometry.h.

Referenced by barrelLayers(), nextLayer(), previousLayer(), and update().

◆ cacheIdentifierIdealMagneticField_

unsigned long long fastsim::Geometry::cacheIdentifierIdealMagneticField_

private

Check interval of validity of the magnetic field.

Definition at line 151 of file Geometry.h.

Referenced by update().

◆ cacheIdentifierTrackerRecoGeometry_

unsigned long long fastsim::Geometry::cacheIdentifierTrackerRecoGeometry_

private

Check interval of validity of the tracker geometry.

Definition at line 150 of file Geometry.h.

Referenced by update().

◆ fixedMagneticFieldZ_

const double fastsim::Geometry::fixedMagneticFieldZ_

private

Use a uniform magnetic field or non-uniform from MagneticFieldRecord.

Definition at line 156 of file Geometry.h.

Referenced by update().

◆ forwardBoundary_

const bool fastsim::Geometry::forwardBoundary_

private

Hack to interface "old" calo to "new" tracking.

Definition at line 168 of file Geometry.h.

Referenced by update().

◆ forwardLayerCfg_

const std::vector<edm::ParameterSet> fastsim::Geometry::forwardLayerCfg_

private

The config in which all parameters of the forward layers are defined.

Definition at line 163 of file Geometry.h.

Referenced by update().

◆ forwardLayers_

std::vector<std::unique_ptr<ForwardSimplifiedGeometry> > fastsim::Geometry::forwardLayers_

private

The vector of forward layers (increasing Z-position)

Definition at line 146 of file Geometry.h.

Referenced by forwardLayers(), nextLayer(), previousLayer(), and update().

◆ geometricSearchTracker_

const GeometricSearchTracker* fastsim::Geometry::geometricSearchTracker_

private

Definition at line 153 of file Geometry.h.

Referenced by update().

◆ magneticField_

const MagneticField* fastsim::Geometry::magneticField_

private

The tracker geometry.

The magnetic field

Definition at line 154 of file Geometry.h.

Referenced by update().

◆ maxRadius_

const double fastsim::Geometry::maxRadius_

private

Definition at line 164 of file Geometry.h.

Referenced by getMaxRadius(), and update().

◆ maxZ_

const double fastsim::Geometry::maxZ_

private

Upper bound of the radius of the whole tracker geometry.

Definition at line 165 of file Geometry.h.

Referenced by getMaxZ(), and update().

◆ ownedMagneticField_

std::unique_ptr<MagneticField> fastsim::Geometry::ownedMagneticField_

private

Needed to create a uniform magnetic field if speciefied in config.

Definition at line 148 of file Geometry.h.

Referenced by update().

◆ trackerAlignmentLabel_

const std::string fastsim::Geometry::trackerAlignmentLabel_

private

The tracker alignment label.

Definition at line 159 of file Geometry.h.

Referenced by update().

◆ trackerBarrelBoundaryCfg_

const edm::ParameterSet fastsim::Geometry::trackerBarrelBoundaryCfg_

private

Hack to interface "old" calo to "new" tracking.

Definition at line 169 of file Geometry.h.

Referenced by update().

◆ trackerForwardBoundaryCfg_

const edm::ParameterSet fastsim::Geometry::trackerForwardBoundaryCfg_

private

Hack to interface "old" calo to "new" tracking.

Definition at line 170 of file Geometry.h.

Referenced by update().

◆ useFixedMagneticFieldZ_

const bool fastsim::Geometry::useFixedMagneticFieldZ_

private

Needed to create a uniform magnetic field if speciefied in config.

Definition at line 155 of file Geometry.h.

Referenced by update().

◆ useTrackerRecoGeometryRecord_

const bool fastsim::Geometry::useTrackerRecoGeometryRecord_

private

Use GeometricSearchTracker (active layers/reco geometry). Can be used to get position/radius of tracker material that reflects active layers.

Definition at line 158 of file Geometry.h.

Referenced by update().

Public Member Functions

Private Attributes

Friends

Detailed Description

Constructor & Destructor Documentation

◆ Geometry()

◆ ~Geometry()

Member Function Documentation

◆ barrelLayers()

◆ forwardLayers()

◆ getMagneticFieldZ()

◆ getMaxRadius()

◆ getMaxZ()

◆ nextLayer() [1/2]

◆ nextLayer() [2/2]

◆ previousLayer() [1/2]

◆ previousLayer() [2/2]

◆ update()

Friends And Related Function Documentation

◆ operator<<

Member Data Documentation

◆ barrelBoundary_

◆ barrelLayerCfg_

◆ barrelLayers_

◆ cacheIdentifierIdealMagneticField_

◆ cacheIdentifierTrackerRecoGeometry_

◆ fixedMagneticFieldZ_

◆ forwardBoundary_

◆ forwardLayerCfg_

◆ forwardLayers_

◆ geometricSearchTracker_

◆ magneticField_

◆ maxRadius_

◆ maxZ_

◆ ownedMagneticField_

◆ trackerAlignmentLabel_

◆ trackerBarrelBoundaryCfg_

◆ trackerForwardBoundaryCfg_

◆ useFixedMagneticFieldZ_

◆ useTrackerRecoGeometryRecord_