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

#include "GeometryCore.h"

Inheritance diagram for geo::GeometryCore:

Classes
struct	Segment
	Simple class with two points (a pair with aliases). More...

Public Types
using	Segment_t = Segment< Point_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...

Public Member Functions
	GeometryCore (fhicl::ParameterSet const &pset)
	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 &	ROOTFile () const
	Returns the full directory path to the geometry file source. 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...

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...

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...

void	GetBeginID (TPCID &id) const
	Initializes the specified ID with the ID of the first TPC. More...

void	GetEndID (TPCID &id) const
	Initializes the specified ID with the invalid ID after the last TPC. More...

bool	IncrementID (TPCID &id) const

TPCID	GetBeginTPCID (CryostatID const &id) const
	Returns the ID of the first TPC in the specified cryostat. More...

TPCID	GetEndTPCID (CryostatID const &id) const

unsigned int	Nviews () const
	Returns the number of views (different wire orientations) More...

void	GetBeginID (PlaneID &id) const
	Initializes the specified ID with the ID of the first plane. More...

void	GetEndID (PlaneID &id) const
	Initializes the specified ID with the invalid ID after the last plane. More...

bool	IncrementID (PlaneID &id) const

PlaneID	GetBeginPlaneID (CryostatID const &id) const
	Returns the ID of the first plane of the specified cryostat. More...

PlaneID	GetEndPlaneID (CryostatID const &id) const

PlaneID	GetBeginPlaneID (TPCID const &id) const
	Returns the ID of the first plane of the specified TPC. More...

PlaneID	GetEndPlaneID (TPCID const &id) const

View_t	View (PlaneID const &pid) const
	Returns the view (wire orientation) on the channels of specified TPC plane. More...

SigType_t	SignalType (PlaneID const &pid) const
	Returns the type of signal on the channels of specified TPC plane. More...

void	GetBeginID (WireID &id) const
	Initializes the specified ID with the ID of the first wire. More...

void	GetEndID (WireID &id) const
	Initializes the specified ID with the invalid ID after the last wire. More...

bool	IncrementID (WireID &id) const

WireID	GetBeginWireID (CryostatID const &id) const
	Returns the ID of the first wire in the specified cryostat. More...

WireID	GetEndWireID (CryostatID const &id) const

WireID	GetBeginWireID (TPCID const &id) const
	Returns the ID of the first wire of the specified TPC. More...

WireID	GetEndWireID (TPCID const &id) const

WireID	GetBeginWireID (PlaneID const &id) const
	Returns the ID of the first wire of the specified wire plane. More...

WireID	GetEndWireID (PlaneID const &id) const

Length_t	WirePitch (View_t view) const
	Returns the distance between two wires in the specified view. More...

WireID	NearestWireID (Point_t const &point, PlaneID const &planeid) const
	Returns the ID of wire closest to position in the specified TPC. More...

bool	IntersectionPoint (WireID const &wid1, WireID const &wid2, double &y, double &z) const
	Returns the intersection point of two wires. More...

PlaneID	ThirdPlane (PlaneID const &pid1, PlaneID const &pid2) const
	Returns the plane that is not in the specified arguments. More...

double	ThirdPlaneSlope (PlaneID const &pid1, double slope1, PlaneID const &pid2, double slope2, PlaneID const &output_plane) const
	Returns the slope on the third plane, given it in the other two. More...

double	ThirdPlaneSlope (PlaneID const &pid1, double slope1, PlaneID const &pid2, double slope2) const
	Returns the slope on the third plane, given it in the other two. More...

double	ThirdPlane_dTdW (PlaneID const &pid1, double slope1, PlaneID const &pid2, double slope2, PlaneID const &output_plane) const
	Returns dT/dW on the third plane, given it in the other two. More...

double	ThirdPlane_dTdW (PlaneID const &pid1, double slope1, PlaneID const &pid2, double slope2) const
	Returns dT/dW on the third plane, given it in the other two. More...

