geo::Geometry Class Reference

The geometry of one entire detector, as served by art. More...

#include <Geometry.h>

Inheritance diagram for geo::Geometry:

Public Types
using	provider_type = GeometryCore
	type of service provider More...
Public Types inherited from geo::GeometryCore
using	instead = geo::Length_t
using	Segment_t = Segment< DefaultPoint_t >
using	CryostatList_t = GeometryData_t::CryostatList_t
	Type of list of cryostats. More...
using	AuxDetList_t = GeometryData_t::AuxDetList_t
	Type of list of auxiliary detectors. More...
using	cryostat_id_iterator = geo::cryostat_id_iterator
	Forward-iterator browsing all cryostat IDs in the detector. More...
using	cryostat_iterator = geo::cryostat_iterator
	Forward-iterator browsing all cryostats in the detector. More...
using	TPC_id_iterator = geo::TPC_id_iterator
	Forward-iterator browsing all TPC IDs in the detector. More...
using	TPC_iterator = geo::TPC_iterator
	Forward-iterator browsing all TPCs in the detector. More...
using	plane_id_iterator = geo::plane_id_iterator
	Forward-iterator browsing all plane IDs in the detector. More...
using	plane_iterator = geo::plane_iterator
	Forward-iterator browsing all planes in the detector. More...
using	wire_id_iterator = geo::wire_id_iterator
	Forward-iterator browsing all wire IDs in the detector. More...
using	wire_iterator = geo::wire_iterator
	Forward-iterator browsing all wires in the detector. More...

Public Member Functions
	Geometry (fhicl::ParameterSet const &pset, art::ActivityRegistry &reg)
provider_type const *	provider () const
	Returns a pointer to the geometry service provider. More...
sumdata::GeometryConfigurationInfo const &	configurationInfo () const
	Returns the current geometry configuration information. More...
Public Member Functions inherited from geo::GeometryCore
	GeometryCore (fhicl::ParameterSet const &pset)
	Initialize geometry from a given configuration. More...
	~GeometryCore ()
	Destructor. 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	ROOTFile () const
	Returns the full directory path to the geometry file source. More...
std::string	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 (geo::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...
template<typename GeoID >
GeoID	GetBeginID () const
	Returns the ID of the first element of the detector. More...
template<typename GeoID >
GeoID	GetNextID (GeoID const &id) const
	Returns the ID next to the specified one. More...
template<typename GeoID >
GeoID	GetEndID () const
	Returns the (possibly invalid) ID after the last subelement of the detector. More...
template<typename GeoID , typename ContextID >
GeoID	GetBeginID (ContextID const &id) const
	Returns the ID of the first subelement of the specified element. More...
template<typename GeoID , typename ContextID >
GeoID	GetEndID (ContextID const &id) const
	Returns the (possibly invalid) ID after the last subelement of the specified element. More...
geo::CryostatGeo const *	PositionToCryostatPtr (geo::Point_t const &point) const
	Returns the cryostat at specified location. More...
geo::CryostatID	PositionToCryostatID (geo::Point_t const &point) const
	Returns the ID of the cryostat at specified location. More...
CryostatGeo const &	PositionToCryostat (double const worldLoc[3], geo::CryostatID &cid) const
	Returns the cryostat at specified location. More...
CryostatGeo const &	PositionToCryostat (double const worldLoc[3], unsigned int &cstat) const
	Returns the cryostat at specified location. More...
void	GetBeginID (geo::CryostatID &id) const
	Initializes the specified ID with the ID of the first cryostat. More...
void	GetEndID (geo::CryostatID &id) const
	Initializes the specified ID with the invalid ID after the last cryostat. More...
bool	IncrementID (geo::CryostatID &id) const
cryostat_id_iterator	begin_cryostat_id () const
	Returns an iterator pointing to the first cryostat ID. More...
cryostat_id_iterator	end_cryostat_id () const
	Returns an iterator pointing after the last cryostat ID. More...
cryostat_iterator	begin_cryostat () const
	Returns an iterator pointing to the first cryostat. More...
cryostat_iterator	end_cryostat () const
	Returns an iterator pointing after the last cryostat. More...
IteratorBox< cryostat_id_iterator,&GeometryCore::begin_cryostat_id,&GeometryCore::end_cryostat_id >	IterateCryostatIDs () const
	Enables ranged-for loops on all cryostat IDs of the detector. More...
IteratorBox< cryostat_iterator,&GeometryCore::begin_cryostat,&GeometryCore::end_cryostat >	IterateCryostats () const
	Enables ranged-for loops on all cryostats of the detector. More...
void	CryostatBoundaries (double *boundaries, geo::CryostatID const &cid) const
	Returns the boundaries of the specified cryostat. More...
void	CryostatBoundaries (double *boundaries, unsigned int cstat=0) const
	Returns the boundaries of the specified cryostat. More...
bool	HasTPC (geo::TPCID const &tpcid) const
	Returns whether we have the specified TPC. More...
bool	HasElement (geo::TPCID const &tpcid) const
	Returns whether we have the specified TPC. More...
geo::TPCID	FindTPCAtPosition (double const worldLoc[3]) const
	Returns the ID of the TPC at specified location. More...
geo::TPCGeo const *	PositionToTPCptr (geo::Point_t const &point) const
	Returns the TPC at specified location. More...
TPCGeo const &	PositionToTPC (double const worldLoc[3], unsigned int &tpc, unsigned int &cstat) const
	Returns the TPC at specified location. More...
TPCGeo const &	PositionToTPC (double const worldLoc[3], TPCID &tpcid) const
	Returns the TPC at specified location. More...
geo::TPCID	PositionToTPCID (geo::Point_t const &point) const
	Returns the ID of the TPC at specified location. More...
void	GetBeginID (geo::TPCID &id) const
	Initializes the specified ID with the ID of the first TPC. More...
void	GetEndID (geo::TPCID &id) const
	Initializes the specified ID with the invalid ID after the last TPC. More...
bool	IncrementID (geo::TPCID &id) const
geo::TPCID	GetBeginTPCID (geo::CryostatID const &id) const
	Returns the ID of the first TPC in the specified cryostat. More...
geo::TPCID	GetEndTPCID (geo::CryostatID const &id) const
TPC_id_iterator	begin_TPC_id () const
	Returns an iterator pointing to the first TPC ID in the detector. More...
TPC_id_iterator	end_TPC_id () const
	Returns an iterator pointing after the last TPC ID in the detector. More...
TPC_id_iterator	begin_TPC_id (geo::CryostatID const &cid) const
TPC_id_iterator	end_TPC_id (geo::CryostatID const &cid) const
TPC_iterator	begin_TPC () const
	Returns an iterator pointing to the first TPC in the detector. More...
TPC_iterator	end_TPC () const
	Returns an iterator pointing after the last TPC in the detector. More...
TPC_iterator	begin_TPC (geo::CryostatID const &cid) const
	Returns an iterator pointing to the first TPC in the detector. More...
TPC_iterator	end_TPC (geo::CryostatID const &cid) const
	Returns an iterator pointing after the last TPC in the detector. More...
IteratorBox< TPC_id_iterator,&GeometryCore::begin_TPC_id,&GeometryCore::end_TPC_id >	IterateTPCIDs () const
	Enables ranged-for loops on all TPC IDs of the detector. More...
LocalIteratorBox< TPC_id_iterator, geo::CryostatID,&GeometryCore::begin_TPC_id,&GeometryCore::end_TPC_id >	IterateTPCIDs (geo::CryostatID const &cid) const
	Enables ranged-for loops on all TPC IDs of the specified cryostat. More...
void	IterateTPCIDs (geo::TPCID const &pid) const =delete
	IterateTPCIDs() is not supported on TPC IDs. More...
void	IterateTPCIDs (geo::PlaneID const &pid) const =delete
	IterateTPCIDs() is not supported on plane IDs. More...
void	IterateTPCIDs (geo::WireID const &pid) const =delete
	IterateTPCIDs() is not supported on wire IDs. More...
void	IterateTPCIDs (readout::TPCsetID const &) const =delete
	IterateTPCIDs() is not supported on readout IDs. More...
void	IterateTPCIDs (readout::ROPID const &) const =delete
	IterateTPCIDs() is not supported on readout IDs. More...
IteratorBox< TPC_iterator,&GeometryCore::begin_TPC,&GeometryCore::end_TPC >	IterateTPCs () const
	Enables ranged-for loops on all TPCs of the detector. More...
LocalIteratorBox< TPC_iterator, geo::CryostatID,&GeometryCore::begin_TPC,&GeometryCore::end_TPC >	IterateTPCs (geo::CryostatID const &cid) const
	Enables ranged-for loops on all TPCs of the specified cryostat. More...
void	IterateTPCs (geo::TPCID const &pid) const =delete
	IterateTPCs() is not supported on TPC IDs. More...
void	IterateTPCs (geo::PlaneID const &pid) const =delete
	IterateTPCs() is not supported on plane IDs. More...
void	IterateTPCs (geo::WireID const &pid) const =delete
	IterateTPCs() is not supported on wire IDs. More...
void	IterateTPCs (readout::TPCsetID const &) const =delete
	IterateTPCs() is not supported on readout IDs. More...
void	IterateTPCs (readout::ROPID const &) const =delete
	IterateTPCs() is not supported on readout IDs. More...
unsigned int	Nviews () const
	Returns the number of views (different wire orientations) More...
std::set< PlaneID > const &	PlaneIDs () const
	Returns a list of possible PlaneIDs in the detector. More...
void	GetBeginID (geo::PlaneID &id) const
	Initializes the specified ID with the ID of the first plane. More...
void	GetEndID (geo::PlaneID &id) const
	Initializes the specified ID with the invalid ID after the last plane. More...
bool	IncrementID (geo::PlaneID &id) const
geo::PlaneID	GetBeginPlaneID (geo::CryostatID const &id) const
	Returns the ID of the first plane of the specified cryostat. More...
geo::PlaneID	GetEndPlaneID (geo::CryostatID const &id) const
geo::PlaneID	GetBeginPlaneID (geo::TPCID const &id) const
	Returns the ID of the first plane of the specified TPC. More...
geo::PlaneID	GetEndPlaneID (geo::TPCID const &id) const
plane_id_iterator	begin_plane_id () const
	Returns an iterator pointing to the first plane ID in the detector. More...
plane_id_iterator	end_plane_id () const
	Returns an iterator pointing after the last plane ID in the detector. More...
plane_id_iterator	begin_plane_id (geo::CryostatID const &ID) const
plane_id_iterator	end_plane_id (geo::CryostatID const &ID) const
plane_id_iterator	begin_plane_id (geo::TPCID const &ID) const
plane_id_iterator	end_plane_id (geo::TPCID const &ID) const
plane_iterator	begin_plane () const
	Returns an iterator pointing to the first plane in the detector. More...
plane_iterator	end_plane () const
	Returns an iterator pointing after the last plane in the detector. More...
plane_iterator	begin_plane (geo::CryostatID const &ID) const
plane_iterator	end_plane (geo::CryostatID const &ID) const
plane_iterator	begin_plane (geo::TPCID const &ID) const
	Returns an iterator pointing to the first plane in the specified TPC. More...
plane_iterator	end_plane (geo::TPCID const &ID) const
	Returns an iterator pointing after the last plane in the specified TPC. More...
IteratorBox< plane_id_iterator,&GeometryCore::begin_plane_id,&GeometryCore::end_plane_id >	IteratePlaneIDs () const
	Enables ranged-for loops on all plane IDs of the detector. More...
LocalIteratorBox< plane_id_iterator, geo::CryostatID,&GeometryCore::begin_plane_id,&GeometryCore::end_plane_id >	IteratePlaneIDs (geo::CryostatID const &cid) const
	Enables ranged-for loops on all plane IDs of the specified cryostat. More...
LocalIteratorBox< plane_id_iterator, geo::TPCID,&GeometryCore::begin_plane_id,&GeometryCore::end_plane_id >	IteratePlaneIDs (geo::TPCID const &tid) const
	Enables ranged-for loops on all plane IDs of the specified TPC. More...
void	IteratePlaneIDs (geo::PlaneID const &pid) const =delete
	IteratePlaneIDs() is not supported on plane IDs. More...
void	IteratePlaneIDs (geo::WireID const &pid) const =delete
	IteratePlaneIDs() is not supported on wire IDs. More...
void	IteratePlaneIDs (readout::TPCsetID const &) const =delete
	IteratePlaneIDs() is not supported on readout IDs. More...
void	IteratePlaneIDs (readout::ROPID const &) const =delete
	IteratePlaneIDs() is not supported on readout IDs. More...
IteratorBox< plane_iterator,&GeometryCore::begin_plane,&GeometryCore::end_plane >	IteratePlanes () const
	Enables ranged-for loops on all planes of the detector. More...
LocalIteratorBox< plane_iterator, geo::CryostatID,&GeometryCore::begin_plane,&GeometryCore::end_plane >	IteratePlanes (geo::CryostatID const &cid) const
	Enables ranged-for loops on all planes of the specified cryostat. More...
LocalIteratorBox< plane_iterator, geo::TPCID,&GeometryCore::begin_plane,&GeometryCore::end_plane >	IteratePlanes (geo::TPCID const &tid) const
	Enables ranged-for loops on all planes of the specified TPC. More...
void	IteratePlanes (geo::PlaneID const &pid) const =delete
	IteratePlanes() is not supported on plane IDs. More...
void	IteratePlanes (geo::WireID const &pid) const =delete
	IteratePlanes() is not supported on wire IDs. More...
void	IteratePlanes (readout::TPCsetID const &) const =delete
	IteratePlanes() is not supported on readout IDs. More...
void	IteratePlanes (readout::ROPID const &) const =delete
	IteratePlanes() is not supported on readout IDs. More...
View_t	View (geo::PlaneID const &pid) const
	Returns the view (wire orientation) on the channels of specified TPC plane. More...
SigType_t	SignalType (geo::PlaneID const &pid) const
	Returns the type of signal on the channels of specified TPC plane. More...
void	GetBeginID (geo::WireID &id) const
	Initializes the specified ID with the ID of the first wire. More...
void	GetEndID (geo::WireID &id) const
	Initializes the specified ID with the invalid ID after the last wire. More...
bool	IncrementID (geo::WireID &id) const
geo::WireID	GetBeginWireID (geo::CryostatID const &id) const
	Returns the ID of the first wire in the specified cryostat. More...
geo::WireID	GetEndWireID (geo::CryostatID const &id) const
geo::WireID	GetBeginWireID (geo::TPCID const &id) const
	Returns the ID of the first wire of the specified TPC. More...
geo::WireID	GetEndWireID (geo::TPCID const &id) const
geo::WireID	GetBeginWireID (geo::PlaneID const &id) const
	Returns the ID of the first wire of the specified wire plane. More...
geo::WireID	GetEndWireID (geo::PlaneID const &id) const
wire_id_iterator	begin_wire_id () const
	Returns an iterator pointing to the first wire ID in the detector. More...
wire_id_iterator	end_wire_id () const
	Returns an iterator pointing after the last wire ID in the detector. More...
wire_id_iterator	begin_wire_id (geo::CryostatID const &id) const
	Returns an iterator pointing to the first wire ID in specified cryostat. More...
wire_id_iterator	end_wire_id (geo::CryostatID const &id) const
wire_id_iterator	begin_wire_id (geo::TPCID const &id) const
	Returns an iterator pointing to the first wire ID in specified TPC. More...
wire_id_iterator	end_wire_id (geo::TPCID const &id) const
	Returns an iterator pointing after the last wire ID in specified TPC. More...
wire_id_iterator	begin_wire_id (geo::PlaneID const &id) const
	Returns an iterator pointing to the first wire ID in specified plane. More...
wire_id_iterator	end_wire_id (geo::PlaneID const &id) const
	Returns an iterator pointing after the last wire ID in specified plane. More...
wire_iterator	begin_wire () const
	Returns an iterator pointing to the first wire in the detector. More...
wire_iterator	end_wire () const
	Returns an iterator pointing after the last wire in the detector. More...
wire_iterator	begin_wire (geo::CryostatID const &id) const
	Returns an iterator pointing to the first wire in specified cryostat. More...
wire_iterator	end_wire (geo::CryostatID const &id) const
	Returns an iterator pointing after the last wire in specified cryostat. More...
wire_iterator	begin_wire (geo::TPCID const &id) const
	Returns an iterator pointing to the first wire in specified TPC. More...
wire_iterator	end_wire (geo::TPCID const &id) const
	Returns an iterator pointing after the last wire in specified TPC. More...
wire_iterator	begin_wire (geo::PlaneID const &id) const
	Returns an iterator pointing to the first wire in specified plane. More...
wire_iterator	end_wire (geo::PlaneID const &id) const
	Returns an iterator pointing after the last wire in specified plane. More...
IteratorBox< wire_id_iterator,&GeometryCore::begin_wire_id,&GeometryCore::end_wire_id >	IterateWireIDs () const
	Enables ranged-for loops on all wire IDs of the detector. More...
LocalIteratorBox< wire_id_iterator, geo::CryostatID,&GeometryCore::begin_wire_id,&GeometryCore::end_wire_id >	IterateWireIDs (geo::CryostatID const &cid) const
	Enables ranged-for loops on all wire IDs of specified cryostat. More...
LocalIteratorBox< wire_id_iterator, geo::TPCID,&GeometryCore::begin_wire_id,&GeometryCore::end_wire_id >	IterateWireIDs (geo::TPCID const &tid) const
	Enables ranged-for loops on all wire IDs of specified TPC. More...
LocalIteratorBox< wire_id_iterator, geo::PlaneID,&GeometryCore::begin_wire_id,&GeometryCore::end_wire_id >	IterateWireIDs (geo::PlaneID const &pid) const
	Enables ranged-for loops on all wire IDs of specified wire plane. More...
void	IterateWireIDs (geo::WireID const &pid) const =delete
	IterateWireIDs() is not supported on wire IDs. More...
void	IterateWireIDs (readout::TPCsetID const &) const =delete
	IterateWireIDs() is not supported on readout IDs. More...
void	IterateWireIDs (readout::ROPID const &) const =delete
	IterateWireIDs() is not supported on readout IDs. More...
IteratorBox< wire_iterator,&GeometryCore::begin_wire,&GeometryCore::end_wire >	IterateWires () const
	Enables ranged-for loops on all wires of the detector. More...
LocalIteratorBox< wire_iterator, geo::CryostatID,&GeometryCore::begin_wire,&GeometryCore::end_wire >	IterateWires (geo::CryostatID const &cid) const
	Enables ranged-for loops on all wires of specified cryostat. More...
LocalIteratorBox< wire_iterator, geo::TPCID,&GeometryCore::begin_wire,&GeometryCore::end_wire >	IterateWires (geo::TPCID const &tid) const
	Enables ranged-for loops on all wires of specified TPC. More...
LocalIteratorBox< wire_iterator, geo::PlaneID,&GeometryCore::begin_wire,&GeometryCore::end_wire >	IterateWires (geo::PlaneID const &tid) const
	Enables ranged-for loops on all wires of specified wire plane. More...
void	IterateWires (geo::WireID const &pid) const =delete
	IterateWires() is not supported on wire IDs. More...
void	IterateWires (readout::TPCsetID const &) const =delete
	IterateWires() is not supported on readout IDs. More...
void	IterateWires (readout::ROPID const &) const =delete
	IterateWires() is not supported on readout IDs. More...
geo::Length_t	WirePitch (geo::View_t view) const
	Returns the distance between two wires in the specified view. More...
geo::WireID	NearestWireID (geo::Point_t const &point, geo::PlaneID const &planeid) const
	Returns the ID of wire closest to position in the specified TPC. More...
geo::WireID::WireID_t	NearestWire (geo::Point_t const &point, geo::PlaneID const &planeid) const
	Returns the index of wire closest to position in the specified TPC. More...
geo::Length_t	WireCoordinate (double YPos, double ZPos, geo::PlaneID const &planeid) const
	Returns the index of the nearest wire to the specified position. More...
geo::Length_t	WireCoordinate (double YPos, double ZPos, unsigned int PlaneNo, unsigned int TPCNo, unsigned int cstat) const
	Returns the index of the nearest wire to the specified position. More...
bool	IntersectLines (double A_start_x, double A_start_y, double A_end_x, double A_end_y, double B_start_x, double B_start_y, double B_end_x, double B_end_y, double &x, double &y) const
	Computes the intersection between two lines on a plane. More...
bool	IntersectSegments (double A_start_x, double A_start_y, double A_end_x, double A_end_y, double B_start_x, double B_start_y, double B_end_x, double B_end_y, double &x, double &y) const
	Computes the intersection between two segments on a plane. More...
bool	IntersectionPoint (geo::WireID const &wid1, geo::WireID const &wid2, double &y, double &z) const
	Returns the intersection point of two wires. More...
bool	IntersectionPoint (unsigned int wire1, unsigned int wire2, unsigned int plane1, unsigned int plane2, unsigned int cstat, unsigned int tpc, double &y, double &z) const
	Returns the intersection point of two wires. More...
geo::PlaneID	ThirdPlane (geo::PlaneID const &pid1, geo::PlaneID const &pid2) const
	Returns the plane that is not in the specified arguments. More...
double	ThirdPlaneSlope (geo::PlaneID const &pid1, double slope1, geo::PlaneID const &pid2, double slope2, geo::PlaneID const &output_plane) const
	Returns the slope on the third plane, given it in the other two. More...
double	ThirdPlaneSlope (geo::PlaneID const &pid1, double slope1, geo::PlaneID const &pid2, double slope2) const
	Returns the slope on the third plane, given it in the other two. More...
double	ThirdPlane_dTdW (geo::PlaneID const &pid1, double slope1, geo::PlaneID const &pid2, double slope2, geo::PlaneID const &output_plane) const
	Returns dT/dW on the third plane, given it in the other two. More...
double	ThirdPlane_dTdW (geo::PlaneID const &pid1, double slope1, geo::PlaneID const &pid2, double slope2) const
	Returns dT/dW on the third plane, given it in the other two. More...
std::string	OpDetGeoName (unsigned int c=0) const
	Returns gdml string which gives sensitive opdet name. More...
SigType_t	SignalType (raw::ChannelID_t const channel) const
	Returns the type of signal on the specified TPC channel. More...
View_t	View (raw::ChannelID_t const channel) const
	Returns the view (wire orientation) on the specified TPC channel. More...
std::vector< geo::WireID >	ChannelToWire (raw::ChannelID_t const channel) const
	Returns a list of wires connected to the specified TPC channel. More...
readout::ROPID	ChannelToROP (raw::ChannelID_t channel) const
raw::ChannelID_t	NearestChannel (geo::Point_t const &worldLoc, geo::PlaneID const &planeid) const
	Returns the ID of the channel nearest to the specified position. More...
bool	ChannelsIntersect (raw::ChannelID_t c1, raw::ChannelID_t c2, double &y, double &z) const
	Returns an intersection point of two channels. More...
unsigned int	MaxTPCsets () const
	Returns the largest number of TPC sets any cryostat in the detector has. More...
template<typename T >
readout::TPCsetDataContainer< T >	makeTPCsetData () const
	Returns a container with one entry per TPC set. More...
template<typename T >
readout::TPCsetDataContainer< T >	makeTPCsetData (T const &defValue) const
	Returns a container with one entry per TPC set. More...
bool	HasTPCset (readout::TPCsetID const &tpcsetid) const
bool	HasElement (readout::TPCsetID const &tpcsetid) const
	Returns whether we have the specified TPC set. More...
readout::TPCsetID	FindTPCsetAtPosition (double const worldLoc[3]) const
	Returns the ID of the TPC set at specified location. More...
readout::TPCsetID	TPCtoTPCset (geo::TPCID const &tpcid) const
	Returns the ID of the TPC set tpcid belongs to. More...
std::vector< geo::TPCID >	TPCsetToTPCs (readout::TPCsetID const &tpcsetid) const
	Returns a list of ID of TPCs belonging to the specified TPC set. More...
void	GetBeginID (readout::TPCsetID &id) const
	Initializes the specified ID with the ID of the first TPC set. More...
void	GetEndID (readout::TPCsetID &id) const
	Initializes the specified ID with the invalid ID after the last TPC set. More...
bool	IncrementID (readout::TPCsetID &id) const
readout::TPCsetID	GetBeginTPCsetID (geo::CryostatID const &id) const
	Returns the ID of the first TPC set in the specified cryostat. More...
readout::TPCsetID	GetEndTPCsetID (geo::CryostatID const &id) const
TPCset_id_iterator	begin_TPCset_id () const
	Returns an iterator pointing to the first TPC set ID in the detector. More...
TPCset_id_iterator	end_TPCset_id () const
	Returns an iterator pointing after the last TPC set ID in the detector. More...
TPCset_id_iterator	begin_TPCset_id (geo::CryostatID const &cid) const
TPCset_id_iterator	end_TPCset_id (geo::CryostatID const &cid) const
IteratorBox< TPCset_id_iterator,&GeometryCore::begin_TPCset_id,&GeometryCore::end_TPCset_id >	IterateTPCsetIDs () const
	Enables ranged-for loops on all TPC set IDs of the detector. More...
LocalIteratorBox< TPCset_id_iterator, geo::CryostatID,&GeometryCore::begin_TPCset_id,&GeometryCore::end_TPCset_id >	IterateTPCsetIDs (geo::CryostatID const &cid) const
	Enables ranged-for loops on all TPC set IDs of the specified cryostat. More...
unsigned int	MaxROPs () const
	Returns the largest number of ROPs a TPC set in the detector has. More...
template<typename T >
readout::ROPDataContainer< T >	makeROPdata () const
	Returns a container with one entry per readout plane. More...
template<typename T >
readout::ROPDataContainer< T >	makeROPdata (T const &defValue) const
	Returns a container with one entry per readout plane. More...
bool	HasROP (readout::ROPID const &ropid) const
bool	HasElement (readout::ROPID const &ropid) const
readout::ROPID	WirePlaneToROP (geo::PlaneID const &planeid) const
	Returns the ID of the ROP planeid belongs to. More...
std::vector< geo::PlaneID >	ROPtoWirePlanes (readout::ROPID const &ropid) const
	Returns a list of ID of planes belonging to the specified ROP. More...
std::vector< geo::TPCID >	ROPtoTPCs (readout::ROPID const &ropid) const
	Returns a list of ID of TPCs the specified ROP spans. More...
raw::ChannelID_t	FirstChannelInROP (readout::ROPID const &ropid) const
	Returns the ID of the first channel in the specified readout plane. More...
void	GetBeginID (readout::ROPID &id) const
	Initializes the specified ID with the ID of the first readout plane. More...
void	GetEndID (readout::ROPID &id) const
	Initializes the specified ID with the invalid ID after the last ROP. More...
bool	IncrementID (readout::ROPID &id) const
readout::ROPID	GetBeginROPID (geo::CryostatID const &id) const
	Returns the ID of the first readout plane of the specified cryostat. More...
readout::ROPID	GetEndROPID (geo::CryostatID const &id) const
readout::ROPID	GetBeginROPID (readout::TPCsetID const &id) const
	Returns the ID of the first readout plane of the specified TPC set. More...
readout::ROPID	GetEndROPID (readout::TPCsetID const &id) const
ROP_id_iterator	begin_ROP_id () const
	Returns an iterator pointing to the first ROP ID in the detector. More...
ROP_id_iterator	end_ROP_id () const
	Returns an iterator pointing after the last ROP ID in the detector. More...
ROP_id_iterator	begin_ROP_id (geo::CryostatID const &ID) const
ROP_id_iterator	end_ROP_id (geo::CryostatID const &ID) const
ROP_id_iterator	begin_ROP_id (readout::TPCsetID const &ID) const
ROP_id_iterator	end_ROP_id (readout::TPCsetID const &ID) const
IteratorBox< ROP_id_iterator,&GeometryCore::begin_ROP_id,&GeometryCore::end_ROP_id >	IterateROPIDs () const
	Enables ranged-for loops on all readout plane IDs of the detector. More...
LocalIteratorBox< ROP_id_iterator, geo::CryostatID,&GeometryCore::begin_ROP_id,&GeometryCore::end_ROP_id >	IterateROPIDs (geo::CryostatID const &cid) const
	Enables ranged-for loops on all readout plane IDs of the specified cryostat. More...
LocalIteratorBox< ROP_id_iterator, readout::TPCsetID,&GeometryCore::begin_ROP_id,&GeometryCore::end_ROP_id >	IterateROPIDs (readout::TPCsetID const &sid) const
	Enables ranged-for loops on all readout plane IDs of the specified TPC set. More...
geo::View_t	View (readout::ROPID const &ropid) const
	Returns the view of the channels in the specified readout plane. More...
geo::SigType_t	SignalType (readout::ROPID const &ropid) const
	Returns the type of signal of channels in specified readout plane. More...
bool	ValueInRange (double value, double min, double max) const
	Returns whether a value is within the specified range. More...
template<typename Point >
geo::GeometryCore::Segment< Point >	WireEndPoints (geo::WireID const &wireid) const
std::string	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...
geo::BoxBoundedGeo	WorldBox () const
geo::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...
const std::string	GetWorldVolumeName () const
	Return the name of the world volume (needed by Geant4 simulation) More...
geo::BoxBoundedGeo	DetectorEnclosureBox (std::string const &name="volDetEnclosure") const
std::string	VolumeName (geo::Point_t const &point) const
	Returns the name of the deepest volume containing specified point. More...
std::string	VolumeName (TVector3 const &point) const
std::string	MaterialName (TVector3 const &point) const
	Name of the deepest material containing the point xyz. More...
std::string	MaterialName (geo::Point_t const &point) const
double	TotalMass () const
	Returns the total mass [kg] of the specified volume (default: world). More...
double	TotalMass (std::string vol) const
double	MassBetweenPoints (geo::Point_t const &p1, geo::Point_t const &p2) const
	Returns the column density between two points. More...
double	MassBetweenPoints (double *p1, double *p2) const
unsigned int	Ncryostats () const
	Returns the number of cryostats in the detector. More...
unsigned int	NElements () const
unsigned int	NSiblingElements (geo::CryostatID const &) const
bool	HasCryostat (geo::CryostatID const &cryoid) const
	Returns whether we have the specified cryostat. More...
bool	HasElement (geo::CryostatID const &cryoid) const
CryostatGeo const &	Cryostat (geo::CryostatID const &cryoid) const
	Returns the specified cryostat. More...
CryostatGeo const &	Cryostat (unsigned int const cstat=0) const
CryostatGeo const &	GetElement (geo::CryostatID const &cryoid) const
CryostatGeo const *	CryostatPtr (geo::CryostatID const &cryoid) const
	Returns the specified cryostat. More...
CryostatGeo const *	GetElementPtr (geo::CryostatID const &cryoid) const
geo::CryostatID::CryostatID_t	FindCryostatAtPosition (geo::Point_t const &worldLoc) const
	Returns the index of the cryostat at specified location. More...
geo::CryostatID::CryostatID_t	FindCryostatAtPosition (double const worldLoc[3]) const
CryostatGeo const &	PositionToCryostat (geo::Point_t const &point) const
	Returns the cryostat at specified location. More...
CryostatGeo const &	PositionToCryostat (double const point[3]) const
geo::Length_t	CryostatHalfWidth (geo::CryostatID const &cid) const
	Returns the half width of the cryostat (x direction) More...
geo::Length_t	CryostatHalfWidth (unsigned int cstat=0) const
geo::Length_t	CryostatHalfHeight (geo::CryostatID const &cid) const
	Returns the height of the cryostat (y direction) More...
geo::Length_t	CryostatHalfHeight (unsigned int cstat=0) const
geo::Length_t	CryostatLength (geo::CryostatID const &cid) const
	Returns the length of the cryostat (z direction) More...
geo::Length_t	CryostatLength (unsigned int cstat=0) const
std::string	GetCryostatVolumeName (geo::CryostatID const &cid) const
	Return the name of LAr TPC volume. More...
std::string	GetCryostatVolumeName (unsigned int const cstat=0) const
unsigned int	NTPC (unsigned int cstat=0) const
	Returns the total number of TPCs in the specified cryostat. More...
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...
template<typename T >
geo::TPCDataContainer< T >	makeTPCData () const
	Returns a container with one entry per TPC. More...
template<typename T >
geo::TPCDataContainer< T >	makeTPCData (T const &defValue) const
	Returns a container with one entry per TPC. More...
unsigned int	NTPC (geo::CryostatID const &cryoid) const
	Returns the total number of TPCs in the specified cryostat. More...
unsigned int	NElements (geo::CryostatID const &cryoid) const
unsigned int	NSiblingElements (geo::TPCID const &tpcid) const
TPCGeo const &	TPC (unsigned int const tpc=0, unsigned int const cstat=0) const
	Returns the specified TPC. More...
TPCGeo const &	TPC (geo::TPCID const &tpcid) const
TPCGeo const &	GetElement (geo::TPCID const &tpcid) const
TPCGeo const *	TPCPtr (geo::TPCID const &tpcid) const
	Returns the specified TPC. More...
TPCGeo const *	GetElementPtr (geo::TPCID const &tpcid) const
geo::TPCID	FindTPCAtPosition (geo::Point_t const &point) const
	Returns the ID of the TPC at specified location. More...
geo::TPCID	FindTPCAtPosition (TVector3 const &point) const
geo::TPCGeo const &	PositionToTPC (geo::Point_t const &point) const
	Returns the TPC at specified location. More...
TPCGeo const &	PositionToTPC (double const point[3]) const
geo::Length_t	DetHalfWidth (geo::TPCID const &tpcid) const
	Returns the half width of the active volume of the specified TPC. More...
geo::Length_t	DetHalfWidth (unsigned int tpc=0, unsigned int cstat=0) const
geo::Length_t	DetHalfHeight (geo::TPCID const &tpcid) const
	Returns the half height of the active volume of the specified TPC. More...
geo::Length_t	DetHalfHeight (unsigned int tpc=0, unsigned int cstat=0) const
geo::Length_t	DetLength (geo::TPCID const &tpcid) const
	Returns the length of the active volume of the specified TPC. More...
geo::Length_t	DetLength (unsigned int tpc=0, unsigned int cstat=0) const
template<typename Point >
Point	GetTPCFrontFaceCenter (geo::TPCID const &tpcid) const
	Returns the center of side of the detector facing the beam. More...
DefaultPoint_t	GetTPCFrontFaceCenter (geo::TPCID const &tpcid) const
template<typename Point >
Point	GetTPCFrontFaceCenter (unsigned int tpc=0, unsigned int cstat=0) const
	Returns the center of side of the detector facing the beam. More...
DefaultPoint_t	GetTPCFrontFaceCenter (unsigned int tpc=0, unsigned int cstat=0) const
std::string	GetLArTPCVolumeName (geo::TPCID const &tpcid) const
	Return the name of specified LAr TPC volume. More...
std::string	GetLArTPCVolumeName (unsigned int const tpc=0, unsigned int const cstat=0) const
unsigned int	Nplanes (unsigned int tpc=0, unsigned int cstat=0) const
	Returns the total number of wire planes in the specified TPC. More...
unsigned int	MaxPlanes () const
	Returns the largest number of planes among all TPCs in this detector. More...
template<typename T >
geo::PlaneDataContainer< T >	makePlaneData () const
	Returns a container with one entry per wire plane. More...
template<typename T >
geo::PlaneDataContainer< T >	makePlaneData (T const &defValue) const
	Returns a container with one entry per wire plane. More...
unsigned int	Nplanes (geo::TPCID const &tpcid) const
	Returns the total number of planes in the specified TPC. More...
unsigned int	NElements (geo::TPCID const &tpcid) const
unsigned int	NSiblingElements (geo::PlaneID const &planeid) const
bool	HasPlane (geo::PlaneID const &planeid) const
	Returns whether we have the specified plane. More...
bool	HasElement (geo::PlaneID const &planeid) const
PlaneGeo const &	Plane (unsigned int const p, unsigned int const tpc=0, unsigned int const cstat=0) const
	Returns the specified wire. More...
PlaneGeo const &	Plane (geo::PlaneID const &planeid) const
PlaneGeo const &	GetElement (geo::PlaneID const &planeid) const
PlaneGeo const *	PlanePtr (geo::PlaneID const &planeid) const
	Returns the specified plane. More...
PlaneGeo const *	GetElementPtr (geo::PlaneID const &planeid) const
geo::Length_t	PlanePitch (geo::TPCID const &tpcid, geo::PlaneID::PlaneID_t p1=0, geo::PlaneID::PlaneID_t p2=1) const
	Returns the distance between two planes. More...
geo::Length_t	PlanePitch (geo::PlaneID const &pid1, geo::PlaneID const &pid2) const
geo::Length_t	PlanePitch (unsigned int p1=0, unsigned int p2=1, unsigned int tpc=0, unsigned int cstat=0) const
unsigned int	Nwires (unsigned int p, unsigned int tpc=0, unsigned int cstat=0) const
	Returns the total number of wires in the specified plane. More...
unsigned int	Nwires (geo::PlaneID const &planeid) const
	Returns the total number of wires in the specified plane. More...
unsigned int	NElements (geo::PlaneID const &planeid) const
unsigned int	NSiblingElements (geo::WireID const &wireid) const
unsigned int	MaxWires () const
	Returns the largest number of wires among all planes in this detector. More...
bool	HasWire (geo::WireID const &wireid) const
	Returns whether we have the specified wire. More...
bool	HasElement (geo::WireID const &wireid) const
WireGeo const *	WirePtr (geo::WireID const &wireid) const
	Returns the specified wire. More...
WireGeo const *	GetElementPtr (geo::WireID const &wireid) const
WireGeo const &	Wire (geo::WireID const &wireid) const
	Returns the specified wire. More...
WireGeo const &	WireIDToWireGeo (geo::WireID const &wireid) const
WireGeo const &	GetElement (geo::WireID const &wireid) const
geo::Length_t	WirePitch (geo::PlaneID const &planeid) const
	Returns the distance between two consecutive wires. More...
geo::Length_t	WirePitch (unsigned int plane=0, unsigned int tpc=0, unsigned int cstat=0) const
double	WireAngleToVertical (geo::View_t view, geo::TPCID const &tpcid) const
	Returns the angle of the wires in the specified view from vertical. More...
double	WireAngleToVertical (geo::View_t view, int TPC=0, int Cryo=0) const
void	WireEndPoints (geo::WireID const &wireid, double *xyzStart, double *xyzEnd) const
	Fills two arrays with the coordinates of the wire end points. More...
void	WireEndPoints (unsigned int cstat, unsigned int tpc, unsigned int plane, unsigned int wire, double *xyzStart, double *xyzEnd) const
	Fills two arrays with the coordinates of the wire end points. More...
template<typename Point >
Segment< Point >	WireEndPoints (geo::WireID const &wireID) const
	Returns a segment whose ends are the wire end points. More...
Segment< DefaultPoint_t >	WireEndPoints (geo::WireID const &wireID) const
geo::WireID	NearestWireID (const double point[3], geo::PlaneID const &planeid) const
	Returns the ID of wire closest to position in the specified TPC. More...
geo::WireID	NearestWireID (std::vector< double > const &point, geo::PlaneID const &planeid) const
geo::WireID	NearestWireID (const TVector3 &point, geo::PlaneID const &planeid) const
geo::WireID	NearestWireID (const double point[3], unsigned int const PlaneNo, unsigned int const TPCNo=0, unsigned int const cstat=0) const
geo::WireID	NearestWireID (std::vector< double > const &point, unsigned int const PlaneNo, unsigned int const TPCNo=0, unsigned int const cstat=0) const
geo::WireID	NearestWireID (const TVector3 &point, unsigned int const PlaneNo, unsigned int const TPCNo=0, unsigned int const cstat=0) const
geo::WireID	NearestWireID (geo::Point_t const &point, unsigned int const PlaneNo, unsigned int const TPCNo=0, unsigned int const cstat=0) const
unsigned int	NearestWire (const double worldLoc[3], geo::PlaneID const &planeid) const
	Returns the index of wire closest to position in the specified TPC. More...
unsigned int	NearestWire (std::vector< double > const &worldLoc, geo::PlaneID const &planeid) const
unsigned int	NearestWire (const TVector3 &worldLoc, geo::PlaneID const &planeid) const
unsigned int	NearestWire (const double worldLoc[3], unsigned int const PlaneNo, unsigned int const TPCNo=0, unsigned int const cstat=0) const
unsigned int	NearestWire (std::vector< double > const &worldLoc, unsigned int const PlaneNo, unsigned int const TPCNo=0, unsigned int const cstat=0) const
unsigned int	NearestWire (const TVector3 &worldLoc, unsigned int const PlaneNo, unsigned int const TPCNo=0, unsigned int const cstat=0) const
unsigned int	NearestWire (geo::Point_t const &worldLoc, unsigned int const PlaneNo, unsigned int const TPCNo=0, unsigned int const cstat=0) const
geo::Length_t	WireCoordinate (geo::Point_t const &pos, geo::PlaneID const &planeid) const
	Returns the index of the nearest wire to the specified position. More...
geo::Length_t	WireCoordinate (TVector3 const &pos, geo::PlaneID const &planeid) const
bool	WireIDsIntersect (WireID const &wid1, WireID const &wid2, geo::Point_t &intersection) const
	Computes the intersection between two wires. More...
bool	WireIDsIntersect (WireID const &wid1, WireID const &wid2, TVector3 &intersection) const
bool	WireIDsIntersect (WireID const &wid1, WireID const &wid2, WireIDIntersection &widIntersect) const
	Computes the intersection between two wires. More...
double	ThirdPlaneSlope (geo::PlaneID::PlaneID_t plane1, double slope1, geo::PlaneID::PlaneID_t plane2, double slope2, geo::TPCID const &tpcid) const
	Returns the slope on the third plane, given it in the other two. More...
double	ThirdPlaneSlope (unsigned int plane1, double slope1, unsigned int plane2, double slope2, unsigned int tpc, unsigned int cstat) const
unsigned int	NOpDets () const
	Number of OpDets in the whole detector. More...
OpDetGeo const &	OpDetGeoFromOpChannel (unsigned int OpChannel) const
	Returns the geo::OpDetGeo object for the given channel number. More...
OpDetGeo const &	OpDetGeoFromOpDet (unsigned int OpDet) const
	Returns the geo::OpDetGeo object for the given detector number. More...
unsigned int	GetClosestOpDet (geo::Point_t const &point) const
	Find the nearest OpChannel to some point. More...
unsigned int	GetClosestOpDet (double const *point) const
unsigned int	NAuxDets () const
	Returns the number of auxiliary detectors. More...
unsigned int	NAuxDetSensitive (size_t const &aid) const
	Returns the number of sensitive components of auxiliary detector. More...
AuxDetGeo const &	AuxDet (unsigned int const ad=0) const
	Returns the specified auxiliary detector. More...
unsigned int	FindAuxDetAtPosition (double const worldLoc[3], double tolerance=0) const
	Returns the index of the auxiliary detector at specified location. More...
unsigned int	FindAuxDetAtPosition (geo::Point_t const &point, double tolerance=0) const
	Returns the index of the auxiliary detector at specified location. More...
void	FindAuxDetSensitiveAtPosition (geo::Point_t const &point, std::size_t &adg, std::size_t &sv, double tolerance=0) const
	Fills the indices of the sensitive auxiliary detector at location. More...
void	FindAuxDetSensitiveAtPosition (double const worldLoc[3], size_t &adg, size_t &sv, double tolerance=0) const
	Fills the indices of the sensitive auxiliary detector at location. More...
AuxDetGeo const &	PositionToAuxDet (geo::Point_t const &point, unsigned int &ad, double tolerance=0) const
	Returns the auxiliary detector at specified location. More...
AuxDetGeo const &	PositionToAuxDet (double const worldLoc[3], unsigned int &ad, double tolerance=0) const
	Returns the auxiliary detector at specified location. More...
const AuxDetSensitiveGeo &	PositionToAuxDetSensitive (geo::Point_t const &point, size_t &ad, size_t &sv, double tolerance=0) const
	Returns the auxiliary detector at specified location. More...
const AuxDetSensitiveGeo &	PositionToAuxDetSensitive (double const worldLoc[3], size_t &ad, size_t &sv, double tolerance=0) const
	Returns the auxiliary detector at specified location. More...
const AuxDetGeo &	ChannelToAuxDet (std::string const &auxDetName, uint32_t const &channel) const
const AuxDetSensitiveGeo &	ChannelToAuxDetSensitive (std::string const &auxDetName, uint32_t const &channel) const
unsigned int	Nchannels () const
	Returns the number of TPC readout channels in the detector. More...
unsigned int	Nchannels (readout::ROPID const &ropid) const
	Returns the number of channels in the specified ROP. More...
std::vector< raw::ChannelID_t >	ChannelsInTPCs () const
	Returns an std::vector<ChannelID_t> in all TPCs in a TPCSet. More...
std::set< geo::View_t > const &	Views () const
	Returns a list of possible views in the detector. More...
bool	HasChannel (raw::ChannelID_t channel) const
	Returns whether the specified channel exists and is valid. More...
raw::ChannelID_t	PlaneWireToChannel (WireID const &wireid) const
	Returns the ID of the TPC channel connected to the specified wire. More...
raw::ChannelID_t	PlaneWireToChannel (unsigned int const plane, unsigned int const wire, unsigned int const tpc=0, unsigned int const cstat=0) const
raw::ChannelID_t	NearestChannel (const double worldLoc[3], geo::PlaneID const &planeid) const
	Returns the ID of the channel nearest to the specified position. More...
raw::ChannelID_t	NearestChannel (std::vector< double > const &worldLoc, geo::PlaneID const &planeid) const
raw::ChannelID_t	NearestChannel (const TVector3 &worldLoc, geo::PlaneID const &planeid) const
raw::ChannelID_t	NearestChannel (const double worldLoc[3], unsigned int const PlaneNo, unsigned int const TPCNo=0, unsigned int const cstat=0) const
raw::ChannelID_t	NearestChannel (std::vector< double > const &worldLoc, unsigned int const PlaneNo, unsigned int const TPCNo=0, unsigned int const cstat=0) const
raw::ChannelID_t	NearestChannel (const TVector3 &worldLoc, unsigned int const PlaneNo, unsigned int const TPCNo=0, unsigned int const cstat=0) const
raw::ChannelID_t	NearestChannel (geo::Point_t const &worldLoc, unsigned int const PlaneNo, unsigned int const TPCNo=0, unsigned int const cstat=0) const
unsigned int	NTPCsets (readout::CryostatID const &cryoid) const
	Returns the total number of TPC sets in the specified cryostat. More...
unsigned int	NSiblingElements (readout::TPCsetID const &tpcsetid) const
unsigned int	NROPs (readout::TPCsetID const &tpcsetid) const
	Returns the total number of ROP in the specified TPC set. More...
unsigned int	NSiblingElements (readout::ROPID const &ropid) const
unsigned int	NOpChannels () const
	Number of electronics channels for all the optical detectors. More...
unsigned int	MaxOpChannel () const
	Largest optical channel number. More...
unsigned int	NOpHardwareChannels (int opDet) const
bool	IsValidOpChannel (int opChannel) const
	Is this a valid OpChannel number? More...
unsigned int	OpChannel (int detNum, int hardwareChannel) const
	Convert detector number and hardware channel to unique channel. More...
unsigned int	OpDetFromOpChannel (int opChannel) const
	Convert unique channel to detector number. More...
unsigned int	HardwareChannelFromOpChannel (int opChannel) const
	Convert unique channel to hardware channel. More...
unsigned int	OpDetFromCryo (unsigned int o, unsigned int c) const
	Get unique opdet number from cryo and internal count. More...
void	LoadGeometryFile (std::string gdmlfile, std::string rootfile, geo::GeometryBuilder &builder, bool bForceReload=false)
	Loads the geometry information from the specified files. More...
void	LoadGeometryFile (std::string gdmlfile, std::string rootfile, bool bForceReload=false)
	Loads the geometry information from the specified files. More...
void	ApplyChannelMap (std::unique_ptr< geo::ChannelMapAlg > pChannelMap)
	Initializes the geometry to work with this channel map. More...

Private Member Functions
void	preBeginRun (art::Run const &run)
	Updates the geometry if needed at the beginning of each new run. More...
void	LoadNewGeometry (std::string gdmlfile, std::string rootfile, bool bForceReload=false)
	Expands the provided paths and loads the geometry description(s) More...
void	InitializeChannelMap ()

Private Attributes
std::string	fRelPath
bool	fDisableWiresInG4
bool	fNonFatalConfCheck
fhicl::ParameterSet	fSortingParameters
	Parameter set to define the channel map sorting. More...
fhicl::ParameterSet	fBuilderParameters
	Parameter set for geometry builder. More...
sumdata::GeometryConfigurationInfo	fConfInfo
	Summary of service configuration. More...

Configuration information checks
void	FillGeometryConfigurationInfo (fhicl::ParameterSet const &config)
	Fills the service configuration information into fConfInfo. More...
bool	CheckConfigurationInfo (sumdata::GeometryConfigurationInfo const &other) const
	Returns if the other configuration is compatible with our current. More...
static sumdata::GeometryConfigurationInfo const &	ReadConfigurationInfo (art::Run const &run)
	Reads and returns the geometry configuration information from the run. More...
static bool	CompareConfigurationInfo (sumdata::GeometryConfigurationInfo const &A, sumdata::GeometryConfigurationInfo const &B)
	Returns if A and B are compatible geometry service configurations. More...

Additional Inherited Members
Static Public Member Functions inherited from geo::GeometryCore
static double	ComputeThirdPlaneSlope (double angle1, double slope1, double angle2, double slope2, double angle_target)
	Returns the slope on the third plane, given it in the other two. More...
static double	ComputeThirdPlane_dTdW (double angle1, double pitch1, double dTdW1, double angle2, double pitch2, double dTdW2, double angle_target, double pitch_target)
	Returns the slope on the third plane, given it in the other two. More...
Static Public Attributes inherited from geo::GeometryCore
static constexpr std::size_t	MaxWireDepthInGDML = 20U
static lar::util::RealComparisons< geo::Length_t >	coordIs { 1e-8 }
	Value of tolerance for equality comparisons. More...
Protected Member Functions inherited from geo::GeometryCore
void	SetDetectorName (std::string const &new_name)
	Sets the detector name. More...
geo::ChannelMapAlg const *	ChannelMap () const
	Returns the object handling the channel map. More...
CryostatList_t &	Cryostats ()
	Return the internal cryostat list. More...
CryostatList_t const &	Cryostats () const
AuxDetList_t &	AuxDets ()
	Return the interfal auxiliary detectors list. More...
AuxDetList_t const &	AuxDets () const

Detailed Description

The geometry of one entire detector, as served by art.

This class extends the interface of the geometry service provider, GeometryCore, to the one of an art service. It handles the correct initialization of the provider using information

It relies on geo::ExptGeoHelperInterface service to obtain the channel mapping algorithm proper for the selected geometry.

The geometry initialization happens immediately on construction. Optionally, the geometry is automatically reinitialized on each run based on the information contained in the art::Run object.

Configuration

In addition to the parameters documented in geo::GeometryCore, the following parameters are supported:

• RelativePath (string, default: no path): this path is prepended to the geometry file names before searching from them; the path string does not affect the file name
• GDML (string, mandatory): path of the GDML file to be served to Geant4 for detector simulation. The full file is composed out of the optional relative path specified by RelativePath path and the base name specified in GDML parameter; this path is searched for in the directories configured in the FW_SEARCH_PATH environment variable;
• ROOT (string, mandatory): currently overridden by GDML parameter, whose value is used instead; this path is assembled in the same way as the one for GDML parameter, except that no alternative (wireless) geometry is used even if DisableWiresInG4 is specified (see below); this file is used to load the geometry used in the internal simulation and reconstruction, basically everywhere except for the Geant4 simulation
• DisableWiresInG4 (boolean, default: false): if true, Geant4 is loaded with an alternative geometry from a file with the standard name as configured with the /GDML/ parameter, but with an additional "_nowires" appended before the ".gdml" suffix
• SkipConfigurationCheck (boolean, default: false): if set to true, failure of configuration consistency check described below is not fatal and it will just produce a warning on each failure;
• SortingParameters (a parameter set; default: empty): this configuration is directly passed to the channel mapping algorithm (see geo::ChannelMapAlg); its content is dependent on the chosen implementation of geo::ChannelMapAlg
• Builder (a parameter set: default: empty): configuration for the geometry builder; if omitted, the standard builder (geo::GeometryBuilderStandard) with standard configuration will be used; if specified, currently the standard builder is nevertheless used; this interface can be "toolized", in which case this parameter set will select and configure the chosen tool.

Note

Currently, the file defined by GDML parameter is also served to ROOT for the internal geometry representation.

Configuration consistency check

The Geometry service checks that the input files were processed with a configuration of Geometry service compatible with the current one.

Two checks may be performed: the standard check, and a legacy check.

Consistency check

The Geometry service checks at the beginning of each run that the current configuration is compatible with the geometry configuration declared in the input file. The Geometry service requires that an additional service, GeometryConfigurationWriter, is run: this service is charged with writing the configuration information into the output files, for the checks in the future job.

The compatibility check is currently very silly, but it can improved in future versions. This check is the same as the legacy check, that verifies that the configured detector name (geo::GeometryCore::DetectorName()) has not changed.

To allow this check to operate correctly, the only requirement is that the service GeometryConfigurationWriter be included in the job:

services.GeometryConfigurationWriter: {}

This must happen on the first job in the processing chain that configures Geometry service. It is irrelevant, but not harmful, in the jobs that follow.

Design details

This section describes the full design of the check from a technical point of view. Users do not need to understand the mechanisms of this check in order to configure their jobs to successfully pass it.

The check happens based on the data contained in the sumdata::GeometryConfigurationInfo data product. Starting from after the construction is complete, geo::Geometry is able to provide at any time an instance of sumdata::GeometryConfigurationInfo describing the geometry configuration for this job, whether the geometry is already configured or not.

The Geometry service loads the geometry at the beginning of the job. At the start of each run from the input file, the Geometry service reads a configuration information sumdata::GeometryConfigurationInfo from the art::Run record and verifies that it is compatible with the current configuration. It is a fatal error for this information not to be available in art::Run, and it is a fatal check failure if the available information is not compatible with the current configuration.

The sumdata::GeometryConfigurationInfo information is put into art::Run record by the geo::GeometryConfigurationWriter producing service. This service verifies whether there is already such information in the run. If no information is available yet in art::Run, the service obtains the current configuration information from the Geometry service, and then puts it into the art::Run record. The art framework guarantees that this happens before the Geometry service itself is notified by art of the start of the new run. If some geo::GeometryConfigurationWriter information is already in the run record, geo::GeometryConfigurationWriter replicates it again. As legacy check, if there is no information in the sumdata::GeometryConfigurationInfo form but there is a sumdata::RunData data product, the latter is used as a base for the check.

Design notes:

• the choice of delegating the writing of data product to a producing service rather than to modules is driven by the fact that there is a way to enforce this service to be actually run, and that no further instrumentation is needed;
• the choice of putting the configuration information in the art::Run is driven by the fact that the run is the highest available container; job-level data products (art::Results) behave very differently from the others and are not currently interfaced with a producing service;
• the information in sumdata::GeometryConfigurationInfo should be compact enough not to bloat the data files with very few events per run, as it may be for the selection of rare processes or signatures.

Definition at line 196 of file Geometry.h.

Member Typedef Documentation

using geo::Geometry::provider_type = GeometryCore

type of service provider

Definition at line 200 of file Geometry.h.

Constructor & Destructor Documentation

geo::Geometry::Geometry	(	fhicl::ParameterSet const &	pset,
		art::ActivityRegistry &	reg
	)

Definition at line 38 of file Geometry_service.cc.

    : GeometryCore(pset)
    , fRelPath          (pset.get< std::string       >("RelativePath",     ""   ))
    , fDisableWiresInG4 (pset.get< bool              >("DisableWiresInG4", false))
    , fNonFatalConfCheck(pset.get< bool              >("SkipConfigurationCheck", false))
    , fSortingParameters(pset.get<fhicl::ParameterSet>("SortingParameters", fhicl::ParameterSet() ))
    , fBuilderParameters(pset.get<fhicl::ParameterSet>("Builder",          fhicl::ParameterSet() ))
  {

    if (pset.has_key("ForceUseFCLOnly")) {
      throw art::Exception(art::errors::Configuration)
        << "Geometry service does not support `ForceUseFCLOnly` configuration parameter any more.\n";
    }

    // add a final directory separator ("/") to fRelPath if not already there
    if (!fRelPath.empty() && (fRelPath.back() != '/')) fRelPath += '/';

    // register a callback to be executed when a new run starts
    reg.sPreBeginRun.watch(this, &Geometry::preBeginRun);

    //......................................................................
    // 5.15.12 BJR: use the gdml file for both the fGDMLFile and fROOTFile
    // variables as ROOT v5.30.06 is once again able to read in gdml files
    // during batch operation, in this case think of fROOTFile meaning the
    // file used to make the ROOT TGeoManager.  I don't want to remove
    // the separate variables in case ROOT breaks again
    std::string GDMLFileName = pset.get<std::string>("GDML");
    std::string ROOTFileName = pset.get<std::string>("GDML");

    // load the geometry
    LoadNewGeometry(GDMLFileName, ROOTFileName);

    FillGeometryConfigurationInfo(pset);

  } // Geometry::Geometry()

Member Function Documentation

bool geo::Geometry::CheckConfigurationInfo ( sumdata::GeometryConfigurationInfo const &  other ) const

private

Returns if the other configuration is compatible with our current.

Definition at line 190 of file Geometry_service.cc.

  {

    MF_LOG_DEBUG("Geometry") << "New geometry information:\n" << other;

    return CompareConfigurationInfo(fConfInfo, other);

  } // Geometry::CheckConfigurationInfo()

bool geo::Geometry::CompareConfigurationInfo ( sumdata::GeometryConfigurationInfo const &  A, sumdata::GeometryConfigurationInfo const &  B  )

staticprivate

Returns if A and B are compatible geometry service configurations.

Definition at line 221 of file Geometry_service.cc.

  {
    /*
     * Implemented criteria:
     *
     * * both informations must be valid
     * * the detector names must exactly match
     *
     */

    if (!A.isDataValid()) {
      mf::LogWarning("Geometry") << "Geometry::CompareConfigurationInfo(): "
        "invalid version for configuration A:\n" << A;
      return false;
    }
    if (!B.isDataValid()) {
      mf::LogWarning("Geometry") << "Geometry::CompareConfigurationInfo(): "
        "invalid version for configuration B:\n" << B;
      return false;
    }

    // currently used only in debug mode (assert())
    [[maybe_unused]] auto const commonVersion = std::min(A.dataVersion, B.dataVersion);

    assert(commonVersion >= 1);

    if (A.detectorName != B.detectorName) { // case sensitive so far
      mf::LogWarning("Geometry") << "Geometry::CompareConfigurationInfo(): "
        "detector name mismatch: '" << A.detectorName << "' vs. '"
        << B.detectorName << "'";
      return false;
    }

    return true;
  } // CompareConfigurationInfo()

sumdata::GeometryConfigurationInfo const& geo::Geometry::configurationInfo ( ) const

inline

Returns the current geometry configuration information.

Definition at line 209 of file Geometry.h.

      { return fConfInfo; }

void geo::Geometry::FillGeometryConfigurationInfo ( fhicl::ParameterSet const &  config )

private

Fills the service configuration information into fConfInfo.

Definition at line 170 of file Geometry_service.cc.

  {

    sumdata::GeometryConfigurationInfo confInfo;
    confInfo.dataVersion = sumdata::GeometryConfigurationInfo::DataVersion_t{2};

    // version 1+:
    confInfo.detectorName = DetectorName();

    // version 2+:
    confInfo.geometryServiceConfiguration = config.to_indented_string();
    fConfInfo = std::move(confInfo);

    MF_LOG_TRACE("Geometry")
      << "Geometry configuration information:\n" << fConfInfo;

  } // Geometry::FillGeometryConfigurationInfo()

void geo::Geometry::InitializeChannelMap ( )

private

Definition at line 103 of file Geometry_service.cc.

  {
    // the channel map is responsible of calling the channel map configuration
    // of the geometry
    art::ServiceHandle<geo::ExptGeoHelperInterface const> helper{};
    auto channelMapAlg = helper->ConfigureChannelMapAlg(fSortingParameters,
                                                        DetectorName());
    if (!channelMapAlg) {
      throw cet::exception("ChannelMapLoadFail")
        << " failed to load new channel map";
    }
    ApplyChannelMap(move(channelMapAlg));
  } // Geometry::InitializeChannelMap()

void geo::Geometry::LoadNewGeometry ( std::string  gdmlfile, std::string  rootfile, bool  bForceReload = false  )

private

Expands the provided paths and loads the geometry description(s)

Definition at line 118 of file Geometry_service.cc.

    {
    // start with the relative path
    std::string GDMLFileName(fRelPath), ROOTFileName(fRelPath);

    // add the base file names
    ROOTFileName.append(gdmlfile); // not rootfile (why?)
    GDMLFileName.append(gdmlfile);

    // special for GDML if geometry with no wires is used for Geant4 simulation
    if(fDisableWiresInG4)
      GDMLFileName.insert(GDMLFileName.find(".gdml"), "_nowires");

    // Search all reasonable locations for the GDML file that contains
    // the detector geometry.
    // cet::search_path constructor decides if initialized value is a path
    // or an environment variable
    cet::search_path const sp{"FW_SEARCH_PATH"};

    std::string GDMLfile;
    if( !sp.find_file(GDMLFileName, GDMLfile) ) {
      throw cet::exception("Geometry")
        << "cannot find the gdml geometry file:"
        << "\n" << GDMLFileName
        << "\nbail ungracefully.\n";
    }

    std::string ROOTfile;
    if( !sp.find_file(ROOTFileName, ROOTfile) ) {
      throw cet::exception("Geometry")
        << "cannot find the root geometry file:\n"
        << "\n" << ROOTFileName
        << "\nbail ungracefully.\n";
    }

    {
      fhicl::Table<geo::GeometryBuilderStandard::Config> const config{fBuilderParameters, {"tool_type"}};
      geo::GeometryBuilderStandard builder{config()};

      // initialize the geometry with the files we have found
      LoadGeometryFile(GDMLfile, ROOTfile, builder, bForceReload);
    }

    // now update the channel map
    InitializeChannelMap();

  } // Geometry::LoadNewGeometry()

void geo::Geometry::preBeginRun ( art::Run const &  run )

private

Updates the geometry if needed at the beginning of each new run.

Definition at line 75 of file Geometry_service.cc.

  {

    sumdata::GeometryConfigurationInfo const inputGeomInfo
      = ReadConfigurationInfo(run);
    if (!CheckConfigurationInfo(inputGeomInfo)) {
      if (fNonFatalConfCheck) {
        // disable the non-fatal option if you need the details
        mf::LogWarning("Geometry") << "Geometry used for " << run.id()
          << " is incompatible with the one configured in the job.";
      }
      else {
        throw cet::exception("Geometry")
          << "Geometry used for run " << run.id()
          << " is incompatible with the one configured in the job!"
          << "\n=== job configuration " << std::string(50, '=')
          << "\n" << fConfInfo
          << "\n=== run configuration " << std::string(50, '=')
          << "\n" << inputGeomInfo
          << "\n======================" << std::string(50, '=')
          << "\n";
      }
    }

  } // Geometry::preBeginRun()

provider_type const* geo::Geometry::provider ( ) const

inline

Returns a pointer to the geometry service provider.

Definition at line 205 of file Geometry.h.

      { return static_cast<provider_type const*>(this); }

sumdata::GeometryConfigurationInfo const & geo::Geometry::ReadConfigurationInfo ( art::Run const &  run )

staticprivate

Reads and returns the geometry configuration information from the run.

Definition at line 201 of file Geometry_service.cc.

  {

    try {
      return run.getProduct<sumdata::GeometryConfigurationInfo>
        (art::InputTag{"GeometryConfigurationWriter"});
    }
    catch (art::Exception const& e) {
      throw art::Exception{
        e.categoryCode(),
        "Can't read geometry configuration information.\n"
        "Is `GeometryConfigurationWriter` service configured?\n",
        e
        };
    }

  } // Geometry::ReadConfigurationInfo()

Member Data Documentation

fhicl::ParameterSet geo::Geometry::fBuilderParameters

private

Parameter set for geometry builder.

Definition at line 256 of file Geometry.h.

sumdata::GeometryConfigurationInfo geo::Geometry::fConfInfo

private

Summary of service configuration.

Definition at line 258 of file Geometry.h.

bool geo::Geometry::fDisableWiresInG4

private

If set true, supply G4 with GDMLfileNoWires rather than GDMLfile

Definition at line 251 of file Geometry.h.

bool geo::Geometry::fNonFatalConfCheck

private

Don't stop if configuration check fails. files specified in the fcl file

Definition at line 253 of file Geometry.h.

std::string geo::Geometry::fRelPath

private

Relative path added to FW_SEARCH_PATH to search for geometry file

Definition at line 249 of file Geometry.h.

fhicl::ParameterSet geo::Geometry::fSortingParameters

private

Parameter set to define the channel map sorting.

Definition at line 255 of file Geometry.h.

---

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

• larcore/larcore/Geometry/Geometry.h
• larcore/larcore/Geometry/Geometry_service.cc