Description of the physical geometry of one entire detector. More...

#include "GeometryCore.h"

Inheritance diagram for geo::GeometryCore:

Public Types
using	CryostatList_t = std::vector< CryostatGeo >

Public Member Functions
	GeometryCore (fhicl::ParameterSet const &pset, std::unique_ptr< GeometryBuilder > builder, std::unique_ptr< GeoObjectSorter > sorter)
	Initialize geometry from a given configuration. More...

	GeometryCore (GeometryCore const &)=delete

	GeometryCore (GeometryCore &&)=delete

GeometryCore &	operator= (GeometryCore const &)=delete

GeometryCore &	operator= (GeometryCore &&)=delete

double	DefaultWiggle () const
	Returns the tolerance used in looking for positions. More...

std::string const &	GDMLFile () const
	Returns the full directory path to the GDML file source. More...

std::vector< TGeoNode const * >	FindAllVolumes (std::set< std::string > const &vol_names) const
	Returns all the nodes with volumes with any of the specified names. More...

std::vector< std::vector< TGeoNode const * > >	FindAllVolumePaths (std::set< std::string > const &vol_names) const
	Returns paths of all nodes with volumes with the specified names. More...

TGeoMaterial const *	Material (Point_t const &point) const
	Returns the material at the specified position. More...

template<typename Stream >
void	Print (Stream &&out, std::string indent=" ") const
	Prints geometry information with maximum verbosity. More...

std::string	Info (std::string indent=" ") const
	Returns a string with complete geometry information. More...

CryostatGeo const *	PositionToCryostatPtr (Point_t const &point) const
	Returns the cryostat at specified location. More...

CryostatID	PositionToCryostatID (Point_t const &point) const
	Returns the ID of the cryostat at specified location. More...

bool	HasTPC (TPCID const &tpcid) const
	Returns whether we have the specified TPC. More...

bool	HasElement (TPCID const &tpcid) const
	Returns whether we have the specified TPC. More...

TPCGeo const *	PositionToTPCptr (Point_t const &point) const
	Returns the TPC at specified location. More...

TPCID	PositionToTPCID (Point_t const &point) const
	Returns the ID of the TPC at specified location. More...

std::string	OpDetGeoName (CryostatID const &cid=details::cryostat_zero) const
	Returns gdml string which gives sensitive opdet name. More...

CryostatList_t const &	Cryostats () const noexcept

Detector information
std::string const &	DetectorName () const
	Returns a string with the name of the detector, as configured. More...

TGeoVolume const *	WorldVolume () const
	Returns a pointer to the world volume. More...

void	WorldBox (double xlo, double xhi, double ylo, double yhi, double zlo, double zhi) const
	Fills the arguments with the boundaries of the world. More...

BoxBoundedGeo	WorldBox () const

Length_t	SurfaceY () const
	The position of the detector respect to earth surface. More...

TGeoManager *	ROOTGeoManager () const
	Access to the ROOT geometry description manager. More...

std::string const &	GetWorldVolumeName () const
	Return the name of the world volume (needed by Geant4 simulation) More...

BoxBoundedGeo	DetectorEnclosureBox (std::string const &name="volDetEnclosure") const

std::string	VolumeName (Point_t const &point) const
	Returns the name of the deepest volume containing specified point. More...


std::string	MaterialName (Point_t const &point) const
	Name of the deepest material containing the point xyz. More...


double	TotalMass () const
	Returns the total mass [kg] of the specified volume (default: world). More...

double	TotalMass (std::string vol) const
	Returns the total mass [kg] of the specified volume (default: world). More...


double	MassBetweenPoints (Point_t const &p1, Point_t const &p2) const
	Returns the column density between two points. More...

Cryostat access and information
unsigned int	Ncryostats () const
	Returns the number of cryostats in the detector. More...

unsigned int	NElements () const
	Returns the number of cryostats in the detector. More...

unsigned int	NSiblingElements (CryostatID const &) const
	Returns the number of cryostats in the detector. More...


bool	HasCryostat (CryostatID const &cryoid) const
	Returns whether we have the specified cryostat. More...

bool	HasElement (CryostatID const &cryoid) const
	Returns whether we have the specified cryostat. More...


CryostatGeo const &	Cryostat (CryostatID const &cryoid=details::cryostat_zero) const
	Returns the specified cryostat. More...

CryostatGeo const &	GetElement (CryostatID const &cryoid) const
	Returns the specified cryostat. More...


CryostatGeo const *	CryostatPtr (CryostatID const &cryoid) const
	Returns the specified cryostat. More...

CryostatGeo const *	GetElementPtr (CryostatID const &cryoid) const
	Returns the specified cryostat. More...


CryostatGeo const &	PositionToCryostat (Point_t const &point) const
	Returns the cryostat at specified location. More...

TPC access and information
unsigned int	MaxTPCs () const
	Returns the largest number of TPCs a cryostat in the detector has. More...

unsigned int	TotalNTPC () const
	Returns the total number of TPCs in the detector. More...

unsigned int	NTPC (CryostatID const &cryoid=details::cryostat_zero) const
	Returns the total number of TPCs in the specified cryostat. More...

unsigned int	NElements (CryostatID const &cryoid) const
	Returns the largest number of TPCs a cryostat in the detector has. More...

unsigned int	NSiblingElements (TPCID const &tpcid) const
	Returns the largest number of TPCs a cryostat in the detector has. More...


TPCGeo const &	TPC (TPCID const &tpcid=details::tpc_zero) const
	Returns the specified TPC. More...

TPCGeo const &	GetElement (TPCID const &tpcid) const
	Returns the specified TPC. More...


TPCGeo const *	TPCPtr (TPCID const &tpcid) const
	Returns the specified TPC. More...

TPCGeo const *	GetElementPtr (TPCID const &tpcid) const
	Returns the specified TPC. More...


TPCID	FindTPCAtPosition (Point_t const &point) const
	Returns the ID of the TPC at specified location. More...


TPCGeo const &	PositionToTPC (Point_t const &point) const
	Returns the TPC at specified location. More...

Optical detector geometry access and information
See also optical detector channel information There are a number of ways to identify an optical detector or channel: geometric: cryostat (e.g. `geo::CryostatID`) and relative optical detector number within it unique optical detector number readout: optical detector channel "hardware" channel And they all should be better documented!
unsigned int	NOpDets () const
	Number of OpDets in the whole detector. More...

OpDetGeo const &	OpDetGeoFromOpDet (unsigned int OpDet) const
	Returns the `geo::OpDetGeo` object for the given detector number. More...

unsigned int	GetClosestOpDet (Point_t const &point) const
	Find the nearest OpChannel to some point. More...

Optical readout channels
See also optical detector geometry information
unsigned int	OpDetFromCryo (unsigned int o, unsigned int c) const
	Get unique opdet number from cryo and internal count. More...

Private Types
using	Iteration = Iterable< details::GeometryIterationPolicy, details::ToGeometryElement >

using	range_type = details::RangeType< iterator_type< T >, id_sentinel_for< T >>

Private Member Functions
void	LoadGeometryFile ()

void	SortGeometry ()

std::vector< GeoNodePathEntry >	FindDetectorEnclosure (std::string const &name="volDetEnclosure") const

bool	FindFirstVolume (std::string const &name, std::vector< GeoNodePathEntry > &path) const

void	BuildGeometry ()
	Parses ROOT geometry nodes and builds LArSoft geometry representation. More...

iterator_type< T >	begin () const

iterator_type< T >	begin (BaseID const &id) const

id_sentinel_for< T >	end () const

id_sentinel_for< T >	end (BaseID const &id) const

range_type< T >	Iterate () const

range_type< T >	Iterate (ID const &id) const

Private Attributes
CryostatList_t	fCryostats {}

std::unique_ptr< GeometryBuilder >	fBuilder

std::unique_ptr< GeoObjectSorter >	fSorter

TGeoManager *	fManager {nullptr}

std::string	fGDMLfile
	path to geometry file used for Geant4 simulation More...

std::string	fDetectorName
	Name of the detector. More...

double	fSurfaceY
	The point where air meets earth for this detector. More...

double	fPositionWiggle
	accounting for rounding errors when testing positions More...

Detailed Description

Description of the physical geometry of one entire detector.

Note: All lengths are specified in centimeters

GeometryCore construction

The constructor of GeometryCore performs two steps:

It initializes a GeometryCore object (the "service provider") with the configuration parameters, a user-provided geometry builder, and a user-provided geometry sorter.
It loads the geometry with GeometryCore::LoadGeometryFile(), which: a. imports the GDML file into ROOT's TGeo* system b. builds all LArSoft geometry constructs using ROOT's geometry system according to the user-provided builder c. sorts all LArSoft geometry constructs according to the provided sorter.

Configuration parameters

GDML (string; mandatory): string identifying GDML file that represents the detector goemetry.
RelativePath (string; default: (empty)): string identifying path of GDML file relative to any paths on the FW_SEARCH_PATH environment variable.
Name (string; default: stem of GDML file): string identifying the detector; it can be different from the base name of the file used to initialize the geometry; standard names are recommended by each experiment.
SurfaceY (real; mandatory): depth of the detector, in centimeters; see SurfaceY() for details
PositionEpsilon (real; default: 0.01%) set the default tolerance (see DefaultWiggle())