std::string	OpDetGeoName (CryostatID const &cid=cryostat_zero) 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< 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 (Point_t const &worldLoc, 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 (Point_t const &worldLoc) const
	Returns the ID of the TPC set at specified location. More...

readout::TPCsetID	TPCtoTPCset (TPCID const &tpcid) const
	Returns the ID of the TPC set tpcid belongs to. More...

std::vector< 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 (CryostatID const &id) const
	Returns the ID of the first TPC set in the specified cryostat. More...

readout::TPCsetID	GetEndTPCsetID (CryostatID const &id) const

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 (PlaneID const &planeid) const
	Returns the ID of the ROP planeid belongs to. More...

std::vector< PlaneID >	ROPtoWirePlanes (readout::ROPID const &ropid) const
	Returns a list of ID of planes belonging to the specified ROP. More...

std::vector< 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 (CryostatID const &id) const
	Returns the ID of the first readout plane of the specified cryostat. More...

readout::ROPID	GetEndROPID (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

View_t	View (readout::ROPID const &ropid) const
	Returns the view of the channels in the specified readout plane. More...

SigType_t	SignalType (readout::ROPID const &ropid) const
	Returns the type of signal of channels in specified readout plane. More...

template<>
TPCID	GetBeginID (CryostatID const &id) const

template<>
TPCID	GetEndID (CryostatID const &id) const

template<>
PlaneID	GetBeginID (CryostatID const &id) const

template<>
PlaneID	GetBeginID (TPCID const &id) const

template<>
PlaneID	GetEndID (CryostatID const &id) const

template<>
PlaneID	GetEndID (TPCID const &id) const

template<>
WireID	GetBeginID (CryostatID const &id) const

template<>
WireID	GetBeginID (TPCID const &id) const

template<>
WireID	GetBeginID (PlaneID const &id) const

template<>
WireID	GetEndID (CryostatID const &id) const

template<>
WireID	GetEndID (TPCID const &id) const

template<>
WireID	GetEndID (PlaneID const &id) const

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...

const std::string	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 *	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...

void	GetBeginID (CryostatID &id) const
	Initializes the specified ID with the ID of the first cryostat. More...

void	GetEndID (CryostatID &id) const
	Initializes the specified ID with the invalid ID after the last cryostat. More...

bool	IncrementID (CryostatID &id) const

template<typename T >
details::begin_type< T >	begin () const
	Initializes the specified ID with the ID of the first cryostat. More...

template<typename T >
details::end_type< T >	end () const
	Initializes the specified ID with the ID of the first cryostat. More...

template<typename T >
details::range_type< T >	Iterate () const
	Initializes the specified ID with the ID of the first cryostat. More...

template<typename T , typename BaseID >
details::begin_type< T >	begin (BaseID const &id) const
	Initializes the specified ID with the ID of the first cryostat. More...

template<typename T , typename BaseID >
details::end_type< T >	end (BaseID const &id) const
	Initializes the specified ID with the ID of the first cryostat. More...

template<typename T , typename ID >
details::range_type< T >	Iterate (ID const &id) const
	Initializes the specified ID with the ID of the first cryostat. More...

Length_t	CryostatHalfWidth (CryostatID const &cid=cryostat_zero) const
	Returns the half width of the cryostat (x direction) More...


Length_t	CryostatHalfHeight (CryostatID const &cid=cryostat_zero) const
	Returns the height of the cryostat (y direction) More...


Length_t	CryostatLength (CryostatID const &cid=cryostat_zero) const
	Returns the length of the cryostat (z direction) More...


std::string	GetCryostatVolumeName (CryostatID const &cid) const
	Return the name of LAr TPC volume. 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...

template<typename T >
TPCDataContainer< T >	makeTPCData () const
	Returns a container with one entry per TPC. More...

template<typename T >
TPCDataContainer< T >	makeTPCData (T const &defValue) const
	Returns a container with one entry per TPC. More...

unsigned int	NTPC (CryostatID const &cryoid=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 *	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...


Length_t	DetHalfWidth (TPCID const &tpcid=tpc_zero) const
	Returns the half width of the active volume of the specified TPC. More...


Length_t	DetHalfHeight (TPCID const &tpcid=tpc_zero) const
	Returns the half height of the active volume of the specified TPC. More...


Length_t	DetLength (TPCID const &tpcid=tpc_zero) const
	Returns the length of the active volume of the specified TPC. More...


Point_t	GetTPCFrontFaceCenter (TPCID const &tpcid) const
	Returns the center of side of the detector facing the beam. More...


std::string	GetLArTPCVolumeName (TPCID const &tpcid=tpc_zero) const
	Return the name of specified LAr TPC volume. More...

Plane access and information
unsigned int	MaxPlanes () const
	Returns the largest number of planes among all TPCs in this detector. More...

template<typename T >
PlaneDataContainer< T >	makePlaneData () const
	Returns a container with one entry per wire plane. More...

template<typename T >
PlaneDataContainer< T >	makePlaneData (T const &defValue) const
	Returns a container with one entry per wire plane. More...

unsigned int	Nplanes (TPCID const &tpcid=tpc_zero) const
	Returns the total number of planes in the specified TPC. More...

unsigned int	NElements (TPCID const &tpcid) const
	Returns the largest number of planes among all TPCs in this detector. More...

unsigned int	NSiblingElements (PlaneID const &planeid) const
	Returns the largest number of planes among all TPCs in this detector. More...


bool	HasPlane (PlaneID const &planeid) const
	Returns whether we have the specified plane. More...

bool	HasElement (PlaneID const &planeid) const
	Returns whether we have the specified plane. More...


PlaneGeo const &	Plane (PlaneID const &planeid) const
	Returns the specified wire. More...

PlaneGeo const &	GetElement (PlaneID const &planeid) const
	Returns the specified wire. More...


PlaneGeo const *	PlanePtr (PlaneID const &planeid) const
	Returns the specified plane. More...

PlaneGeo const *	GetElementPtr (PlaneID const &planeid) const
	Returns the specified plane. More...


Length_t	PlanePitch (TPCID const &tpcid, PlaneID::PlaneID_t p1=0, PlaneID::PlaneID_t p2=1) const
	Returns the distance between two planes. More...

Length_t	PlanePitch (PlaneID const &pid1, PlaneID const &pid2) const
	Returns the distance between two planes. More...

Wire access and information
unsigned int	Nwires (PlaneID const &planeid) const
	Returns the total number of wires in the specified plane. More...

unsigned int	NElements (PlaneID const &planeid) const
	Returns the total number of wires in the specified plane. More...

unsigned int	NSiblingElements (WireID const &wireid) const
	Returns the total number of wires in the specified plane. More...

unsigned int	MaxWires () const
	Returns the largest number of wires among all planes in this detector. More...


bool	HasWire (WireID const &wireid) const
	Returns whether we have the specified wire. More...

bool	HasElement (WireID const &wireid) const
	Returns whether we have the specified wire. More...


WireGeo const *	WirePtr (WireID const &wireid) const
	Returns the specified wire. More...

WireGeo const *	GetElementPtr (WireID const &wireid) const
	Returns the specified wire. More...


WireGeo const &	Wire (WireID const &wireid) const
	Returns the specified wire. More...

WireGeo const &	WireIDToWireGeo (WireID const &wireid) const
	Returns the specified wire. More...

WireGeo const &	GetElement (WireID const &wireid) const
	Returns the specified wire. More...


double	WireAngleToVertical (View_t view, TPCID const &tpcid) const
	Returns the angle of the wires in the specified view from vertical. More...

Wire geometry queries
Please note the differences between functions: ChannelsIntersect(), WireIDsIntersect() and IntersectionPoint() all calculate wires intersection using the same equation. ChannelsIntersect() and WireIdsIntersect() will return true if the two wires cross, return false if they don't. IntersectionPoint() does not check if the two wires cross.
void	WireEndPoints (WireID const &wireid, double xyzStart, double xyzEnd) const
	Fills two arrays with the coordinates of the wire end points. More...

Segment< Point_t >	WireEndPoints (WireID const &wireID) const
	Returns a segment whose ends are the wire end points. More...


Length_t	WireCoordinate (Point_t const &pos, PlaneID const &planeid) const
	Returns the index of the nearest wire to the specified position. More...


bool	WireIDsIntersect (WireID const &wid1, WireID const &wid2, Point_t &intersection) const
	Computes the intersection between two wires. More...


bool	WireIDsIntersect (WireID const &wid1, WireID const &wid2, WireIDIntersection &widIntersect) const
	Computes the intersection between two wires. More...


double	ThirdPlaneSlope (PlaneID::PlaneID_t plane1, double slope1, PlaneID::PlaneID_t plane2, double slope2, TPCID const &tpcid) const
	Returns the slope on the third plane, given it in the other two. 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 &	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 (Point_t const &point) const
	Find the nearest OpChannel to some point. More...

Auxiliary detectors access and information
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 (Point_t const &point, double tolerance=0) const
	Returns the index of the auxiliary detector at specified location. More...

void	FindAuxDetSensitiveAtPosition (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...

AuxDetGeo const &	PositionToAuxDet (Point_t const &point, unsigned int &ad, double tolerance=0) const
	Returns the auxiliary detector at specified location. More...

const AuxDetSensitiveGeo &	PositionToAuxDetSensitive (Point_t const &point, 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
	Returns the number of auxiliary detectors. More...

const AuxDetSensitiveGeo &	ChannelToAuxDetSensitive (std::string const &auxDetName, uint32_t const &channel) const
	Returns the number of auxiliary detectors. More...

TPC readout channels and views
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< 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...

TPC set information
unsigned int	NTPCsets (geo::CryostatID const &cryoid) const
	Returns the total number of TPC sets in the specified cryostat. More...

unsigned int	NSiblingElements (readout::TPCsetID const &tpcsetid) const
	Returns the total number of TPC sets in the specified cryostat. More...

Readout plane information
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
	Returns the total number of ROP in the specified TPC set. More...

Optical readout channels
See also optical detector geometry information
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
	Number of electronics channels for all the optical detectors. More...

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...

Geometry initialization
void	LoadGeometryFile (std::string gdmlfile, std::string rootfile, 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< ChannelMapAlg > pChannelMap)
	Initializes the geometry to work with this channel map. More...

Static Public Member Functions
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
static constexpr std::size_t	MaxWireDepthInGDML = 20U

Private Member Functions
CryostatList_t &	Cryostats ()
	Return the internal cryostat list. More...

CryostatList_t const &	Cryostats () const

AuxDetList_t &	AuxDets ()
	Return the internal auxdet list. More...

AuxDetList_t const &	AuxDets () const

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

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

void	BuildGeometry (GeometryBuilder &builder)

bool	WireIDIntersectionCheck (const WireID &wid1, const WireID &wid2) const
	Wire ID check for WireIDsIntersect methods. More...

void	SortGeometry (GeoObjectSorter const &sorter)
	Runs the sorting of geometry with the sorter provided by channel mapping. More...

void	UpdateAfterSorting ()
	Performs all the updates needed after sorting. More...

void	ClearGeometry ()
	Deletes the detector geometry structures. More...

Private Attributes
GeometryData_t	fGeoData
	The detector description data. More...

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

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

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

std::string	fROOTfile
	path to geometry file for geometry in GeometryCore More...

double	fMinWireZDist

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

fhicl::ParameterSet	fBuilderParameters

std::unique_ptr< const ChannelMapAlg >	fChannelMapAlg
	Object containing the channel to wire mapping. More...

std::set< View_t >	allViews
	All views in the detector. More...

static constexpr CryostatID	cryostat_zero {0}
	Returns the specified cryostat. More...

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

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

static constexpr TPCID	tpc_zero {cryostat_zero, 0}
	Returns the specified TPC. More...

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

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

static constexpr PlaneID	plane_zero {tpc_zero, 0}
	Returns the distance between two consecutive wires. More...

Length_t	WirePitch (PlaneID const &planeid=plane_zero) const
	Returns the distance between two consecutive wires. More...

Detailed Description

Description of geometry of one entire detector.

Note: All lengths are specified in centimetres

How to correctly instantiate a GeometryCore object

Instantiation is a multi-step procedure:

construct a GeometryCore object (the "service provider"), with the full configuration; at this step, configuration is just stored
load a geometry with GeometryCore::LoadGeometryFile(); this loads the detector geometry information
prepare a channel map algorithm object (might use for example GeometryCore::DetectorName() or the detector geometry from the newly created object, but any use of channel mapping related functions is forbidden and it would yield undefined behaviour (expected to be catastrophic)
acquire the channel mapping algorithm with GeometryCore::ApplyChannelMap().

Step 3 (creation of the channel mapping algorithm object) can be performed at any time before step 4, provided that no GeometryCore instance is needed for it.

Configuration parameters

Name (string; mandatory): 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. This name can be used, for example, to select which channel mapping algorithm to use.
SurfaceY (real; mandatory): depth of the detector, in centimetrs; see SurfaceY() for details
MinWireZDist (real; default: 3)
PositionEpsilon (real; default: 0.01%) set the default tolerance (see DefaultWiggle())

Definition at line 119 of file GeometryCore.h.

Member Typedef Documentation

using geo::GeometryCore::AuxDetList_t = GeometryData_t::AuxDetList_t

Type of list of auxiliary detectors.

Definition at line 141 of file GeometryCore.h.

using geo::GeometryCore::CryostatList_t = GeometryData_t::CryostatList_t

Type of list of cryostats.

Definition at line 139 of file GeometryCore.h.

using geo::GeometryCore::Segment_t = Segment<Point_t>

Definition at line 136 of file GeometryCore.h.

Constructor & Destructor Documentation

geo::GeometryCore::GeometryCore ( fhicl::ParameterSet const & pset )

explicit

Initialize geometry from a given configuration.

Parameters

pset	configuration parameters

This constructor does not load any geometry description. The next step is to do exactly that, by GeometryCore::LoadGeometryFile().

Definition at line 73 of file GeometryCore.cxx.

References fDetectorName.

     : fSurfaceY(pset.get<double>("SurfaceY"))
     , fDetectorName(pset.get<std::string>("Name"))
     , fMinWireZDist(pset.get<double>("MinWireZDist", 3.0))
     , fPositionWiggle(pset.get<double>("PositionEpsilon", 1.e-4))
     , fBuilderParameters(pset.get<fhicl::ParameterSet>("Builder", fhicl::ParameterSet()))
   {
     std::transform(fDetectorName.begin(), fDetectorName.end(), fDetectorName.begin(), ::tolower);
   }

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

delete

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

delete

Member Function Documentation

void geo::GeometryCore::ApplyChannelMap ( std::unique_ptr< ChannelMapAlg > pChannelMap )

Initializes the geometry to work with this channel map.

Parameters

pChannelMap a pointer to the channel mapping algorithm to be used

See also: LoadGeometryFile()

The specified channel mapping is used with this geometry. These modifications typically involve some resorting of the objects.

This method needs to be called after LoadGeometryFile() to complete the geometry initialization.

Definition at line 84 of file GeometryCore.cxx.

References fChannelMapAlg, fGeoData, SortGeometry(), and UpdateAfterSorting().

Referenced by GetEndROPID(), and geo::Geometry::InitializeChannelMap().

   {
     SortGeometry(pChannelMap->Sorter());
     UpdateAfterSorting(); // after channel mapping has sorted objects, set their IDs
     pChannelMap->Initialize(fGeoData);
     fChannelMapAlg = move(pChannelMap);
   }

const AuxDetGeo & geo::GeometryCore::AuxDet ( unsigned int const ad = 0 ) const

Returns the specified auxiliary detector.

Parameters

ad	the auxiliary detector index

Returns: a constant reference to the specified auxiliary detector

Todo:

what happens if it does not exist?

remove the default parameter?

Definition at line 318 of file GeometryCore.cxx.

References AuxDets(), and NAuxDets().

Referenced by ChannelToAuxDet(), ChannelToAuxDetSensitive(), NAuxDets(), PositionToAuxDet(), PositionToAuxDetSensitive(), Print(), and larg4::LArG4::produce().

   {
     if (ad >= NAuxDets())
       throw cet::exception("GeometryCore") << "AuxDet " << ad << " does not exist\n";
     return AuxDets()[ad];
   }

AuxDetList_t& geo::GeometryCore::AuxDets ( )

inlineprivate

Return the internal auxdet list.

Definition at line 2428 of file GeometryCore.h.

References geo::GeometryData_t::auxDets, and fGeoData.

Referenced by AuxDet(), BuildGeometry(), ChannelToAuxDet(), ChannelToAuxDetSensitive(), FindAuxDetAtPosition(), FindAuxDetSensitiveAtPosition(), NAuxDets(), NAuxDetSensitive(), and SortGeometry().

2428 { return fGeoData.auxDets; }

geo::GeometryCore::fGeoData

GeometryData_t fGeoData

The detector description data.

Definition: GeometryCore.h:2431

geo::GeometryData_t::auxDets

AuxDetList_t auxDets

The auxiliary detectors.

Definition: GeometryData.h:38

AuxDetList_t const& geo::GeometryCore::AuxDets ( ) const

inlineprivate

Definition at line 2429 of file GeometryCore.h.

References geo::GeometryData_t::auxDets, and fGeoData.

2429 { return fGeoData.auxDets; }

geo::GeometryCore::fGeoData

GeometryData_t fGeoData

The detector description data.

Definition: GeometryCore.h:2431

geo::GeometryData_t::auxDets

AuxDetList_t auxDets

The auxiliary detectors.

Definition: GeometryData.h:38

template<typename T >

details::begin_type<T> geo::GeometryCore::begin ( ) const

inline

Initializes the specified ID with the ID of the first cryostat.

Definition at line 529 of file GeometryCore.h.

References geo::details::IteratorMaker< T, typename >::create_begin().

Referenced by TotalNTPC().

     {
       return details::IteratorMaker<T>::create_begin(this);
     }

template<typename T , typename BaseID >

details::begin_type<T> geo::GeometryCore::begin ( BaseID const & id ) const

inline

Initializes the specified ID with the ID of the first cryostat.

Definition at line 547 of file GeometryCore.h.

References geo::details::IteratorMaker< T, typename >::create_begin().

     {
       return details::IteratorMaker<T>::create_begin(this, id);
     }

void geo::GeometryCore::BuildGeometry ( GeometryBuilder & builder )

private

Parses ROOT geometry nodes and builds LArSoft geometry representation.

Parameters

builder the algorithm to be used

Definition at line 1009 of file GeometryCore.cxx.

References AuxDets(), Cryostats(), geo::GeometryBuilder::extractAuxiliaryDetectors(), and geo::GeometryBuilder::extractCryostats().

Referenced by LoadGeometryFile().

   {
     GeoNodePath path{gGeoManager->GetTopNode()};
     Cryostats() = builder.extractCryostats(path);
     AuxDets() = builder.extractAuxiliaryDetectors(path);
   }

bool geo::GeometryCore::ChannelsIntersect	(	raw::ChannelID_t	c1,
		raw::ChannelID_t	c2,
		double &	y,
		double &	z
	)		const

Returns an intersection point of two channels.

Parameters

c1	one channel ID
c2	the other channel ID
y	(output) y coordinate of the intersection
z	(output) z coordinate of the intersection

Returns: whether a intersection point was found

Todo:

what happens for channels from different TPCs?

what happens for channels with multiple intersection points?

Deprecated:: This is clearly not APA-aware

Definition at line 1157 of file GeometryCore.cxx.

References util::abs(), ChannelToWire(), geo::vect::cross(), geo::GeometryCore::Segment< Point >::end(), geo::WireGeo::HalfL(), geo::IntersectLines(), geo::TPCID::InvalidID, geo::IntersectionPointAndOffsets< Point >::offset1, geo::IntersectionPointAndOffsets< Point >::offset2, geo::IntersectionPointAndOffsets< Point >::point, lar::util::PointWithinSegments(), geo::GeometryCore::Segment< Point >::start(), geo::TPCID::TPC, geo::WireIDIntersection::TPC, Wire(), WireEndPoints(), WireIDIntersectionCheck(), WireIDsIntersect(), geo::WiresIntersectionAndOffsets(), geo::WireIDIntersection::y, and geo::WireIDIntersection::z.

Referenced by vertex::FeatureVertexFinder::Find3dVtxFrom2dClusterVtxCand(), evd::TWQMultiTPCProjectionView::FindEndPoint(), evd::TWQMultiTPCProjectionView::FindLineLength(), vertex::FeatureVertexFinder::Get3dVertexCandidates(), util::GeometryUtilities::GetProjectedPoint(), util::GeometryUtilities::GetYZ(), vertex::VertexFinder2D::produce(), and Views().

   {
     // [GP] these errors should be exceptions, and this function is deprecated
     // because it violates interoperability
     std::vector<WireID> chan1wires = ChannelToWire(c1);
     if (chan1wires.empty()) {
       mf::LogError("ChannelsIntersect")
         << "1st channel " << c1 << " maps to no wire (is it a real one?)";
       return false;
     }
     std::vector<WireID> chan2wires = ChannelToWire(c2);
     if (chan2wires.empty()) {
       mf::LogError("ChannelsIntersect")
         << "2nd channel " << c2 << " maps to no wire (is it a real one?)";
       return false;
     }
 
     if (chan1wires.size() > 1) {
       mf::LogWarning("ChannelsIntersect")
         << "1st channel " << c1 << " maps to " << chan2wires.size() << " wires; using the first!";
       return false;
     }
     if (chan2wires.size() > 1) {
       mf::LogError("ChannelsIntersect")
         << "2nd channel " << c2 << " maps to " << chan2wires.size() << " wires; using the first!";
       return false;
     }
 
     WireIDIntersection widIntersect;
     if (this->WireIDsIntersect(chan1wires[0], chan2wires[0], widIntersect)) {
       y = widIntersect.y;
       z = widIntersect.z;
       return true;
     }
     else {
       y = widIntersect.y;
       z = widIntersect.z;
       return false;
     }
   }

std::vector< raw::ChannelID_t > geo::GeometryCore::ChannelsInTPCs ( ) const

Returns an std::vector<ChannelID_t> in all TPCs in a TPCSet.

Definition at line 210 of file GeometryCore.cxx.

References fChannelMapAlg.

Referenced by NAuxDets().

   {
     std::vector<raw::ChannelID_t> channels;
     channels.reserve(fChannelMapAlg->Nchannels());
 
     for (auto const& ts : Iterate<readout::TPCsetID>()) {
       for (auto const t : fChannelMapAlg->TPCsetToTPCs(ts)) {
         for (auto const& wire : Iterate<WireID>(t)) {
           channels.push_back(fChannelMapAlg->PlaneWireToChannel(wire));
         }
       }
     }
     std::sort(channels.begin(), channels.end());
     auto last = std::unique(channels.begin(), channels.end());
     channels.erase(last, channels.end());
     return channels;
   }

const AuxDetGeo & geo::GeometryCore::ChannelToAuxDet	(	std::string const &	auxDetName,
		uint32_t const &	channel
	)		const

Returns the number of auxiliary detectors.

Todo:: use a AutDetID_t instead of unsigned int?

This method returns the total number of scintillator paddles (Auxiliary Detectors aka AuxDet) outside of the cryostat

Todo:: Change return type to size_t

Definition at line 447 of file GeometryCore.cxx.

References AuxDet(), AuxDets(), and fChannelMapAlg.

Referenced by NAuxDets().

   {
     size_t adIdx = fChannelMapAlg->ChannelToAuxDet(AuxDets(), auxDetName, channel);
     return this->AuxDet(adIdx);
   }

const AuxDetSensitiveGeo & geo::GeometryCore::ChannelToAuxDetSensitive	(	std::string const &	auxDetName,
		uint32_t const &	channel
	)		const

Returns the number of auxiliary detectors.

Todo:: use a AutDetID_t instead of unsigned int?

This method returns the total number of scintillator paddles (Auxiliary Detectors aka AuxDet) outside of the cryostat

Todo:: Change return type to size_t

Definition at line 455 of file GeometryCore.cxx.

References AuxDet(), AuxDets(), fChannelMapAlg, and geo::AuxDetGeo::SensitiveVolume().

Referenced by NAuxDets().

   {
     auto idx = fChannelMapAlg->ChannelToSensitiveAuxDet(AuxDets(), auxDetName, channel);
     return this->AuxDet(idx.first).SensitiveVolume(idx.second);
   }

readout::ROPID geo::GeometryCore::ChannelToROP ( raw::ChannelID_t channel ) const

Returns the ID of the ROP the channel belongs to

Exceptions

cet::exception (category: "Geometry") if non-existent channel

Definition at line 1087 of file GeometryCore.cxx.

References fChannelMapAlg.

Referenced by reco3d::TripletFinder::FillBadMap(), reco3d::TripletFinder::FillHitMap(), View(), and Views().

   {
     return fChannelMapAlg->ChannelToROP(channel);
   }

std::vector< WireID > geo::GeometryCore::ChannelToWire ( raw::ChannelID_t const channel ) const

Returns a list of wires connected to the specified TPC channel.

Parameters

channel TPC channel ID

Returns: vector containing the ID of all the connected wires

Exceptions

cet::exception (category: "Geometry") if non-existent channel

Definition at line 1081 of file GeometryCore.cxx.

References fChannelMapAlg.

Referenced by hit::MCHitAnaExample::analyze(), MCBTDemo::analyze(), detsim::WienerFilterAna::analyze(), apa::APAGeometryAlg::APAChannelsIntersect(), lar_cluster3d::StandardHit3DBuilder::BuildChannelStatusVec(), lar_cluster3d::SnippetHit3DBuilder::BuildChannelStatusVec(), ChannelsIntersect(), apa::APAGeometryAlg::ChanSegsPerSide(), lar_cluster3d::StandardHit3DBuilder::CollectArtHits(), lar_cluster3d::SnippetHit3DBuilder::CollectArtHits(), apa::DisambigAlg::CompareViews(), lar_cluster3d::MinSpanTreeAlg::configure(), reco3d::TripletFinder::FillHitMap(), evd::RawDataDrawer::FillQHisto(), evd::RecoBaseDrawer::FillQHisto(), lar_pandora::PFParticleHitDumper::FillRecoWires(), evd::RecoBaseDrawer::FillTQHisto(), evd::RecoBaseDrawer::FillTQHistoDP(), reco_tool::CandHitStandard::findHitCandidates(), reco_tool::CandHitDerivative::findHitCandidates(), reco_tool::CandHitMorphological::findHitCandidates(), hit::HitCheater::FindHitsOnChannel(), evd::RecoBaseDrawer::GetHits(), lcvn::WireHelper::GetID(), lcvn::SimChannelHelper::GetID(), cluster::SmallClusterFinderAlg::GetPlaneAndTPC(), corner::CornerFinderAlg::GrabWires(), evd::RecoBaseDrawer::Hit2D(), lar_cluster3d::SpacePointHit3DBuilder::Hit3DBuilder(), apa::APAGeometryAlg::Init(), hit::DisambigCheater::InitHitToWids(), reco3d::IntersectionCache::ISect(), apa::APAGeometryAlg::LineSegChanIntersect(), apa::DisambigAlg::MakeCloseHits(), sim::MCRecoEdep::MakeMCEdep(), apa::APAGeometryAlg::NearestWireIDOnChan(), btutil::MCBTAlg::ProcessSimChannel(), hit::TTHitFinder::produce(), hit::RawHitFinder::produce(), hit::FFTHitFinder::produce(), hit::GausHitFinder::produce(), hit::DPRawHitFinder::produce(), evd::RawDataDrawer::RawDigit2D(), hit::RFFHitFinderAlg::Run(), hit::CCHitFinderAlg::RunCCHitFinder(), evd::RawDataDrawer::RunOperation(), dnn::SavePiMu::saveImage(), img::DataProviderAlg::setWireDriftData(), apa::APAGeometryAlg::ThreeChanPos(), apa::DisambigAlg::TrivialDisambig(), Views(), and evd::RecoBaseDrawer::Wire2D().

   {
     return fChannelMapAlg->ChannelToWire(channel);
   }

void geo::GeometryCore::ClearGeometry ( )

private

Deletes the detector geometry structures.

Definition at line 157 of file GeometryCore.cxx.

References fGeoData.

Referenced by LoadGeometryFile().

   {
     fGeoData = {};
   }

double geo::GeometryCore::ComputeThirdPlane_dTdW	(	double	angle1,
		double	pitch1,
		double	dTdW1,
		double	angle2,
		double	pitch2,
		double	dTdW2,
		double	angle_target,
		double	pitch_target
	)

static

Returns the slope on the third plane, given it in the other two.

Parameters

angle1	angle or the wires on the first plane
pitch1	wire pitch on the first plane
dTdW1	slope in dt/dw units as observed on the first plane
angle2	angle or the wires on the second plane
pitch2	wire pitch on the second plane
dTdW2	slope in dt/dw units as observed on the second plane
angle_target	angle or the wires on the target plane
pitch_target	wire pitch on the target plane

Returns: dt/dw slope as measured on the third plane, or 999 if infinity

The input slope must be specified in dt/dw non-homogeneous coordinates.

This function will return a small slope if both input slopes are small.

Definition at line 1424 of file GeometryCore.cxx.

References ComputeThirdPlaneSlope().

Referenced by ThirdPlane_dTdW(), and ThirdPlaneSlope().

   {
     // we need to convert dt/dw into homogeneous coordinates, and then back;
     // slope = [dT * (TDCperiod / driftVelocity)] / [dW * wirePitch]
     // The coefficient of dT is assumed to be the same for all the planes,
     // and it finally cancels out. Pitches cancel out only if they are all
     // the same.
     return pitch_target *
            ComputeThirdPlaneSlope(angle1, dTdW1 / pitch1, angle2, dTdW2 / pitch2, angle_target);
   }

double geo::GeometryCore::ComputeThirdPlaneSlope	(	double	angle1,
		double	slope1,
		double	angle2,
		double	slope2,
		double	angle_target
	)

static

Returns the slope on the third plane, given it in the other two.

Parameters

angle1	angle or the wires on the first plane
slope1	slope as observed on the first plane
angle2	angle or the wires on the second plane
slope2	slope as observed on the second plane
angle_target	angle or the wires on the target plane

Returns: the slope as measure on the third plane, or 999 if infinity

This function will return a small slope if both input slopes are small.

Definition at line 1396 of file GeometryCore.cxx.

References util::abs().

Referenced by ComputeThirdPlane_dTdW(), and ThirdPlaneSlope().

   {
     // note that, if needed, the trigonometric functions can be pre-calculated.
 
     // Can't resolve very small slopes
     if ((std::abs(slope1) < 0.001) && (std::abs(slope2)) < 0.001) return 0.001;
 
     // We need the "wire coordinate direction" for each plane.
     // This is perpendicular to the wire orientation.
     double slope3 = 0.001;
     if (std::abs(slope1) > 0.001 && std::abs(slope2) > 0.001) {
       slope3 =
         (+(1. / slope1) * std::sin(angle3 - angle2) - (1. / slope2) * std::sin(angle3 - angle1)) /
         std::sin(angle1 - angle2);
     }
     if (slope3 != 0.)
       slope3 = 1. / slope3;
     else
       slope3 = 999.;
 
     return slope3;
   }

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

Returns the specified cryostat.

Parameters

cstat	number of cryostat
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 303 of file GeometryCore.cxx.

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

Referenced by phot::PDFastSimANN::beginJob(), opdet::SimPhotonCounter::beginJob(), evgen::PhotonGen::beginRun(), larg4::LArVoxelReadoutGeometry::Construct(), ems::MultiEMShowers::convCluster(), CryostatHalfHeight(), CryostatHalfWidth(), CryostatLength(), detinfo::DetectorPropertiesStandard::DataFor(), cosmic::BeamFlashTrackMatchTaggerAlg::FillFlashProperties(), opdet::FlashHypothesisAnaAlg::FillOpDetPositions(), GetCryostatVolumeName(), GetElement(), ems::EMShower3D::LinkCandidates(), trkf::SpacePointAlg::makeSpacePoints(), NOpDets(), OpDetFromCryo(), OpDetGeoFromOpDet(), OpDetGeoName(), 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";
   }

Length_t geo::GeometryCore::CryostatHalfHeight ( CryostatID const & cid = cryostat_zero ) const

Returns the height of the cryostat (y direction)

Definition at line 706 of file GeometryCore.cxx.

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

Referenced by simfilter::FilterNoDirtNeutrinos::filter(), Iterate(), and evgen::FileMuons::ReadEvents().

   {
     return Cryostat(cid).HalfHeight();
   }

Length_t geo::GeometryCore::CryostatHalfWidth ( CryostatID const & cid = cryostat_zero ) const

Returns the half width of the cryostat (x direction)

Definition at line 700 of file GeometryCore.cxx.

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

Referenced by simfilter::FilterNoDirtNeutrinos::filter(), Iterate(), and evgen::FileMuons::ReadEvents().

   {
     return Cryostat(cid).HalfWidth();
   }

Length_t geo::GeometryCore::CryostatLength ( CryostatID const & cid = cryostat_zero ) const

Returns the length of the cryostat (z direction)

Definition at line 712 of file GeometryCore.cxx.

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

Referenced by Iterate(), and evgen::FileMuons::ReadEvents().

   {
     return Cryostat(cid).Length();
   }

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 477 of file GeometryCore.h.

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

Referenced by Cryostat(), GetElementPtr(), GetEndPlaneID(), GetEndTPCID(), GetEndWireID(), HasTPC(), and TPCPtr().

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

CryostatList_t& geo::GeometryCore::Cryostats ( )

inlineprivate

Return the internal cryostat list.

Definition at line 2424 of file GeometryCore.h.

References geo::GeometryData_t::cryostats, and fGeoData.

Referenced by BuildGeometry(), CryostatPtr(), MaxPlanes(), MaxTPCs(), MaxWires(), Ncryostats(), SortGeometry(), TotalNTPC(), and UpdateAfterSorting().

2424 { return fGeoData.cryostats; }

geo::GeometryCore::fGeoData

GeometryData_t fGeoData

The detector description data.

Definition: GeometryCore.h:2431

geo::GeometryData_t::cryostats

CryostatList_t cryostats

The detector cryostats.

Definition: GeometryData.h:37

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

inlineprivate

Definition at line 2425 of file GeometryCore.h.

References geo::GeometryData_t::cryostats, and fGeoData.

2425 { return fGeoData.cryostats; }

geo::GeometryCore::fGeoData

GeometryData_t fGeoData

The detector description data.

Definition: GeometryCore.h:2431

geo::GeometryData_t::cryostats

CryostatList_t cryostats

The detector cryostats.

Definition: GeometryData.h:37

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 175 of file GeometryCore.h.

References fPositionWiggle.

175 { return fPositionWiggle; }

geo::GeometryCore::fPositionWiggle

double fPositionWiggle

accounting for rounding errors when testing positions

Definition: GeometryCore.h:2439

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 509 of file GeometryCore.cxx.

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

Referenced by 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()->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
     const double halfwidth = pBox->GetDX();
     const double halfheight = pBox->GetDY();
     const double 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 203 of file GeometryCore.h.

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

203 { return fDetectorName; }

geo::GeometryCore::fDetectorName

std::string fDetectorName

Name of the detector.

Definition: GeometryCore.h:2434

Length_t geo::GeometryCore::DetHalfHeight ( TPCID const & tpcid = tpc_zero ) const

Returns the half height of the active volume of the specified TPC.

Parameters

tpcid	ID of the TPC
tpc	TPC number within the cryostat
cstat	number of cryostat

Returns: the value of the half height of the specified TPC

Exceptions

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

See also: geo::TPCGeo::ActiveHalfHeight()

See geo::TPCGeo::ActiveHalfHeight() for more details.

Todo:

deprecate this function

rename the function

Definition at line 688 of file GeometryCore.cxx.

References geo::TPCGeo::ActiveHalfHeight(), and TPC().

Referenced by lar::example::AnalysisExample::analyze(), evgen::NDKGen::beginJob(), evgen::GENIEGen::beginJob(), trkf::SpacePointAna::bookHistograms(), LArStackingAction::ClassifyNewTrack(), cosmic::CosmicPCAxisTagger::CosmicPCAxisTagger(), evd_tool::MicroBooNEDrawer::DetOutline3D(), evd::Display3DPad::Draw(), lar_pandora::PFParticleCosmicAna::FillRecoTree(), simfilter::FilterNoDirtNeutrinos::filter(), util::GeometryUtilities::Get2DangleFrom3D(), GetBeginTPCID(), trk::TrackContainmentAlg::GetCosmicTagID(), cosmic::BeamFlashTrackMatchTaggerAlg::InDetector(), trk::TrackContainmentAlg::IsContained(), trkf::SeedAna::MCHists::MCHists(), trkf::TrackAna::MCHists::MCHists(), trk::TrackContainmentAlg::ProcessTracks(), trkf::SpacePts::produce(), trkf::Track3Dreco::produce(), vertex::VertexFinder2D::produce(), trkf::Track3DKalmanSPS::produce(), trkf::SeedAna::RecoHists::RecoHists(), and trkf::TrackAna::RecoHists::RecoHists().

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

Length_t geo::GeometryCore::DetHalfWidth ( TPCID const & tpcid = tpc_zero ) const

Returns the half width of the active volume of the specified TPC.

Parameters

tpcid	ID of the TPC
tpc	TPC number within the cryostat
cstat	number of cryostat

Returns: the value of the half width of the specified TPC

Exceptions

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

See also: geo::TPCGeo::ActiveHalfWidth()

Todo:

deprecate this function

rename the function

Definition at line 682 of file GeometryCore.cxx.

References geo::TPCGeo::ActiveHalfWidth(), and TPC().

Referenced by lar::example::AnalysisExample::analyze(), evgen::NDKGen::beginJob(), evgen::GENIEGen::beginJob(), trkf::SpacePointAna::bookHistograms(), LArStackingAction::ClassifyNewTrack(), cosmic::CosmicPCAxisTagger::CosmicPCAxisTagger(), evd_tool::MicroBooNEDrawer::DetOutline3D(), evd::Display3DPad::Draw(), lar_pandora::PFParticleCosmicAna::FillRecoTree(), simfilter::FilterNoDirtNeutrinos::filter(), util::GeometryUtilities::Get2DangleFrom3D(), GetBeginTPCID(), trk::TrackContainmentAlg::GetCosmicTagID(), cosmic::BeamFlashTrackMatchTaggerAlg::InDetector(), cosmic::BeamFlashTrackMatchTaggerAlg::InDriftWindow(), trk::TrackContainmentAlg::IsContained(), trkf::SeedAna::MCHists::MCHists(), trkf::TrackAna::MCHists::MCHists(), trkf::CCTrackMaker::PlnMatch(), trk::TrackContainmentAlg::ProcessTracks(), trkf::Track3DKalmanSPS::produce(), trkf::SeedAna::RecoHists::RecoHists(), and trkf::TrackAna::RecoHists::RecoHists().

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

Length_t geo::GeometryCore::DetLength ( TPCID const & tpcid = tpc_zero ) const

Returns the length of the active volume of the specified TPC.

Parameters

tpcid	ID of the TPC
tpc	TPC number within the cryostat
cstat	number of cryostat

Returns: the value of the length of the specified TPC

Exceptions

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

See also: geo::TPCGeo::ActiveLength()

See geo::TPCGeo::ActiveLength() for more details.

Todo:

deprecate this function

rename the function

Definition at line 694 of file GeometryCore.cxx.

References geo::TPCGeo::ActiveLength(), and TPC().

Referenced by lar::example::AnalysisExample::analyze(), evgen::NDKGen::beginJob(), evgen::GENIEGen::beginJob(), trkf::SpacePointAna::bookHistograms(), LArStackingAction::ClassifyNewTrack(), cosmic::CosmicPCAxisTagger::CosmicPCAxisTagger(), evd_tool::MicroBooNEDrawer::DetOutline3D(), evd::Display3DPad::Draw(), lar_pandora::PFParticleCosmicAna::FillRecoTree(), simfilter::FilterNoDirtNeutrinos::filter(), util::GeometryUtilities::Get2DangleFrom3D(), GetBeginTPCID(), trk::TrackContainmentAlg::GetCosmicTagID(), cosmic::BeamFlashTrackMatchTaggerAlg::InDetector(), trk::TrackContainmentAlg::IsContained(), trkf::SeedAna::MCHists::MCHists(), trkf::TrackAna::MCHists::MCHists(), lar_cluster3d::StandardHit3DBuilder::NearestWireID(), lar_cluster3d::SnippetHit3DBuilder::NearestWireID(), trkf::CCTrackMaker::PlnMatch(), trk::TrackContainmentAlg::ProcessTracks(), evgen::CosmicsGen::produce(), trkf::Track3DKalmanSPS::produce(), trkf::SeedAna::RecoHists::RecoHists(), and trkf::TrackAna::RecoHists::RecoHists().

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

template<typename T >

details::end_type<T> geo::GeometryCore::end ( ) const

inline

Initializes the specified ID with the ID of the first cryostat.

Definition at line 535 of file GeometryCore.h.

References geo::details::IteratorMaker< T, typename >::create_end().

Referenced by TotalNTPC().

     {
       return details::IteratorMaker<T>::create_end(this);
     }

template<typename T , typename BaseID >

details::end_type<T> geo::GeometryCore::end ( BaseID const & id ) const

inline

Initializes the specified ID with the ID of the first cryostat.

Definition at line 553 of file GeometryCore.h.

References geo::details::IteratorMaker< T, typename >::create_end().

     {
       return details::IteratorMaker<T>::create_end(this, 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 654 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 637 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;
   }

unsigned int geo::GeometryCore::FindAuxDetAtPosition	(	Point_t const &	point,
		double	tolerance = `0`
	)		const

Returns the index of the auxiliary detector at specified location.

Parameters

point	location to be tested
tolerance	tolerance (cm) for matches. Default 0

Returns: the index of the detector, or std::numeric_limits<unsigned int>::max() if no detector is there

Bug:: Actually, an exception is thrown.

Definition at line 410 of file GeometryCore.cxx.

References AuxDets(), and fChannelMapAlg.

Referenced by FindAuxDetSensitiveAtPosition(), NAuxDets(), and PositionToAuxDet().

   {
     return fChannelMapAlg->NearestAuxDet(point, AuxDets(), tolerance);
   }

void geo::GeometryCore::FindAuxDetSensitiveAtPosition	(	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.

Parameters

point	location to be tested
adg	_(output)_ auxiliary detector index
sv	_(output)_ sensitive volume index
tolerance	tolerance (cm) for matches. Default 0.

Definition at line 426 of file GeometryCore.cxx.

References AuxDets(), fChannelMapAlg, and FindAuxDetAtPosition().

Referenced by larg4::AuxDetReadoutGeometry::FindAndMakeAuxDetSensitive(), sim::GenericCRTUtility::GetAuxDetSimChannelByNumber(), NAuxDets(), and PositionToAuxDetSensitive().

   {
     adg = FindAuxDetAtPosition(point, tolerance);
     sv = fChannelMapAlg->NearestSensitiveAuxDet(point, AuxDets(), tolerance);
   }

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

private

Definition at line 978 of file GeometryCore.cxx.

References FindFirstVolume(), and ROOTGeoManager().

Referenced by DetectorEnclosureBox().

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

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

private

Definition at line 987 of file GeometryCore.cxx.

Referenced by FindDetectorEnclosure().

   {
     assert(!path.empty());
 
     auto const* pCurrent = path.back();
 
     // 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

worldLoc 3D point (world reference frame, centimeters)

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

Definition at line 326 of file GeometryCore.cxx.

References geo::CryostatID::Cryostat, fPositionWiggle, geo::CryostatGeo::ID(), geo::CryostatID::markInvalid(), 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(), 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
     TPCID tpcid = cryo->PositionToTPCID(point, 1. + fPositionWiggle);
     if (tpcid) return tpcid;
 
     // return an invalid TPC ID with cryostat information set:
     tpcid.Cryostat = cryo->ID().Cryostat;
     tpcid.markInvalid();
     return tpcid;
   }

readout::TPCsetID geo::GeometryCore::FindTPCsetAtPosition ( Point_t const & worldLoc ) const

Returns the ID of the TPC set at specified location.

Parameters

worldLoc 3D coordinates of the point (world reference frame)

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

Definition at line 1485 of file GeometryCore.cxx.

References FindTPCAtPosition(), and TPCtoTPCset().

Referenced by HasElement().

   {
     return TPCtoTPCset(FindTPCAtPosition(worldLoc));
   }

raw::ChannelID_t geo::GeometryCore::FirstChannelInROP ( readout::ROPID const & ropid ) const

Returns the ID of the first channel in the specified readout plane.

Parameters

ropid ID of the readout plane

Returns: ID of first channel, or raw::InvalidChannelID if ID is invalid

Note that this check is performed on the validity of the readout plane ID, that does not necessarily imply that the readout plane specified by the ID actually exists. Check if the ROP exists with HasROP(). The behaviour for non-existing readout planes is undefined.

Definition at line 1542 of file GeometryCore.cxx.

References fChannelMapAlg.

Referenced by HasElement().

   {
     return fChannelMapAlg->FirstChannelInROP(ropid);
   }

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 193 of file GeometryCore.h.

References fGDMLfile.

Referenced by larg4::LArG4::beginJob().

193 { return fGDMLfile; }

geo::GeometryCore::fGDMLfile

std::string fGDMLfile

path to geometry file used for Geant4 simulation

Definition: GeometryCore.h:2435

template<typename GeoID >

GeoID geo::GeometryCore::GetBeginID ( ) const

inline

Returns the ID of the first element of the detector.

Template Parameters

GeoID type of the ID to be returned

Returns: ID of the first subelement in the detector

Definition at line 357 of file GeometryCore.h.

Referenced by GetBeginID(), and GetEndID().

     {
       GeoID id;
       GetBeginID(id);
       return id;
     }

template<typename GeoID , typename ContextID >

GeoID geo::GeometryCore::GetBeginID ( ContextID const & id ) const

Returns the ID of the first subelement of the specified element.

Template Parameters

GeoID	type of the ID to be returned
ContextID	type of the ID of the containing element

Parameters

id	ID of the containing element

Returns: ID of the first subelement in the specified geometry element

void geo::GeometryCore::GetBeginID ( CryostatID & id ) const

inline

Initializes the specified ID with the ID of the first cryostat.

Definition at line 518 of file GeometryCore.h.

References HasCryostat().

518 { id = CryostatID(0, HasCryostat(CryostatID(0))); }

geo::fhicl::CryostatID

IDparameter< geo::CryostatID > CryostatID

Member type of validated geo::CryostatID parameter.

Definition: geo_types_fhicl.h:270

geo::GeometryCore::HasCryostat

bool HasCryostat(CryostatID const &cryoid) const

Returns whether we have the specified cryostat.

Definition: GeometryCore.h:446

void geo::GeometryCore::GetBeginID ( TPCID & id ) const

inline

Initializes the specified ID with the ID of the first TPC.

iterators

Definition at line 782 of file GeometryCore.h.

References GetBeginID(), GetEndID(), and IncrementID().

     {
       GetBeginID(id.asCryostatID());
       id.TPC = 0;
     }

void geo::GeometryCore::GetBeginID ( PlaneID & id ) const

inline

Initializes the specified ID with the ID of the first plane.

Definition at line 1060 of file GeometryCore.h.

References GetBeginID(), GetEndID(), and IncrementID().

     {
       GetBeginID(id.asTPCID());
       id.Plane = 0;
     }

void geo::GeometryCore::GetBeginID ( WireID & id ) const

inline

Initializes the specified ID with the ID of the first wire.

Definition at line 1220 of file GeometryCore.h.

References GetBeginID(), GetEndID(), and IncrementID().

     {
       GetBeginID(id.asPlaneID());
       id.Wire = 0;
     }

void geo::GeometryCore::GetBeginID ( readout::TPCsetID & id ) const

inline

Initializes the specified ID with the ID of the first TPC set.

iterators

Definition at line 2091 of file GeometryCore.h.

References GetBeginID().

     {
       GetBeginID(id.asCryostatID());
       id.TPCset = 0;
     }

void geo::GeometryCore::GetBeginID ( readout::ROPID & id ) const

inline

Initializes the specified ID with the ID of the first readout plane.

iterators

Definition at line 2256 of file GeometryCore.h.

References GetBeginID().

     {
       GetBeginID(id.asTPCsetID());
       id.ROP = 0;
     }

template<>

TPCID geo::GeometryCore::GetBeginID ( CryostatID const & id ) const

inline

Definition at line 2549 of file GeometryCore.h.

References GetBeginTPCID().

   {
     return GetBeginTPCID(id);
   }

template<>

PlaneID geo::GeometryCore::GetBeginID ( CryostatID const & id ) const

inline

Definition at line 2562 of file GeometryCore.h.

References GetBeginPlaneID().

   {
     return GetBeginPlaneID(id);
   }

template<>

PlaneID geo::GeometryCore::GetBeginID ( TPCID const & id ) const

inline

Definition at line 2568 of file GeometryCore.h.

References GetBeginPlaneID().

   {
     return GetBeginPlaneID(id);
   }

template<>

WireID geo::GeometryCore::GetBeginID ( CryostatID const & id ) const

inline

Definition at line 2587 of file GeometryCore.h.

References GetBeginWireID().

   {
     return GetBeginWireID(id);
   }

template<>

WireID geo::GeometryCore::GetBeginID ( TPCID const & id ) const

inline

Definition at line 2593 of file GeometryCore.h.

References GetBeginWireID().

   {
     return GetBeginWireID(id);
   }

template<>

WireID geo::GeometryCore::GetBeginID ( PlaneID const & id ) const

inline

Definition at line 2599 of file GeometryCore.h.

References GetBeginWireID().

   {
     return GetBeginWireID(id);
   }

PlaneID geo::GeometryCore::GetBeginPlaneID ( CryostatID const & id ) const

inline

Returns the ID of the first plane of the specified cryostat.

Definition at line 1074 of file GeometryCore.h.

References GetBeginTPCID(), and GetEndPlaneID().

Referenced by GetBeginID(), GetBeginWireID(), and GetEndPlaneID().

1074 { return {GetBeginTPCID(id), 0}; }

geo::GeometryCore::GetBeginTPCID

TPCID GetBeginTPCID(CryostatID const &id) const

Returns the ID of the first TPC in the specified cryostat.

Definition: GeometryCore.h:796

PlaneID geo::GeometryCore::GetBeginPlaneID ( TPCID const & id ) const

inline

Returns the ID of the first plane of the specified TPC.

Definition at line 1081 of file GeometryCore.h.

References GetEndPlaneID(), PlanePitch(), SignalType(), and View().

1081 { return {id, 0}; }

readout::ROPID geo::GeometryCore::GetBeginROPID ( CryostatID const & id ) const

inline

Returns the ID of the first readout plane of the specified cryostat.

Definition at line 2274 of file GeometryCore.h.

References GetBeginTPCsetID().

Referenced by geo::GeometryCore::GetBeginID< readout::ROPID, CryostatID >(), and geo::GeometryCore::GetBeginID< readout::ROPID, readout::TPCsetID >().

2274 { return {GetBeginTPCsetID(id), 0}; }

geo::GeometryCore::GetBeginTPCsetID

readout::TPCsetID GetBeginTPCsetID(CryostatID const &id) const

Returns the ID of the first TPC set in the specified cryostat.

Definition: GeometryCore.h:2109

readout::ROPID geo::GeometryCore::GetBeginROPID ( readout::TPCsetID const & id ) const

inline

Returns the ID of the first readout plane of the specified TPC set.

Definition at line 2281 of file GeometryCore.h.

2281 { return {id, 0}; }

TPCID geo::GeometryCore::GetBeginTPCID ( CryostatID const & id ) const

inline

Returns the ID of the first TPC in the specified cryostat.

Definition at line 796 of file GeometryCore.h.

References DetHalfHeight(), DetHalfWidth(), DetLength(), GetEndTPCID(), and tpc_zero.

Referenced by GetBeginID(), GetBeginPlaneID(), and GetEndTPCID().

796 { return {id, 0}; }

readout::TPCsetID geo::GeometryCore::GetBeginTPCsetID ( CryostatID const & id ) const

inline

Returns the ID of the first TPC set in the specified cryostat.

Definition at line 2109 of file GeometryCore.h.

Referenced by geo::GeometryCore::GetBeginID< readout::TPCsetID, CryostatID >(), and GetBeginROPID().

2109 { return {id, 0}; }

WireID geo::GeometryCore::GetBeginWireID ( CryostatID const & id ) const

inline

Returns the ID of the first wire in the specified cryostat.

Definition at line 1234 of file GeometryCore.h.

References GetBeginPlaneID(), and GetEndWireID().

Referenced by GetBeginID(), and GetEndWireID().

1234 { return {GetBeginPlaneID(id), 0}; }

geo::GeometryCore::GetBeginPlaneID

PlaneID GetBeginPlaneID(CryostatID const &id) const

Returns the ID of the first plane of the specified cryostat.

Definition: GeometryCore.h:1074

WireID geo::GeometryCore::GetBeginWireID ( TPCID const & id ) const

inline

Returns the ID of the first wire of the specified TPC.

Definition at line 1241 of file GeometryCore.h.

References GetEndWireID().

1241 { return {PlaneID(id, 0), 0}; }

geo::fhicl::PlaneID

IDparameter< geo::PlaneID > PlaneID

Member type of validated geo::PlaneID parameter.

Definition: geo_types_fhicl.h:355

WireID geo::GeometryCore::GetBeginWireID ( PlaneID const & id ) const

inline

Returns the ID of the first wire of the specified wire plane.

Definition at line 1248 of file GeometryCore.h.

References GetEndWireID().

1248 { return {id, 0}; }

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

Find the nearest OpChannel to some point.

Parameters

xyz	point to be queried, in world coordinates

Returns: 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 1635 of file GeometryCore.cxx.

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

Referenced by ThirdPlaneSlope().

   {
     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);
   }

std::string geo::GeometryCore::GetCryostatVolumeName ( CryostatID const & cid ) const

Return the name of LAr TPC volume.

Parameters

cstat index of the cryostat

Returns: the name of the specified TPC

This information is used in the event display.

Todo:

Use a cryostat ID instead

What if it does not exist?

Definition at line 676 of file GeometryCore.cxx.

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

Referenced by Iterate().

   {
     return Cryostat(cid).Volume()->GetName();
   }

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

inline

Returns the specified cryostat.

Parameters

cstat	number of cryostat
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 465 of file GeometryCore.h.

References Cryostat().

Referenced by sce::SCECorrection::applyT0Shift(), and evd::SimulationDrawer::MCTruthOrtho().

465 { return Cryostat(cryoid); }

geo::GeometryCore::Cryostat

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

Returns the specified cryostat.

Definition: GeometryCore.cxx:303

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

inline

Returns the specified TPC.

Parameters

tpcid	ID of the tpc
tpc	tpc number within the cryostat
cstat	number of cryostat

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 723 of file GeometryCore.h.

References TPC().

723 { return TPC(tpcid); }

geo::GeometryCore::TPC

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

Returns the specified TPC.

Definition: GeometryCore.h:722

PlaneGeo const& geo::GeometryCore::GetElement ( PlaneID const & planeid ) const

inline

Returns the specified wire.

Parameters

planeid	ID of the plane
p	plane number within the TPC
tpc	TPC number within the cryostat
cstat	number of cryostat

Returns: a constant reference to the specified plane

Exceptions

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

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

Definition at line 1035 of file GeometryCore.h.

References Plane().

1035 { return Plane(planeid); }

geo::GeometryCore::Plane

PlaneGeo const & Plane(PlaneID const &planeid) const

Returns the specified wire.

Definition: GeometryCore.h:1034

WireGeo const& geo::GeometryCore::GetElement ( WireID const & wireid ) const

inline

Returns the specified wire.

Parameters

wireid ID of the wire

Returns: a constant reference to the specified wire

Exceptions

cet::exception if not found

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

Definition at line 1212 of file GeometryCore.h.

References Wire().

1212 { return Wire(wireid); }

geo::GeometryCore::Wire

WireGeo const & Wire(WireID const &wireid) const

Returns the specified wire.

Definition: GeometryCore.h:1210

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 481 of file GeometryCore.h.

References CryostatPtr(), PositionToCryostat(), PositionToCryostatID(), and PositionToCryostatPtr().

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

481 { return CryostatPtr(cryoid); }

geo::GeometryCore::CryostatPtr

CryostatGeo const * CryostatPtr(CryostatID const &cryoid) const

Returns the specified cryostat.

Definition: GeometryCore.h:477

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 740 of file GeometryCore.h.

References FindTPCAtPosition(), PositionToTPC(), PositionToTPCID(), PositionToTPCptr(), and TPCPtr().

740 { return TPCPtr(tpcid); }

geo::GeometryCore::TPCPtr

TPCGeo const * TPCPtr(TPCID const &tpcid) const

Returns the specified TPC.

Definition: GeometryCore.h:735

PlaneGeo const* geo::GeometryCore::GetElementPtr ( PlaneID const & planeid ) const

inline

Returns the specified plane.

Parameters

planeid plane ID

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

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

Definition at line 1052 of file GeometryCore.h.

References PlanePtr().

1052 { return PlanePtr(planeid); }

geo::GeometryCore::PlanePtr

PlaneGeo const * PlanePtr(PlaneID const &planeid) const

Returns the specified plane.

Definition: GeometryCore.h:1047

WireGeo const* geo::GeometryCore::GetElementPtr ( WireID const & wireid ) const

inline

Returns the specified wire.

Parameters

wireid wire ID

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

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

Definition at line 1197 of file GeometryCore.h.

References WirePtr().

1197 { return WirePtr(wireid); }

geo::GeometryCore::WirePtr

WireGeo const * WirePtr(WireID const &wireid) const

Returns the specified wire.

Definition: GeometryCore.h:1192

template<typename GeoID >

GeoID geo::GeometryCore::GetEndID ( ) const

inline

Returns the (possibly invalid) ID after the last subelement of the detector.

Template Parameters

GeoID type of the ID to be returned

Returns: ID after the last subelement in the specified geometry element

Definition at line 385 of file GeometryCore.h.

References GetBeginID().

Referenced by GetBeginID(), and GetEndID().

     {
       GeoID id;
       GetEndID(id);
       return id;
     }

template<typename GeoID , typename ContextID >

GeoID geo::GeometryCore::GetEndID ( ContextID const & id ) const

Returns the (possibly invalid) ID after the last subelement of the specified element.

Template Parameters

GeoID	type of the ID to be returned
ContextID	type of the ID of the containing element

Parameters

id	ID of the containing element

Returns: ID (possibly invalid) after the last subelement in the specified geometry element

void geo::GeometryCore::GetEndID ( CryostatID & id ) const

inline

Initializes the specified ID with the invalid ID after the last cryostat.

Definition at line 521 of file GeometryCore.h.

References IncrementID(), and Ncryostats().

521 { id = CryostatID(Ncryostats(), false); }

geo::fhicl::CryostatID

IDparameter< geo::CryostatID > CryostatID

Member type of validated geo::CryostatID parameter.

Definition: geo_types_fhicl.h:270

geo::GeometryCore::Ncryostats

unsigned int Ncryostats() const

Returns the number of cryostats in the detector.

Definition: GeometryCore.h:430

void geo::GeometryCore::GetEndID ( TPCID & id ) const

Initializes the specified ID with the invalid ID after the last TPC.

Definition at line 380 of file GeometryCore.cxx.

References GetBeginID(), GetEndID(), and MaxTPCs().

   {
     if (MaxTPCs() == 0) {
       GetBeginID(id);
       id.markInvalid();
     }
     else {
       GetEndID(id.asCryostatID());
       id.deepestIndex() = 0;
     }
   }

void geo::GeometryCore::GetEndID ( PlaneID & id ) const

Initializes the specified ID with the invalid ID after the last plane.

Definition at line 718 of file GeometryCore.cxx.

References GetBeginID(), GetEndID(), and MaxPlanes().

   {
     if (MaxPlanes() == 0) {
       GetBeginID(id);
       id.markInvalid();
     }
     else {
       GetEndID(id.asTPCID());
       id.deepestIndex() = 0;
     }
   }

void geo::GeometryCore::GetEndID ( WireID & id ) const

Initializes the specified ID with the invalid ID after the last wire.

Definition at line 840 of file GeometryCore.cxx.

References GetBeginID(), GetEndID(), and MaxWires().

   {
     if (MaxWires() == 0) {
       GetBeginID(id);
       id.markInvalid();
     }
     else {
       GetEndID(id.asPlaneID());
       id.deepestIndex() = 0;
     }
   }

void geo::GeometryCore::GetEndID ( readout::TPCsetID & id ) const

inline

Initializes the specified ID with the invalid ID after the last TPC set.

Definition at line 2098 of file GeometryCore.h.

References GetEndID(), and IncrementID().

     {
       GetEndID(id.asCryostatID());
       id.TPCset = 0;
     }

void geo::GeometryCore::GetEndID ( readout::ROPID & id ) const

inline

Initializes the specified ID with the invalid ID after the last ROP.

Definition at line 2263 of file GeometryCore.h.

References GetEndID(), and IncrementID().

     {
       GetEndID(id.asTPCsetID());
       id.ROP = 0;
     }

template<>

TPCID geo::GeometryCore::GetEndID ( CryostatID const & id ) const

inline

Definition at line 2555 of file GeometryCore.h.

References GetEndTPCID().

   {
     return GetEndTPCID(id);
   }

template<>

PlaneID geo::GeometryCore::GetEndID ( CryostatID const & id ) const

inline

Definition at line 2574 of file GeometryCore.h.

References GetEndPlaneID().

   {
     return GetEndPlaneID(id);
   }

template<>

PlaneID geo::GeometryCore::GetEndID ( TPCID const & id ) const

inline

Definition at line 2580 of file GeometryCore.h.

References GetEndPlaneID().

   {
     return GetEndPlaneID(id);
   }

template<>

WireID geo::GeometryCore::GetEndID ( CryostatID const & id ) const

inline

Definition at line 2605 of file GeometryCore.h.

References GetEndWireID().

   {
     return GetEndWireID(id);
   }

template<>

WireID geo::GeometryCore::GetEndID ( TPCID const & id ) const

inline

Definition at line 2611 of file GeometryCore.h.

References GetEndWireID().

   {
     return GetEndWireID(id);
   }

template<>

WireID geo::GeometryCore::GetEndID ( PlaneID const & id ) const

inline

Definition at line 2617 of file GeometryCore.h.

References GetEndWireID().

   {
     return GetEndWireID(id);
   }

PlaneID geo::GeometryCore::GetEndPlaneID ( CryostatID const & id ) const

Returns the (possibly invalid) ID after the last plane of the specified cryostat.

Definition at line 731 of file GeometryCore.cxx.

References CryostatPtr(), GetBeginPlaneID(), GetEndTPCID(), and geo::CryostatGeo::MaxPlanes().

Referenced by GetBeginPlaneID(), GetEndID(), and GetEndWireID().

   {
     CryostatGeo const* cryo = CryostatPtr(id);
     return (cryo && cryo->MaxPlanes() > 0) ? PlaneID{GetEndTPCID(id), 0} : GetBeginPlaneID(id);
   }

PlaneID geo::GeometryCore::GetEndPlaneID ( TPCID const & id ) const

Returns the (possibly invalid) ID after the last plane of the specified TPC.

Definition at line 738 of file GeometryCore.cxx.

References GetBeginPlaneID(), GetNextID(), geo::CryostatID::markInvalid(), geo::TPCGeo::Nplanes(), TPC(), and TPCPtr().

   {
     if (TPCGeo const* TPC = TPCPtr(id); TPC && TPC->Nplanes() > 0) return {GetNextID(id), 0};
     PlaneID pid = GetBeginPlaneID(id);
     pid.markInvalid();
     return pid;
   }

readout::ROPID geo::GeometryCore::GetEndROPID ( CryostatID const & id ) const

inline

Returns the (possibly invalid) ID after the last readout plane of the specified cryostat.

Definition at line 2278 of file GeometryCore.h.

References GetEndTPCsetID().

Referenced by geo::GeometryCore::GetEndID< readout::ROPID, CryostatID >(), and geo::GeometryCore::GetEndID< readout::ROPID, readout::TPCsetID >().

2278 { return {GetEndTPCsetID(id), 0}; }

geo::GeometryCore::GetEndTPCsetID

readout::TPCsetID GetEndTPCsetID(CryostatID const &id) const

Definition: GeometryCore.h:2113

readout::ROPID geo::GeometryCore::GetEndROPID ( readout::TPCsetID const & id ) const

inline

Returns the (possibly invalid) ID after the last readout plane of the specified TPC set.

Definition at line 2285 of file GeometryCore.h.

References ApplyChannelMap(), GetNextID(), HardwareChannelFromOpChannel(), IsValidOpChannel(), LoadGeometryFile(), MaxOpChannel(), NOpChannels(), NOpHardwareChannels(), OpChannel(), OpDetFromCryo(), OpDetFromOpChannel(), SignalType(), and View().

2285 { return {GetNextID(id), 0}; }

geo::GeometryCore::GetNextID

GeoID GetNextID(GeoID const &id) const

Returns the ID next to the specified one.

Definition: GeometryCore.h:371

TPCID geo::GeometryCore::GetEndTPCID ( CryostatID const & id ) const

Returns the (possibly invalid) ID after the last TPC of the specified cryostat.

Definition at line 393 of file GeometryCore.cxx.

References geo::CryostatID::Cryostat, CryostatPtr(), GetBeginTPCID(), geo::CryostatID::markInvalid(), and geo::CryostatGeo::NTPC().

Referenced by GetBeginTPCID(), GetEndID(), and GetEndPlaneID().

   {
     if (CryostatGeo const* cryo = CryostatPtr(id); cryo && cryo->NTPC() > 0)
       return {id.Cryostat + 1, 0};
     TPCID tpcid = GetBeginTPCID(id);
     tpcid.markInvalid();
     return tpcid;
   }

readout::TPCsetID geo::GeometryCore::GetEndTPCsetID ( CryostatID const & id ) const

inline

Returns the (possibly invalid) ID after the last TPC set of the specified cryostat.

Definition at line 2113 of file GeometryCore.h.

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

Referenced by geo::GeometryCore::GetEndID< readout::TPCsetID, CryostatID >(), and GetEndROPID().

2113 { return {id.Cryostat + 1, 0}; }

WireID geo::GeometryCore::GetEndWireID ( CryostatID const & id ) const

Returns the (possibly invalid) ID after the last wire in the specified cryostat.

Definition at line 853 of file GeometryCore.cxx.

References CryostatPtr(), GetBeginWireID(), GetEndPlaneID(), geo::CryostatID::markInvalid(), and geo::CryostatGeo::MaxWires().

Referenced by GetBeginWireID(), and GetEndID().

   {
     CryostatGeo const* cryo = CryostatPtr(id);
     if (cryo && cryo->MaxWires() > 0) return {GetEndPlaneID(id), 0};
     WireID wid = GetBeginWireID(id);
     wid.markInvalid();
     return wid;
   }

WireID geo::GeometryCore::GetEndWireID ( TPCID const & id ) const

Returns the (possibly invalid) ID after the last wire of the specified TPC.

Definition at line 863 of file GeometryCore.cxx.

References GetBeginWireID(), GetEndPlaneID(), geo::CryostatID::markInvalid(), geo::TPCGeo::MaxWires(), TPC(), and TPCPtr().

   {
     TPCGeo const* TPC = TPCPtr(id);
     if (TPC && TPC->MaxWires() > 0) return {GetEndPlaneID(id), 0};
     WireID wid = GetBeginWireID(id);
     wid.markInvalid();
     return wid;
   }

WireID geo::GeometryCore::GetEndWireID ( PlaneID const & id ) const

Returns the (possibly invalid) ID after the last wire of the specified wire plane.

Definition at line 873 of file GeometryCore.cxx.

References GetBeginWireID(), GetNextID(), geo::CryostatID::markInvalid(), geo::PlaneGeo::Nwires(), and PlanePtr().

   {
     if (PlaneGeo const* plane = PlanePtr(id); plane && plane->Nwires() > 0)
       return {GetNextID(id), 0};
     WireID wid = GetBeginWireID(id);
     wid.markInvalid();
     return wid;
   }

std::string geo::GeometryCore::GetLArTPCVolumeName ( TPCID const & tpcid = tpc_zero ) const

Return the name of specified LAr TPC volume.

Parameters

tpcid	ID of the TPC
tpc	index of TPC in the cryostat
cstat	index of the cryostat

Returns: the name of the specified TPC

This information is used by Geant4 simulation

Todo:: What if it does not exist?

Definition at line 670 of file GeometryCore.cxx.

References geo::TPCGeo::ActiveVolume(), and TPC().

Referenced by LArStackingAction::ClassifyNewTrack(), GetTPCFrontFaceCenter(), trkf::SpacePts::produce(), trkf::Track3Dreco::produce(), trkf::Track3DKalman::produce(), vertex::VertexFinder2D::produce(), and trkf::Track3DKalmanSPS::produce().

   {
     return TPC(tpcid).ActiveVolume()->GetName();
   }

template<typename GeoID >

GeoID geo::GeometryCore::GetNextID ( GeoID const & id ) const

inline

Returns the ID next to the specified one.

Template Parameters

GeoID type of the ID to be returned

Parameters

id	the element ID to be incremented

Returns: ID of the next subelement after id

Definition at line 371 of file GeometryCore.h.

References IncrementID().

Referenced by GetEndPlaneID(), GetEndROPID(), and GetEndWireID().

     {
       auto nextID(id);
       IncrementID(nextID);
       return nextID;
     }

Point_t geo::GeometryCore::GetTPCFrontFaceCenter ( TPCID const & tpcid ) const

inline

Returns the center of side of the detector facing the beam.

Parameters

tpcid ID of the TPC

Returns: position of center of TPC face toward the beam, in world coordinates [cm]

Effectively, this is the center of the side of TPC active volume which faces the negative z direction, the first that a beam following the positive z direction crosses.

Definition at line 872 of file GeometryCore.h.

References geo::TPCGeo::GetFrontFaceCenter(), GetLArTPCVolumeName(), MaxPlanes(), TPC(), and tpc_zero.

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

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

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

Definition at line 501 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).
     return std::string("volWorld");
   }

unsigned int geo::GeometryCore::HardwareChannelFromOpChannel ( int opChannel ) const

Convert unique channel to hardware channel.

Definition at line 268 of file GeometryCore.cxx.

References fChannelMapAlg.

Referenced by GetEndROPID().

   {
     return fChannelMapAlg->HardwareChannelFromOpChannel(opChannel);
   }

bool geo::GeometryCore::HasChannel ( raw::ChannelID_t channel ) const

Returns whether the specified channel exists and is valid.

Parameters

channel the ID of the channel

Returns: whether the specified channel exists

A channel is defined as existing and valid if its ID is not invalid and if the channel is physical.

Definition at line 495 of file GeometryCore.cxx.

References fChannelMapAlg.

Referenced by Views().

   {
     return fChannelMapAlg->HasChannel(channel);
   }

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 446 of file GeometryCore.h.

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

Referenced by CryostatPtr(), GetBeginID(), HasElement(), and IncrementID().

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

geo::GeometryCore::Ncryostats

unsigned int Ncryostats() const

Returns the number of cryostats in the detector.

Definition: GeometryCore.h:430

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 447 of file GeometryCore.h.

References HasCryostat().

447 { return HasCryostat(cryoid); }

geo::GeometryCore::HasCryostat

bool HasCryostat(CryostatID const &cryoid) const

Returns whether we have the specified cryostat.

Definition: GeometryCore.h:446

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

inline

Returns whether we have the specified TPC.

Definition at line 706 of file GeometryCore.h.

References HasTPC().

706 { return HasTPC(tpcid); }

geo::GeometryCore::HasTPC

bool HasTPC(TPCID const &tpcid) const

Returns whether we have the specified TPC.

Definition: GeometryCore.h:699

bool geo::GeometryCore::HasElement ( PlaneID const & planeid ) const

inline

Returns whether we have the specified plane.

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

Definition at line 1016 of file GeometryCore.h.

References HasPlane().

1016 { return HasPlane(planeid); }

geo::GeometryCore::HasPlane

bool HasPlane(PlaneID const &planeid) const

Returns whether we have the specified plane.

Definition: GeometryCore.h:1011

bool geo::GeometryCore::HasElement ( WireID const & wireid ) const

inline

Returns whether we have the specified wire.

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

Definition at line 1180 of file GeometryCore.h.

References HasWire().

1180 { return HasWire(wireid); }

geo::GeometryCore::HasWire

bool HasWire(WireID const &wireid) const

Returns whether we have the specified wire.

Definition: GeometryCore.h:1175

bool geo::GeometryCore::HasElement ( readout::TPCsetID const & tpcsetid ) const

inline

Returns whether we have the specified TPC set.

Definition at line 2059 of file GeometryCore.h.

References FindTPCsetAtPosition(), HasTPCset(), TPCsetToTPCs(), and TPCtoTPCset().

2059 { return HasTPCset(tpcsetid); }

geo::GeometryCore::HasTPCset

bool HasTPCset(readout::TPCsetID const &tpcsetid) const

Definition: GeometryCore.cxx:1479

bool geo::GeometryCore::HasElement ( readout::ROPID const & ropid ) const

inline

Returns whether we have the specified readout plane

Returns: whether the readout plane is valid and exists

Definition at line 2198 of file GeometryCore.h.

References FirstChannelInROP(), HasROP(), ROPtoTPCs(), ROPtoWirePlanes(), and WirePlaneToROP().

2198 { return HasROP(ropid); }

geo::GeometryCore::HasROP

bool HasROP(readout::ROPID const &ropid) const

Definition: GeometryCore.cxx:1518

bool geo::GeometryCore::HasPlane ( PlaneID const & planeid ) const

inline

Returns whether we have the specified plane.

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

Definition at line 1011 of file GeometryCore.h.

References geo::TPCGeo::HasPlane(), and TPCPtr().

Referenced by HasElement().

     {
       TPCGeo const* pTPC = TPCPtr(planeid);
       return pTPC ? pTPC->HasPlane(planeid) : false;
     }

bool geo::GeometryCore::HasROP ( readout::ROPID const & ropid ) const

Returns whether we have the specified readout plane

Returns: whether the readout plane is valid and exists

Definition at line 1518 of file GeometryCore.cxx.

References fChannelMapAlg.

Referenced by HasElement(), and makeROPdata().

   {
     return fChannelMapAlg->HasROP(ropid);
   }

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

inline

Returns whether we have the specified TPC.

Definition at line 699 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;
     }

bool geo::GeometryCore::HasTPCset ( readout::TPCsetID const & tpcsetid ) const

Returns whether we have the specified TPC set

Returns: whether the TPC set is valid and exists

Definition at line 1479 of file GeometryCore.cxx.

References fChannelMapAlg.

Referenced by HasElement(), and makeTPCsetData().

   {
     return fChannelMapAlg->HasTPCset(tpcsetid);
   }

bool geo::GeometryCore::HasWire ( WireID const & wireid ) const

inline

Returns whether we have the specified wire.

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

Definition at line 1175 of file GeometryCore.h.

References geo::PlaneGeo::HasWire(), and PlanePtr().

Referenced by tca::FillmAllTraj(), HasElement(), pma::ProjectionMatchingAlg::validate(), pma::ProjectionMatchingAlg::validate_on_adc(), pma::ProjectionMatchingAlg::validate_on_adc_test(), and WireIDIntersectionCheck().

     {
       PlaneGeo const* pPlane = PlanePtr(wireid);
       return pPlane ? pPlane->HasWire(wireid) : false;
     }

bool geo::GeometryCore::IncrementID ( CryostatID & id ) const

inline

Sets the ID to the ID after the specified one.

Returns: whether the ID is actually valid (validity flag is also set)

Definition at line 2481 of file GeometryCore.h.

References HasCryostat().

Referenced by GetBeginID(), GetEndID(), GetNextID(), and IncrementID().

 {
   ++id.Cryostat;
   if (id) id.isValid = HasCryostat(id); // if invalid already, it stays so
   return bool(id);
 }

bool geo::GeometryCore::IncrementID ( TPCID & id ) const

inline

Sets the ID to the ID after the specified one.

Returns: whether the ID is actually valid (validity flag is also set)

Definition at line 2488 of file GeometryCore.h.

References IncrementID(), NTPC(), and TPC().

 {
   unsigned int const nTPCsInCryo = NTPC(id);
   if (++id.TPC < nTPCsInCryo) return bool(id); // if was invalid, it stays so
   // no more TPCs in this cryostat
   id.TPC = 0;
   return IncrementID(id.asCryostatID()); // also sets validity
 }

bool geo::GeometryCore::IncrementID ( PlaneID & id ) const

inline

Sets the ID to the ID after the specified one.

Returns: whether the ID is actually valid (validity flag is also set)

Definition at line 2497 of file GeometryCore.h.

References IncrementID(), Nplanes(), and Plane().

 {
   // this implementation is non-optimal, in that the cryostat lookup is
   // performed both here and, potentially, in IncrementID(TPCID)
   unsigned int const nPlanesInTPC = Nplanes(id);
   if (++id.Plane < nPlanesInTPC) return bool(id); // if was invalid, stays so
   // no more planes in this TPCs
   id.Plane = 0;
   return IncrementID(id.asTPCID()); // also sets validity
 }

bool geo::GeometryCore::IncrementID ( WireID & id ) const

inline

Sets the ID to the ID after the specified one.

Returns: whether the ID is actually valid (validity flag is also set)

Definition at line 2508 of file GeometryCore.h.

References IncrementID(), Nwires(), and Wire().

 {
   // this implementation is non-optimal, in that the TPC lookup is
   // performed both here and, potentially, in IncrementID(PlaneID)
   unsigned int const nWiresInPlane = Nwires(id);
   if (++id.Wire < nWiresInPlane) return bool(id); // if was invalid, stays so
   // no more wires in this plane
   id.Wire = 0;
   return IncrementID(id.asPlaneID()); // also sets validity
 }

bool geo::GeometryCore::IncrementID ( readout::TPCsetID & id ) const

inline

Sets the ID to the ID after the specified one.

Returns: whether the ID is actually valid (validity flag is also set)

Definition at line 2519 of file GeometryCore.h.

References IncrementID(), and NTPCsets().

 {
   unsigned int const nTPCsetsInCryo = NTPCsets(id);
   if (++id.TPCset < nTPCsetsInCryo) return bool(id); // if was invalid, it stays so
   // no more TPC sets in this cryostat
   id.TPCset = 0;
   return IncrementID(id.asCryostatID()); // also sets validity
 }

bool geo::GeometryCore::IncrementID ( readout::ROPID & id ) const

inline

Sets the ID to the ID after the specified one.

Returns: whether the ID is actually valid (validity flag is also set)

Definition at line 2528 of file GeometryCore.h.

References IncrementID(), and NROPs().

 {
   // this implementation is non-optimal, in that the cryostat lookup is
   // performed both here and, potentially, in IncrementID(TPCsetID)
   unsigned int const nROPinTPC = NROPs(id);
   if (++id.ROP < nROPinTPC) return bool(id); // if was invalid, stays so
   // no more readout planes in this TPC set
   id.ROP = 0;
   return IncrementID(id.asTPCsetID()); // also sets validity
 }

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

Returns a string with complete geometry information.

See also: Print()

Definition at line 1073 of file GeometryCore.cxx.

References Print().

Referenced by SurfaceY().

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

bool geo::GeometryCore::IntersectionPoint	(	WireID const &	wid1,
		WireID const &	wid2,
		double &	y,
		double &	z
	)		const

Returns the intersection point of two wires.

Parameters

wid1	ID of the first wire
wid2	ID of the other wire
y	(output) y coordinate of the intersection point
z	(output) z coordinate of the intersection point

Returns: whether an intersection was found within the TPC

See also: WireIDsIntersect()

The behaviour of this method reflects the one of WireIDsIntersect(), which supersedes this one.

To test if the result is infinity, use e.g. std::isfinite(y).

Deprecated:: This method uses arbitrary assumptions and should not be used. Use WireIDsIntersect() returning a vector, instead.

Definition at line 1451 of file GeometryCore.cxx.

References WireIDsIntersect(), geo::WireIDIntersection::y, and geo::WireIDIntersection::z.

Referenced by pma::ProjectionMatchingAlg::addEndpointRef_(), sppt::SpacePointAlg_TimeSort::fillCoordinatesArrays(), trkf::CCTrackMaker::FillEndMatch(), tca::FillWireIntersections(), filter::MuonFilter::filter(), tca::Find3DVertices(), vertex::FeatureVertexFinder::Get3dVertexCandidates(), pma::Track3D::InitFromHits(), tca::Match2Planes(), cluster::ClusterMatchAlg::Match_RoughZ(), trkf::CCTrackMaker::PlnMatch(), and trkf::TrackTrajectoryAlg::ShortTrackTrajectory().

   {
     WireIDIntersection widIntersect;
     bool const found = WireIDsIntersect(wid1, wid2, widIntersect);
     y = widIntersect.y;
     z = widIntersect.z;
     return found;
   }

bool geo::GeometryCore::IsValidOpChannel ( int opChannel ) const

Is this a valid OpChannel number?

Definition at line 274 of file GeometryCore.cxx.

References fChannelMapAlg, and NOpDets().

Referenced by cosmic::BeamFlashTrackMatchTaggerAlg::CheckCompatibility(), GetEndROPID(), cosmic::BeamFlashTrackMatchTaggerAlg::PrintHypothesisFlashComparison(), lariov::SIOVPmtGainProvider::Reconfigure(), and opdet::RunHitFinder().

   {
     return fChannelMapAlg->IsValidOpChannel(opChannel, this->NOpDets());
   }

template<typename T >

details::range_type<T> geo::GeometryCore::Iterate ( ) const

inline

Initializes the specified ID with the ID of the first cryostat.

Definition at line 541 of file GeometryCore.h.

References geo::details::IteratorMaker< T, typename >::create_range().

Referenced by vertex::FeatureVertexFinderAna::analyze(), pfpf::PFPAna::analyze(), cluster::ClusterAna::analyze(), cluster::DBclusterAna::analyze(), evgen::GaisserParam::beginJob(), trkf::SpacePointAna::bookHistograms(), pma::PMAlgTracker::build(), ShowerRecoTools::ShowerTrajPointdEdx::CalculateElement(), corner::CornerFinderAlg::create_smaller_histos(), lar_pandora::LArPandoraInput::CreatePandoraReadoutGaps(), sim::details::createPlaneIndexMap(), evd_tool::ICARUSDrawer::DetOutline3D(), trkf::TrackKalmanFitter::doFitWork(), larg4::ISTPC::extractActiveLArVolume(), larg4::OpFastScintillation::extractActiveVolumes(), cluster::HoughBaseAlg::FastTransform(), trkf::CCTrackMaker::FillChgNear(), tca::FillWireHitRange(), vertex::FeatureVertexFinder::Find2dClusterVertexCandidates(), vertex::FeatureVertexFinder::Find3dVtxFrom2dClusterVtxCand(), trkf::CCTrackMaker::FindMaybeVertices(), ems::MCinfo::Findtpcborders(), vertex::FeatureVertexFinder::Get3dVertexCandidates(), corner::CornerFinderAlg::get_feature_points(), corner::CornerFinderAlg::get_feature_points_fast(), corner::CornerFinderAlg::get_feature_points_LineIntegralScore(), mvapid::MVAAlg::GetDetectorEdges(), lar_pandora::LArPandoraInput::GetTrueStartAndEndPoints(), mvapid::MVAAlg::GetWireNormals(), corner::CornerFinderAlg::GrabWires(), cluster::HoughBaseAlg::HoughBaseAlg(), cluster::DBScan3DAlg::init(), corner::CornerFinderAlg::InitializeGeometry(), cluster::DBScanAlg::InitScan(), tca::InsideTPC(), lar_pandora::LArPandoraGeometry::LoadGeometry(), sim::MCRecoEdep::MakeMCEdep(), shower::TCShowerAlg::makeShowers(), trkf::SpacePointAlg::makeSpacePoints(), sim::MCRecoPart::MCRecoPart(), evd::RecoBaseDrawer::OpFlashOrtho(), evd::Ortho3DPad::Ortho3DPad(), evgen::CORSIKAGen::populateNShowers(), trkf::CCTrackMaker::PrintClusters(), evgen::CosmicsGen::produce(), tss::TrackShowerHits::produce(), evgen::NDKGen::produce(), trkf::CCTrackMaker::produce(), evgen::NucleonDecay::produce(), vertex::FeatureVertexFinder::produce(), evgen::NeutronOsc::produce(), evgen::CORSIKAGen::produce(), evd::RecoBaseDrawer::RecoBaseDrawer(), phot::PhotonVisibilityService::reconfigure(), lariov::SIOVElectronicsCalibProvider::Reconfigure(), lariov::DetPedestalRetrievalAlg::Reconfigure(), evgen::ActiveVolumeVertexSampler::reconfigure(), evgen::ActiveVolumeVertexSampler::sample_vertex_pos(), evd::SimulationDrawer::SimulationDrawer(), trkf::CCTrackMaker::StoreTrack(), evd::TWQProjectionView::TWQProjectionView(), and trkf::SpacePointAlg::update().

     {
       return details::IteratorMaker<T>::create_range(this);
     }

template<typename T , typename ID >

details::range_type<T> geo::GeometryCore::Iterate ( ID const & id ) const

inline

Initializes the specified ID with the ID of the first cryostat.

Definition at line 559 of file GeometryCore.h.

References geo::details::IteratorMaker< T, typename >::create_range(), cryostat_zero, CryostatHalfHeight(), CryostatHalfWidth(), CryostatLength(), GetCryostatVolumeName(), MaxTPCs(), and TotalNTPC().

     {
       return details::IteratorMaker<T>::create_range(this, id);
     }

void geo::GeometryCore::LoadGeometryFile	(	std::string	gdmlfile,
		std::string	rootfile,
		GeometryBuilder &	builder,
		bool	bForceReload = `false`
	)

Loads the geometry information from the specified files.

Parameters

gdmlfile	path to file to be used for Geant4 simulation
rootfile	path to file for internal geometry representation
builder	algorithm to be used for the interpretation of geometry
bForceReload	reload even if there is already a valid geometry

See also: ApplyChannelMap()

Both paths must directly resolve to an available file, as no search is performed for them.

The gdmlfile parameter does not have to necessarily be in GDML format, as long as it's something supported by Geant4. This file is not used by the geometry, but its path is provided on request by the simulation modules (see LArSoft LArG4 module). The rootfile also does not need to be a ROOT file, but just anything that TGeoManager::Import() supports. This file is parsed immediately and the internal geometry representation is built out of it.

Note: After calling this method, the detector geometry information can be considered complete, but the geometry service provider is not fully initialized yet, since it's still necessary to provide or update the channel mapping.

Definition at line 93 of file GeometryCore.cxx.

References BuildGeometry(), ClearGeometry(), fGDMLfile, and fROOTfile.

Referenced by GetEndROPID(), LoadGeometryFile(), and geo::Geometry::LoadNewGeometry().

   {
     if (gdmlfile.empty()) {
       throw cet::exception("GeometryCore") << "No GDML Geometry file specified!\n";
     }
 
     if (rootfile.empty()) {
       throw cet::exception("GeometryCore") << "No ROOT Geometry file specified!\n";
     }
 
     ClearGeometry();
 
     // Open the GDML file, and convert it into ROOT TGeoManager format.
     // Then lock the gGeoManager to prevent future imports, for example
     // in AuxDetGeometry
     if (!gGeoManager || bForceReload) {
       if (gGeoManager)
         TGeoManager::UnlockGeometry();
       else { // very first time (or so it should)
         // [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(rootfile.c_str());
       gGeoManager->LockGeometry();
     }
 
     BuildGeometry(builder);
 
     fGDMLfile = move(gdmlfile);
     fROOTfile = move(rootfile);
 
     mf::LogInfo("GeometryCore") << "New detector geometry loaded from "
                                 << "\n\t" << fROOTfile << "\n\t" << fGDMLfile << "\n";
   } // GeometryCore::LoadGeometryFile()

void geo::GeometryCore::LoadGeometryFile	(	std::string	gdmlfile,
		std::string	rootfile,
		bool	bForceReload = `false`
	)

Loads the geometry information from the specified files.

Parameters

gdmlfile	path to file to be used for Geant4 simulation
rootfile	path to file for internal geometry representation
bForceReload	reload even if there is already a valid geometry

See also: ApplyChannelMap()

This legacy version of LoadGeometryFile() uses a standard geo::GeometryBuilder implementation. Do not rely on it if you can avoid it.

Definition at line 143 of file GeometryCore.cxx.

References fBuilderParameters, and LoadGeometryFile().

   {
     fhicl::Table<GeometryBuilderStandard::Config> const builderConfig(fBuilderParameters,
                                                                       {"tool_type"});
     // this is a wink to the understanding that we might be using an art-based
     // service provider configuration sprinkled with tools.
     GeometryBuilderStandard builder{builderConfig()};
     LoadGeometryFile(gdmlfile, rootfile, builder, bForceReload);
   }

template<typename T >

PlaneDataContainer<T> geo::GeometryCore::makePlaneData ( ) const

inline

Returns a container with one entry per wire plane.

Template Parameters

T	type of data in the container

Returns: a container with one default-constructed T per plane

See also: geo::PlaneDataContainer

The working assumption is that all cryostats have the same number of TPCs, and all TPCs have the same number of planes. It is always guaranteed that all existing planes have an entry in the container, although if the previous working assumption is not satisfied there will be entries in the containers which are not associated to a valid plane.

The interface of the container is detailed in the documentation of the container itself, geo::PlaneDataContainer. Example of usage:

auto const* geom = lar::providerFrom<geo::GeometryCore>();
auto hitsPerPlane
  = geom->makePlaneData<std::vector<recob::Hit const*>>();
for (recob::Hit const& hit: hits) {
  if (hit.WireID()) hitsPerPlane[hit.WireID()].push_back(&hit);
} // for

where the container will be filled with pointers to all hits on the given wire plane (wire IDs are implicitly converted into plane IDs in the index operator[] call).

Definition at line 937 of file GeometryCore.h.

References MaxPlanes(), MaxTPCs(), and Ncryostats().

     {
       return {Ncryostats(), MaxTPCs(), MaxPlanes()};
     }

template<typename T >

PlaneDataContainer<T> geo::GeometryCore::makePlaneData ( T const & defValue ) const

inline

Returns a container with one entry per wire plane.

Template Parameters

T	type of data in the container

Parameters

defValue the initial value of all elements in the container

Returns: a container with one default-constructed T per plane

See also: geo::PlaneDataContainer

This function operates as makePlaneData() const, except that copies the specified value into all the entries of the container. Example:

auto const* geom = lar::providerFrom<geo::GeometryCore>();
auto nHitsPerPlane = geom->makePlaneData(0U);
for (recob::Hit const& hit: hits) {
  if (hit.WireID()) ++(hitsPerPlane[hit.WireID()]);
} // for

Definition at line 961 of file GeometryCore.h.

References MaxPlanes(), MaxTPCs(), and Ncryostats().

     {
       return {Ncryostats(), MaxTPCs(), MaxPlanes(), defValue};
     }

template<typename T >

readout::ROPDataContainer<T> geo::GeometryCore::makeROPdata ( ) const

inline

Returns a container with one entry per readout plane.

Template Parameters

T	type of data in the container

Returns: a container with one default-constructed T per readout plane

See also: readout::ROPDataContainer

The working assumption is that all cryostats have the same number of TPC sets, and all TPC sets have the same number of readout planes. It is always guaranteed that all existing readout planes have an entry in the container, although if the previous working assumption is not satisfied there will be entries in the container which are not associated to a valid readout plane.

The interface of the container is detailed in the documentation of the container itself, readout::ROPDataContainer. Example of usage:

auto const* geom = lar::providerFrom<geo::GeometryCore>();
auto hitsPerROP
  = geom->makeROPdata<std::vector<recob::Hit const*>>();

Definition at line 2164 of file GeometryCore.h.

References MaxROPs(), MaxTPCsets(), and Ncryostats().

     {
       return {Ncryostats(), MaxTPCsets(), MaxROPs()};
     }

template<typename T >

readout::ROPDataContainer<T> geo::GeometryCore::makeROPdata ( T const & defValue ) const

inline

Returns a container with one entry per readout plane.

Template Parameters

T	type of data in the container

Parameters

defValue the initial value of all elements in the container

Returns: a container with one default-constructed T per readout plane

See also: readout::ROPDataContainer

This function operates as makeROPdata() const, except that copies the specified value into all the entries of the container. Example:

auto const* geom = lar::providerFrom<geo::GeometryCore>();

auto nHitsPerROP = geom->makeROPdata(0U);

Definition at line 2184 of file GeometryCore.h.

References HasROP(), MaxROPs(), MaxTPCsets(), and Ncryostats().

     {
       return {Ncryostats(), MaxTPCsets(), MaxROPs(), defValue};
     }

template<typename T >

TPCDataContainer<T> geo::GeometryCore::makeTPCData ( ) const

inline

Returns a container with one entry per TPC.

Template Parameters

T	type of data in the container

Returns: a container with one default-constructed T per TPC

See also: geo::TPCDataContainer

The working assumption is that all cryostats have the same number of TPCs. It is always guaranteed that all existing TPCs have an entry in the container, although if the previous working assumption is not satisfied there will be entries in the containers which are not associated to a valid TPC.

The interface of the container is detailed in the documentation of the container itself, geo::TPCDataContainer. Example of usage:

auto const* geom = lar::providerFrom<geo::GeometryCore>();
auto tracksPerTPC
  = geom->makeTPCData<std::vector<recob::Track const*>>();
for (recob::Track const& track: tracks) {
  geo::TPCGeo const* tpc = geom->PositionToTPCptr(track.Start());
  if (tpc) tracksPerTPC[tpc->ID()].push_back(&track);
} // for

where the container will be filled with pointers to all tracks starting from a given TPC (tracks reconstructed as starting outside the TPCs will be not saved in the container).

Definition at line 645 of file GeometryCore.h.

References MaxTPCs(), and Ncryostats().

     {
       return {Ncryostats(), MaxTPCs()};
     }

template<typename T >

TPCDataContainer<T> geo::GeometryCore::makeTPCData ( T const & defValue ) const

inline

Returns a container with one entry per TPC.

Template Parameters

T	type of data in the container

Parameters

defValue the initial value of all elements in the container

Returns: a container with a value defValue per each TPC

See also: geo::TPCDataContainer

This function operates as makeTPCData() const, except that copies the specified value into all the entries of the container. Example:

auto const* geom = lar::providerFrom<geo::GeometryCore>();
auto nTracksPerTPC = geom->makeTPCData(0U);
for (recob::Track const& track: tracks) {
  geo::TPCGeo const* tpc = geom->PositionToTPCptr(track.Start());
  if (tpc) ++(tracksPerTPC[tpc->ID()]);
} // for

Definition at line 670 of file GeometryCore.h.

References MaxTPCs(), and Ncryostats().

     {
       return {Ncryostats(), MaxTPCs(), defValue};
     }

template<typename T >

readout::TPCsetDataContainer<T> geo::GeometryCore::makeTPCsetData ( ) const

inline

Returns a container with one entry per TPC set.

Template Parameters

T	type of data in the container

Returns: a container with one default-constructed T per TPC set

See also: readout::TPCsetDataContainer

The working assumption is that all cryostats have the same number of TPC sets. It is always guaranteed that all existing TPC sets have an entry in the container, although if the previous working assumption is not satisfied there will be entries in the containers which are not associated to a valid TPC set.

The interface of the container is detailed in the documentation of the container itself, readout::TPCsetDataContainer. Example of usage:

auto const* geom = lar::providerFrom<geo::GeometryCore>();
auto tracksPerTPCset
  = geom->makeTPCsetData<std::vector<recob::Track const*>>();

Definition at line 2026 of file GeometryCore.h.

References MaxTPCsets(), and Ncryostats().

     {
       return {Ncryostats(), MaxTPCsets()};
     }

template<typename T >

readout::TPCsetDataContainer<T> geo::GeometryCore::makeTPCsetData ( T const & defValue ) const

inline

Returns a container with one entry per TPC set.

Template Parameters

T	type of data in the container

Parameters

defValue the initial value of all elements in the container

Returns: a container with a value defValue per each TPC set

See also: readout::TPCsetDataContainer

This function operates as makeTPCsetData() const, except that it copies the specified value into all the entries of the container. Example:

auto const* geom = lar::providerFrom<geo::GeometryCore>();

auto nTracksPerTPCset = geom->makeTPCsetData(0U);

Definition at line 2046 of file GeometryCore.h.

References HasTPCset(), MaxTPCsets(), and Ncryostats().

     {
       return {Ncryostats(), MaxTPCsets(), defValue};
     }

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 1033 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 949 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.

Returns: material of the origin by default

Definition at line 958 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::MaxOpChannel ( ) const

Largest optical channel number.

Definition at line 244 of file GeometryCore.cxx.

References fChannelMapAlg, and NOpDets().

Referenced by cosmic::BeamFlashTrackMatchTaggerAlg::CheckCompatibility(), opdet::ConstructFlash(), GetEndROPID(), and cosmic::BeamFlashTrackMatchTaggerAlg::PrintHypothesisFlashComparison().

   {
     return fChannelMapAlg->MaxOpChannel(this->NOpDets());
   }

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

Returns the largest number of planes among all TPCs in this detector.

Definition at line 818 of file GeometryCore.cxx.

References Cryostats().

Referenced by pma::PMAlgTracker::build(), ShowerRecoTools::ShowerTrajPointdEdx::CalculateElement(), shower::EMShowerAlg::CheckIsolatedHits_(), img::DataProviderAlg::DataProviderAlg(), trkf::TrackKalmanFitter::doFitWork(), lar_pandora::detector_functions::GetDetectorType(), GetEndID(), GetTPCFrontFaceCenter(), makePlaneData(), shower::EMShowerAlg::MakeShower(), shower::EMShowerAlg::MakeSpacePoints(), Nviews(), shower::EMShowerAlg::OrderShowerHits(), pma::PMAlgTracker::PMAlgTracker(), trkf::PMAlgTrackMaker::PMAlgTrackMaker(), nnet::PointIdTrainingData::PointIdTrainingData(), shower::EMShowerAlg::RelativeWireWidth_(), lar_pandora::LArPandoraGeometry::ShouldSwitchUV(), trkf::TrackKalmanFitter::sortOutput(), and shower::EMShowerAlg::WorstPlane_().

   {
     unsigned int maxPlanes = 0;
     for (CryostatGeo const& cryo : Cryostats()) {
       unsigned int maxPlanesInCryo = cryo.MaxPlanes();
       if (maxPlanesInCryo > maxPlanes) maxPlanes = maxPlanesInCryo;
     }
     return maxPlanes;
   }

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

Returns the largest number of ROPs a TPC set in the detector has.

Definition at line 1512 of file GeometryCore.cxx.

References fChannelMapAlg.

Referenced by makeROPdata(), and NSiblingElements().

   {
     return fChannelMapAlg->MaxROPs();
   }

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

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

Definition at line 796 of file GeometryCore.cxx.

References Cryostats().

Referenced by GetEndID(), Iterate(), makePlaneData(), makeTPCData(), and evd::TWQProjectionView::SetUpTPCselection().

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

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

Returns the largest number of TPC sets any cryostat in the detector has.

Definition at line 1473 of file GeometryCore.cxx.

References fChannelMapAlg.

Referenced by makeROPdata(), makeTPCsetData(), and NSiblingElements().

   {
     return fChannelMapAlg->MaxTPCsets();
   }

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

Returns the largest number of wires among all planes in this detector.

Definition at line 829 of file GeometryCore.cxx.

References Cryostats().

Referenced by cluster::BlurredClusteringAlg::ConvertRecobHitsToVector(), GetEndID(), and NSiblingElements().

   {
     unsigned int maxWires = 0;
     for (CryostatGeo const& cryo : Cryostats()) {
       unsigned int maxWiresInCryo = cryo.MaxWires();
       if (maxWiresInCryo > maxWires) maxWires = maxWiresInCryo;
     }
     return maxWires;
   }

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

inline

Returns the number of auxiliary detectors.

Todo:: use a AutDetID_t instead of unsigned int?

This method returns the total number of scintillator paddles (Auxiliary Detectors aka AuxDet) outside of the cryostat

Todo:: Change return type to size_t

Definition at line 1775 of file GeometryCore.h.

References AuxDet(), AuxDets(), ChannelsInTPCs(), ChannelToAuxDet(), ChannelToAuxDetSensitive(), FindAuxDetAtPosition(), FindAuxDetSensitiveAtPosition(), NAuxDetSensitive(), Nchannels(), PositionToAuxDet(), and PositionToAuxDetSensitive().

Referenced by AuxDet(), NAuxDetSensitive(), Print(), and larg4::LArG4::produce().

1775 { return AuxDets().size(); }

geo::GeometryCore::AuxDets

AuxDetList_t & AuxDets()

Return the internal auxdet list.

Definition: GeometryCore.h:2428

unsigned int geo::GeometryCore::NAuxDetSensitive ( size_t const & aid ) const

Returns the number of sensitive components of auxiliary detector.

Parameters

aid	ID of the auxiliary detector

Returns: number of sensitive components in the auxiliary detector aid cet::exception (category "Geometry") if aid does not exist

Definition at line 280 of file GeometryCore.cxx.

References AuxDets(), and NAuxDets().

Referenced by NAuxDets().

   {
     if (aid < NAuxDets()) { return AuxDets()[aid].NSensitiveVolume(); }
     throw cet::exception("Geometry")
       << "Requested AuxDet index " << aid << " is out of range: " << NAuxDets();
   }

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

Returns the number of TPC readout channels in the detector.

Definition at line 198 of file GeometryCore.cxx.

References fChannelMapAlg.

Referenced by larg4::LArG4Ana::beginJob(), lar_cluster3d::StandardHit3DBuilder::BuildChannelStatusVec(), lar_cluster3d::SnippetHit3DBuilder::BuildChannelStatusVec(), trkf::SeedFinderAlgorithm::CalculateGeometricalElements(), apa::APAGeometryAlg::Init(), cluster::DBScanAlg::InitScan(), NAuxDets(), hit::MCHitFinder::produce(), and detsim::SimWire::produce().

   {
     return fChannelMapAlg->Nchannels();
   }

unsigned int geo::GeometryCore::Nchannels ( readout::ROPID const & ropid ) const

Returns the number of channels in the specified ROP.

Returns: number of channels in the specified ROP, 0 if non-existent

Definition at line 204 of file GeometryCore.cxx.

References fChannelMapAlg.

   {
     return fChannelMapAlg->Nchannels(ropid);
   }

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 430 of file GeometryCore.h.

References Cryostats().

Referenced by detsim::WienerFilterAna::beginJob(), detsim::DriftElectronstoPlane::beginJob(), detsim::SimDriftElectrons::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(), detsim::WienerFilterAna::endJob(), larg4::ISTPC::extractActiveLArVolume(), larg4::OpFastScintillation::extractActiveVolumes(), GetEndID(), HasCryostat(), lar_cluster3d::SpacePointHit3DBuilder::Hit3DBuilder(), makePlaneData(), makeROPdata(), trkf::SpacePointAlg::makeSpacePoints(), makeTPCData(), makeTPCsetData(), NElements(), NOpDets(), NSiblingElements(), OpDetFromCryo(), OpDetGeoFromOpDet(), larg4::OpFastScintillation::OpFastScintillation(), phot::PDFastSimPAR::PDFastSimPAR(), Print(), larg4::LArG4::produce(), evd::TWQProjectionView::SelectTPC(), evd::TWQProjectionView::SetUpTPCselection(), cheat::BackTracker::SpacePointHitsToWeightedXYZ(), and UpdateAfterSorting().

430 { return Cryostats().size(); }

geo::GeometryCore::Cryostats

CryostatList_t & Cryostats()

Return the internal cryostat list.

Definition: GeometryCore.h:2424

raw::ChannelID_t geo::GeometryCore::NearestChannel	(	Point_t const &	worldLoc,
		PlaneID const &	planeid
	)		const

Returns the ID of the channel nearest to the specified position.

Parameters

worldLoc	3D coordinates of the point (world reference frame)
planeid	ID of the wire plane the channel must belong to

Returns: the ID of the channel, or raw::InvalidChannelID if invalid wire

Bug:: on invalid wire, a geo::InvalidWireError exception is thrown

Definition at line 1105 of file GeometryCore.cxx.

References raw::InvalidChannelID, NearestWireID(), and PlaneWireToChannel().

Referenced by larg4::LArVoxelReadout::DriftIonizationElectrons(), sim::MCRecoEdep::MakeMCEdep(), vertex::FeatureVertexFinder::produce(), detsim::SimDriftElectrons::produce(), apa::DisambigAlg::TrivialDisambig(), and Views().

   {
     // This method is supposed to return a channel number rather than
     //  a wire number.  Perform the conversion here (although, maybe
     //  faster if we deal in wire numbers rather than channel numbers?)
 
     // NOTE on failure both NearestChannel() and upstream:
     // * according to documentation, should return invalid channel
     // * in the actual code throw an exception because of a BUG
     //
     // The following implementation automatically becomes in fact compliant to
     // the documentation if upstreams becomes compliant to.
     // When that happens, just delete this comment.
     WireID const wireID = NearestWireID(worldPos, planeid);
     return wireID ? PlaneWireToChannel(wireID) : raw::InvalidChannelID;
   }

WireID geo::GeometryCore::NearestWireID	(	Point_t const &	point,
		PlaneID const &	planeid
	)		const

Returns the ID of wire closest to position in the specified TPC.

Parameters

point	the point to be tested [cm]
planeid	ID of the plane

Returns: the ID of the wire, or an invalid wire ID

See also: geo::PlaneGeo::ClosestWireID()

Bug:: Instead of returning an invalid wire ID, an exception is thrown!

If the nearest wire is not closer than half a wire pitch, the result is marked invalid. The returned (invalid) ID will contain the non-existing wire that would be the nearest, if it existed.

If the wire ID is invalid and the existing closest wire is desired, a possible solution is (when the BUG will be solved):

geo::WireID wireID = geom->NearestWireID(point, planeID);

if (!wireID) wireID = geom->Plane(planeID).ClosestWireID(wireID);

Note however that this will execute plane lookup twice, and a more efficient approach would be to ask the plane everything directly:

geo::PlaneGeo const& plane = geom->Plane(planeID);
geo::WireID wireID = plane.NearestWireID(point);
if (!wireID) wireID = plane.ClosestWireID(wireID);

Until the BUG is fixed, the actual working code is:

geo::PlaneGeo const& plane = geom->Plane(planeID);
geo::WireID wireID;
try {
  wireID = plane.NearestWireID(point);
}
catch (geo::InvalidWireError const& e) {
  if (!e.hasSuggestedWire()) throw;
  wireID = plane.ClosestWireID(e.suggestedWireID());
}

Definition at line 1099 of file GeometryCore.cxx.

References geo::PlaneGeo::NearestWireID(), and Plane().

Referenced by vertex::FeatureVertexFinderAna::analyze(), trkf::TrackAna::analyze(), evd::RecoBaseDrawer::DrawTrack2D(), evd::TWQMultiTPCProjectionView::FindEndPoint(), evd::TWQProjectionView::FindEndPoint(), hit::HitCheater::FindHitsOnChannel(), util::GeometryUtilities::Get2DPointProjection(), util::GeometryUtilities::Get2DPointProjectionCM(), opdet::GetHitGeometryInfo(), trkf::FeatureTracker::GetProjectedEnds(), nnet::TrainingDataAlg::getProjection(), hit::DisambigCheater::InitHitToWids(), apa::APAGeometryAlg::LineSegChanIntersect(), NearestChannel(), apa::APAGeometryAlg::NearestWireIDOnChan(), evd::RecoBaseDrawer::OpFlash2D(), trk::TrackContainmentAlg::ProcessTracks(), cluster::ClusterCheater::produce(), vertex::FeatureVertexFinder::produce(), shower::EMShowerAlg::Project3DPointOntoPlane_(), and evd::RecoBaseDrawer::Seed2D().

   {
     return Plane(planeid).NearestWireID(worldPos);
   }

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 431 of file GeometryCore.h.

References Ncryostats().

431 { return Ncryostats(); }

geo::GeometryCore::Ncryostats

unsigned int Ncryostats() const

Returns the number of cryostats in the detector.

Definition: GeometryCore.h:430

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 691 of file GeometryCore.h.

References NTPC().

691 { return NTPC(cryoid); }

geo::GeometryCore::NTPC

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

Returns the total number of TPCs in the specified cryostat.

Definition: GeometryCore.h:686

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

inline

Returns the largest number of planes among all TPCs in this detector.

Definition at line 982 of file GeometryCore.h.

References Nplanes().

982 { return Nplanes(tpcid); }

geo::GeometryCore::Nplanes

unsigned int Nplanes(TPCID const &tpcid=tpc_zero) const

Returns the total number of planes in the specified TPC.

Definition: GeometryCore.h:977

unsigned int geo::GeometryCore::NElements ( PlaneID const & planeid ) const

inline

Returns the total number of wires in the specified plane.

Parameters

planeid plane ID

Returns: number of wires in specified plane, or 0 if no plane 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 1156 of file GeometryCore.h.

References Nwires().

1156 { return Nwires(planeid); }

geo::GeometryCore::Nwires

unsigned int Nwires(PlaneID const &planeid) const

Returns the total number of wires in the specified plane.

Definition: GeometryCore.h:1151

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

Number of electronics channels for all the optical detectors.

Todo:: add explanation of the different IDs

Definition at line 238 of file GeometryCore.cxx.

References fChannelMapAlg, and NOpDets().

Referenced by opdet::OpHitAna::analyze(), opdet::OpFlashAna::analyze(), opdet::SimPhotonCounter::analyze(), opdet::OpDetResponseInterface::doNOpChannels(), opdet::OpDigiProperties::FillGainArray(), opdet::OpDigiProperties::FillPedMeanArray(), GetEndROPID(), opdet::OpDigiProperties::OpDigiProperties(), and opdet::OptDetDigitizer::produce().

   {
     return fChannelMapAlg->NOpChannels(this->NOpDets());
   }

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

Number of OpDets in the whole detector.

Definition at line 229 of file GeometryCore.cxx.

References Cryostat(), and Ncryostats().

Referenced by cosmic::BeamFlashTrackMatchTaggerAlg::CheckCompatibility(), phot::CreateHybridLibrary::CreateHybridLibrary(), opdet::FlashHypothesisAnaAlg::FillOpDetPositions(), larg4::OpDetLookup::FindClosestOpDet(), IsValidOpChannel(), phot::PhotonVisibilityService::LoadLibrary(), phot::PhotonMappingIdentityTransformations::makeLibraryIndicesToOpDetsMap(), phot::PhotonMappingIdentityTransformations::makeOpDetsToLibraryIndicesMap(), MaxOpChannel(), 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(), opdet::FlashHypothesisAnaAlg::SetOutputObjects(), and ThirdPlaneSlope().

   {
     int N = 0;
     for (size_t cstat = 0; cstat != Ncryostats(); ++cstat)
       N += this->Cryostat(CryostatID(cstat)).NOpDet();
     return N;
   }

unsigned int geo::GeometryCore::NOpHardwareChannels ( int opDet ) const

Number of electronics channels for all the optical detectors.

Todo:: add explanation of the different IDs

Definition at line 250 of file GeometryCore.cxx.

References fChannelMapAlg.

Referenced by GetEndROPID().

   {
     return fChannelMapAlg->NOpHardwareChannels(opDet);
   }

unsigned int geo::GeometryCore::Nplanes ( TPCID const & tpcid = tpc_zero ) const

inline

Returns the total number of planes in the specified TPC.

Parameters

tpcid TPC ID

Returns: number of planes in specified TPC, or 0 if no TPC 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 977 of file GeometryCore.h.

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

     {
       TPCGeo const* pTPC = GetElementPtr(tpcid);
       return pTPC ? pTPC->NElements() : 0;
     }

unsigned int geo::GeometryCore::NROPs ( readout::TPCsetID const & tpcsetid ) const

Returns the total number of ROP in the specified TPC set.

Parameters

tpcsetid TPC set ID

Returns: number of readout planes in the TPC set, or 0 if no TPC set found

Note that this methods explicitly check the existence of the TPC set.

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

Definition at line 1506 of file GeometryCore.cxx.

References fChannelMapAlg.

Referenced by GetEndTPCsetID(), IncrementID(), and NSiblingElements().

   {
     return fChannelMapAlg->NROPs(tpcsetid);
   }

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 432 of file GeometryCore.h.

References Ncryostats().

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

432 { return Ncryostats(); }

geo::GeometryCore::Ncryostats

unsigned int Ncryostats() const

Returns the number of cryostats in the detector.

Definition: GeometryCore.h:430

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 692 of file GeometryCore.h.

References NTPC().

692 { return NTPC(tpcid); }

geo::GeometryCore::NTPC

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

Returns the total number of TPCs in the specified cryostat.

Definition: GeometryCore.h:686

unsigned int geo::GeometryCore::NSiblingElements ( PlaneID const & planeid ) const

inline

Returns the largest number of planes among all TPCs in this detector.

Definition at line 983 of file GeometryCore.h.

References Nplanes(), and Nviews().

983 { return Nplanes(planeid); }

geo::GeometryCore::Nplanes

unsigned int Nplanes(TPCID const &tpcid=tpc_zero) const

Returns the total number of planes in the specified TPC.

Definition: GeometryCore.h:977

unsigned int geo::GeometryCore::NSiblingElements ( WireID const & wireid ) const

inline

Returns the total number of wires in the specified plane.

Parameters

planeid plane ID

Returns: number of wires in specified plane, or 0 if no plane 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 1157 of file GeometryCore.h.

References MaxWires(), and Nwires().

1157 { return Nwires(wireid); }

geo::GeometryCore::Nwires

unsigned int Nwires(PlaneID const &planeid) const

Returns the total number of wires in the specified plane.

Definition: GeometryCore.h:1151

unsigned int geo::GeometryCore::NSiblingElements ( readout::TPCsetID const & tpcsetid ) const

inline

Returns the total number of TPC sets in the specified cryostat.

Parameters

cryoid cryostat ID

Returns: number of TPC sets in the cryostat, or 0 if no cryostat found

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

Definition at line 1996 of file GeometryCore.h.

References MaxTPCsets(), and NTPCsets().

     {
       return NTPCsets(tpcsetid);
     }

unsigned int geo::GeometryCore::NSiblingElements ( readout::ROPID const & ropid ) const

inline

Returns the total number of ROP in the specified TPC set.

Parameters

tpcsetid TPC set ID

Returns: number of readout planes in the TPC set, or 0 if no TPC set found

Note that this methods explicitly check the existence of the TPC set.

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

Definition at line 2136 of file GeometryCore.h.

References MaxROPs(), and NROPs().

2136 { return NROPs(ropid); }

geo::GeometryCore::NROPs

unsigned int NROPs(readout::TPCsetID const &tpcsetid) const

Returns the total number of ROP in the specified TPC set.

Definition: GeometryCore.cxx:1506

unsigned int geo::GeometryCore::NTPC ( CryostatID const & cryoid = 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 686 of file GeometryCore.h.

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

Referenced by detsim::WienerFilterAna::beginJob(), detsim::DriftElectronstoPlane::beginJob(), detsim::SimDriftElectrons::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(), IncrementID(), apa::APAGeometryAlg::Init(), 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::NTPCsets ( geo::CryostatID const & cryoid ) const

Returns the total number of TPC sets in the specified cryostat.

Parameters

cryoid cryostat ID

Returns: number of TPC sets in the cryostat, or 0 if no cryostat found

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

Definition at line 1467 of file GeometryCore.cxx.

References fChannelMapAlg.

Referenced by IncrementID(), NSiblingElements(), and Views().

   {
     return fChannelMapAlg->NTPCsets(cryoid);
   }

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

Returns the number of views (different wire orientations)

Returns the number of different views, or wire orientations, in the detector.

The function assumes that all TPCs in all cryostats of a detector have the same number of planes, which should be a safe assumption.

Todo:: Change return type to size_t

Definition at line 289 of file GeometryCore.cxx.

References MaxPlanes().

Referenced by evd_tool::MicroBooNEDrawer::DrawBadChannels(), evd_tool::ICARUSDrawer::DrawBadChannels(), and NSiblingElements().

   {
     return MaxPlanes();
   }

unsigned int geo::GeometryCore::Nwires ( PlaneID const & planeid ) const

inline

Returns the total number of wires in the specified plane.

Parameters

planeid plane ID

Returns: number of wires in specified plane, or 0 if no plane 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 1151 of file GeometryCore.h.

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

Referenced by lar_cluster3d::StandardHit3DBuilder::BuildChannelStatusVec(), lar_cluster3d::SnippetHit3DBuilder::BuildChannelStatusVec(), lar_pandora::LArPandoraInput::CreatePandoraReadoutGaps(), noisefilteralg::WireCellNoiseFilter::DoNoiseFilter(), evd_tool::MicroBooNEDrawer::DrawBadChannels(), evd_tool::ICARUSDrawer::DrawBadChannels(), sppt::SpacePointAlg_TimeSort::fillCoordinatesArrays(), trkf::CCTrackMaker::FillWireHitRange(), tca::FillWireHitRange(), vertex::FeatureVertexFinder::Find2dClusterVertexCandidates(), evd::RawDataDrawer::RoIextractorClass::Finish(), evd::RawDataDrawer::GetRegionOfInterest(), evd::RecoBaseDrawer::GetRegionOfInterest(), util::GeometryUtilities::GetYZ(), cluster::MergeClusterAlg::GlobalWire(), cluster::BlurredClusteringAlg::GlobalWire(), shower::EMShowerAlg::GlobalWire_(), corner::CornerFinderAlg::GrabWires(), IncrementID(), corner::CornerFinderAlg::InitializeGeometry(), lar_cluster3d::StandardHit3DBuilder::NearestWireID(), lar_cluster3d::SnippetHit3DBuilder::NearestWireID(), NElements(), NSiblingElements(), util::GeometryUtilities::SelectPolygonHitList(), evd::TWQProjectionView::SetWire(), img::DataProviderAlg::setWireDriftData(), cluster::HoughBaseAlg::Transform(), evd::TWireProjPad::TWireProjPad(), evd::TWQMultiTPCProjectionView::TWQMultiTPCProjectionView(), evd::TWQProjectionView::TWQProjectionView(), evd::RecoBaseDrawer::Wire2D(), WireIDIntersectionCheck(), evd::TWQMultiTPCProjectionView::ZoomInterest(), and evd::TWQProjectionView::ZoomInterest().

     {
       PlaneGeo const* pPlane = GetElementPtr(planeid);
       return pPlane ? pPlane->NElements() : 0;
     }

unsigned int geo::GeometryCore::OpChannel	(	int	detNum,
		int	hardwareChannel
	)		const

Convert detector number and hardware channel to unique channel.

Definition at line 256 of file GeometryCore.cxx.

References fChannelMapAlg.

Referenced by GetEndROPID(), and ThirdPlaneSlope().

   {
     return fChannelMapAlg->OpChannel(detNum, hardwareChannel);
   }

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

Get unique opdet number from cryo and internal count.

Definition at line 1569 of file GeometryCore.cxx.

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

Referenced by GetClosestOpDet(), and GetEndROPID().

   {
     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";
   }

unsigned int geo::GeometryCore::OpDetFromOpChannel ( int opChannel ) const

Convert unique channel to detector number.

Definition at line 262 of file GeometryCore.cxx.

References fChannelMapAlg.

Referenced by cheat::PhotonBackTracker::ChannelToTrackSDPs(), cosmic::BeamFlashTrackMatchTaggerAlg::CheckCompatibility(), opdet::OpDetResponseInterface::doReadoutToGeoChannel(), GetEndROPID(), OpDetGeoFromOpChannel(), cheat::PhotonBackTracker::OpHitToSDPs(), cheat::PhotonBackTracker::OpHitToSimSDPs_Ps(), cheat::PhotonBackTracker::OpHitToTrackSDPs(), cosmic::BeamFlashTrackMatchTaggerAlg::PrintHypothesisFlashComparison(), and cheat::PhotonBackTracker::TrackIdsToOpHits_Ps().

   {
     return fChannelMapAlg->OpDetFromOpChannel(opChannel);
   }

const OpDetGeo & geo::GeometryCore::OpDetGeoFromOpChannel ( unsigned int OpChannel ) const

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

Parameters

OpChannel optical detector unique channel number

See also: GeometryCoreOpDetGeometry "optical detector identification"

Definition at line 1597 of file GeometryCore.cxx.

References OpDetFromOpChannel(), and OpDetGeoFromOpDet().

Referenced by evdb_tool::OpHit3DDrawer::Draw(), evdb_tool::DrawSimPhoton3D::Draw(), evdb_tool::OpFlash3DDrawer::Draw(), opdet::GetHitGeometryInfo(), and ThirdPlaneSlope().

   {
     return this->OpDetGeoFromOpDet(this->OpDetFromOpChannel(OpChannel));
   }

const OpDetGeo & 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 1603 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(), phot::PropagationTimeModel::opDetCenters(), phot::PDFastSimPAR::opDetCenters(), OpDetGeoFromOpChannel(), phot::PropagationTimeModel::opDetOrientations(), larg4::OpFastScintillation::OpFastScintillation(), phot::SemiAnalyticalModel::opticalDetectors(), phot::PhotonVisibilityService::SolidAngleFactorImpl(), and ThirdPlaneSlope().

   {
     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 this->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 = cryostat_zero ) const

Returns gdml string which gives sensitive opdet name.

Parameters

c	ID of the cryostat the detector is in

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

Todo:: Change to use CryostatID

Definition at line 1562 of file GeometryCore.cxx.

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

Referenced by larg4::LArG4::beginJob(), and ThirdPlaneSlope().

   {
     return Cryostat(cid).OpDetGeoName();
   }

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

delete

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

delete

PlaneGeo const& geo::GeometryCore::Plane ( PlaneID const & planeid ) const

inline

Returns the specified wire.

Parameters

planeid	ID of the plane
p	plane number within the TPC
tpc	TPC number within the cryostat
cstat	number of cryostat

Returns: a constant reference to the specified plane

Exceptions

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

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

Definition at line 1034 of file GeometryCore.h.

References geo::TPCGeo::Plane(), and TPC().

1034 { return TPC(planeid).Plane(planeid); }

geo::GeometryCore::TPC

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

Returns the specified TPC.

Definition: GeometryCore.h:722

geo::TPCGeo::Plane

PlaneGeo const & Plane(geo::View_t view) const

Return the plane in the tpc with View_t view.

Definition: TPCGeo.cxx:252

double geo::GeometryCore::PlanePitch	(	TPCID const &	tpcid,
		PlaneID::PlaneID_t	p1 = `0`,
		PlaneID::PlaneID_t	p2 = `1`
	)		const

Returns the distance between two planes.

Parameters

p1	index of the first plane
p2	index of the second plane
tpc	tpc number within the cryostat
cstat	cryostat number

Returns: distance between the planes

Todo:

add a version with plane IDs

deprecate this function

add a default version for a given TPCID

add a version with two plane indices for a given TPCID

return the absolute value of the distance (makes the order unimportant)

document what will happen (in the future methods) with planes on different TPCs

Definition at line 749 of file GeometryCore.cxx.

References geo::TPCGeo::PlanePitch(), and TPC().

Referenced by GetBeginPlaneID(), PlanePitch(), trkf::SpacePts::produce(), and trkf::Track3Dreco::produce().

   {
     return TPC(tpcid).PlanePitch(p1, p2);
   }

double geo::GeometryCore::PlanePitch	(	PlaneID const &	pid1,
		PlaneID const &	pid2
	)		const

Returns the distance between two planes.

Parameters

p1	index of the first plane
p2	index of the second plane
tpc	tpc number within the cryostat
cstat	cryostat number

Returns: distance between the planes

Todo:

add a version with plane IDs

deprecate this function

add a default version for a given TPCID

add a version with two plane indices for a given TPCID

return the absolute value of the distance (makes the order unimportant)

document what will happen (in the future methods) with planes on different TPCs

Definition at line 756 of file GeometryCore.cxx.

References geo::TPCID::asTPCID(), geo::PlaneID::Plane, and PlanePitch().

   {
     return PlanePitch(pid1.asTPCID(), pid1.Plane, pid2.Plane);
   }

PlaneGeo const* geo::GeometryCore::PlanePtr ( PlaneID const & planeid ) const

inline

Returns the specified plane.

Parameters

planeid plane ID

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

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

Definition at line 1047 of file GeometryCore.h.

References geo::TPCGeo::PlanePtr(), and TPCPtr().

Referenced by GetElementPtr(), GetEndWireID(), HasWire(), and WirePtr().

     {
       TPCGeo const* pTPC = TPCPtr(planeid);
       return pTPC ? pTPC->PlanePtr(planeid) : nullptr;
     }

raw::ChannelID_t geo::GeometryCore::PlaneWireToChannel ( WireID const & wireid ) const

Returns the ID of the TPC channel connected to the specified wire.

Parameters

plane	the number of plane
wire	the number of wire
tpc	the number of TPC
cryostat	the number of cryostat
wireid	the ID of the wire

Returns: the ID of the channel, or raw::InvalidChannelID if invalid wire

Todo:: Verify the raw::InvalidChannelID part

Definition at line 1124 of file GeometryCore.cxx.

References fChannelMapAlg.

Referenced by hit::MCHitAnaExample::analyze(), cluster::BlurredClusteringAlg::ConvertRecobHitsToVector(), lar_pandora::LArPandoraInput::CreatePandoraReadoutGaps(), evd::TQPad::Draw(), evd_tool::MicroBooNEDrawer::DrawBadChannels(), evd_tool::ICARUSDrawer::DrawBadChannels(), evd::RawDataDrawer::FillTQHisto(), tca::FillWireHitRange(), vertex::FeatureVertexFinder::Find3dVtxFrom2dClusterVtxCand(), evd::TWQMultiTPCProjectionView::FindEndPoint(), evd::TWQMultiTPCProjectionView::FindLineLength(), vertex::FeatureVertexFinder::Get3dVertexCandidates(), tca::GetOrigin(), util::GeometryUtilities::GetProjectedPoint(), util::GeometryUtilities::GetYZ(), cluster::DBScan3DAlg::init(), apa::DisambigAlg::MakeCloseHits(), tca::NearbySrcHit(), NearestChannel(), vertex::VertexFinder2D::produce(), calo::Calorimetry::produce(), lariov::SIOVElectronicsCalibProvider::Reconfigure(), lariov::DetPedestalRetrievalAlg::Reconfigure(), pma::ProjectionMatchingAlg::validate(), pma::ProjectionMatchingAlg::validate_on_adc(), pma::ProjectionMatchingAlg::validate_on_adc_test(), Views(), and evd::RecoBaseDrawer::Wire2D().

   {
     return fChannelMapAlg->PlaneWireToChannel(wireid);
   }

const AuxDetGeo & geo::GeometryCore::PositionToAuxDet	(	Point_t const &	point,
		unsigned int &	ad,
		double	tolerance = `0`
	)		const

Returns the auxiliary detector at specified location.

Parameters

point	location to be tested
ad	_(output)_ the auxiliary detector index
tolerance	tolerance (cm) for matches. Default 0.

Returns: constant reference to AuxDetGeo object of the auxiliary detector

Todo:: what happens if it does not exist?

Definition at line 416 of file GeometryCore.cxx.

References AuxDet(), and FindAuxDetAtPosition().

Referenced by larg4::AuxDetReadoutGeometry::FindAndMakeAuxDet(), and NAuxDets().

   {
     // locate the desired Auxiliary Detector
     ad = FindAuxDetAtPosition(point, tolerance);
     return AuxDet(ad);
   }

const AuxDetSensitiveGeo & geo::GeometryCore::PositionToAuxDetSensitive	(	Point_t const &	point,
		size_t &	ad,
		size_t &	sv,
		double	tolerance = `0`
	)		const

Returns the auxiliary detector at specified location.

Parameters

point	location to be tested
ad	_(output)_ the auxiliary detector index
sv	_(output)_ the auxiliary detector sensitive volume index
tolerance	tolerance (cm) for matches. Default 0.

Returns: reference to AuxDetSensitiveGeo object of the auxiliary detector

Todo:: what happens if it does not exist?

Definition at line 436 of file GeometryCore.cxx.

References AuxDet(), FindAuxDetSensitiveAtPosition(), and geo::AuxDetGeo::SensitiveVolume().

Referenced by NAuxDets().

   {
     // locate the desired Auxiliary Detector
     FindAuxDetSensitiveAtPosition(point, ad, sv, tolerance);
     return AuxDet(ad).SensitiveVolume(sv);
   }

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 403 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 352 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 343 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 366 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 373 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 359 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 2677 of file GeometryCore.h.

References AuxDet(), DetectorEnclosureBox(), DetectorName(), geo::PlaneGeo::ID(), art::detail::indent(), geo::AuxDetSensitiveGeo::MaxVerbosity, geo::AuxDetGeo::MaxVerbosity, geo::OpDetGeo::MaxVerbosity, geo::WireGeo::MaxVerbosity, geo::TPCGeo::MaxVerbosity, geo::PlaneGeo::MaxVerbosity, NAuxDets(), Ncryostats(), geo::TPCGeo::Nplanes(), geo::AuxDetGeo::NSensitiveVolume(), geo::PlaneGeo::Nwires(), geo::TPCGeo::Plane(), geo::AuxDetSensitiveGeo::PrintAuxDetInfo(), geo::AuxDetGeo::PrintAuxDetInfo(), geo::OpDetGeo::PrintOpDetInfo(), geo::PlaneGeo::PrintPlaneInfo(), geo::TPCGeo::PrintTPCInfo(), geo::WireGeo::PrintWireInfo(), geo::AuxDetGeo::SensitiveVolume(), SignalType(), geo::SignalTypeName(), w, and geo::PlaneGeo::Wire().

Referenced by geo::DumpGeometry::dumpGeometryCore(), Info(), and SurfaceY().

 {
 
   out << "Detector " << DetectorName() << " has " << Ncryostats() << " cryostats and " << NAuxDets()
       << " auxiliary detectors:";
 
   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);
 
     const unsigned int nTPCs = cryostat.NTPC();
     for (unsigned int t = 0; t < nTPCs; ++t) {
       const TPCGeo& tpc = cryostat.TPC(t);
 
       out << "\n" << indent << "  ";
       tpc.PrintTPCInfo(std::forward<Stream>(out), indent + "    ", tpc.MaxVerbosity);
 
       const unsigned int nPlanes = tpc.Nplanes();
       for (unsigned int p = 0; p < nPlanes; ++p) {
         const PlaneGeo& plane = tpc.Plane(p);
         const unsigned int nWires = plane.Nwires();
 
         out << "\n" << indent << "    ";
         plane.PrintPlaneInfo(std::forward<Stream>(out), indent + "      ", plane.MaxVerbosity);
         SigType_t const sigType = SignalType(plane.ID());
         out << "\n"
             << indent << "      "
             << "signal type: " << SignalTypeName(sigType) << " (" << static_cast<int>(sigType)
             << ")";
 
         for (unsigned int w = 0; w < nWires; ++w) {
           const WireGeo& wire = plane.Wire(w);
           WireID wireID(plane.ID(), w);
 
           // the wire should be aligned on z axis, half on each side of 0,
           // in its local frame
           out << "\n" << indent << "      " << wireID << " ";
           wire.PrintWireInfo(std::forward<Stream>(out), indent + "      ", wire.MaxVerbosity);
         } // for wire
       }   // for plane
     }     // 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
 
   unsigned int const nAuxDets = NAuxDets();
   for (unsigned int iDet = 0; iDet < nAuxDets; ++iDet) {
     AuxDetGeo const& auxDet = AuxDet(iDet);
 
     out << "\n" << indent << "[#" << iDet << "] ";
     auxDet.PrintAuxDetInfo(std::forward<Stream>(out), indent + "  ", auxDet.MaxVerbosity);
 
     unsigned int const nSensitive = auxDet.NSensitiveVolume();
     switch (nSensitive) {
     case 0: break;
     case 1: {
       AuxDetSensitiveGeo const& auxDetS = auxDet.SensitiveVolume(0U);
       out << "\n" << indent << "  ";
       auxDetS.PrintAuxDetInfo(std::forward<Stream>(out), indent + "    ", auxDetS.MaxVerbosity);
       break;
     }
     default:
       for (unsigned int iSens = 0; iSens < nSensitive; ++iSens) {
         out << "\n" << indent << "[#" << iSens << "] ";
         AuxDetSensitiveGeo const& auxDetS = auxDet.SensitiveVolume(iSens);
         auxDetS.PrintAuxDetInfo(std::forward<Stream>(out), indent + "    ", auxDetS.MaxVerbosity);
       } // for
       break;
     } // if sensitive detectors
 
   } // for auxiliary detector
 
   out << '\n';
 
 } // geo::GeometryCore::Print()

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

inline

Returns the full directory path to the geometry file source.

Returns: the full directory path to the geometry file source

This is the full path of the source of the detector geometry GeometryCore relies on.

Definition at line 184 of file GeometryCore.h.

References fROOTfile.

Referenced by geo::DumpGeometry::dumpGeometryCore(), and evgen::GENIEGen::GENIEGen().

184 { return fROOTfile; }

geo::GeometryCore::fROOTfile

std::string fROOTfile

path to geometry file for geometry in GeometryCore

Definition: GeometryCore.h:2436

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

Access to the ROOT geometry description manager.

Definition at line 192 of file GeometryCore.cxx.

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

   {
     return gGeoManager;
   }

std::vector< TPCID > geo::GeometryCore::ROPtoTPCs ( readout::ROPID const & ropid ) const

Returns a list of ID of TPCs the specified ROP spans.

Parameters

ropid ID of the readout plane

Returns: the list of TPC IDs, empty if readout plane ID is invalid

Note that this check is performed on the validity of the readout plane ID, that does not necessarily imply that the readout plane specified by the ID actually exists. Check if the ROP exists with HasROP(). The behaviour on non-existing readout planes is undefined.

Definition at line 1536 of file GeometryCore.cxx.

References fChannelMapAlg.

Referenced by reco3d::TripletFinder::FillBadMap(), reco3d::TripletFinder::FillHitMap(), and HasElement().

   {
     return fChannelMapAlg->ROPtoTPCs(ropid);
   }

std::vector< PlaneID > geo::GeometryCore::ROPtoWirePlanes ( readout::ROPID const & ropid ) const

Returns a list of ID of planes belonging to the specified ROP.

Parameters

ropid ID of the readout plane

Returns: list of ID of wire planes belonging to the specified ROP

If ropid is an invalid ID, an empty list is returned. If ropid is a valid ID (i.e. an ID whose isValid flag is set) that points to a non-existent readout plane, the result is undefined. Use HasROP() to check if the readout plane actually exists.

Definition at line 1530 of file GeometryCore.cxx.

References fChannelMapAlg.

Referenced by HasElement().

   {
     return fChannelMapAlg->ROPtoWirePlanes(ropid);
   }

SigType_t geo::GeometryCore::SignalType ( PlaneID const & pid ) const

Returns the type of signal on the channels of specified TPC plane.

Parameters

plane TPC plane ID

Returns: the type of signal on the specified plane, or geo::kMysteryType

Assumes that all the channels on the plane have the same signal type.

Todo:: verify that kMysteryType is returned on invalid plane

Definition at line 469 of file GeometryCore.cxx.

References WirePlaneToROP().

Referenced by caldata::CalWireAna::analyze(), lar::example::AnalysisExample::analyze(), evdb_tool::DrawWireHist::BookHistogram(), evdb_tool::DrawRawHist::BookHistogram(), cluster::HoughBaseAlg::FastTransform(), reco3d::TripletFinder::FillHitMap(), hit::HitCheater::FindHitsOnChannel(), GetBeginPlaneID(), GetEndROPID(), cluster::MergeClusterAlg::GlobalWire(), cluster::BlurredClusteringAlg::GlobalWire(), shower::EMShowerAlg::GlobalWire_(), cluster::HoughBaseAlg::HoughBaseAlg(), shwf::ShowerReco::LongTransEnergy(), trkf::SpacePointAlg::makeSpacePoints(), Print(), evd::TWQMultiTPCProjectionView::PrintCharge(), evd::TWQProjectionView::PrintCharge(), hit::TTHitFinder::produce(), hit::RawHitFinder::produce(), hit::FFTHitFinder::produce(), cluster::DBcluster::produce(), caldata::CalWire::produce(), reco3d::SpacePointSolver::produce(), trkf::SpacePts::produce(), detsim::SimWire::produce(), evd::RawDataDrawer::QueueDrawingBoxes(), lariov::DetPedestalRetrievalAlg::Reconfigure(), hit::RFFHitFinderAlg::Run(), evd::TWireProjPad::TWireProjPad(), trkf::SpacePointAlg::update(), Views(), and evd::RecoBaseDrawer::Wire2D().

   {
     // map wire plane -> readout plane -> first channel,
     // then use SignalType(channel)
 
     auto const ropid = WirePlaneToROP(pid);
     if (!ropid.isValid) {
       throw cet::exception("GeometryCore") << "SignalType(): Mapping of wire plane "
                                            << std::string(pid) << " to readout plane failed!\n";
     }
     return SignalType(ropid);
   }

SigType_t geo::GeometryCore::SignalType ( raw::ChannelID_t const channel ) const

Returns the type of signal on the specified TPC channel.

Parameters

channel TPC channel ID

Returns: the type of signal on the specified channel, or geo::kMysteryType

Todo:: verify that kMysteryType is returned on invalid channel

Definition at line 463 of file GeometryCore.cxx.

References fChannelMapAlg.

   {
     return fChannelMapAlg->SignalTypeForChannel(channel);
   }

SigType_t geo::GeometryCore::SignalType ( readout::ROPID const & ropid ) const

Returns the type of signal of channels in specified readout plane.

Parameters

ropid readout plane ID

Returns: the type of signal on the specified ROP

Assumes that all the channels on the readout plane have the same signal type. If ropid is an invalid ID, geo::kMysteryType is returned. If ropid is a valid ID (i.e. an ID whose isValid flag is set) that points to a non-existent readout plane, the result is undefined. Use HasROP() to check if the readout plane actually exists.

Definition at line 1554 of file GeometryCore.cxx.

References fChannelMapAlg.

   {
     return fChannelMapAlg->SignalTypeForROPID(ropid);
   }

void geo::GeometryCore::SortGeometry ( GeoObjectSorter const & sorter )

private

Runs the sorting of geometry with the sorter provided by channel mapping.

Definition at line 163 of file GeometryCore.cxx.

References AuxDets(), Cryostats(), geo::GeoObjectSorter::SortAuxDets(), and geo::GeoObjectSorter::SortCryostats().

Referenced by ApplyChannelMap().

   {
     mf::LogInfo("GeometryCore") << "Sorting volumes...";
 
     sorter.SortAuxDets(AuxDets());
     sorter.SortCryostats(Cryostats());
 
     CryostatID::CryostatID_t c = 0;
     for (CryostatGeo& cryo : Cryostats()) {
       cryo.SortSubVolumes(sorter);
       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 centimetres, 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 251 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().

251 { return fSurfaceY; }

geo::GeometryCore::fSurfaceY

double fSurfaceY

The point where air meets earth for this detector.

Definition: GeometryCore.h:2433

PlaneID geo::GeometryCore::ThirdPlane	(	PlaneID const &	pid1,
		PlaneID const &	pid2
	)		const

Returns the plane that is not in the specified arguments.

Parameters

pid1	a plane
pid2	another plane

Returns: the ID to the third plane

Exceptions

cet::exception	(category: "GeometryCore") if other than 3 planes
cet::exception	(category: "GeometryCore") if pid1 and pid2 match

This function requires a geometry with exactly three planes. If the two input planes are not on the same TPC, the result is undefined.

Definition at line 1292 of file GeometryCore.cxx.

References Nplanes(), and geo::PlaneID::Plane.

Referenced by ThirdPlane_dTdW(), and ThirdPlaneSlope().

   {
     // how many planes in the TPC pid1 belongs to:
     const unsigned int nPlanes = Nplanes(pid1);
     if (nPlanes != 3) {
       throw cet::exception("GeometryCore")
         << "ThirdPlane() supports only TPCs with 3 planes, and I see " << nPlanes << " instead\n";
     }
 
     PlaneID::PlaneID_t target_plane = nPlanes;
     for (PlaneID::PlaneID_t iPlane = 0; iPlane < nPlanes; ++iPlane) {
       if ((iPlane == pid1.Plane) || (iPlane == pid2.Plane)) continue;
       if (target_plane != nPlanes) {
         throw cet::exception("GeometryCore")
           << "ThirdPlane() found too many planes that are not " << std::string(pid1) << " nor "
           << std::string(pid2) << "! (first " << target_plane << ", then " << iPlane << ")\n";
       } // if we had a target already
       target_plane = iPlane;
     } // for
     if (target_plane == nPlanes) {
       throw cet::exception("GeometryCore")
         << "ThirdPlane() can't find a plane that is not " << std::string(pid1) << " nor "
         << std::string(pid2) << "!\n";
     }
 
     return PlaneID(pid1, target_plane);
   }

double geo::GeometryCore::ThirdPlane_dTdW	(	PlaneID const &	pid1,
		double	slope1,
		PlaneID const &	pid2,
		double	slope2,
		PlaneID const &	output_plane
	)		const

Returns dT/dW on the third plane, given it in the other two.

Parameters

pid1	ID of the plane of the first dT/dW
dTdW1	dT/dW as seen on the first plane
pid2	ID of the plane of the second dT/dW
dTdW2	dT/dW as seen on the second plane
output_plane	ID of the plane on which to calculate the slope

Returns: dT/dW on the third plane, or -999. if dT/dW would be infinity

Exceptions

cet::exception	(category: "GeometryCore") if different TPC
cet::exception	(category: "GeometryCore") if same plane
cet::exception	(category: "GeometryCore") if other than 3 planes

Given a dT/dW as projected in two planes, returns the dT/dW as projected in the third plane. The dT/dW are defined in time ticks/wide number units.

Definition at line 1352 of file GeometryCore.cxx.

References ComputeThirdPlane_dTdW(), geo::PlaneGeo::PhiZ(), geo::TPCGeo::Plane(), TPC(), and geo::PlaneGeo::WirePitch().

Referenced by ThirdPlane_dTdW(), and ThirdPlaneSlope().

   {
     CheckIndependentPlanesOnSameTPC(pid1, pid2, "ThirdPlane_dTdW()");
 
     TPCGeo const& TPC = this->TPC(pid1);
 
     double angle[3], pitch[3];
     PlaneGeo const* const planes[3] = {
       &TPC.Plane(pid1), &TPC.Plane(pid2), &TPC.Plane(output_plane)};
 
     // We need wire pitch and "wire coordinate direction" for each plane.
     // The latter is perpendicular to the wire orientation.
     // PlaneGeo::PhiZ() defines the right orientation too.
     for (size_t i = 0; i < 3; ++i) {
       angle[i] = planes[i]->PhiZ();
       pitch[i] = planes[i]->WirePitch();
     }
 
     return ComputeThirdPlane_dTdW(
       angle[0], pitch[0], slope1, angle[1], pitch[1], slope2, angle[2], pitch[2]);
   }

double geo::GeometryCore::ThirdPlane_dTdW	(	PlaneID const &	pid1,
		double	slope1,
		PlaneID const &	pid2,
		double	slope2
	)		const

Returns dT/dW on the third plane, given it in the other two.

Parameters

pid1	ID of the plane of the first dT/dW
dTdW1	dT/dW as seen on the first plane
pid2	ID of the plane of the second dT/dW
dTdW2	dT/dW as seen on the second plane

Returns: dT/dW on the third plane, or -999. if dT/dW would be infinity

Exceptions

cet::exception	(category: "GeometryCore") if different TPC
cet::exception	(category: "GeometryCore") if same plane
cet::exception	(category: "GeometryCore") if other than 3 planes

Given a dT/dW as projected in two planes, returns the dT/dW as projected in the third plane. This function is a shortcut assuming exactly three wire planes in the TPC, in which case the output plane is chosen as the one that is neither of the input planes.

Definition at line 1379 of file GeometryCore.cxx.

References ThirdPlane(), and ThirdPlane_dTdW().

   {
     PlaneID target_plane = ThirdPlane(pid1, pid2);
     return ThirdPlane_dTdW(pid1, slope1, pid2, slope2, target_plane);
   }

double geo::GeometryCore::ThirdPlaneSlope	(	PlaneID const &	pid1,
		double	slope1,
		PlaneID const &	pid2,
		double	slope2,
		PlaneID const &	output_plane
	)		const

Returns the slope on the third plane, given it in the other two.

Parameters

pid1	ID of the plane of the first slope
slope1	slope as seen on the first plane
pid2	ID of the plane of the second slope
slope2	slope as seen on the second plane
output_plane	ID of the plane on which to calculate the slope

Returns: the slope on the third plane, or -999. if slope would be infinity

Exceptions

cet::exception	(category: "GeometryCore") if different TPC
cet::exception	(category: "GeometryCore") if input planes match

Given a slope as projected in two planes, returns the slope as projected in the specified output plane. The slopes are defined in uniform units; they should be computed as distance ratios (or tangent of a geometrical angle; the formula is still valid using dt/dw directly in case of equal wire pitch in all planes and uniform drift velocity.

Definition at line 1321 of file GeometryCore.cxx.

References ComputeThirdPlaneSlope(), geo::PlaneGeo::PhiZ(), geo::TPCGeo::Plane(), and TPC().

Referenced by trkf::CCTrackMaker::FillEndMatch(), trkf::CCTrackMaker::PlnMatch(), and ThirdPlaneSlope().

   {
     CheckIndependentPlanesOnSameTPC(pid1, pid2, "ThirdPlaneSlope()");
 
     TPCGeo const& TPC = this->TPC(pid1);
 
     // We need the "wire coordinate direction" for each plane.
     // This is perpendicular to the wire orientation.
     // PlaneGeo::PhiZ() defines the right orientation too.
     return ComputeThirdPlaneSlope(TPC.Plane(pid1).PhiZ(),
                                   slope1,
                                   TPC.Plane(pid2).PhiZ(),
                                   slope2,
                                   TPC.Plane(output_plane).PhiZ());
   }

double geo::GeometryCore::ThirdPlaneSlope	(	PlaneID const &	pid1,
		double	slope1,
		PlaneID const &	pid2,
		double	slope2
	)		const

Returns the slope on the third plane, given it in the other two.

Parameters

pid1	ID of the plane of the first slope
slope1	slope as seen on the first plane
pid2	ID of the plane of the second slope
slope2	slope as seen on the second plane

Returns: the slope on the third plane, or -999. if slope would be infinity

Exceptions

cet::exception	(category: "GeometryCore") if different TPC
cet::exception	(category: "GeometryCore") if same plane
cet::exception	(category: "GeometryCore") if other than 3 planes

Given a slope as projected in two planes, returns the slope as projected in the third plane. This function is a shortcut assuming exactly three wire planes in the TPC, in which case the output plane is chosen as the one that is neither of the input planes.

Definition at line 1342 of file GeometryCore.cxx.

References ThirdPlane(), and ThirdPlaneSlope().

   {
     PlaneID target_plane = ThirdPlane(pid1, pid2);
     return ThirdPlaneSlope(pid1, slope1, pid2, slope2, target_plane);
   }

double geo::GeometryCore::ThirdPlaneSlope	(	PlaneID::PlaneID_t	plane1,
		double	slope1,
		PlaneID::PlaneID_t	plane2,
		double	slope2,
		TPCID const &	tpcid
	)		const

inline

Returns the slope on the third plane, given it in the other two.

Parameters

plane1	index of the plane of the first slope
slope1	slope as seen on the first plane
plane2	index of the plane of the second slope
slope2	slope as seen on the second plane
tpcid	TPC where the two planes belong

Returns: the slope on the third plane, or -999. if slope would be infinity

Exceptions

cet::exception	(category: "GeometryCore") if different TPC
cet::exception	(category: "GeometryCore") if same plane
cet::exception	(category: "GeometryCore") if other than 3 planes

Given a slope as projected in two planes, returns the slope as projected in the third plane.

Definition at line 1586 of file GeometryCore.h.

References ComputeThirdPlane_dTdW(), ComputeThirdPlaneSlope(), cryostat_zero, GetClosestOpDet(), NOpDets(), OpChannel(), OpDetGeoFromOpChannel(), OpDetGeoFromOpDet(), OpDetGeoName(), ThirdPlane_dTdW(), and ThirdPlaneSlope().

     {
       return ThirdPlaneSlope(PlaneID(tpcid, plane1), slope1, PlaneID(tpcid, plane2), slope2);
     }

double geo::GeometryCore::TotalMass ( ) const

inline

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

Definition at line 319 of file GeometryCore.h.

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

319 { return TotalMass(GetWorldVolumeName()); }

geo::GeometryCore::GetWorldVolumeName

const std::string GetWorldVolumeName() const

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

Definition: GeometryCore.cxx:501

geo::GeometryCore::TotalMass

double TotalMass() const

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

Definition: GeometryCore.h:319

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

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

Definition at line 1021 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 807 of file GeometryCore.cxx.

References begin(), Cryostats(), end(), geo::CryostatGeo::NTPC(), and sum.

Referenced by Iterate().

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

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

inline

Returns the specified TPC.

Parameters

tpcid	ID of the tpc
tpc	tpc number within the cryostat
cstat	number of cryostat

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 722 of file GeometryCore.h.

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

Referenced by hit::MagDriftAna::analyze(), larg4::ISCalcCorrelated::AngleToEFieldAtStep(), pma::ProjectionMatchingAlg::buildShowerSeg(), phot::PropagationTimeModel::cathodeCentre(), pma::VtxCandidate::ComputeMse2D(), DetHalfHeight(), DetHalfWidth(), DetLength(), hit::DisambigCheater::DisambigCheater(), larg4::LArVoxelReadout::DriftIonizationElectrons(), larg4::ISCalcCorrelated::EFieldAtStep(), larg::LArSimChannelAna::ensureHists(), hit::MagDriftAna::ensureHists(), trkf::SpacePointAlg::fillComplexSpacePoint(), tca::FillWireHitRange(), tca::FindShowers3D(), lar_pandora::detector_functions::GetDetectorType(), GetElement(), GetEndPlaneID(), GetEndWireID(), GetLArTPCVolumeName(), trkf::FeatureTracker::GetProjectedEnds(), nnet::TrainingDataAlg::getProjection(), GetTPCFrontFaceCenter(), lar_pandora::LArPandoraInput::GetTrueX0(), pma::ProjectionMatchingAlg::guideEndpoints(), IncrementID(), pma::Track3D::InitFromMiddle(), trkf::SpacePointAlg::makeSpacePoints(), pma::PMAlgTracker::matchCluster(), larg4::OpFastScintillation::OpFastScintillation(), Plane(), PlanePitch(), trkf::PMAlgTrajFitter::produce(), detsim::DriftElectronstoPlane::produce(), detsim::SimDriftElectrons::produce(), trkf::PMAlgTrackMaker::produce(), evgen::ActiveVolumeVertexSampler::sample_vertex_pos(), tca::SaveCRInfo(), phot::SemiAnalyticalModel::SemiAnalyticalModel(), lar_pandora::LArPandoraGeometry::ShouldSwitchUV(), trkf::CCTrackMaker::TagCosmics(), lar_pandora::VintageLArTPCThreeView::TargetViewU(), lar_pandora::VintageLArTPCThreeView::TargetViewV(), ThirdPlane_dTdW(), ThirdPlaneSlope(), apa::APAGeometryAlg::ThreeChanPos(), calo::GnocchiCalorimetry::TrajectoryToWirePosition(), apa::DisambigAlg::TrivialDisambig(), DUNE::NeutrinoTrackingEff::truthLength(), trkf::SpacePointAlg::update(), apa::DisambigAlg::UseEndPts(), pma::ProjectionMatchingAlg::validate(), pma::ProjectionMatchingAlg::validate_on_adc_test(), evd::RecoBaseDrawer::Vertex2D(), trkf::VertexFitAlg::VertexFit(), WireAngleToVertical(), and WirePitch().

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

geo::GeometryCore::Cryostat

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

Returns the specified cryostat.

Definition: GeometryCore.cxx:303

geo::CryostatGeo::TPC

const TPCGeo & TPC(unsigned int itpc) const

Return the itpc'th TPC in the cryostat.

Definition: CryostatGeo.cxx:84

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 735 of file GeometryCore.h.

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

Referenced by GetElementPtr(), GetEndPlaneID(), GetEndWireID(), HasPlane(), and PlanePtr().

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

std::vector< TPCID > geo::GeometryCore::TPCsetToTPCs ( readout::TPCsetID const & tpcsetid ) const

Returns a list of ID of TPCs belonging to the specified TPC set.

Parameters

tpcsetid ID of the TPC set to convert into TPC IDs

Returns: the list of TPCs, empty if TPC set is invalid

Note that the check is performed on the validity of the TPC set ID, that does not necessarily imply that the TPC set specified by the ID actually exists. Check the existence of the TPC set first (HasTPCset()). Behaviour on valid, non-existent TPC set IDs is undefined.

Definition at line 1497 of file GeometryCore.cxx.

References fChannelMapAlg.

Referenced by HasElement().

   {
     return fChannelMapAlg->TPCsetToTPCs(tpcsetid);
   }

readout::TPCsetID geo::GeometryCore::TPCtoTPCset ( TPCID const & tpcid ) const

Returns the ID of the TPC set tpcid belongs to.

Definition at line 1491 of file GeometryCore.cxx.

References fChannelMapAlg.

Referenced by FindTPCsetAtPosition(), and HasElement().

   {
     return fChannelMapAlg->TPCtoTPCset(tpcid);
   }

void geo::GeometryCore::UpdateAfterSorting ( )

private

Performs all the updates needed after sorting.

Definition at line 179 of file GeometryCore.cxx.

References allViews, Cryostats(), and Ncryostats().

Referenced by ApplyChannelMap().

   {
     for (size_t c = 0; c < Ncryostats(); ++c)
       Cryostats()[c].UpdateAfterSorting(CryostatID(c));
 
     allViews.clear();
     for (auto const& tpc : Iterate<TPCGeo>()) {
       auto const& TPCviews = tpc.Views();
       allViews.insert(TPCviews.cbegin(), TPCviews.cend());
     }
   }

View_t geo::GeometryCore::View ( PlaneID const & pid ) const

Returns the view (wire orientation) on the channels of specified TPC plane.

Parameters

plane TPC plane ID

Returns: the type of signal on the specified plane, or geo::kUnknown

Definition at line 489 of file GeometryCore.cxx.

References geo::kUnknown, Plane(), and geo::PlaneGeo::View().

Referenced by nnet::WaveformDenoiseTest::analyze(), nnet::NoiseWaveformDump::analyze(), nnet::RawWaveformDump::analyze(), nnet::RawWaveformClnSigDump::analyze(), calo::TrackCalorimetryAlg::AnalyzeHit(), apa::APAGeometryAlg::APAChannelsIntersect(), apa::APAGeometryAlg::APAView(), tca::FillWireHitRange(), hit::HitCheater::FindHitsOnChannel(), apa::APAGeometryAlg::FirstChannelInView(), corner::CornerFinderAlg::get_feature_points(), corner::CornerFinderAlg::get_feature_points_LineIntegralScore(), GetBeginPlaneID(), GetEndROPID(), quad::GetPts2D(), apa::APAGeometryAlg::Init(), apa::DisambigAlg::MakeCloseHits(), apa::APAGeometryAlg::NearestWireIDOnChan(), reco3d::SpacePointSolver::produce(), cluster::TrajCluster::produce(), vertex::FeatureVertexFinder::produce(), shower::TCShowerTemplateMaker::showerProfileTrue(), lar_pandora::DUNEFarDetVDThreeView::TargetViewU(), lar_pandora::ProtoDUNEDualPhase::TargetViewU(), lar_pandora::VintageLArTPCThreeView::TargetViewU(), lar_pandora::DUNEFarDetVDThreeView::TargetViewV(), lar_pandora::ProtoDUNEDualPhase::TargetViewV(), lar_pandora::VintageLArTPCThreeView::TargetViewV(), lar_pandora::DUNEFarDetVDThreeView::TargetViewW(), lar_pandora::ICARUS::TargetViewW(), lar_pandora::VintageLArTPCThreeView::TargetViewW(), cheat::BackTracker::TrackIdToSimIDEs_Ps(), View(), and Views().

   {
     return pid ? Plane(pid).View() : kUnknown;
   }

View_t geo::GeometryCore::View ( raw::ChannelID_t const channel ) const

Returns the view (wire orientation) on the specified TPC channel.

Parameters

channel TPC channel ID

Returns: the type of signal on the specified channel, or geo::kUnknown

The view of the readout plane channel belongs to is returned, as in View(readout::ROPID const&) const.

Definition at line 483 of file GeometryCore.cxx.

References ChannelToROP(), raw::InvalidChannelID, geo::kUnknown, and View().

   {
     return (channel == raw::InvalidChannelID) ? kUnknown : View(ChannelToROP(channel));
   }

View_t geo::GeometryCore::View ( readout::ROPID const & ropid ) const

Returns the view of the channels in the specified readout plane.

Parameters

ropid readout plane ID

Returns: the type of signal on the specified ROP

Returns the view (wire orientation) on the channels of specified readout plane. If ropid is an invalid ID, geo::kUnknown is returned. If ropid is a valid ID (i.e. an ID whose isValid flag is set) that points to a non-existent readout plane, the result is undefined. Use HasROP() to check if the readout plane actually exists.

Definition at line 1548 of file GeometryCore.cxx.

References fChannelMapAlg, and View().

   {
     return View(fChannelMapAlg->FirstWirePlaneInROP(ropid));
   }

std::set<View_t> const& geo::GeometryCore::Views ( ) const

inline

Returns a list of possible views in the detector.

Returns: the set of views

Definition at line 1882 of file GeometryCore.h.

References allViews, c1, c2, ChannelsIntersect(), ChannelToROP(), ChannelToWire(), HasChannel(), NearestChannel(), NTPCsets(), PlaneWireToChannel(), SignalType(), and View().

Referenced by cluster::HoughLineFinderAna::analyze(), vertex::FeatureVertexFinderAna::analyze(), detinfo::DetectorPropertiesStandard::CheckTimeOffsets(), cluster::EndPointAlg::EndPoint(), cluster::HoughBaseAlg::FastTransform(), pma::PMAlgTracker::PMAlgTracker(), and vertex::VertexFinder2D::produce().

1882 { return allViews; }

geo::GeometryCore::allViews

std::set< View_t > allViews

All views in the detector.

Definition: GeometryCore.h:2448

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 928 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();
   }

WireGeo const& geo::GeometryCore::Wire ( WireID const & wireid ) const

inline

Returns the specified wire.

Parameters

wireid ID of the wire

Returns: a constant reference to the specified wire

Exceptions

cet::exception if not found

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

Definition at line 1210 of file GeometryCore.h.

References Plane(), and geo::PlaneGeo::Wire().

Referenced by ChannelsIntersect(), lar_pandora::LArPandoraInput::CreatePandoraHits2D(), util::GeometryUtilities::GeometryUtilities(), GetElement(), lar_pandora::PFParticleHitDumper::GetUVW(), IncrementID(), trkf::Track3DKalmanHitAlg::makeSeed(), WireEndPoints(), and WireIDToWireGeo().

1210 { return Plane(wireid).Wire(wireid); }

geo::PlaneGeo::Wire

WireGeo const & Wire(unsigned int iwire) const

Definition: PlaneGeo.cxx:465

geo::GeometryCore::Plane

PlaneGeo const & Plane(PlaneID const &planeid) const

Returns the specified wire.

Definition: GeometryCore.h:1034

double geo::GeometryCore::WireAngleToVertical	(	View_t	view,
		TPCID const &	tpcid
	)		const

Returns the angle of the wires in the specified view from vertical.

Parameters

view	the view
TPC	the index of the TPC in the specified cryostat
Cryo	the cryostat
tpcid	ID of the TPC

Returns: the angle [radians]

Exceptions

cet::exception ("GeometryCore" category) if no such view

The angle is defined as in WireGeo::ThetaZ().

This method assumes all wires in the view have the same angle (it queries for the first).

Deprecated:: This does not feel APA-ready

Definition at line 781 of file GeometryCore.cxx.

References geo::TPCGeo::Nplanes(), geo::TPCGeo::Plane(), geo::PlaneGeo::ThetaZ(), TPC(), geo::PlaneGeo::View(), and geo::PlaneGeo::ViewName().

Referenced by ShowerRecoTools::ShowerUnidirectiondEdx::CalculateElement(), util::GeometryUtilities::CalculatePitch(), util::GeometryUtilities::CalculatePitchPolar(), util::GeometryUtilities::Get2DangleFrom3D(), calo::GnocchiCalorimetry::GetPitch(), shower::EMShowerAlg::MakeShower(), util::GeometryUtilities::PitchInView(), calo::ShowerCalorimetry::produce(), calo::Calorimetry::produce(), lar_pandora::detector_functions::WireAngle(), lar_pandora::PFParticleHitDumper::YZtoU(), and lar_pandora::PFParticleHitDumper::YZtoV().

   {
     // loop over the planes in cryostat 0, tpc 0 to find the plane with the
     // specified view
     TPCGeo const& TPC = this->TPC(tpcid);
     for (unsigned int p = 0; p < TPC.Nplanes(); ++p) {
       PlaneGeo const& plane = TPC.Plane(p);
       if (plane.View() == view) return plane.ThetaZ();
     } // for
     throw cet::exception("GeometryCore")
       << "WireAngleToVertical(): no view \"" << PlaneGeo::ViewName(view) << "\" (#" << ((int)view)
       << ") in " << std::string(tpcid);
   }

Length_t geo::GeometryCore::WireCoordinate	(	Point_t const &	pos,
		PlaneID const &	planeid
	)		const

Returns the index of the nearest wire to the specified position.

Parameters

pos	world coordinates of the position (it will be projected)
planeid	ID of the plane

Returns: an index interpolation between the two nearest wires

See also: ChannelMapAlg::WireCoordinate()

Respect to NearestWireID(), this method returns a real number, representing a continuous coordinate in the wire axis, with the round values corresponding to the actual wires.

Definition at line 1093 of file GeometryCore.cxx.

References Plane(), and geo::PlaneGeo::WireCoordinate().

Referenced by tca::ChgFracBetween(), tca::ChgFracNearEnd(), evd::RecoBaseDrawer::DrawProng2D(), evd::RecoBaseDrawer::DrawTrackVertexAssns2D(), trkf::CCTrackMaker::FillEndMatch(), tca::Find3DVertices(), trkf::CCTrackMaker::FindMaybeVertices(), tca::FitTP3Ds(), shower::TCShowerElectronLikelihood::getShowerProfile(), cluster::MergeClusterAlg::GlobalWire(), cluster::BlurredClusteringAlg::GlobalWire(), shower::EMShowerAlg::GlobalWire_(), ems::Hit2D::Hit2D(), lar_cluster3d::PCASeedFinderAlg::LineFit2DHits(), lar_cluster3d::HoughSeedFinderAlg::LineFit2DHits(), tca::MakeBareTP(), shower::TCShowerAlg::makeShowers(), tca::MakeTP3D(), evd::SimulationDrawer::MCTruthVectors2D(), shower::LArPandoraShowerAlg::OrderShowerHits(), shower::EMShowerAlg::OrderShowerHits_(), trkf::CCTrackMaker::PlnMatch(), tca::PosInPlane(), trkf::CCTrackMaker::PrintClusters(), evd::RecoBaseDrawer::Prong2D(), tca::SetSection(), shower::TCShowerTemplateMaker::showerProfile(), shower::TCShowerTemplateMaker::showerProfileTrue(), evd::RecoBaseDrawer::Slice2D(), trkf::TrackLineFitAlg::TrkLineFit(), pma::ProjectionMatchingAlg::validate(), pma::ProjectionMatchingAlg::validate_on_adc(), pma::ProjectionMatchingAlg::validate_on_adc_test(), evd::RecoBaseDrawer::Vertex2D(), and trkf::VertexFitAlg::VertexFit().

   {
     return Plane(planeid).WireCoordinate(pos);
   }

void geo::GeometryCore::WireEndPoints	(	WireID const &	wireid,
		double *	xyzStart,
		double *	xyzEnd
	)		const

Fills two arrays with the coordinates of the wire end points.

Parameters

wireid	ID of the wire
xyzStart	(output) an array with the start coordinate
xyzEnd	(output) an array with the end coordinate

Exceptions

cet::exception wire not present

The starting point is the wire end with lower z coordinate.

Deprecated:: use the wire ID interface instead (but note that it does not sort the ends)

Definition at line 1130 of file GeometryCore.cxx.

References util::abs(), geo::GeometryCore::Segment< Point >::end(), and geo::GeometryCore::Segment< Point >::start().

Referenced by trkf::SeedFinderAlgorithm::CalculateGeometricalElements(), ChannelsIntersect(), lar_cluster3d::StandardHit3DBuilder::DistanceFromPointToHitWire(), trkf::SeedFinderAlgorithm::GetHitDistAndProj(), quad::GetPts2D(), and apa::DisambigAlg::TrivialDisambig().

   {
     Segment_t result = WireEndPoints(wireid);
 
     xyzStart[0] = result.start().X();
     xyzStart[1] = result.start().Y();
     xyzStart[2] = result.start().Z();
     xyzEnd[0] = result.end().X();
     xyzEnd[1] = result.end().Y();
     xyzEnd[2] = result.end().Z();
 
     if (xyzEnd[2] < xyzStart[2]) {
       //ensure that "End" has higher z-value than "Start"
       std::swap(xyzStart[0], xyzEnd[0]);
       std::swap(xyzStart[1], xyzEnd[1]);
       std::swap(xyzStart[2], xyzEnd[2]);
     }
     if (xyzEnd[1] < xyzStart[1] && std::abs(xyzEnd[2] - xyzStart[2]) < 0.01) {
       // if wire is vertical ensure that "End" has higher y-value than "Start"
       std::swap(xyzStart[0], xyzEnd[0]);
       std::swap(xyzStart[1], xyzEnd[1]);
       std::swap(xyzStart[2], xyzEnd[2]);
     }
   }

geo::GeometryCore::Segment< geo::Point_t > geo::GeometryCore::WireEndPoints ( WireID const & wireID ) const

inline

Returns a segment whose ends are the wire end points.

Parameters

wireid ID of the wire

Returns: a segment whose ends are the wire end points

Exceptions

cet::exception wire not present

The start and end are assigned as returned from the geo::WireGeo object. The rules for this assignment are documented in that class.

Deprecated:: use the wire ID interface instead (but note that it does not sort the ends)

Definition at line 2668 of file GeometryCore.h.

References geo::WireGeo::GetEnd(), geo::WireGeo::GetStart(), and Wire().

 {
   WireGeo const& wire = Wire(wireid);
   return {wire.GetStart(), wire.GetEnd()};
 }

bool geo::GeometryCore::WireIDIntersectionCheck	(	const WireID &	wid1,
		const WireID &	wid2
	)		const

private

Wire ID check for WireIDsIntersect methods.

Definition at line 1644 of file GeometryCore.cxx.

References geo::TPCID::asTPCID(), HasWire(), Nwires(), geo::PlaneID::Plane, and geo::WireID::planeID().

Referenced by ChannelsIntersect().

   {
     if (wid1.asTPCID() != wid2) {
       mf::LogError("WireIDIntersectionCheck")
         << "Comparing two wires on different TPCs: return failure.";
       return false;
     }
     if (wid1.Plane == wid2.Plane) {
       mf::LogError("WireIDIntersectionCheck")
         << "Comparing two wires in the same plane: return failure";
       return false;
     }
     if (!HasWire(wid1)) {
       mf::LogError("WireIDIntersectionCheck")
         << "1st wire " << wid1 << " does not exist (max wire number: " << Nwires(wid1.planeID())
         << ")";
       return false;
     }
     if (!HasWire(wid2)) {
       mf::LogError("WireIDIntersectionCheck")
         << "2nd wire " << wid2 << " does not exist (max wire number: " << Nwires(wid2.planeID())
         << ")";
       return false;
     }
     return true;
   }

bool geo::GeometryCore::WireIDsIntersect	(	WireID const &	wid1,
		WireID const &	wid2,
		Point_t &	intersection
	)		const

Computes the intersection between two wires.

Parameters

	wid1	ID of the first wire
	wid2	ID of the other wire
[out]	intersection	the intersection point (global coordinates)

Returns: whether an intersection was found inside the TPC the wires belong

See also: geo::WiresIntersection(), geo::LineClosestPoint()

The wires identified by wid1 and wid2 are intersected, and the 3D intersection point is written into the intersection parameter. The "intersection" point is actually the point belonging to the first wire (wid2) which is the closest (in Euclidean 3D metric) to the second wire.

The intersection is computed only if the wires belong to different planes of the same TPC. If that is not the case (i.e. they belong to different TPC or cryostat, or if they belong to the same plane), false is returned and intersection is set with all components to infinity (std::numeric_limits<>::infinity()).

When the intersection is computed, it is always stored in the intersection output parameter. Return value is true if this intersection lies within the physical boundaries first wire, while it is instead false if it lies on the extrapolation of the wire direction, but not within the wire physical extension.

To test that the result is not infinity (nor NaN), use geo::vect::isfinite(intersection) etc.

Note: If geo::WireGeo objects are already available, using instead the free function geo::WiresIntersection() or the method geo::WireGeo::IntersectionWith() is faster (and recommended). For purely geometric intersection, geo::LineClosestPoint() is also available.

Referenced by apa::APAGeometryAlg::APAChannelsIntersect(), ChannelsIntersect(), apa::DisambigAlg::CompareViews(), shower::EMShowerAlg::Construct3DPoint_(), evd::TWQProjectionView::FindEndPoint(), evd::TWQProjectionView::FindLineLength(), IntersectionPoint(), reco3d::IntersectionCache::ISect(), lar_cluster3d::StandardHit3DBuilder::makeDeadChannelPair(), lar_cluster3d::SnippetHit3DBuilder::makeDeadChannelPair(), lar_cluster3d::StandardHit3DBuilder::makeHitPair(), and apa::APAGeometryAlg::ThreeChanPos().

bool geo::GeometryCore::WireIDsIntersect	(	WireID const &	wid1,
		WireID const &	wid2,
		WireIDIntersection &	widIntersect
	)		const

Computes the intersection between two wires.

Parameters

wid1	ID of the first wire
wid2	ID of the other wire
widIntersect	(output) the coordinate of the intersection point

Returns: whether an intersection was found within the TPC

The "intersection" refers to the projection of the wires into the same $ x = 0 $ plane. Wires are assumed to have at most one intersection. If wires are parallel, widIntersect will have the two components set to infinity (std::numeric_limits<>::infinity()) and the TPC number set to invalid (geo::TPCID::InvalidID). Also, false is returned. If the intersection is outside the TPC, false is also returned, but the widIntersect will contain the coordinates of that intersection. The TPC number is still set to invalid, although the intersection might belong to a valid TPC somewhere else.

Deprecated:: This method uses arbitrary assumptions and should not be used. Use the interface returning a full vector instead.

WireGeo const& geo::GeometryCore::WireIDToWireGeo ( WireID const & wireid ) const

inline

Returns the specified wire.

Parameters

wireid ID of the wire

Returns: a constant reference to the specified wire

Exceptions

cet::exception if not found

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

Definition at line 1211 of file GeometryCore.h.

References Wire().

Referenced by trkf::SpacePointAlg::compatible(), lar_cluster3d::SnippetHit3DBuilder::DistanceFromPointToHitWire(), trkf::SpacePointAlg::fillComplexSpacePoint(), trkf::SpacePointAlg::fillSpacePoint(), cluster::MergeClusterAlg::GlobalWire(), cluster::BlurredClusteringAlg::GlobalWire(), shower::EMShowerAlg::GlobalWire_(), ems::Hit2D::Hit2D(), trkf::SpacePointAlg::makeSpacePoints(), lar_cluster3d::PrincipalComponentsAlg::PCAAnalysis_2D(), lar_cluster3d::PrincipalComponentsAlg::PCAAnalysis_calc2DDocas(), trkf::SpacePointAlg::separation(), trkf::TrackKalmanFitter::setupInputStates(), trkf::SurfWireLine::SurfWireLine(), trkf::SurfWireX::SurfWireX(), apa::APAGeometryAlg::ThreeChanPos(), and lar_cluster3d::SnippetHit3DBuilder::WireIDsIntersect().

1211 { return Wire(wireid); }

geo::GeometryCore::Wire

WireGeo const & Wire(WireID const &wireid) const

Returns the specified wire.

Definition: GeometryCore.h:1210

Length_t geo::GeometryCore::WirePitch ( PlaneID const & planeid = plane_zero ) const

Returns the distance between two consecutive wires.

Parameters

p	plane number within the TPC
tpc	tpc number within the cryostat
cstat	cryostat number

Returns: the distance between the two wires

Note: The current geometry assumptions imply that wire pitch is constant between all wires on the same wire plane. This is an assumption non-trivial to remove.

Todo:

add a version with wire IDs

deprecate this function

document what will happen (in the future methods) with wires on different planes

Definition at line 763 of file GeometryCore.cxx.

References Plane(), and geo::PlaneGeo::WirePitch().

Referenced by vertex::FeatureVertexFinderAna::analyze(), shwf::ShowerReco::beginJob(), mvapid::MVAAlg::CalcSegmentdEdxDist(), ShowerRecoTools::ShowerUnidirectiondEdx::CalculateElement(), ShowerRecoTools::ShowerTrajPointdEdx::CalculateElement(), trkf::SeedFinderAlgorithm::CalculateGeometricalElements(), evd::RecoBaseDrawer::Cluster2D(), lar_cluster3d::DBScanAlg::configure(), lar_pandora::LArPandoraInput::CreatePandoraHits2D(), lar_pandora::LArPandoraInput::CreatePandoraReadoutGaps(), tca::dEdx(), trkf::Track3DKalmanSPS::dQdxCalc(), evd::RecoBaseDrawer::DrawTrack2D(), cluster::EndPointAlg::EndPoint(), trkf::SpacePointAlg::fillComplexSpacePoint(), trkf::SpacePointAlg::fillSpacePoint(), tca::FillWireHitRange(), apa::DisambigAlg::FindChanTimeEndPts(), lar_cluster3d::HoughSeedFinderAlg::findHoughClusters(), cluster::SmallClusterFinderAlg::FindSmallClusters(), util::GeometryUtilities::GeometryUtilities(), lar_pandora::LArPandoraInput::GetMips(), calo::Calorimetry::GetPitch(), calo::GnocchiCalorimetry::GetPitch(), shower::TCShowerElectronLikelihood::getShowerProfile(), shower::TCShowerAlg::goodHit(), evd::RecoBaseDrawer::Hit2D(), shower::LArPandoraShowerAlg::HitCoordinates(), shower::EMShowerAlg::HitPosition_(), apa::APAGeometryAlg::Init(), lar_cluster3d::PCASeedFinderAlg::LineFit2DHits(), lar_cluster3d::HoughSeedFinderAlg::LineFit2DHits(), shower::EMShowerAlg::MakeShower(), trkf::SpacePointAlg::makeSpacePoints(), cluster::ClusterMatchTQ::MatchedClusters(), shower::LArPandoraShowerAlg::OrderShowerHits(), cluster::DBCluster3D::produce(), calo::ShowerCalorimetry::produce(), trkf::SpacePts::produce(), trkf::Track3Dreco::produce(), trkf::CCTrackMaker::produce(), vertex::VertexFinder2D::produce(), calo::Calorimetry::produce(), shower::TCShowerTemplateMaker::showerProfile(), shower::TCShowerTemplateMaker::showerProfileTrue(), trkf::KHitWireLine::subpredict(), trkf::KHitWireX::subpredict(), trkf::TrackLineFitAlg::TrkLineFit(), trkf::VertexFitAlg::VertexFit(), lar_pandora::VintageLArTPCThreeView::WirePitchU(), lar_pandora::VintageLArTPCThreeView::WirePitchV(), and lar_pandora::VintageLArTPCThreeView::WirePitchW().

   {
     return Plane(planeid).WirePitch();
   }

Length_t geo::GeometryCore::WirePitch ( View_t view ) const

Returns the distance between two wires in the specified view.

Parameters

w1	index of the first wire
w2	index of the second wire
p	plane number within the TPC
tpc	tpc number within the cryostat
cstat	cryostat number

Returns: the distance between the two wires

This method assumes that all the wires on all the planes on the specified view of all TPCs have the same pitch.

Definition at line 771 of file GeometryCore.cxx.

References Plane(), TPC(), and geo::PlaneGeo::WirePitch().

   {
     // look in cryostat 0, tpc 0 to find the plane with the
     // specified view
     return TPC({0, 0}).Plane(view).WirePitch();
   }

readout::ROPID geo::GeometryCore::WirePlaneToROP ( PlaneID const & planeid ) const

Returns the ID of the ROP planeid belongs to.

Parameters

planeid ID of the wire plane

Returns: the ID of the ROP planeid belongs to

If planeid is an invalid ID, an invalid ROP ID is returned. If planeid is a valid ID (i.e. an ID whose isValid flag is set) that points to a non-existent wire plane, the result is undefined. Use HasPlaneID() to check if the wire plane actually exists.

Definition at line 1524 of file GeometryCore.cxx.

References fChannelMapAlg.

Referenced by HasElement(), and SignalType().

   {
     return fChannelMapAlg->WirePlaneToROP(planeid);
   }

WireGeo const* geo::GeometryCore::WirePtr ( WireID const & wireid ) const

inline

Returns the specified wire.

Parameters

wireid wire ID

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

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

Definition at line 1192 of file GeometryCore.h.

References PlanePtr(), and geo::PlaneGeo::WirePtr().

Referenced by lar_cluster3d::MinSpanTreeAlg::configure(), evd_tool::MicroBooNEDrawer::DrawBadChannels(), evd_tool::ICARUSDrawer::DrawBadChannels(), and GetElementPtr().

     {
       PlaneGeo const* pPlane = PlanePtr(wireid);
       return pPlane ? pPlane->WirePtr(wireid) : nullptr;
     } // WirePtr()

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 911 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 889 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 883 of file GeometryCore.cxx.

References GetWorldVolumeName().

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

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

Member Data Documentation

std::set<View_t> geo::GeometryCore::allViews

private

All views in the detector.

Definition at line 2448 of file GeometryCore.h.

Referenced by UpdateAfterSorting(), and Views().

constexpr CryostatID geo::GeometryCore::cryostat_zero {0}

static

Returns the specified cryostat.

Parameters

cstat	number of cryostat
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 463 of file GeometryCore.h.

Referenced by Iterate(), and ThirdPlaneSlope().

fhicl::ParameterSet geo::GeometryCore::fBuilderParameters

private

Configuration for the geometry builder (needed since builder is created after construction).

Definition at line 2443 of file GeometryCore.h.

Referenced by LoadGeometryFile().

std::unique_ptr<const ChannelMapAlg> geo::GeometryCore::fChannelMapAlg

private

Object containing the channel to wire mapping.

Definition at line 2444 of file GeometryCore.h.

Referenced by ApplyChannelMap(), ChannelsInTPCs(), ChannelToAuxDet(), ChannelToAuxDetSensitive(), ChannelToROP(), ChannelToWire(), FindAuxDetAtPosition(), FindAuxDetSensitiveAtPosition(), FirstChannelInROP(), HardwareChannelFromOpChannel(), HasChannel(), HasROP(), HasTPCset(), IsValidOpChannel(), MaxOpChannel(), MaxROPs(), MaxTPCsets(), Nchannels(), NOpChannels(), NOpHardwareChannels(), NROPs(), NTPCsets(), OpChannel(), OpDetFromOpChannel(), PlaneWireToChannel(), ROPtoTPCs(), ROPtoWirePlanes(), SignalType(), TPCsetToTPCs(), TPCtoTPCset(), View(), and WirePlaneToROP().

std::string geo::GeometryCore::fDetectorName

private

Name of the detector.

Definition at line 2434 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 2435 of file GeometryCore.h.

Referenced by GDMLFile(), and LoadGeometryFile().

GeometryData_t geo::GeometryCore::fGeoData

private

The detector description data.

Definition at line 2431 of file GeometryCore.h.

Referenced by ApplyChannelMap(), AuxDets(), ClearGeometry(), and Cryostats().

double geo::GeometryCore::fMinWireZDist

private

Minimum distance in Z from a point in which to look for the closest wire

Definition at line 2437 of file GeometryCore.h.

double geo::GeometryCore::fPositionWiggle

private

accounting for rounding errors when testing positions

Definition at line 2439 of file GeometryCore.h.

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

std::string geo::GeometryCore::fROOTfile

private

path to geometry file for geometry in GeometryCore

Definition at line 2436 of file GeometryCore.h.

Referenced by LoadGeometryFile(), and ROOTFile().

double geo::GeometryCore::fSurfaceY

private

The point where air meets earth for this detector.

Definition at line 2433 of file GeometryCore.h.

Referenced by SurfaceY().

constexpr std::size_t geo::GeometryCore::MaxWireDepthInGDML = 20U

static

Wires must be found in GDML description within this number of nested volumes.

Definition at line 145 of file GeometryCore.h.

constexpr PlaneID geo::GeometryCore::plane_zero {tpc_zero, 0}

static

Returns the distance between two consecutive wires.

Parameters

p	plane number within the TPC
tpc	tpc number within the cryostat
cstat	cryostat number

Returns: the distance between the two wires

Note: The current geometry assumptions imply that wire pitch is constant between all wires on the same wire plane. This is an assumption non-trivial to remove.

Todo:

add a version with wire IDs

deprecate this function

document what will happen (in the future methods) with wires on different planes

Definition at line 1275 of file GeometryCore.h.

constexpr TPCID geo::GeometryCore::tpc_zero {cryostat_zero, 0}

static

Returns the specified TPC.

Parameters

tpcid	ID of the tpc
tpc	tpc number within the cryostat
cstat	number of cryostat

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 721 of file GeometryCore.h.

Referenced by GetBeginTPCID(), and GetTPCFrontFaceCenter().

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

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

Classes

Public Types

Public Member Functions

Static Public Member Functions

Static Public Attributes

Private Member Functions

Private Attributes

Detailed Description

How to correctly instantiate a GeometryCore object

Configuration parameters

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation