geo::Geometry Class Reference

The geometry of one entire detector (near, far, ipnd). More...

#include <Geometry.h>

List of all members.

Public Member Functions
	~Geometry ()
const PlaneGeo &	Plane (unsigned int i) const
const std::set< unsigned int > &	GetPlanesByView (View_t v=kXorY) const
const unsigned int	NextPlaneInView (unsigned int p, int d=+1) const
const unsigned int	NextPlaneOtherView (unsigned int p, int d=+1) const
const CellGeo &	IdToCell (const CellUniqueId &id, int *iplane=0, int *icell=0) const
double	DetHalfWidth () const
double	DetHalfHeight () const
double	DetLength () const
double	SurfaceY () const
void	WorldBox (double *xlo, double *xhi, double *ylo, double *yhi, double *zlo, double *zhi) const
int	CurrentCell (int *ip, int *ic) const
const CellUniqueId	CurrentCellId () const
const TGeoMaterial *	Material (double x, double y, double z) const
Static Public Member Functions
Geometry &	Instance (int runnum, short detId)
Private Types
typedef std::pair< unsigned short, unsigned short >	PlaneCellPair
typedef std::map< CellUniqueId, PlaneCellPair >	UIDMap
Private Member Functions
	Geometry (const char *gdmlfile)
void	FindPlanes (std::vector< const TGeoNode * > &n, unsigned int depth)
void	MakePlane (std::vector< const TGeoNode * > &n, unsigned int depth)
void	SetDrawOptions ()
void	BuildMaps ()
void	SetDetectorSize ()
Private Attributes
int	fRunNumber
	Run number of configuration.
int	fDetId
	Id number of detector geometry.
std::vector< PlaneGeo * >	fPlanes
	The detector planes.
UIDMap	fIdMap
	Unique ID -> Plane,Cell.
std::set< unsigned int >	fAllPlanes
	List of all planes.
std::set< unsigned int >	fXplanes
	List of X measuring planes.
std::set< unsigned int >	fYplanes
	List of Y measuring planes.
double	fDetLength
	Detector 1/2 length (cm).
double	fDetHalfHeight
	Detector 1/2 height (cm).
double	fDetHalfWidth
	Detector 1/2 width (cm).
Static Private Attributes
Geometry *	fInstance = 0
	Instance of geometry.

---

Detailed Description

The geometry of one entire detector (near, far, ipnd).

Definition at line 29 of file Geometry.h.

---

Member Typedef Documentation

typedef std::pair<unsigned short, unsigned short> geo::Geometry::PlaneCellPair [private]

Definition at line 68 of file Geometry.h. Referenced by BuildMaps().

typedef std::map<CellUniqueId, PlaneCellPair> geo::Geometry::UIDMap [private]

Definition at line 69 of file Geometry.h.

---

Constructor & Destructor Documentation

Geometry::~Geometry (   )

Definition at line 130 of file Geometry.cxx. References fPlanes. { for (unsigned int i=0; i<fPlanes.size(); ++i) { if (fPlanes[i]) { delete fPlanes[i]; fPlanes[i] = 0; } } }

Geometry::Geometry (  const char *  gdmlfile  )  [private]

Definition at line 83 of file Geometry.cxx. References BuildMaps(), FindPlanes(), fPlanes, plane_sort(), SetDetectorSize(), and SetDrawOptions(). Referenced by Instance(). { std::string fname; // Test if the gdml file can be openned using exactly the name we've // been passed while (1) { struct stat sb; fname = gdmlfile; if (stat(fname.c_str(), &sb)==0) break; const char* srt_private = getenv("SRT_PRIVATE_CONTEXT"); if (srt_private!=0) { fname = srt_private; fname += "/Geometry/gdml/"; fname += gdmlfile; if (stat(fname.c_str(), &sb)==0) break; } const char* srt_public = getenv("SRT_PUBLIC_CONTEXT"); if (srt_public!=0) { fname = srt_public; fname += "/Geometry/gdml/"; fname += gdmlfile; if (stat(fname.c_str(), &sb)==0) break; } // Failed to resolve the file name throw Exception(__FILE__, __LINE__, Exception::FILE_NOT_FOUND, "GDML file not found."); } // Open the GDML file TGeoManager::Import(fname.c_str()); this->SetDrawOptions(); std::vector<const TGeoNode*> n(16); n[0] = gGeoManager->GetTopNode(); this->FindPlanes(n, 0); sort(fPlanes.begin(), fPlanes.end(), plane_sort); this->SetDetectorSize(); this->BuildMaps(); }

---

Member Function Documentation

void Geometry::BuildMaps (   )  [private]

Build maps used for quick access to the geometry Definition at line 410 of file Geometry.cxx. References geo::PlaneGeo::Cell(), fAllPlanes, fIdMap, fPlanes, fXplanes, fYplanes, geo::CellGeo::Id(), geo::kX, geo::kY, geo::PlaneGeo::Ncells(), Plane(), and PlaneCellPair. Referenced by Geometry(). { // Sets which list planes by view for (unsigned int i=0; i<fPlanes.size(); ++i) { fAllPlanes.insert(i); if (fPlanes[i]->View()==kX) fXplanes.insert(i); else if (fPlanes[i]->View()==kY) fYplanes.insert(i); else { throw Exception(__FILE__,__LINE__,Exception::BAD_GEO_CONFIG, "Bad plane view!"); } } // Unique Id -> cell map for (unsigned int i=0; i<fPlanes.size(); ++i) { const PlaneGeo* p = fPlanes[i]; for (int j=0; j<p->Ncells(); ++j) { // Assert that the cell ids are in fact unique if (fIdMap.find(this->Plane(i).Cell(j).Id())!=fIdMap.end()) { throw Exception(__FILE__,__LINE__,Exception::BAD_CELL_UNIQUE_ID, "Duplicate Cell UIDs"); } PlaneCellPair p(i,j); fIdMap[this->Plane(i).Cell(j).Id()] = p; } } }

int Geometry::CurrentCell (  int *  planeid, int *  cellid )  const

Return the plane and cell number for the current tracking position held by the gGeoManager Parameters: planeid  : pointer to plane number, >=0 on success, -1 on failure cellid  : pointer to cell number, >=0 on success, -1 on failure Returns: >0 if cell is found, <0 if not found. Definition at line 146 of file Geometry.cxx. References IdToCell(). Referenced by testFindCell(). { try { this->IdToCell(this->CurrentCellId(), planeid, cellid); } catch (Exception e) { *planeid = -1; *cellid = -1; return -1; } return 1; }

const CellUniqueId Geometry::CurrentCellId (   )  const

Return the unique cell Id# (well, #'s) for the current cell Definition at line 163 of file Geometry.cxx. References geo::CellUniqueId, and geo::PathToUniqueId(). { return PathToUniqueId(gGeoManager->GetPath()); }

double Geometry::DetHalfHeight (   )  const

Definition at line 185 of file Geometry.cxx. References fDetHalfHeight. Referenced by evd::Display3D::Draw(), and main(). { return fDetHalfHeight; }

double Geometry::DetHalfWidth (   )  const

Definition at line 178 of file Geometry.cxx. Referenced by evd::Display3D::Draw(), and main(). { return fDetHalfWidth; }

double Geometry::DetLength (   )  const

Definition at line 192 of file Geometry.cxx. References fDetLength. Referenced by mcchk::CosmicAna::Ana(), evd::Display3D::Draw(), main(), and evgen::CRYGen::Sample(). { return fDetLength; }

void Geometry::FindPlanes (  std::vector< const TGeoNode * > &  n, unsigned int  depth )  [private]

Recursively search for planes in the geometry Parameters: n  - Array holding the path of nodes tranversed depth  - Depth of the search to this point Exceptions: geo::Exception  is maximum depth is exceeded. Definition at line 267 of file Geometry.cxx. References MakePlane(). Referenced by Geometry(). { const char* nm = n[depth]->GetName(); if (strncmp(nm,"vPlane", 6)==0) { this->MakePlane(n, depth); return; } // Explore the next layer down unsigned int deeper = depth+1; if (deeper>=n.size()) { throw Exception(__FILE__,__LINE__,Exception::BAD_NODE, "Exceeded maximum depth."); } const TGeoVolume* v = n[depth]->GetVolume(); int nd = v->GetNdaughters(); for (int i=0; i<nd; ++i) { n[deeper] = v->GetNode(i); this->FindPlanes(n, deeper); } }

const std::set< unsigned int > & Geometry::GetPlanesByView (  View_t  v = kXorY  )  const

Return list of planes which measure the requested projection Parameters: v  : X/Y or All (see View_t typedef in PlaneGeo.h) Returns: : a set of plane indicies satifying the request Exceptions: :  geo::Exception if initialization fails Definition at line 347 of file Geometry.cxx. References fAllPlanes, fXplanes, fYplanes, geo::kX, geo::kY, and geo::View_t. Referenced by subshower::RecoSubShower::FindMaxWindow(), and testFindPlanes(). { // Return the user's choice, fall back on all planes if (v==kX) return fXplanes; else if (v==kY) return fYplanes; return fAllPlanes; }

const CellGeo & Geometry::IdToCell (  const CellUniqueId &  id, int *  iplane = 0, int *  icell = 0 )  const

Given a unique cell identifier, look up the plane and cell numbers. Parameters: id  : Cell identifier iplane  : optional, pointer to return plane number icell  : optional, pointer to return cell number Returns: cell geometry description Exceptions: geo::Exception  if id is not found Definition at line 327 of file Geometry.cxx. References geo::PlaneGeo::Cell(), geo::CellUniqueId, fIdMap, and Plane(). Referenced by CurrentCell(), novamc::MCApplication::Stepping(), and testUniqueId(). { UIDMap::const_iterator itr = fIdMap.find(id); if (itr == fIdMap.end()) { throw Exception(__FILE__,__LINE__,Exception::BAD_CELL_UNIQUE_ID); } *iplane = itr->second.first; *icell = itr->second.second; return this->Plane(*iplane).Cell(*icell); }

Geometry & Geometry::Instance (  int  runnum, short  detId )  [static]

Build a detector geometry Parameters: runnum  : Run number to configure geometry for detId  : Detector ID (0=near, 1=far, 2=ipnd) Exceptions: geo::Exception  if requested detector/run combination cannot be satisfied Definition at line 48 of file Geometry.cxx. References fDetId, fInstance, fRunNumber, and Geometry(). Referenced by mcchk::CosmicAna::Ana(), evd::Display3D::Draw(), evd::DetectorView::Draw(), evd::PlaneView::DrawMCHits(), evd::Display3D::DrawMCHits(), evd::PlaneView::DrawPlaneClusters(), evd::Display3D::DrawRawData(), evd::PlaneView::DrawRawDigit(), evd::PlaneView::DrawShowers(), evd::PlaneView::DrawTrackCandidates(), evd::PlaneView::DrawTracks(), subshower::RecoSubShower::FormStripList(), main(), novamc::MCApplication::MCApplication(), calhit::CalHit::Raw(), rpr::TrackReco::Reco(), spider::SpiderWeb::Reco(), photrans::SimpleTransport::Reco(), subshower::RecoSubShower::Reco(), rpr::FindTrackSeg::Reco(), cluster::Clusterer::Reco(), and rsim::Simulator::SetGeom(). { // If our current geometry doesn't match request, get rid of it if (fInstance!=0) { if (fInstance->fRunNumber != runnum || fInstance->fDetId != detId) { delete fInstance; fInstance = 0; gGeoManager->Clear(); } } // Build a new geometry if we need to if (fInstance==0) { static char* fname[3] = {"neardet.gdml","fardet.gdml","ipnddet.gdml"}; if (detId!=rawdata::kNear && detId!=rawdata::kFar && detId!=rawdata::kIPND) { char msg[256]; sprintf(msg,"Unknown detector id number: %d",(int)detId); throw Exception(__FILE__,__LINE__,Exception::BAD_GEO_CONFIG,msg); } if (runnum<0) { char msg[256]; std::sprintf(msg,"Bad run number: %d",runnum); throw Exception(__FILE__,__LINE__,Exception::BAD_GEO_CONFIG,msg); } fInstance = new Geometry(fname[detId]); fInstance->fDetId = detId; fInstance->fRunNumber = runnum; } return *fInstance; }

void Geometry::MakePlane (  std::vector< const TGeoNode * > &  n, unsigned int  depth )  [private]

Definition at line 292 of file Geometry.cxx. References fPlanes. Referenced by FindPlanes(). { fPlanes.push_back(new PlaneGeo(n, depth)); }

const TGeoMaterial * Geometry::Material (  double  x, double  y, double  z )  const

Definition at line 170 of file Geometry.cxx. Referenced by proto_evgen::TargetVolume::RandomVertex(). { const TGeoNode* node = gGeoManager->FindNode(x,y,z); return node->GetMedium()->GetMaterial(); }

const unsigned int Geometry::NextPlaneInView (  unsigned int  p1, int  d = +1 )  const

Return the index of the next plane in a particular view Parameters: p1  : Index of current plane d  : Direction to step in (>0 next down stream, <0 upstream) Returns: Index of next plane in same view. If no plane can be found (eg. reach end of detector) return kPLANE_NOT_FOUND. Exceptions: :  Asserts that p1 is in valid range Definition at line 366 of file Geometry.cxx. References fPlanes, and geo::kPLANE_NOT_FOUND. Referenced by subshower::RecoSubShower::LinkedBlobs(), testFindPlanes(), and subshower::RecoSubShower::TransCluster(). { assert(p1<fPlanes.size()); // March along from p1 in the direction d until we find a match int s = (d>0 ? 1 : -1); if (s<0 && p1==0) return kPLANE_NOT_FOUND; if (s>0 && p1==fPlanes.size()-1) return kPLANE_NOT_FOUND; for (unsigned int p2=p1+d; 1; p2+=s) { if (fPlanes[p1]->View() == fPlanes[p2]->View()) return p2; if (p2==fPlanes.size()-1) return kPLANE_NOT_FOUND; if (p2==0) return kPLANE_NOT_FOUND; } }

const unsigned int Geometry::NextPlaneOtherView (  unsigned int  p1, int  d = +1 )  const

Return the index of the next plane in a particular view Parameters: p1  : Index of current plane d  : Direction to step in (>0 next down stream, <0 upstream) Returns: index of next plane in same view. Exceptions: :  Asserts that p1 is in valid range Definition at line 391 of file Geometry.cxx. References fPlanes, and geo::kPLANE_NOT_FOUND. Referenced by testFindPlanes(). { assert(p1<fPlanes.size()); // March along from p1 in the direction d until we find a match int s = (d>0 ? 1 : -1); if (s<0 && p1==0) return kPLANE_NOT_FOUND; if (s>0 && p1==fPlanes.size()-1) return kPLANE_NOT_FOUND; for (unsigned int p2=p1+d; 1; p2+=s) { if (fPlanes[p1]->View() != fPlanes[p2]->View()) return p2; if (p2==fPlanes.size()) return kPLANE_NOT_FOUND; if (p2==0) return kPLANE_NOT_FOUND; } }

const PlaneGeo & Geometry::Plane (  unsigned int  i  )  const

Return the geometry description of the ith plane in the detector. Parameters: i  : input plane number, starting from 0 Returns: plane geometry for ith plane Exceptions: geo::Exception  if iplane is outside allowed range Definition at line 307 of file Geometry.cxx. References fPlanes. Referenced by spider::Filament::AddHit(), subshower::RecoSubShower::BestHough(), BuildMaps(), rpr::TrackReco::CalcChi2Ndof(), subshower::RecoSubShower::CalculateEnergyVertexAngle(), rpr::TrackReco::Connection(), evd::PlaneView::DrawMCHits(), evd::Display3D::DrawMCHits(), evd::PlaneView::DrawPlaneClusters(), evd::Display3D::DrawRawData(), evd::PlaneView::DrawRawDigit(), evd::PlaneView::DrawShowers(), evd::PlaneView::DrawTrackCandidates(), spider::Filament::FitDist(), subshower::RecoSubShower::HoughTransCluster(), IdToCell(), main(), calhit::CalHit::Raw(), rpr::TrackReco::Reco(), spider::SpiderWeb::Reco(), rpr::FindTrackSeg::Reco(), SetDetectorSize(), testCellPos(), testFindCell(), testFindPlanes(), testStepping(), testUniqueId(), subshower::RecoSubShower::TransCluster(), spider::Filament::Update(), and cluster::Clusterer::UpdatePlaneClusterStat(). { if (i>=fPlanes.size()) throw Exception(__FILE__,__LINE__, Exception::BAD_PLANE_NUMBER, "Plane index out of range"); return *fPlanes[i]; }

void Geometry::SetDetectorSize (   )  [private]

Calcualte the detector size based on the geomtry. Requires a little bit of work, so do this once when the geometry is updated Definition at line 444 of file Geometry.cxx. References geo::PlaneGeo::Cell(), fDetHalfHeight, fDetHalfWidth, fDetLength, fPlanes, geo::CellGeo::GetCenter(), and Plane(). Referenced by Geometry(). { double dummy; // Compute the height and width based on the sizes of the vertical // and horizontal planes. Remember, in the local plane frame z goes // along the length of the modules. Hence the use of axis=3 to get // the detector height (from the vertical planes) and width (from // the horizontal planes). const TGeoShape* vp = gGeoManager->GetVolume("vPlaneV")->GetShape(); const TGeoShape* hp = gGeoManager->GetVolume("vPlaneH")->GetShape(); vp->GetAxisRange(3,dummy,fDetHalfHeight); hp->GetAxisRange(3,dummy,fDetHalfWidth); // Remember -- in the local plane coordinate frame, the "depth" is // along y, hence axis=2. In the world coordinate this is along z. double vplanez1, vplanez2; vp->GetAxisRange(2,vplanez1,vplanez2); // Compute the detector length based on the center positions of // cells in the first and last plane. Adjust to account for the // plane widths. This ajustment works if the vertical and horizontal // planes have the same depth, or if the detector begins and ends // with vertical planes. As of the TDR both of these conditions was // true for all the NOvA detectors. double xyz1[3] = {0,0,0}; double xyz2[3] = {0,0,0}; this->Plane(0). Cell(0).GetCenter(xyz1); this->Plane(fPlanes.size()-1).Cell(0).GetCenter(xyz2); fDetLength = (xyz2[2]-xyz1[2])+(vplanez2-vplanez1); }

void Geometry::SetDrawOptions (   )  [private]

Definition at line 256 of file Geometry.cxx. Referenced by Geometry(). { }

double Geometry::SurfaceY (   )  const

A typical y-position value at the surface (where earth meets air) for this detector site Returns: typical y position at surface in units of cm Exceptions: geo::Exception  if detector ID is not set properly Todo: : Only far det number is reasonable accurate. Near and IPND need some thought Definition at line 210 of file Geometry.cxx. References fDetId. Referenced by evgen::CRYGen::Sample(). { switch (fDetId) { case 0: return 130.0E2; // near det: surface ~130m up from det. center case 1: return 9.94E2; // far det: surface ~10m up from det. center case 2: return -2.0E2; // IPND: surface ~2 meter below det, center default: throw Exception(__FILE__,__LINE__,Exception::BAD_GEO_CONFIG); } return 0.0; }

void Geometry::WorldBox (  double *  xlo, double *  xhi, double *  ylo, double *  yhi, double *  zlo, double *  zhi )  const

Return the ranges of x,y and z for the "world volume" that the entire geometry lives in. If any pointers are 0, then those coordinates are ignored. Parameters: xlo  : On return, lower bound on x positions xhi  : On return, upper bound on x positions ylo  : On return, lower bound on y positions yhi  : On return, upper bound on y positions zlo  : On return, lower bound on z positions zhi  : On return, upper bound on z positions Definition at line 233 of file Geometry.cxx. Referenced by evgen::CRYGen::Sample(), and testProject(). { const TGeoShape* s = gGeoManager->GetVolume("vWorld")->GetShape(); assert(s); if (xlo || xhi) { double x1, x2; s->GetAxisRange(1,x1,x2); if (xlo) *xlo = x1; if (xhi) *xhi = x2; } if (ylo || yhi) { double y1, y2; s->GetAxisRange(2,y1,y2); if (ylo) *ylo = y1; if (yhi) *yhi = y2; } if (zlo || zhi) { double z1, z2; s->GetAxisRange(3,z1,z2); if (zlo) *zlo = z1; if (zhi) *zhi = z2; } }

---

Member Data Documentation

std::set<unsigned int> geo::Geometry::fAllPlanes [private]

List of all planes. Definition at line 77 of file Geometry.h. Referenced by BuildMaps(), and GetPlanesByView().

double geo::Geometry::fDetHalfHeight [private]

Detector 1/2 height (cm). Definition at line 82 of file Geometry.h. Referenced by DetHalfHeight(), and SetDetectorSize().

double geo::Geometry::fDetHalfWidth [private]

Detector 1/2 width (cm). Definition at line 83 of file Geometry.h. Referenced by SetDetectorSize().

int geo::Geometry::fDetId [private]

Id number of detector geometry. Definition at line 73 of file Geometry.h. Referenced by Instance(), and SurfaceY().

double geo::Geometry::fDetLength [private]

Detector 1/2 length (cm). Definition at line 81 of file Geometry.h. Referenced by DetLength(), and SetDetectorSize().

UIDMap geo::Geometry::fIdMap [private]

Unique ID -> Plane,Cell. Definition at line 75 of file Geometry.h. Referenced by BuildMaps(), and IdToCell().

Geometry * Geometry::fInstance = 0 [static, private]

Instance of geometry. Definition at line 27 of file Geometry.cxx. Referenced by Instance().

std::vector<PlaneGeo*> geo::Geometry::fPlanes [private]

The detector planes. Definition at line 74 of file Geometry.h. Referenced by BuildMaps(), Geometry(), MakePlane(), NextPlaneInView(), NextPlaneOtherView(), Plane(), SetDetectorSize(), and ~Geometry().

int geo::Geometry::fRunNumber [private]

Run number of configuration. Definition at line 72 of file Geometry.h. Referenced by Instance().

std::set<unsigned int> geo::Geometry::fXplanes [private]

List of X measuring planes. Definition at line 78 of file Geometry.h. Referenced by BuildMaps(), and GetPlanesByView().

std::set<unsigned int> geo::Geometry::fYplanes [private]

List of Y measuring planes. Definition at line 79 of file Geometry.h. Referenced by BuildMaps(), and GetPlanesByView().

---

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

• Geometry.h
• Geometry.cxx

---