Definition at line 91 of file GeometryCore.h.

Member Typedef Documentation

using geo::GeometryCore::CryostatList_t = std::vector<CryostatGeo>

Definition at line 95 of file GeometryCore.h.

using geo::GeometryCore::Iteration = Iterable<details::GeometryIterationPolicy, details::ToGeometryElement>

private

Definition at line 92 of file GeometryCore.h.

using geo::Iterable< details::GeometryIterationPolicy , details::ToGeometryElement >::range_type = details::RangeType<iterator_type<T>, id_sentinel_for<T>>

inherited

Definition at line 118 of file Iterable.h.

Constructor & Destructor Documentation

geo::GeometryCore::GeometryCore	(	fhicl::ParameterSet const &	pset,
		std::unique_ptr< GeometryBuilder >	builder,
		std::unique_ptr< GeoObjectSorter >	sorter
	)

Initialize geometry from a given configuration.

Parameters

pset	configuration parameters
builder	builder for LArSoft's geometry constructs
sorter	sorter for LArSoft's geometry constructs, applied after building is complete

Definition at line 50 of file GeometryCore.cxx.

References fBuilder, fDetectorName, fGDMLfile, fPositionWiggle, fSorter, fSurfaceY, LoadGeometryFile(), geo::details::maybe_default_detector_name(), and lar::searchPathPlusRelative().

     : Iteration{details::GeometryIterationPolicy{this}, details::ToGeometryElement{this}}
     , fBuilder{std::move(builder)}
     , fSorter{std::move(sorter)}
     , fGDMLfile{lar::searchPathPlusRelative(pset.get<std::string>("RelativePath", ""),
                                             pset.get<std::string>("GDML"))}
     , fDetectorName{details::maybe_default_detector_name(pset, fGDMLfile)}
     , fSurfaceY(pset.get<double>("SurfaceY"))
     , fPositionWiggle(pset.get<double>("PositionEpsilon", 1.e-4))
   {
     std::transform(fDetectorName.begin(), fDetectorName.end(), fDetectorName.begin(), [](auto c) {
       return std::tolower(c);
     });
 
     LoadGeometryFile();
   }

geo::GeometryCore::GeometryCore ( GeometryCore const & )

delete

geo::GeometryCore::GeometryCore ( GeometryCore && )

delete

Member Function Documentation

iterator_type<T> geo::Iterable< details::GeometryIterationPolicy , details::ToGeometryElement >::begin ( ) const

inlineinherited

Definition at line 72 of file Iterable.h.

Referenced by GetElementPtr().

     {
       using namespace details;
       using ID = typename IDIteratorValueType<T>::type;
       auto const iterator = iterator_for(ID::first(), fPolicy);
       if constexpr (std::is_base_of<CryostatID, T>{}) { return iterator; }
       else {
         static_assert(!std::is_same_v<Transform, void_tag>);
         return fTransform.template transform<T>(iterator);
       }
     }

iterator_type<T> geo::Iterable< details::GeometryIterationPolicy , details::ToGeometryElement >::begin ( BaseID const & id ) const

inlineinherited

Definition at line 85 of file Iterable.h.

     {
       using namespace details;
       using ID = typename IDIteratorValueType<T>::type;
       static_assert(is_base_of_strict<BaseID, ID>);
       auto const iterator = iterator_for(ID::first(id), fPolicy);
       if constexpr (std::is_base_of<CryostatID, T>{}) { return iterator; }
       else {
         static_assert(!std::is_same_v<Transform, void_tag>);
         return fTransform.template transform<T>(iterator);
       }
     }

void geo::GeometryCore::BuildGeometry ( )

private

Parses ROOT geometry nodes and builds LArSoft geometry representation.

Definition at line 527 of file GeometryCore.cxx.

References fBuilder, and fCryostats.

Referenced by LoadGeometryFile().

   {
     GeoNodePath path{gGeoManager->GetTopNode()};
     fCryostats = fBuilder->extractCryostats(path);
   }

CryostatGeo const & geo::GeometryCore::Cryostat ( CryostatID const & cryoid = details::cryostat_zero ) const

Returns the specified cryostat.

Parameters

cryoid cryostat ID

Returns: a constant reference to the specified cryostat

Exceptions

cet::exception (GeometryCore category) if cryostat not present

The GetElement() method is overloaded and its return depends on the type of ID.

Todo:: Make the cryostat number mandatory (as CryostatID)

Definition at line 150 of file GeometryCore.cxx.

References geo::CryostatID::Cryostat, and CryostatPtr().

Referenced by phot::PDFastSimANN::beginJob(), opdet::SimPhotonCounter::beginJob(), larg4::LArG4::beginJob(), evgen::PhotonGen::beginRun(), larg4::LArVoxelReadoutGeometry::Construct(), detinfo::DetectorPropertiesStandard::DataFor(), cosmic::BeamFlashTrackMatchTaggerAlg::FillFlashProperties(), opdet::FlashHypothesisAnaAlg::FillOpDetPositions(), simfilter::FilterNoDirtNeutrinos::filter(), GetElement(), HasElement(), trkf::SpacePointAlg::makeSpacePoints(), OpDetFromCryo(), OpDetGeoFromOpDet(), evgen::PhotonGen::PhotonGen(), larg4::LArG4::produce(), phot::PhotonVisibilityService::reconfigure(), and TPC().

   {
     if (auto pCryo = CryostatPtr(cryoid)) { return *pCryo; }
     throw cet::exception("GeometryCore") << "Cryostat #" << cryoid.Cryostat << " does not exist\n";
   }

CryostatGeo const* geo::GeometryCore::CryostatPtr ( CryostatID const & cryoid ) const

inline

Returns the specified cryostat.

Parameters

cryoid cryostat ID

Returns: a constant pointer to the specified cryostat, or nullptr if none

The GetElementPtr() method is overloaded and its return depends on the type of ID.

Definition at line 345 of file GeometryCore.h.

References geo::CryostatID::Cryostat, fCryostats, and HasCryostat().

Referenced by Cryostat(), GetElementPtr(), HasTPC(), and TPCPtr().

     {
       return HasCryostat(cryoid) ? &fCryostats[cryoid.Cryostat] : nullptr;
     }

CryostatList_t const& geo::GeometryCore::Cryostats ( ) const

inlinenoexcept

Definition at line 599 of file GeometryCore.h.

References fCryostats, LoadGeometryFile(), and SortGeometry().

599 { return fCryostats; }

geo::GeometryCore::fCryostats

CryostatList_t fCryostats

Definition: GeometryCore.h:605

double geo::GeometryCore::DefaultWiggle ( ) const

inline

Returns the tolerance used in looking for positions.

Returns: the tolerance value

This parameter is used as tolerance ("wiggle") for methods that require it (e.g. geo::CryostatGeo::FindTPCAtPosition()). Typically, it's a additional fraction of tolerance: 0 means no tolerance, 0.1 means 10% tolerance.

Todo:: Confirm the definition of wiggle: this one is taken from other doc

Definition at line 121 of file GeometryCore.h.

References fPositionWiggle.

121 { return fPositionWiggle; }

geo::GeometryCore::fPositionWiggle

double fPositionWiggle

accounting for rounding errors when testing positions

Definition: GeometryCore.h:614

BoxBoundedGeo geo::GeometryCore::DetectorEnclosureBox ( std::string const & name = "volDetEnclosure" ) const

Returns the absolute coordinates of the detector enclosure volume [cm].

Parameters

name	name of the volume to be sought (default: `volDetEnclosure`)

Exceptions

cet::exception if the specified volume is not found

Definition at line 221 of file GeometryCore.cxx.

References FindDetectorEnclosure(), and geo::LocalTransformation< StoredMatrix >::LocalToWorld().

Referenced by geo::WireReadoutDumper::dumpDetectorInfo(), Print(), and SurfaceY().

   {
     auto const& path = FindDetectorEnclosure(name);
     if (path.empty()) {
       throw cet::exception("GeometryCore")
         << "DetectorEnclosureBox(): can't find enclosure volume '" << name << "'\n";
     }
 
     TGeoVolume const* pEncl = path.back().node->GetVolume();
     auto const* pBox = dynamic_cast<TGeoBBox const*>(pEncl->GetShape());
 
     // check that this is indeed a box
     if (!pBox) {
       // at initialisation time we don't know yet our real ID
       throw cet::exception("GeometryCore")
         << "Detector enclosure '" << name << "' is not a box! (it is a "
         << pEncl->GetShape()->IsA()->GetName() << ")\n";
     }
 
     LocalTransformation<TGeoHMatrix> trans(path, path.size() - 1);
     // get the half width, height, etc of the cryostat
     double const halfwidth = pBox->GetDX();
     double const halfheight = pBox->GetDY();
     double const halflength = pBox->GetDZ();
 
     return {trans.LocalToWorld(Point_t{-halfwidth, -halfheight, -halflength}),
             trans.LocalToWorld(Point_t{+halfwidth, +halfheight, +halflength})};
   }

std::string const& geo::GeometryCore::DetectorName ( ) const

inline

Returns a string with the name of the detector, as configured.

Definition at line 140 of file GeometryCore.h.

References fDetectorName, WorldBox(), and WorldVolume().

140 { return fDetectorName; }

geo::GeometryCore::fDetectorName

std::string fDetectorName

Name of the detector.

Definition: GeometryCore.h:612

id_sentinel_for<T> geo::Iterable< details::GeometryIterationPolicy , details::ToGeometryElement >::end ( void ) const

inlineinherited

Definition at line 99 of file Iterable.h.

Referenced by GetElementPtr().

     {
       using namespace details;
       using ID = typename IDIteratorValueType<T>::type;
       static_assert(std::is_base_of<CryostatID, ID>{});
       return {fPolicy.template GetEndID<ID>()};
     }

id_sentinel_for<T> geo::Iterable< details::GeometryIterationPolicy , details::ToGeometryElement >::end ( BaseID const & id ) const

inlineinherited

Definition at line 108 of file Iterable.h.

     {
       using namespace details;
       using ID = typename IDIteratorValueType<T>::type;
       static_assert(std::is_base_of<CryostatID, ID>{});
       static_assert(is_base_of_strict<BaseID, ID>);
       return {fPolicy.template GetEndID<ID>(id)};
     }

std::vector< std::vector< TGeoNode const * > > geo::GeometryCore::FindAllVolumePaths ( std::set< std::string > const & vol_names ) const

Returns paths of all nodes with volumes with the specified names.

Parameters

vol_names list of names of volumes

Returns: list paths of the found nodes

All the nodes in the geometry are checked, and the path of all the ones that contain a volume with a name among the ones specified in vol_names is saved in the collection and returned.

A node path is a ordered list of all nodes leading to the final one, starting from thetop level (root) down. The node at the back() of the path is the one with name in vol_names. No empty paths are returned.

Definition at line 363 of file GeometryCore.cxx.

References geo::CollectPathsByName::paths, and ROOTGeoManager().

Referenced by SurfaceY().

   {
     CollectPathsByName path_collector(vol_names);
 
     ROOTGeoNodeForwardIterator iNode(ROOTGeoManager()->GetTopNode());
 
     while (*iNode) {
       path_collector(iNode);
       ++iNode;
     }
 
     return path_collector.paths;
   }

std::vector< TGeoNode const * > geo::GeometryCore::FindAllVolumes ( std::set< std::string > const & vol_names ) const

Returns all the nodes with volumes with any of the specified names.

Parameters

vol_names list of names of volumes

Returns: list of nodes found

All the nodes in the geometry are checked, and all the ones that contain a volume with a name among the ones specified in vol_names are saved in the collection and returned.

Definition at line 346 of file GeometryCore.cxx.

References geo::CollectNodesByName::nodes, and ROOTGeoManager().

Referenced by SurfaceY().

   {
     CollectNodesByName node_collector(vol_names);
 
     ROOTGeoNodeForwardIterator iNode{ROOTGeoManager()->GetTopNode()};
     TGeoNode const* pCurrentNode;
 
     while ((pCurrentNode = *iNode)) {
       node_collector(*pCurrentNode);
       ++iNode;
     }
 
     return node_collector.nodes;
   }

std::vector< GeoNodePathEntry > geo::GeometryCore::FindDetectorEnclosure ( std::string const & name = "volDetEnclosure" ) const

private

Definition at line 496 of file GeometryCore.cxx.

References FindFirstVolume(), and ROOTGeoManager().

Referenced by DetectorEnclosureBox().

   {
     std::vector<GeoNodePathEntry> path{{ROOTGeoManager()->GetTopNode()}};
     if (!FindFirstVolume(name, path)) path.clear();
     return path;
   }

bool geo::GeometryCore::FindFirstVolume	(	std::string const &	name,
		std::vector< GeoNodePathEntry > &	path
	)		const

private

Definition at line 505 of file GeometryCore.cxx.

Referenced by FindDetectorEnclosure().

   {
     assert(!path.empty());
 
     auto const* pCurrent = path.back().node;
 
     // first check the current layer
     if (strncmp(name.c_str(), pCurrent->GetName(), name.length()) == 0) return true;
 
     //explore the next layer down
     auto const* pCurrentVolume = pCurrent->GetVolume();
     unsigned int nd = pCurrentVolume->GetNdaughters();
     for (unsigned int i = 0; i < nd; ++i) {
       path.push_back({pCurrentVolume->GetNode(i)});
       if (FindFirstVolume(name, path)) return true;
       path.pop_back();
     }
     return false;
   }

TPCID geo::GeometryCore::FindTPCAtPosition ( Point_t const & point ) const

Returns the ID of the TPC at specified location.

Parameters

point 3D point (world reference frame, centimeters)

Returns: the TPC ID, or an invalid one if no TPC is there

Definition at line 157 of file GeometryCore.cxx.

References fPositionWiggle, PositionToCryostatPtr(), and geo::CryostatGeo::PositionToTPCID().

Referenced by trkf::TrajectoryMCSFitter::breakTrajInSegments(), pma::ProjectionMatchingAlg::buildShowerSeg(), ShowerRecoTools::ShowerUnidirectiondEdx::CalculateElement(), ShowerRecoTools::ShowerTrajPointdEdx::CalculateElement(), ems::MultiEMShowers::convCluster(), evd::RecoBaseDrawer::DrawTrack2D(), hit::HitCheater::FindHitsOnChannel(), shower::EMShowerAlg::FindInitialTrackHits(), geo::WireReadoutGeom::FindTPCsetAtPosition(), GetElementPtr(), opdet::GetHitGeometryInfo(), nnet::TrainingDataAlg::getProjection(), lar_pandora::LArPandoraInput::GetTrueStartAndEndPoints(), hit::DisambigCheater::InitHitToWids(), trkf::TrajectoryMCSFitter::linearRegression(), evd::SimulationDrawer::MCTruthOrtho(), shower::EMShowerAlg::OrderShowerHits_(), calo::Calorimetry::produce(), shower::EMShowerAlg::Project3DPointOntoPlane_(), filt::LArG4ParticleFilter::StartInTPCCheck(), filt::LArG4ParticleFilter::StopInTPCCheck(), filt::LArG4ParticleFilter::TPCTrajLengthCheck(), DUNE::NeutrinoTrackingEff::truthLength(), and DUNE::MuonTrackingEff::truthLength().

   {
     // first find the cryostat
     CryostatGeo const* cryo = PositionToCryostatPtr(point);
     if (!cryo) return {};
 
     // then ask it about the TPC
     return cryo->PositionToTPCID(point, 1. + fPositionWiggle);
   }

std::string const& geo::GeometryCore::GDMLFile ( ) const

inline

Returns the full directory path to the GDML file source.

Returns: the full directory path to the GDML file source

This is the full path of the source of the detector geometry handed to the detector simulation (GEANT).

Definition at line 130 of file GeometryCore.h.

References fGDMLfile.

Referenced by larg4::LArG4::beginJob(), geo::DumpGeometry::dumpGeometry(), and evgen::GENIEGen::GENIEGen().

130 { return fGDMLfile; }

geo::GeometryCore::fGDMLfile

std::string fGDMLfile

path to geometry file used for Geant4 simulation

Definition: GeometryCore.h:611

unsigned int geo::GeometryCore::GetClosestOpDet ( Point_t const & point ) const

Find the nearest OpChannel to some point.

Parameters

point point to be queried, in world coordinates

Returns: the index of the nearest OpChannel to the point, or std::numeric_limits<unsigned int>::max() if invalid point

Deprecated:: This method does not tell in which cryostat the detector is; use geo::CryostatGeo::GetClosestOpDet() instead (find the cryostat with PositionToCryostatPtr()).

Definition at line 658 of file GeometryCore.cxx.

References geo::CryostatID::Cryostat, geo::CryostatGeo::GetClosestOpDet(), geo::CryostatGeo::ID(), OpDetFromCryo(), and PositionToCryostatPtr().

Referenced by GetElementPtr().

   {
     CryostatGeo const* cryo = PositionToCryostatPtr(point);
     if (!cryo) return std::numeric_limits<unsigned int>::max();
     int o = cryo->GetClosestOpDet(point);
     return OpDetFromCryo(o, cryo->ID().Cryostat);
   }

CryostatGeo const& geo::GeometryCore::GetElement ( CryostatID const & cryoid ) const

inline

Returns the specified cryostat.

Parameters

cryoid cryostat ID

Returns: a constant reference to the specified cryostat

Exceptions

cet::exception (GeometryCore category) if cryostat not present

The GetElement() method is overloaded and its return depends on the type of ID.

Todo:: Make the cryostat number mandatory (as CryostatID)

Definition at line 334 of file GeometryCore.h.

References Cryostat().

Referenced by evd::SimulationDrawer::MCTruthOrtho().

334 { return Cryostat(cryoid); }

geo::GeometryCore::Cryostat

CryostatGeo const & Cryostat(CryostatID const &cryoid=details::cryostat_zero) const

Returns the specified cryostat.

Definition: GeometryCore.cxx:150

TPCGeo const& geo::GeometryCore::GetElement ( TPCID const & tpcid ) const

inline

Returns the specified TPC.

Parameters

tpcid ID of the tpc

Returns: a constant reference to the specified TPC

Exceptions

cet::exception	(`GeometryCore` category) if cryostat not present
cet::exception	(`TPCOutOfRange` category) if no such TPC

The GetElement() method is overloaded and its return depends on the type of ID.

Definition at line 452 of file GeometryCore.h.

References TPC().

452 { return TPC(tpcid); }

geo::GeometryCore::TPC

TPCGeo const & TPC(TPCID const &tpcid=details::tpc_zero) const

Returns the specified TPC.

Definition: GeometryCore.h:448

CryostatGeo const* geo::GeometryCore::GetElementPtr ( CryostatID const & cryoid ) const

inline

Returns the specified cryostat.

Parameters

cryoid cryostat ID

Returns: a constant pointer to the specified cryostat, or nullptr if none

The GetElementPtr() method is overloaded and its return depends on the type of ID.

Definition at line 349 of file GeometryCore.h.

References geo::Iterable< details::GeometryIterationPolicy, details::ToGeometryElement >::begin(), CryostatPtr(), geo::Iterable< details::GeometryIterationPolicy, details::ToGeometryElement >::end(), geo::Iterable< details::GeometryIterationPolicy, details::ToGeometryElement >::Iterate(), MaxTPCs(), PositionToCryostat(), PositionToCryostatID(), PositionToCryostatPtr(), and TotalNTPC().

Referenced by geo::details::getElementPtr(), and NTPC().

349 { return CryostatPtr(cryoid); }

geo::GeometryCore::CryostatPtr

CryostatGeo const * CryostatPtr(CryostatID const &cryoid) const

Returns the specified cryostat.

Definition: GeometryCore.h:345

TPCGeo const* geo::GeometryCore::GetElementPtr ( TPCID const & tpcid ) const

inline

Returns the specified TPC.

Parameters

tpcid TPC ID

Returns: a constant pointer to the specified TPC, or nullptr if none

The GetElementPtr() method is overloaded and its return depends on the type of ID.

Definition at line 468 of file GeometryCore.h.

References geo::details::cryostat_zero, FindTPCAtPosition(), GetClosestOpDet(), NOpDets(), OpDetFromCryo(), OpDetGeoFromOpDet(), OpDetGeoName(), PositionToTPC(), PositionToTPCID(), PositionToTPCptr(), and TPCPtr().

468 { return TPCPtr(tpcid); }

geo::GeometryCore::TPCPtr

TPCGeo const * TPCPtr(TPCID const &tpcid) const

Returns the specified TPC.

Definition: GeometryCore.h:463

std::string const & geo::GeometryCore::GetWorldVolumeName ( ) const

Return the name of the world volume (needed by Geant4 simulation)

Definition at line 212 of file GeometryCore.cxx.

Referenced by SurfaceY(), WorldBox(), and WorldVolume().

   {
     // For now, and possibly forever, this is a constant (given the definition of
     // "nodeNames" above).
     static std::string const worldVolumeName{"volWorld"};
     return worldVolumeName;
   }

bool geo::GeometryCore::HasCryostat ( CryostatID const & cryoid ) const

inline

Returns whether we have the specified cryostat.

The HasElement() method is overloaded and its meaning depends on the type of ID.

Definition at line 318 of file GeometryCore.h.

References geo::CryostatID::Cryostat, and Ncryostats().

Referenced by CryostatPtr(), and HasElement().

318 { return cryoid.Cryostat < Ncryostats(); }

geo::GeometryCore::Ncryostats

unsigned int Ncryostats() const

Returns the number of cryostats in the detector.

Definition: GeometryCore.h:303

bool geo::GeometryCore::HasElement ( CryostatID const & cryoid ) const

inline

Returns whether we have the specified cryostat.

The HasElement() method is overloaded and its meaning depends on the type of ID.

Definition at line 319 of file GeometryCore.h.

References Cryostat(), geo::details::cryostat_zero, and HasCryostat().

319 { return HasCryostat(cryoid); }

geo::GeometryCore::HasCryostat

bool HasCryostat(CryostatID const &cryoid) const

Returns whether we have the specified cryostat.

Definition: GeometryCore.h:318

bool geo::GeometryCore::HasElement ( TPCID const & tpcid ) const

inline

Returns whether we have the specified TPC.

Definition at line 436 of file GeometryCore.h.

References HasTPC().

436 { return HasTPC(tpcid); }

geo::GeometryCore::HasTPC

bool HasTPC(TPCID const &tpcid) const

Returns whether we have the specified TPC.

Definition: GeometryCore.h:429

bool geo::GeometryCore::HasTPC ( TPCID const & tpcid ) const

inline

Returns whether we have the specified TPC.

Definition at line 429 of file GeometryCore.h.

References CryostatPtr(), and geo::CryostatGeo::HasTPC().

Referenced by pma::ProjectionMatchingAlg::buildShowerSeg(), ems::MultiEMShowers::convCluster(), HasElement(), and evd::TWQProjectionView::SelectTPC().

     {
       CryostatGeo const* pCryo = CryostatPtr(tpcid);
       return pCryo ? pCryo->HasTPC(tpcid) : false;
     }

std::string geo::GeometryCore::Info ( std::string indent = " " ) const

Returns a string with complete geometry information.

See also: Print()

Definition at line 588 of file GeometryCore.cxx.

References Print().

Referenced by SurfaceY().

   {
     std::ostringstream sstr;
     Print(sstr, indent);
     return sstr.str();
   }

range_type<T> geo::Iterable< details::GeometryIterationPolicy , details::ToGeometryElement >::Iterate ( ) const

inlineinherited

Definition at line 121 of file Iterable.h.

Referenced by GetElementPtr().

     {
       return ranges::make_subrange(begin<T>(), end<T>());
     }

range_type<T> geo::Iterable< details::GeometryIterationPolicy , details::ToGeometryElement >::Iterate ( ID const & id ) const

inlineinherited

Definition at line 127 of file Iterable.h.

     {
       return ranges::make_subrange(begin<T>(id), end<T>(id));
     }

void geo::GeometryCore::LoadGeometryFile ( )

private

Definition at line 70 of file GeometryCore.cxx.

References BuildGeometry(), fGDMLfile, fManager, and SortGeometry().

Referenced by Cryostats(), and GeometryCore().

   {
     if (fManager) {
       throw cet::exception("GeometryCore") << "Reloading a geometry is not supported.\n";
     }
 
     if (fGDMLfile.empty()) {
       throw cet::exception("GeometryCore") << "No GDML Geometry file specified!\n";
     }
 
     (void)gROOT; // <= Can be removed once ROOT 6.26/08 is adopted
 
     if (!gGeoManager) {
       // [20210630, petrillo@slac.stanford.edu]
       // ROOT 6.22.08 allows us to choose the representation of lengths in the geometry
       // objects parsed from GDML.  In LArSoft we want them to be centimeters (ROOT
       // standard).  This was tracked as Redmine issue #25990, and I leave this mark
       // because I feel that we'll be back to it not too far in the future.  Despite the
       // documentation (ROOT 6.22/08), it seems the units are locked from the beginning,
       // so we unlock without prejudice.
       TGeoManager::LockDefaultUnits(false);
       TGeoManager::SetDefaultUnits(TGeoManager::kRootUnits);
       TGeoManager::LockDefaultUnits(true);
 
       TGeoManager::Import(fGDMLfile.c_str());
       gGeoManager->LockGeometry();
     }
 
     BuildGeometry();
 
     fManager = gGeoManager;
 
     SortGeometry();
 
     mf::LogInfo("GeometryCore") << "New detector geometry loaded from\n\t" << fGDMLfile;
   }

double geo::GeometryCore::MassBetweenPoints	(	Point_t const &	p1,
		Point_t const &	p2
	)		const

Returns the column density between two points.

Parameters

p1	the first point
p2	the second point

Returns: the column density [kg / cm²]

The column density is defined as $\int_{\vec{p}_{1}}^{\vec{p}_{2}} \rho(\vec{p}) d\vec{p}$ where $\rho(\vec{p})$ is the density at point $\vec{p}$ , which the integral leads from p1 to p2 in a straight line.

Both points are specified in world coordinates.

Definition at line 550 of file GeometryCore.cxx.

References dir, and geo::vect::makePointFromCoords().

Referenced by SurfaceY().

   {
     //The purpose of this method is to determine the column density between the two points
     //given.  Do that by starting at p1 and stepping until you get to the node of p2.
     //calculate the distance between the point just inside that node and p2 to get the
     //last bit of column density
     double columnD = 0.;
 
     //first initialize a track - get the direction cosines
     Vector_t const dir = (p2 - p1).Unit();
 
     double const dxyz[3] = {dir.X(), dir.Y(), dir.Z()};
     double const cp1[3] = {p1.X(), p1.Y(), p1.Z()};
     gGeoManager->InitTrack(cp1, dxyz);
 
     //might be helpful to have a point to a TGeoNode
     TGeoNode* node = gGeoManager->GetCurrentNode();
 
     //check that the points are not in the same volume already.  if they are in different
     //volumes, keep stepping until you are in the same volume as the second point
     while (!gGeoManager->IsSameLocation(p2.X(), p2.Y(), p2.Z())) {
       gGeoManager->FindNextBoundary();
       columnD += gGeoManager->GetStep() * node->GetMedium()->GetMaterial()->GetDensity();
 
       //the act of stepping puts you in the next node and returns that node
       node = gGeoManager->Step();
     } //end loop to get to volume of second point
 
     //now you are in the same volume as the last point, but not at that point.  get the
     //distance between the current point and the last one
     Point_t const last = vect::makePointFromCoords(gGeoManager->GetCurrentPoint());
     double const lastStep = (p2 - last).R();
     columnD += lastStep * node->GetMedium()->GetMaterial()->GetDensity();
 
     return columnD;
   }

TGeoMaterial const * geo::GeometryCore::Material ( Point_t const & point ) const

Returns the material at the specified position.

Definition at line 467 of file GeometryCore.cxx.

Referenced by MaterialName(), and SurfaceY().

   {
     auto const pNode = gGeoManager->FindNode(point.X(), point.Y(), point.Z());
     if (!pNode) return nullptr;
     auto const pMedium = pNode->GetMedium();
     return pMedium ? pMedium->GetMaterial() : nullptr;
   }

std::string geo::GeometryCore::MaterialName ( Point_t const & point ) const

Name of the deepest material containing the point xyz.

Parameters

point the location to query, in world coordinates

Returns: material name at the specified position

Definition at line 476 of file GeometryCore.cxx.

References geo::BoxBoundedGeo::ContainsPosition(), Material(), geo::BoxBoundedGeo::Max(), geo::BoxBoundedGeo::Min(), and WorldBox().

Referenced by larg4::LArG4Ana::analyze(), and SurfaceY().

   {
     // check that the given point is in the World volume at least
     BoxBoundedGeo worldBox = WorldBox();
     if (!worldBox.ContainsPosition(point)) {
       mf::LogWarning("GeometryCoreBadInputPoint")
         << "point " << point << " is not inside the world volume " << worldBox.Min() << " -- "
         << worldBox.Max() << "; returning unknown material name";
       return {"unknownMaterial"};
     }
     auto const pMaterial = Material(point);
     if (!pMaterial) {
       mf::LogWarning("GeometryCoreBadInputPoint")
         << "material for point " << point << " not found! returning unknown material name";
       return {"unknownMaterial"};
     }
     return pMaterial->GetName();
   }

unsigned int geo::GeometryCore::MaxTPCs ( ) const

Returns the largest number of TPCs a cryostat in the detector has.

Definition at line 379 of file GeometryCore.cxx.

References fCryostats.

Referenced by geo::details::GeometryIterationPolicy::EndTPCID(), GetElementPtr(), and evd::TWQProjectionView::SetUpTPCselection().

   {
     unsigned int maxTPCs = 0;
     for (CryostatGeo const& cryo : fCryostats) {
       unsigned int maxTPCsInCryo = cryo.NTPC();
       if (maxTPCsInCryo > maxTPCs) maxTPCs = maxTPCsInCryo;
     }
     return maxTPCs;
   }

unsigned int geo::GeometryCore::Ncryostats ( ) const

inline

Returns the number of cryostats in the detector.

The NElements() and NSiblingElements() methods are overloaded and their return depends on the type of ID.

Todo:: Change return type to size_t

Definition at line 303 of file GeometryCore.h.

References fCryostats.

Referenced by detsim::WienerFilterAna::beginJob(), detsim::SimDriftElectrons::beginJob(), detsim::DriftElectronstoPlane::beginJob(), lar_cluster3d::StandardHit3DBuilder::BuildHitPairMap(), lar_cluster3d::SnippetHit3DBuilder::BuildHitPairMap(), larg4::LArVoxelReadout::ClearSimChannels(), lar_cluster3d::StandardHit3DBuilder::CollectArtHits(), lar_cluster3d::SnippetHit3DBuilder::CollectArtHits(), larg4::LArVoxelReadoutGeometry::Construct(), detinfo::DetectorPropertiesStandard::DataFor(), hit::DisambigCheater::DisambigCheater(), geo::WireReadoutDumper::dumpDetectorInfo(), geo::details::GeometryIterationPolicy::EndCryostatID(), detsim::WienerFilterAna::endJob(), geo::details::ReadoutIterationPolicy::EndPlaneID(), geo::details::GeometryIterationPolicy::EndTPCID(), geo::details::ReadoutIterationPolicy::EndWireID(), larg4::ISTPC::extractActiveLArVolume(), larg4::OpFastScintillation::extractActiveVolumes(), HasCryostat(), lar_cluster3d::SpacePointHit3DBuilder::Hit3DBuilder(), trkf::SpacePointAlg::makeSpacePoints(), NElements(), NSiblingElements(), OpDetFromCryo(), OpDetGeoFromOpDet(), larg4::OpFastScintillation::OpFastScintillation(), phot::PDFastSimPAR::PDFastSimPAR(), Print(), larg4::LArG4::produce(), evd::TWQProjectionView::SelectTPC(), evd::TWQProjectionView::SetUpTPCselection(), and cheat::BackTracker::SpacePointHitsToWeightedXYZ().

303 { return fCryostats.size(); }

geo::GeometryCore::fCryostats

CryostatList_t fCryostats

Definition: GeometryCore.h:605

unsigned int geo::GeometryCore::NElements ( ) const

inline

Returns the number of cryostats in the detector.

The NElements() and NSiblingElements() methods are overloaded and their return depends on the type of ID.

Todo:: Change return type to size_t

Definition at line 304 of file GeometryCore.h.

References Ncryostats().

304 { return Ncryostats(); }

geo::GeometryCore::Ncryostats

unsigned int Ncryostats() const

Returns the number of cryostats in the detector.

Definition: GeometryCore.h:303

unsigned int geo::GeometryCore::NElements ( CryostatID const & cryoid ) const

inline

Returns the largest number of TPCs a cryostat in the detector has.

Definition at line 421 of file GeometryCore.h.

References NTPC().

421 { return NTPC(cryoid); }

geo::GeometryCore::NTPC

unsigned int NTPC(CryostatID const &cryoid=details::cryostat_zero) const

Returns the total number of TPCs in the specified cryostat.

Definition: GeometryCore.h:416

unsigned int geo::GeometryCore::NOpDets ( ) const

Number of OpDets in the whole detector.

Definition at line 133 of file GeometryCore.cxx.

Referenced by cosmic::BeamFlashTrackMatchTaggerAlg::CheckCompatibility(), phot::CreateHybridLibrary::CreateHybridLibrary(), opdet::FlashHypothesisAnaAlg::FillOpDetPositions(), larg4::OpDetLookup::FindClosestOpDet(), GetElementPtr(), geo::WireReadoutGeom::IsValidOpChannel(), phot::PhotonVisibilityService::LoadLibrary(), phot::PhotonMappingIdentityTransformations::makeLibraryIndicesToOpDetsMap(), phot::PhotonMappingIdentityTransformations::makeOpDetsToLibraryIndicesMap(), geo::WireReadoutGeom::MaxOpChannel(), geo::WireReadoutGeom::NOpChannels(), cosmic::BeamFlashTrackMatchTaggerAlg::NormalizeLightHypothesis(), phot::PropagationTimeModel::opDetCenters(), phot::PropagationTimeModel::opDetOrientations(), phot::PDFastSimPAR::PDFastSimPAR(), phot::PhotonLibraryHybrid::PhotonLibraryHybrid(), cosmic::BeamFlashTrackMatchTaggerAlg::PrintHypothesisFlashComparison(), wc::CellTree::processOpFlash(), sim::PhotonHitConverter::produce(), larg4::LArG4::produce(), lariov::SIOVPmtGainProvider::Reconfigure(), phot::SemiAnalyticalModel::SemiAnalyticalModel(), and opdet::FlashHypothesisAnaAlg::SetOutputObjects().

   {
     int N = 0;
     for (auto const& cryo : Iterate<CryostatGeo>())
       N += cryo.NOpDet();
     return N;
   }

unsigned int geo::GeometryCore::NSiblingElements ( CryostatID const & ) const

inline

Returns the number of cryostats in the detector.

The NElements() and NSiblingElements() methods are overloaded and their return depends on the type of ID.

Todo:: Change return type to size_t

Definition at line 305 of file GeometryCore.h.

References Ncryostats().

Referenced by geo::details::GeometryIterationPolicy::NSiblings().

305 { return Ncryostats(); }

geo::GeometryCore::Ncryostats

unsigned int Ncryostats() const

Returns the number of cryostats in the detector.

Definition: GeometryCore.h:303

unsigned int geo::GeometryCore::NSiblingElements ( TPCID const & tpcid ) const

inline

Returns the largest number of TPCs a cryostat in the detector has.

Definition at line 422 of file GeometryCore.h.

References NTPC().

422 { return NTPC(tpcid); }

geo::GeometryCore::NTPC

unsigned int NTPC(CryostatID const &cryoid=details::cryostat_zero) const

Returns the total number of TPCs in the specified cryostat.

Definition: GeometryCore.h:416

unsigned int geo::GeometryCore::NTPC ( CryostatID const & cryoid = details::cryostat_zero ) const

inline

Returns the total number of TPCs in the specified cryostat.

Parameters

cryoid cryostat number

Returns: number of TPCs in specified cryostat, or 0 if no cryostat found

The NElements() and NSiblingElements() methods are overloaded and their return depends on the type of ID.

Todo:: Change return type to size_t

Definition at line 416 of file GeometryCore.h.

References GetElementPtr(), and geo::CryostatGeo::NElements().

