TotemRPGeometry Class Reference

The manager class for TOTEM RP geometry. More...

#include <TotemRPGeometry.h>

Public Types
typedef std::map< unsigned int, std::set< unsigned int > >	mapSetType
typedef std::map< unsigned int, const DetGeomDesc * >	mapType
typedef std::map< int, const DetGeomDesc * >	RPDeviceMapType

Public Member Functions
char	AddDetector (unsigned int, const DetGeomDesc *&)
	adds an item to the map (detector ID –> DetGeomDesc) performs necessary checks, returns 0 if succesful More...
char	AddRPDevice (unsigned int id, const DetGeomDesc *&det_geom_desc)
	adds a RP package (primary vacuum) to a map More...
mapType::const_iterator	beginDet () const
	begin iterator over (silicon) detectors More...
RPDeviceMapType::const_iterator	beginRP () const
	begin iterator over RPs More...
char	Build (const DetGeomDesc *)
	build up from DetGeomDesc structure, return 0 = success More...
void	BuildSets ()
	builds maps element ID –> set of subelements (re)builds stationsInArm, rpsInStation, detsInRP out of theMap More...
std::set< unsigned int > const &	DetsInRP (unsigned int) const
mapType::const_iterator	endDet () const
	end iterator over (silicon) detectors More...
RPDeviceMapType::const_iterator	endRP () const
	end iterator over RPs More...
const DetGeomDesc *	GetDetector (unsigned int) const
	returns geometry of a detector performs necessary checks, returns NULL if fails input is raw ID More...
const DetGeomDesc *	GetDetector (const TotemRPDetId &id) const
const DetGeomDesc *	GetDetector (const CTPPSDetId &id) const
CLHEP::Hep3Vector	GetDetEdgeNormalVector (unsigned int id) const
	returns a normal vector for the edge of a detector More...
CLHEP::Hep3Vector	GetDetEdgePosition (unsigned int id) const
	returns the position of the edge of a detector More...
CLHEP::Hep3Vector	GetDetTranslation (unsigned int id) const
void	GetReadoutDirection (unsigned int id, double &dx, double &dy) const
const DetGeomDesc *	GetRPDevice (unsigned int id) const
	returns geometry of a RP box More...
CLHEP::HepRotation	GetRPGlobalRotation (int copy_no) const
	returns number of detectors in the geometry (size of theMap) More...
CLHEP::Hep3Vector	GetRPGlobalTranslation (int copy_no) const
	position of a RP package (translation z corresponds to the first plane - TODO check it) More...
CLHEP::Hep3Vector	GetRPThinFoilNormalVector (int copy_no) const
	returns a normal vector for the thin foil of a RP box More...
CLHEP::Hep3Vector	GetRPThinFoilPosition (int copy_no) const
	returns the (outer) position of the thin foil of a RP box More...
CLHEP::Hep3Vector	GlobalToLocal (const DetGeomDesc *gd, const CLHEP::Hep3Vector &r) const
CLHEP::Hep3Vector	GlobalToLocal (unsigned int id, const CLHEP::Hep3Vector &r) const
CLHEP::Hep3Vector	GlobalToLocalDirection (unsigned int id, const CLHEP::Hep3Vector &dir) const
CLHEP::Hep3Vector	LocalToGlobal (const DetGeomDesc *gd, const CLHEP::Hep3Vector &r) const
CLHEP::Hep3Vector	LocalToGlobal (unsigned int id, const CLHEP::Hep3Vector &r) const
CLHEP::Hep3Vector	LocalToGlobalDirection (unsigned int id, const CLHEP::Hep3Vector &dir) const
unsigned int	NumberOfDetsIncluded () const
DetGeomDesc const *	operator[] (unsigned int id) const
	same as GetDetector More...
std::set< unsigned int > const &	RPsInStation (unsigned int) const
	after checks returns set of RP corresponding to the given station ID More...
std::set< unsigned int > const &	StationsInArm (unsigned int) const
	after checks returns set of stations corresponding to the given arm ID More...
	TotemRPGeometry ()
	TotemRPGeometry (const DetGeomDesc *gd)
	build up from DetGeomDesc More...
	~TotemRPGeometry ()

Protected Attributes
mapSetType	detsInRP
mapSetType	rpsInStation
mapSetType	stationsInArm
	map: parent ID -> set of subelements E.g. stationsInArm is map of arm ID -> set of stations (in that arm) More...
mapType	theMap
	map: detectorID –> DetGeomDesc More...
RPDeviceMapType	theRomanPotMap
	map: RPID –> DetGeomDesc More...

Detailed Description

The manager class for TOTEM RP geometry.

See schema of TOTEM RP geometry classes

This is kind of "public relation class" for the tree structure of DetGeomDesc. It provides convenient interface to answer frequently asked questions about the geometry of TOTEM Roman Pots. These questions are of type:
a) If detector ID is xxx, what is the ID of corresponding station?
b) What is the geometry (shift, roatation, material, etc.) of detector with id xxx?
c) If RP ID is xxx, which are the detector IDs inside this pot?
d) If hit position in local detector coordinate system is xxx, what is the hit position in global c.s.?
etc. (see the comments in definition bellow)
This class is built for both ideal and real geometry. I.e. it is produced by TotemRPIdealGeometryESModule in IdealGeometryRecord and similarly for the real geometry

Definition at line 39 of file TotemRPGeometry.h.

Member Typedef Documentation

typedef std::map<unsigned int, std::set<unsigned int> > TotemRPGeometry::mapSetType

Definition at line 44 of file TotemRPGeometry.h.

typedef std::map<unsigned int, const DetGeomDesc* > TotemRPGeometry::mapType

Definition at line 42 of file TotemRPGeometry.h.

typedef std::map<int, const DetGeomDesc* > TotemRPGeometry::RPDeviceMapType

Definition at line 43 of file TotemRPGeometry.h.

Constructor & Destructor Documentation

TotemRPGeometry::TotemRPGeometry ( )

inline

Definition at line 46 of file TotemRPGeometry.h.

{}

TotemRPGeometry::~TotemRPGeometry ( )

inline

Definition at line 47 of file TotemRPGeometry.h.

{}

TotemRPGeometry::TotemRPGeometry ( const DetGeomDesc *  gd )

inline

build up from DetGeomDesc

Definition at line 50 of file TotemRPGeometry.h.

References AddDetector(), AddRPDevice(), Build(), and GetDetector().

    {
      Build(gd);
    }

Member Function Documentation

char TotemRPGeometry::AddDetector	(	unsigned int	id,
		const DetGeomDesc *&	gD
	)

adds an item to the map (detector ID –> DetGeomDesc) performs necessary checks, returns 0 if succesful

Definition at line 51 of file TotemRPGeometry.cc.

References hcalTTPDigis_cfi::id.

Referenced by TotemRPGeometry().

{
  // check if the ID is already in map
  if (theMap.find(id) != theMap.end())
    return 1;

  // add gD
  theMap[id] = gD;
  return 0;
}

char TotemRPGeometry::AddRPDevice	(	unsigned int	id,
		const DetGeomDesc *&	det_geom_desc
	)

adds a RP package (primary vacuum) to a map

Definition at line 110 of file TotemRPGeometry.cc.

References hcalTTPDigis_cfi::id.

Referenced by TotemRPGeometry().

{
  // check if the copy_no is already in map
  if (theRomanPotMap.find(id) != theRomanPotMap.end())
    return 1;

  // add gD
  theRomanPotMap[id] = (DetGeomDesc*) gD;
  return 0;
}

mapType::const_iterator TotemRPGeometry::beginDet ( ) const

inline

begin iterator over (silicon) detectors

Definition at line 101 of file TotemRPGeometry.h.

References theMap.

Referenced by GeometryInfoModule::PrintGeometry().

    {
      return theMap.begin();
    }

RPDeviceMapType::const_iterator TotemRPGeometry::beginRP ( ) const

inline

begin iterator over RPs

Definition at line 113 of file TotemRPGeometry.h.

References theRomanPotMap.

Referenced by GeometryInfoModule::PrintGeometry().

    {
      return theRomanPotMap.begin();
    }

char TotemRPGeometry::Build

(

const DetGeomDesc *

gD

)

build up from DetGeomDesc structure, return 0 = success

Definition at line 19 of file TotemRPGeometry.cc.

References DetGeomDesc::components(), edmIntegrityCheck::d, DDD_CTPPS_DIAMONDS_DETECTOR_NAME, DDD_TOTEM_RP_DETECTOR_NAME, DDD_TOTEM_RP_PRIMARY_VACUUM_NAME, DetGeomDesc::geographicalID(), mps_fire::i, DDName::name(), DetGeomDesc::name(), and or.

Referenced by TotemRPGeometry().

{
  // propagate through the GeometricalDet structure and add
  // all detectors to 'theMap'
  deque<const DetGeomDesc *> buffer;
  buffer.push_back(gD);
  while (buffer.size() > 0)
  {
    const DetGeomDesc *d = buffer.front();
    buffer.pop_front();

    // check if it is RP detector
    if (! d->name().name().compare(DDD_TOTEM_RP_DETECTOR_NAME)
       or d->name().name().compare(DDD_CTPPS_DIAMONDS_DETECTOR_NAME)==0)
      AddDetector(d->geographicalID(), d);

    // check if it is RP device (primary vacuum)
    if (! d->name().name().compare(DDD_TOTEM_RP_PRIMARY_VACUUM_NAME))
      AddRPDevice(d->geographicalID(), d);
    
    for (unsigned int i = 0; i < d->components().size(); i++)
      buffer.push_back(d->components()[i]);
  }

  // build sets from theMap
  BuildSets();

  return 0;
}

void TotemRPGeometry::BuildSets

(

)

builds maps element ID –> set of subelements (re)builds stationsInArm, rpsInStation, detsInRP out of theMap

Definition at line 152 of file TotemRPGeometry.cc.

References CTPPSDetId::getArmId(), CTPPSDetId::getRPId(), and CTPPSDetId::getStationId().

Referenced by endRP().

{
  // reset
  stationsInArm.clear();
  rpsInStation.clear();
  detsInRP.clear();

  // build
  for (mapType::const_iterator it = theMap.begin(); it != theMap.end(); ++it)
  {
    const CTPPSDetId detId(it->first);
    const CTPPSDetId rpId = detId.getRPId();
    const CTPPSDetId stId = detId.getStationId();
    const CTPPSDetId armId = detId.getArmId();

    stationsInArm[armId].insert(armId);
    rpsInStation[stId].insert(rpId);
    detsInRP[rpId].insert(detId);
  }
}

std::set< unsigned int > const & TotemRPGeometry::DetsInRP

(

unsigned int

id

)

const

after checks returns set of detectors corresponding to the given RP ID containts decimal detetector IDs

Definition at line 194 of file TotemRPGeometry.cc.

Referenced by endRP().

{
  mapSetType::const_iterator it = detsInRP.find(id);
  if (it == detsInRP.end())
    throw cms::Exception("TotemRPGeometry") << "RP with ID " << id << " not found.";
  return (*it).second;
}

mapType::const_iterator TotemRPGeometry::endDet ( ) const

inline

end iterator over (silicon) detectors

Definition at line 107 of file TotemRPGeometry.h.

References theMap.

Referenced by GeometryInfoModule::PrintGeometry().

    {
      return theMap.end();
    }

RPDeviceMapType::const_iterator TotemRPGeometry::endRP ( ) const

inline

end iterator over RPs

Definition at line 119 of file TotemRPGeometry.h.

References BuildSets(), DetsInRP(), dir, GetDetTranslation(), GetReadoutDirection(), GetRPGlobalRotation(), GetRPGlobalTranslation(), GlobalToLocal(), GlobalToLocalDirection(), LocalToGlobal(), LocalToGlobalDirection(), alignCSCRings::r, RPsInStation(), StationsInArm(), and theRomanPotMap.

Referenced by GeometryInfoModule::PrintGeometry().

    {
      return theRomanPotMap.end();
    }

const DetGeomDesc * TotemRPGeometry::GetDetector

(

unsigned int

id

)

const

returns geometry of a detector performs necessary checks, returns NULL if fails input is raw ID

Definition at line 64 of file TotemRPGeometry.cc.

Referenced by TotemRPDQMSource::analyze(), CTPPSDiamondRecHitProducerAlgorithm::build(), GetDetector(), operator[](), and TotemRPGeometry().

{
  // check if id is RP id?

  // check if there is a corresponding key
//  std::cout<<"TotemRPGeometry::GetDetector entered, id="<<id<<std::endl;
  mapType::const_iterator it = theMap.find(id);
  if (it == theMap.end())
    throw cms::Exception("TotemRPGeometry") << "Not found detector with ID " << id << ", i.e. "
      << CTPPSDetId(id);

  // the [] operator cannot be used as this method is const
  // and it must be const and one gets TotemRPGeometry const
  // from EventSetup
  //std::cout<<"det. retrieved:"<<id<<std::endl;
  return (*it).second;
}

const DetGeomDesc* TotemRPGeometry::GetDetector ( const TotemRPDetId &  id ) const

inline

Definition at line 70 of file TotemRPGeometry.h.

References GetDetector().

    {
      return GetDetector( id.rawId() );
    }

const DetGeomDesc* TotemRPGeometry::GetDetector ( const CTPPSDetId &  id ) const

inline

Definition at line 74 of file TotemRPGeometry.h.

References GetDetector().

    {
      return GetDetector( id.rawId() );
    }

CLHEP::Hep3Vector TotemRPGeometry::GetDetEdgeNormalVector

(

unsigned int

id

)

const

returns a normal vector for the edge of a detector

Definition at line 103 of file TotemRPGeometry.cc.

References mathSSE::sqrt().

Referenced by operator[]().

{
    return GetDetector(id)->rotation() * CLHEP::Hep3Vector(-sqrt(2)/2, -sqrt(2)/2, 0.);
}

CLHEP::Hep3Vector TotemRPGeometry::GetDetEdgePosition

(

unsigned int

id

)

const

returns the position of the edge of a detector

Definition at line 84 of file TotemRPGeometry.cc.

References mathSSE::sqrt(), and x().

Referenced by operator[]().

{
    // hardcoded for now, values taken from RP_Hybrid.xml
    // +-------+
    // |       |
    // |   + (0,0)
    //  *(x,y) |
    //   \-----+
    // x=-RP_Det_Size_a/2+RP_Det_Edge_Length/(2*sqrt(2))
    // y=x
    // ideally we would get this from the geometry in the event setup
    double x=-36.07/2+22.276/(2*sqrt(2));
    return LocalToGlobal(id, CLHEP::Hep3Vector(x, x, 0.));
}

CLHEP::Hep3Vector TotemRPGeometry::GetDetTranslation

(

unsigned int

id

)

const

returns translation (position) of a detector raw ID as input

Definition at line 264 of file TotemRPGeometry.cc.

References tmp, and x().

Referenced by endRP(), and TotemRPLocalTrackFitterAlgorithm::prepareReconstAlgebraData().

{
  auto gd = GetDetector(id);
  CLHEP::Hep3Vector tmp;
  tmp.setX((gd->translation()).x());
  tmp.setY((gd->translation()).y());
  tmp.setZ((gd->translation()).z());
  return tmp;
}

void TotemRPGeometry::GetReadoutDirection	(	unsigned int	id,
		double &	dx,
		double &	dy
	)		const

returns (the transverse part of) the readout direction in global coordinates raw ID expected

Definition at line 276 of file TotemRPGeometry.cc.

References edmIntegrityCheck::d.

Referenced by endRP(), and GeometryInfoModule::PrintGeometry().

{
  CLHEP::Hep3Vector d = LocalToGlobalDirection(id, CLHEP::Hep3Vector(0., 1., 0.));
  dx = d.x();
  dy = d.y();
}

const DetGeomDesc * TotemRPGeometry::GetRPDevice

(

unsigned int

id

)

const

returns geometry of a RP box

Definition at line 123 of file TotemRPGeometry.cc.

Referenced by operator[](), and TotemRPUVPatternFinder::produce().

{
  // check if there is a corresponding key
  RPDeviceMapType::const_iterator it = theRomanPotMap.find(id);
  if (it == theRomanPotMap.end())
    throw cms::Exception("TotemRPGeometry") << "Not found RP device with ID " << id << ", i.e. "
      << TotemRPDetId(id);

  return (*it).second;
}

CLHEP::HepRotation TotemRPGeometry::GetRPGlobalRotation

(

int

copy_no

)

const

returns number of detectors in the geometry (size of theMap)

Definition at line 297 of file TotemRPGeometry.cc.

References makeMuonMisalignmentScenario::rot, geometryCSVtoXML::xx, geometryCSVtoXML::xy, geometryCSVtoXML::xz, geometryCSVtoXML::yy, geometryCSVtoXML::yz, and geometryCSVtoXML::zz.

Referenced by endRP().

{
  double xx, xy, xz, yx, yy, yz, zx, zy, zz;
  GetRPDevice(copy_no)->rotation().GetComponents(xx, xy, xz, yx, yy, yz, zx, zy, zz);
  CLHEP::HepRep3x3 rot_mat( xx, xy, xz, yx, yy, yz, zx, zy, zz);
  CLHEP::HepRotation rot(rot_mat);
  return rot;
}

CLHEP::Hep3Vector TotemRPGeometry::GetRPGlobalTranslation

(

int

copy_no

)

const

position of a RP package (translation z corresponds to the first plane - TODO check it)

Definition at line 285 of file TotemRPGeometry.cc.

References tmp, and x().

Referenced by TotemRPDQMSource::analyze(), endRP(), and TotemRPLocalTrackFitter::produce().

{
  CLHEP::Hep3Vector tmp;
  auto gd = GetRPDevice(copy_no);
  tmp.setX((gd->translation()).x());
  tmp.setY((gd->translation()).y());
  tmp.setZ((gd->translation()).z());
  return tmp;
}

CLHEP::Hep3Vector TotemRPGeometry::GetRPThinFoilNormalVector

(

int

copy_no

)

const

returns a normal vector for the thin foil of a RP box

Definition at line 145 of file TotemRPGeometry.cc.

Referenced by operator[]().

{
    return GetRPDevice(copy_no)->rotation() * CLHEP::Hep3Vector(0., -1., 0.);
}

CLHEP::Hep3Vector TotemRPGeometry::GetRPThinFoilPosition

(

int

copy_no

)

const

returns the (outer) position of the thin foil of a RP box

Definition at line 136 of file TotemRPGeometry.cc.

Referenced by operator[]().

{
    // hardcoded for now, taken from RP_Box.xml:RP_Box_primary_vacuum_y
    // ideally we would get this from the geometry in the event setup
    return LocalToGlobal(GetRPDevice(copy_no), CLHEP::Hep3Vector(0., -135.65/2.0, 0.));
}

CLHEP::Hep3Vector TotemRPGeometry::GlobalToLocal	(	const DetGeomDesc *	gd,
		const CLHEP::Hep3Vector &	r
	)		const

Definition at line 227 of file TotemRPGeometry.cc.

References alignCSCRings::r, DetGeomDesc::rotation(), tmp, DetGeomDesc::translation(), and x().

Referenced by TotemRPDQMSource::analyze(), and endRP().

{
  CLHEP::Hep3Vector tmp = r;
  tmp.setX(tmp.x() - (gd->translation()).x());
  tmp.setY(tmp.y() - (gd->translation()).y());
  tmp.setZ(tmp.z() - (gd->translation()).z());
  return (gd->rotation()).Inverse() * tmp;
}

CLHEP::Hep3Vector TotemRPGeometry::GlobalToLocal	(	unsigned int	id,
		const CLHEP::Hep3Vector &	r
	)		const

Definition at line 238 of file TotemRPGeometry.cc.

References alignCSCRings::r, tmp, and x().

{
  auto gd = GetDetector(id);
  CLHEP::Hep3Vector tmp = r;
  tmp.setX(tmp.x() - (gd->translation()).x());
  tmp.setY(tmp.y() - (gd->translation()).y());
  tmp.setZ(tmp.z() - (gd->translation()).z());
  return (gd->rotation()).Inverse() * tmp;
}

CLHEP::Hep3Vector TotemRPGeometry::GlobalToLocalDirection	(	unsigned int	id,
		const CLHEP::Hep3Vector &	dir
	)		const

Definition at line 257 of file TotemRPGeometry.cc.

References dir, and idealTransformation::rotation.

Referenced by endRP().

{
  return (GetDetector(id)->rotation()).Inverse() * dir;
}

CLHEP::Hep3Vector TotemRPGeometry::LocalToGlobal	(	const DetGeomDesc *	gd,
		const CLHEP::Hep3Vector &	r
	)		const

coordinate transformations between local<–>global reference frames dimensions in mm, raw ID expected

Definition at line 204 of file TotemRPGeometry.cc.

References alignCSCRings::r, DetGeomDesc::rotation(), tmp, DetGeomDesc::translation(), and x().

Referenced by endRP().

{
  CLHEP::Hep3Vector tmp = gd->rotation() * r;
  tmp.setX(tmp.x() + (gd->translation()).x());
  tmp.setY(tmp.y() + (gd->translation()).y());
  tmp.setZ(tmp.z() + (gd->translation()).z());
  return tmp;
}

CLHEP::Hep3Vector TotemRPGeometry::LocalToGlobal	(	unsigned int	id,
		const CLHEP::Hep3Vector &	r
	)		const

Definition at line 215 of file TotemRPGeometry.cc.

References alignCSCRings::r, tmp, and x().

{
  auto gd = GetDetector(id);
  CLHEP::Hep3Vector tmp = gd->rotation() * r;
  tmp.setX(tmp.x() + (gd->translation()).x());
  tmp.setY(tmp.y() + (gd->translation()).y());
  tmp.setZ(tmp.z() + (gd->translation()).z());
  return tmp;
}

CLHEP::Hep3Vector TotemRPGeometry::LocalToGlobalDirection	(	unsigned int	id,
		const CLHEP::Hep3Vector &	dir
	)		const

direction transformations between local<–>global reference frames (dimensions in mm), raw ID expected

Definition at line 250 of file TotemRPGeometry.cc.

References dir.

Referenced by TotemRPDQMSource::analyze(), endRP(), and TotemRPLocalTrackFitterAlgorithm::prepareReconstAlgebraData().

{
  return GetDetector(id)->rotation() * dir;
}

unsigned int TotemRPGeometry::NumberOfDetsIncluded ( ) const

inline

Definition at line 163 of file TotemRPGeometry.h.

References theMap.

    {
      return theMap.size();
    }

DetGeomDesc const* TotemRPGeometry::operator[] ( unsigned int  id ) const

inline

same as GetDetector

Definition at line 80 of file TotemRPGeometry.h.

References GetDetector(), GetDetEdgeNormalVector(), GetDetEdgePosition(), GetRPDevice(), GetRPThinFoilNormalVector(), and GetRPThinFoilPosition().

    {
      return GetDetector(id);
    }

std::set< unsigned int > const & TotemRPGeometry::RPsInStation

(

unsigned int

id

)

const

after checks returns set of RP corresponding to the given station ID

Definition at line 184 of file TotemRPGeometry.cc.

Referenced by endRP().

{
  mapSetType::const_iterator it = rpsInStation.find(id);
  if (it == rpsInStation.end())
    throw cms::Exception("TotemRPGeometry") << "Station with ID " << id << " not found.";
  return (*it).second;
}

std::set< unsigned int > const & TotemRPGeometry::StationsInArm

(

unsigned int

id

)

const

after checks returns set of stations corresponding to the given arm ID

Definition at line 174 of file TotemRPGeometry.cc.

Referenced by endRP().

{
  mapSetType::const_iterator it = stationsInArm.find(id);
  if (it == stationsInArm.end())
    throw cms::Exception("TotemRPGeometry") << "Arm with ID " << id << " not found.";
  return (*it).second;
}

Member Data Documentation

mapSetType TotemRPGeometry::detsInRP

protected

Definition at line 174 of file TotemRPGeometry.h.

mapSetType TotemRPGeometry::rpsInStation

protected

Definition at line 174 of file TotemRPGeometry.h.

mapSetType TotemRPGeometry::stationsInArm

protected

map: parent ID -> set of subelements E.g. stationsInArm is map of arm ID -> set of stations (in that arm)

Definition at line 174 of file TotemRPGeometry.h.

mapType TotemRPGeometry::theMap

protected

map: detectorID –> DetGeomDesc

Definition at line 169 of file TotemRPGeometry.h.

Referenced by beginDet(), endDet(), and NumberOfDetsIncluded().

RPDeviceMapType TotemRPGeometry::theRomanPotMap

protected

map: RPID –> DetGeomDesc

Definition at line 170 of file TotemRPGeometry.h.

Referenced by beginRP(), and endRP().