Referenced by apa::APAGeometryAlg::APAGeometryAlg(), detsim::WienerFilterAna::beginJob(), detsim::SimDriftElectrons::beginJob(), detsim::DriftElectronstoPlane::beginJob(), lar_cluster3d::StandardHit3DBuilder::BuildHitPairMap(), lar_cluster3d::SnippetHit3DBuilder::BuildHitPairMap(), mvapid::MVAAlg::CalcSegmentdEdxDist(), larg4::LArVoxelReadout::ClearSimChannels(), lar_cluster3d::StandardHit3DBuilder::CollectArtHits(), lar_cluster3d::SnippetHit3DBuilder::CollectArtHits(), hit::DisambigCheater::DisambigCheater(), detsim::WienerFilterAna::endJob(), mvapid::MVAAlg::GetWireNormals(), lar_cluster3d::SpacePointHit3DBuilder::Hit3DBuilder(), NElements(), NSiblingElements(), phot::PDFastSimPAR::PDFastSimPAR(), nnet::PointIdTrainingData::PointIdTrainingData(), evgen::ActiveVolumeVertexSampler::reconfigure(), evgen::ActiveVolumeVertexSampler::sample_vertex_pos(), evd::TWQProjectionView::SelectTPC(), phot::SemiAnalyticalModel::SemiAnalyticalModel(), tca::TrajClusterAlg::SetSourceHits(), evd::TWQProjectionView::SetUpTPCselection(), cheat::BackTracker::SpacePointHitsToWeightedXYZ(), tca::StitchPFPs(), apa::DisambigAlg::TrivialDisambig(), and evd::TWQMultiTPCProjectionView::TWQMultiTPCProjectionView().

     {
       CryostatGeo const* pCryo = GetElementPtr(cryoid);
       return pCryo ? pCryo->NElements() : 0;
     }

unsigned int geo::GeometryCore::OpDetFromCryo	(	unsigned int	o,
		unsigned int	c
	)		const

Get unique opdet number from cryo and internal count.

Todo:: add explanation of the different IDs

Definition at line 598 of file GeometryCore.cxx.

References Cryostat(), Ncryostats(), and geo::CryostatGeo::NOpDet().

Referenced by GetClosestOpDet(), and GetElementPtr().

   {
     static bool Loaded = false;
     static std::vector<unsigned int> LowestID;
     static unsigned int NCryo;
 
     CryostatID const cid{c};
     // If not yet loaded static parameters, do it
     if (Loaded == false) {
 
       Loaded = true;
 
       // Store the lowest ID for each cryostat
       NCryo = Ncryostats();
       LowestID.resize(NCryo + 1);
       LowestID.at(0) = 0;
       for (size_t cryo = 0; cryo != NCryo; ++cryo) {
         LowestID.at(cryo + 1) = LowestID.at(cryo) + Cryostat(cid).NOpDet();
       }
     }
 
     if ((c < NCryo) && (o < Cryostat(cid).NOpDet())) { return LowestID.at(c) + o; }
 
     throw cet::exception("OpDetCryoToOpID Error")
       << "Coordinates c=" << c << ", o=" << o << " out of range. Abort\n";
   }

OpDetGeo const & geo::GeometryCore::OpDetGeoFromOpDet ( unsigned int OpDet ) const

Returns the geo::OpDetGeo object for the given detector number.

Parameters

OpDet optical detector unique number

See also: GeometryCoreOpDetGeometry "optical detector identification"

Definition at line 626 of file GeometryCore.cxx.

References Cryostat(), Ncryostats(), geo::CryostatGeo::NOpDet(), and geo::CryostatGeo::OpDet().

Referenced by opdet::SimPhotonCounter::beginJob(), phot::CreateHybridLibrary::CreateHybridLibrary(), phot::PhotonVisibilityService::DistanceToOpDetImpl(), larg4::OpDetLookup::FindClosestOpDet(), phot::PhotonLibraryHybrid::GetCount(), GetElementPtr(), phot::PropagationTimeModel::opDetCenters(), phot::PDFastSimPAR::opDetCenters(), geo::WireReadoutGeom::OpDetGeoFromOpChannel(), phot::PropagationTimeModel::opDetOrientations(), larg4::OpFastScintillation::OpFastScintillation(), phot::SemiAnalyticalModel::opticalDetectors(), and phot::PhotonVisibilityService::SolidAngleFactorImpl().

   {
     static bool Loaded = false;
     static std::vector<unsigned int> LowestID;
     static size_t NCryo;
     // If not yet loaded static parameters, do it
     if (Loaded == false) {
 
       Loaded = true;
 
       // Store the lowest ID for each cryostat
       NCryo = Ncryostats();
       LowestID.resize(NCryo + 1);
       LowestID[0] = 0;
       for (size_t cryo = 0; cryo != NCryo; ++cryo) {
         LowestID[cryo + 1] = LowestID[cryo] + Cryostat(CryostatID(cryo)).NOpDet();
       }
     }
 
     for (size_t i = 0; i != NCryo; ++i) {
       if ((OpDet >= LowestID[i]) && (OpDet < LowestID[i + 1])) {
         int c = i;
         int o = OpDet - LowestID[i];
         return Cryostat(CryostatID(c)).OpDet(o);
       }
     }
     // If we made it here, we didn't find the right combination. abort
     throw cet::exception("OpID To OpDetCryo error") << "OpID out of range, " << OpDet << "\n";
   }

std::string geo::GeometryCore::OpDetGeoName ( CryostatID const & cid = details::cryostat_zero ) const

Returns gdml string which gives sensitive opdet name.

Parameters

cid	ID of the cryostat the detector is in

This name is defined in the geometry (GDML) description.

Todo:: Change to use CryostatID

Referenced by GetElementPtr().

GeometryCore& geo::GeometryCore::operator= ( GeometryCore const & )

delete

GeometryCore& geo::GeometryCore::operator= ( GeometryCore && )

delete

CryostatGeo const & geo::GeometryCore::PositionToCryostat ( Point_t const & point ) const

Returns the cryostat at specified location.

Parameters

point the location [cm]

Returns: a constant reference to the geo::CryostatGeo containing point

Exceptions

cet::exception ("Geometry" category) if no cryostat matches

The tolerance used here is the one returned by DefaultWiggle().

Definition at line 205 of file GeometryCore.cxx.

References PositionToCryostatPtr().

Referenced by GetElementPtr().

   {
     if (auto cstat = PositionToCryostatPtr(point)) { return *cstat; }
     throw cet::exception("GeometryCore") << "Can't find any cryostat at position " << point << "\n";
   }

CryostatID geo::GeometryCore::PositionToCryostatID ( Point_t const & point ) const

Returns the ID of the cryostat at specified location.

Parameters

point the location [cm]

Returns: ID of the cryostat including point (invalid if none)

The tolerance used here is the one returned by DefaultWiggle().

Definition at line 177 of file GeometryCore.cxx.

References geo::CryostatGeo::ID(), and PositionToCryostatPtr().

Referenced by pma::ProjectionMatchingAlg::buildShowerSeg(), ems::MultiEMShowers::convCluster(), larg4::LArVoxelReadoutGeometry::FindNestedVolume(), GetElementPtr(), sim::MCRecoEdep::MakeMCEdep(), evd::SimulationDrawer::MCTruthOrtho(), and detsim::SimDriftElectrons::produce().

   {
     CryostatGeo const* cryo = PositionToCryostatPtr(point);
     return cryo ? cryo->ID() : CryostatID{};
   }

CryostatGeo const * geo::GeometryCore::PositionToCryostatPtr ( Point_t const & point ) const

Returns the cryostat at specified location.

Parameters

point the location [cm]

Returns: pointer to the geo::CryostatGeo including point, or nullptr

The tolerance used here is the one returned by DefaultWiggle().

Definition at line 168 of file GeometryCore.cxx.

References fPositionWiggle.

Referenced by FindTPCAtPosition(), GetClosestOpDet(), GetElementPtr(), PositionToCryostat(), PositionToCryostatID(), and PositionToTPCptr().

   {
     for (auto const& cryostat : Iterate<CryostatGeo>()) {
       if (cryostat.ContainsPosition(point, 1.0 + fPositionWiggle)) return &cryostat;
     }
     return nullptr;
   }

TPCGeo const & geo::GeometryCore::PositionToTPC ( Point_t const & point ) const

Returns the TPC at specified location.

Parameters

point the location [cm]

Returns: a constant reference to the geo::TPCGeo including point

Exceptions

cet::exception ("Geometry" category) if no TPC matches

Definition at line 191 of file GeometryCore.cxx.

References PositionToTPCptr().

Referenced by GetElementPtr(), and opreco::OpticalRecoAna::update_MC_particle_time().

   {
     if (auto tpc = PositionToTPCptr(point)) { return *tpc; }
     throw cet::exception("GeometryCore") << "Can't find any TPC at position " << point << "\n";
   }

TPCID geo::GeometryCore::PositionToTPCID ( Point_t const & point ) const

Returns the ID of the TPC at specified location.

Parameters

point the location [cm]

Returns: ID of the TPC at specified location, invalid if none

See also: PositionToTPC()

Definition at line 198 of file GeometryCore.cxx.

References geo::TPCGeo::ID(), and PositionToTPCptr().

Referenced by larg4::ISCalcCorrelated::AngleToEFieldAtStep(), evdb_tool::DrawLArVoxel3D::Draw(), evdb_tool::DrawSimEnergyDeposit3D::drawAll(), evdb_tool::DrawSimEnergyDeposit3D::drawMCPartAssociated(), larg4::ISCalcCorrelated::EFieldAtStep(), larg4::LArVoxelReadoutGeometry::FindNestedVolume(), GetElementPtr(), lar_pandora::LArPandoraInput::GetTrueX0(), apa::APAGeometryAlg::LineSegChanIntersect(), sim::MCRecoEdep::MakeMCEdep(), evd::SimulationDrawer::MCTruth3D(), detsim::SimDriftElectrons::produce(), and cheat::BackTracker::SpacePointHitsToWeightedXYZ().

   {
     TPCGeo const* tpc = PositionToTPCptr(point);
     return tpc ? tpc->ID() : TPCID{};
   }

TPCGeo const * geo::GeometryCore::PositionToTPCptr ( Point_t const & point ) const

Returns the TPC at specified location.

Parameters

point the location [cm]

Returns: the geo::TPCGeo including point, or nullptr if none

Definition at line 184 of file GeometryCore.cxx.

References fPositionWiggle, PositionToCryostatPtr(), and geo::CryostatGeo::PositionToTPCptr().

Referenced by GetElementPtr(), lar_pandora::PFParticleMonitoring::GetStartAndEndPoints(), PositionToTPC(), and PositionToTPCID().

   {
     CryostatGeo const* cryo = PositionToCryostatPtr(point);
     return cryo ? cryo->PositionToTPCptr(point, 1. + fPositionWiggle) : nullptr;
   }

template<typename Stream >

void geo::GeometryCore::Print	(	Stream &&	out,
		std::string	indent = `" "`
	)		const

Prints geometry information with maximum verbosity.

Definition at line 633 of file GeometryCore.h.

References DetectorEnclosureBox(), DetectorName(), art::detail::indent(), geo::TPCGeo::MaxVerbosity, geo::OpDetGeo::MaxVerbosity, Ncryostats(), geo::OpDetGeo::PrintOpDetInfo(), and geo::TPCGeo::PrintTPCInfo().

Referenced by Info(), and SurfaceY().

 {
 
   out << "Detector " << DetectorName() << " has " << Ncryostats() << " cryostats:";
 
   auto const& detEnclosureBox = DetectorEnclosureBox();
   out << "\n"
       << indent << "Detector enclosure: " << detEnclosureBox.Min() << " -- "
       << detEnclosureBox.Max() << " cm => ( " << detEnclosureBox.SizeX() << " x "
       << detEnclosureBox.SizeY() << " x " << detEnclosureBox.SizeZ() << " ) cm^3";
 
   for (auto const& cryostat : Iterate<CryostatGeo>()) {
     out << "\n" << indent;
     cryostat.PrintCryostatInfo(std::forward<Stream>(out), indent + "  ", cryostat.MaxVerbosity);
 
     unsigned const int nTPCs = cryostat.NTPC();
     for (unsigned int t = 0; t < nTPCs; ++t) {
       TPCGeo const& tpc = cryostat.TPC(t);
 
       out << "\n" << indent << "  ";
       tpc.PrintTPCInfo(std::forward<Stream>(out), indent + "    ", tpc.MaxVerbosity);
     } // for TPC
 
     unsigned int nOpDets = cryostat.NOpDet();
     for (unsigned int iOpDet = 0; iOpDet < nOpDets; ++iOpDet) {
       OpDetGeo const& opDet = cryostat.OpDet(iOpDet);
       out << "\n" << indent << "  [OpDet #" << iOpDet << "] ";
       opDet.PrintOpDetInfo(std::forward<Stream>(out), indent + "  ", opDet.MaxVerbosity);
     } // for
   }   // for cryostat
 
   out << '\n';
 
 } // geo::GeometryCore::Print()

TGeoManager * geo::GeometryCore::ROOTGeoManager ( ) const

Access to the ROOT geometry description manager.

Definition at line 126 of file GeometryCore.cxx.

References fManager.

Referenced by evgen::BaseRadioGen::BaseRadioGen(), evgen::LightSource::checkMaterials(), FindAllVolumePaths(), FindAllVolumes(), FindDetectorEnclosure(), evgen::GENIEGen::GENIEGen(), evgen::RadioGen::SampleOne(), and SurfaceY().

   {
     assert(fManager == gGeoManager);
     return fManager;
   }

void geo::GeometryCore::SortGeometry ( )

private

Definition at line 108 of file GeometryCore.cxx.

References fCryostats, and fSorter.

Referenced by Cryostats(), and LoadGeometryFile().

   {
     mf::LogInfo("GeometryCore") << "Sorting volumes...";
 
     if (not fSorter) { return; }
 
     fSorter->sort(fCryostats);
 
     // Renumber cryostats according to sorted order
     CryostatID::CryostatID_t c = 0;
     for (CryostatGeo& cryo : fCryostats) {
       cryo.SortSubVolumes(*fSorter);
       cryo.UpdateAfterSorting(CryostatID{c});
       ++c;
     }
   }

Length_t geo::GeometryCore::SurfaceY ( ) const

inline

The position of the detector respect to earth surface.

Returns: typical y position at surface in units of cm

This is the depth (y) of the surface (where earth meets air) for this detector site. The number is expressed in world coordinates and in centimeters, and it represents the y coordinate of earth surface. A negative value means that the origin of coordinates, typically matching the detector centre, is above surface.

Todo:: check that this is actually how it is used

Definition at line 186 of file GeometryCore.h.

References DetectorEnclosureBox(), FindAllVolumePaths(), FindAllVolumes(), fSurfaceY, GetWorldVolumeName(), art::detail::indent(), Info(), MassBetweenPoints(), Material(), MaterialName(), Print(), ROOTGeoManager(), TotalMass(), and VolumeName().

Referenced by evgen::CosmicsGen::produce().

186 { return fSurfaceY; }

geo::GeometryCore::fSurfaceY

double fSurfaceY

The point where air meets earth for this detector.

Definition: GeometryCore.h:613

double geo::GeometryCore::TotalMass ( ) const

inline

Returns the total mass [kg] of the specified volume (default: world).

Definition at line 255 of file GeometryCore.h.

Referenced by evgen::GENIEGen::GENIEGen(), and SurfaceY().

255 { return TotalMass(GetWorldVolumeName()); }

geo::GeometryCore::GetWorldVolumeName

std::string const & GetWorldVolumeName() const

Return the name of the world volume (needed by Geant4 simulation)

Definition: GeometryCore.cxx:212

geo::GeometryCore::TotalMass

double TotalMass() const

Returns the total mass [kg] of the specified volume (default: world).

Definition: GeometryCore.h:255

double geo::GeometryCore::TotalMass ( std::string vol ) const

Returns the total mass [kg] of the specified volume (default: world).

Definition at line 538 of file GeometryCore.cxx.

   {
     //the TGeoNode::GetVolume() returns the TGeoVolume of the detector outline and ROOT
     //calculates the mass in kg for you
     TGeoVolume* gvol = gGeoManager->FindVolumeFast(vol.c_str());
     if (gvol) return gvol->Weight();
 
     throw cet::exception("GeometryCore")
       << "could not find specified volume '" << vol << " 'to determine total mass\n";
   }

unsigned int geo::GeometryCore::TotalNTPC ( ) const

Returns the total number of TPCs in the detector.

Definition at line 390 of file GeometryCore.cxx.

References fCryostats, and sum.

Referenced by GetElementPtr().

   {
     // it looks like C++11 lambdas have made STL algorithms easier to use, but only so
     // much:
     return std::accumulate(
       fCryostats.begin(), fCryostats.end(), 0U, [](unsigned int sum, CryostatGeo const& cryo) {
         return sum + cryo.NTPC();
       });
   }

TPCGeo const& geo::GeometryCore::TPC ( TPCID const & tpcid = details::tpc_zero ) const

inline

Returns the specified TPC.

Parameters

tpcid ID of the tpc

Returns: a constant reference to the specified TPC

Exceptions

cet::exception	(`GeometryCore` category) if cryostat not present
cet::exception	(`TPCOutOfRange` category) if no such TPC

The GetElement() method is overloaded and its return depends on the type of ID.

Definition at line 448 of file GeometryCore.h.

References Cryostat(), and geo::CryostatGeo::TPC().

Referenced by lar::example::AnalysisExample::analyze(), larg4::ISCalcCorrelated::AngleToEFieldAtStep(), sce::SCECorrection::applyT0Shift(), trkf::SpacePointAna::bookHistograms(), pma::ProjectionMatchingAlg::buildShowerSeg(), phot::PropagationTimeModel::cathodeCentre(), LArStackingAction::ClassifyNewTrack(), evd::Display3DPad::Draw(), larg4::LArVoxelReadout::DriftIonizationElectrons(), larg4::ISCalcCorrelated::EFieldAtStep(), larg::LArSimChannelAna::ensureHists(), hit::MagDriftAna::ensureHists(), tca::FillWireHitRange(), simfilter::FilterNoDirtNeutrinos::filter(), util::GeometryUtilities::Get2DangleFrom3D(), trk::TrackContainmentAlg::GetCosmicTagID(), GetElement(), nnet::TrainingDataAlg::getProjection(), lar_pandora::LArPandoraInput::GetTrueX0(), cosmic::BeamFlashTrackMatchTaggerAlg::InDetector(), cosmic::BeamFlashTrackMatchTaggerAlg::InDriftWindow(), pma::Track3D::InitFromMiddle(), trk::TrackContainmentAlg::IsContained(), pma::PMAlgTracker::mergeCoLinear(), lar_cluster3d::StandardHit3DBuilder::NearestWireID(), lar_cluster3d::SnippetHit3DBuilder::NearestWireID(), larg4::OpFastScintillation::OpFastScintillation(), phot::PDFastSimPAR::PDFastSimPAR(), trkf::CCTrackMaker::PlnMatch(), trk::TrackContainmentAlg::ProcessTracks(), evgen::CosmicsGen::produce(), trkf::SpacePts::produce(), trkf::Track3Dreco::produce(), trkf::Track3DKalman::produce(), vertex::VertexFinder2D::produce(), detsim::SimDriftElectrons::produce(), detsim::DriftElectronstoPlane::produce(), trkf::Track3DKalmanSPS::produce(), trkf::PMAlgTrackMaker::produce(), evgen::ActiveVolumeVertexSampler::sample_vertex_pos(), tca::SaveCRInfo(), phot::SemiAnalyticalModel::SemiAnalyticalModel(), pma::Track3D::SetT0FromDx(), lar_pandora::LArPandoraGeometry::ShouldSwitchUV(), geo::WireReadoutGeom::SortPlanes(), trkf::CCTrackMaker::TagCosmics(), lar_pandora::ICARUS::TargetViewU(), lar_pandora::VintageLArTPCThreeView::TargetViewU(), lar_pandora::ICARUS::TargetViewV(), lar_pandora::VintageLArTPCThreeView::TargetViewV(), apa::APAGeometryAlg::ThreeChanPos(), calo::GnocchiCalorimetry::TrajectoryToWirePosition(), apa::DisambigAlg::TrivialDisambig(), apa::DisambigAlg::UseEndPts(), and evd::RecoBaseDrawer::Vertex2D().

     {
       return Cryostat(tpcid).TPC(tpcid);
     }

TPCGeo const* geo::GeometryCore::TPCPtr ( TPCID const & tpcid ) const

inline

Returns the specified TPC.

Parameters

tpcid TPC ID

Returns: a constant pointer to the specified TPC, or nullptr if none

The GetElementPtr() method is overloaded and its return depends on the type of ID.

Definition at line 463 of file GeometryCore.h.

References CryostatPtr(), and geo::CryostatGeo::TPCPtr().

Referenced by GetElementPtr().

     {
       CryostatGeo const* pCryo = CryostatPtr(tpcid);
       return pCryo ? pCryo->TPCPtr(tpcid) : nullptr;
     }

std::string geo::GeometryCore::VolumeName ( Point_t const & point ) const

Returns the name of the deepest volume containing specified point.

Parameters

point the location to query, in world coordinates

Returns: name of the volume containing the point

Todo:

what happens if none?

Unify the coordinates type

Definition at line 446 of file GeometryCore.cxx.

References util::abs(), and WorldVolume().

Referenced by larg4::LArG4Ana::analyze(), LArStackingAction::InsideTPC(), and SurfaceY().

   {
     // check that the given point is in the World volume at least
     TGeoVolume const* volWorld = WorldVolume();
     double halflength = ((TGeoBBox*)volWorld->GetShape())->GetDZ();
     double halfheight = ((TGeoBBox*)volWorld->GetShape())->GetDY();
     double halfwidth = ((TGeoBBox*)volWorld->GetShape())->GetDX();
     if (std::abs(point.x()) > halfwidth || std::abs(point.y()) > halfheight ||
         std::abs(point.z()) > halflength) {
       mf::LogWarning("GeometryCoreBadInputPoint")
         << "point (" << point.x() << "," << point.y() << "," << point.z() << ") "
         << "is not inside the world volume "
         << " half width = " << halfwidth << " half height = " << halfheight
         << " half length = " << halflength << " returning unknown volume name";
       return "unknownVolume";
     }
 
     return gGeoManager->FindNode(point.X(), point.Y(), point.Z())->GetName();
   }

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

Fills the arguments with the boundaries of the world.

Parameters

xlo	(output) pointer to the lower x coordinate
xlo	(output) pointer to the upper x coordinate
ylo	(output) pointer to the lower y coordinate
ylo	(output) pointer to the upper y coordinate
zlo	(output) pointer to the lower z coordinate
zlo	(output) pointer to the upper z coordinate

Exceptions

cet::exception ("GeometryCore" category) if no world found

See also: GetWorldVolumeName()

This method fills the boundaries of the world volume (GetWorldVolumeName()).

If a pointer is null, its coordinate is skipped.

Deprecated:: Use the version without arguments instead.

Definition at line 429 of file GeometryCore.cxx.

References geo::BoxBoundedGeo::MaxX(), geo::BoxBoundedGeo::MaxY(), geo::BoxBoundedGeo::MaxZ(), geo::BoxBoundedGeo::MinX(), geo::BoxBoundedGeo::MinY(), geo::BoxBoundedGeo::MinZ(), and WorldBox().

Referenced by evd_tool::ICARUSDrawer::DetOutline3D(), and evgen::CORSIKAGen::GetSample().

   {
     BoxBoundedGeo const box = WorldBox();
     if (xlo) *xlo = box.MinX();
     if (ylo) *ylo = box.MinY();
     if (zlo) *zlo = box.MinZ();
     if (xhi) *xhi = box.MaxX();
     if (yhi) *yhi = box.MaxY();
     if (zhi) *zhi = box.MaxZ();
   }

BoxBoundedGeo geo::GeometryCore::WorldBox ( ) const

Returns a box with the extremes of the world volume (from shape axes).

See also: GetWorldVolumeName()

Definition at line 407 of file GeometryCore.cxx.

References GetWorldVolumeName(), WorldVolume(), x1, x2, y1, and y2.

Referenced by DetectorName(), MaterialName(), and WorldBox().

   {
     TGeoVolume const* world = WorldVolume();
     if (!world) {
       throw cet::exception("GeometryCore") << "no world volume '" << GetWorldVolumeName() << "'\n";
     }
     TGeoShape const* s = world->GetShape();
     if (!s) {
       throw cet::exception("GeometryCore")
         << "world volume '" << GetWorldVolumeName() << "' is shapeless!!!\n";
     }
 
     double x1, x2, y1, y2, z1, z2;
     s->GetAxisRange(1, x1, x2);
     s->GetAxisRange(2, y1, y2);
     s->GetAxisRange(3, z1, z2);
 
     // BoxBoundedGeo constructor will sort the coordinates as needed
     return BoxBoundedGeo{x1, x2, y1, y2, z1, z2};
   }

TGeoVolume const * geo::GeometryCore::WorldVolume ( ) const

Returns a pointer to the world volume.

Definition at line 401 of file GeometryCore.cxx.

References GetWorldVolumeName().

Referenced by DetectorName(), VolumeName(), and WorldBox().

   {
     return gGeoManager->FindVolumeFast(GetWorldVolumeName().c_str());
   }

Member Data Documentation

std::unique_ptr<GeometryBuilder> geo::GeometryCore::fBuilder

private

Definition at line 607 of file GeometryCore.h.

Referenced by BuildGeometry(), and GeometryCore().

CryostatList_t geo::GeometryCore::fCryostats {}

private

Definition at line 605 of file GeometryCore.h.

Referenced by BuildGeometry(), CryostatPtr(), Cryostats(), MaxTPCs(), Ncryostats(), SortGeometry(), and TotalNTPC().

std::string geo::GeometryCore::fDetectorName

private

Name of the detector.

Definition at line 612 of file GeometryCore.h.

Referenced by DetectorName(), and GeometryCore().

std::string geo::GeometryCore::fGDMLfile

private

path to geometry file used for Geant4 simulation

Definition at line 611 of file GeometryCore.h.

Referenced by GDMLFile(), GeometryCore(), and LoadGeometryFile().

TGeoManager* geo::GeometryCore::fManager {nullptr}

private

Definition at line 610 of file GeometryCore.h.

Referenced by LoadGeometryFile(), and ROOTGeoManager().

double geo::GeometryCore::fPositionWiggle

private

accounting for rounding errors when testing positions

Definition at line 614 of file GeometryCore.h.

Referenced by DefaultWiggle(), FindTPCAtPosition(), GeometryCore(), PositionToCryostatPtr(), and PositionToTPCptr().

std::unique_ptr<GeoObjectSorter> geo::GeometryCore::fSorter

private

Definition at line 608 of file GeometryCore.h.

Referenced by GeometryCore(), and SortGeometry().

double geo::GeometryCore::fSurfaceY

private

The point where air meets earth for this detector.

Definition at line 613 of file GeometryCore.h.

Referenced by GeometryCore(), and SurfaceY().

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

larcorealg/v10_00_02/source/larcorealg/Geometry/GeometryCore.h
larcorealg/v10_00_02/source/larcorealg/Geometry/GeometryCore.cxx

Public Types

Public Member Functions

Private Types

Private Member Functions

Private Attributes

Detailed Description

GeometryCore construction

Configuration parameters

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation