Geometry information for a single cryostat. More...

#include "CryostatGeo.h"

Inheritance diagram for geo::CryostatGeo:

Classes
struct	CryostatGeoCoordinatesTag
	Tag for vectors in the "local" GDML coordinate frame of the cryostat. More...

Public Types
using	ID_t = CryostatID

using	TPCList_t = std::vector< geo::TPCGeo >
	Type used internally to store the TPCs. More...

using	OpDetList_t = std::vector< geo::OpDetGeo >
	Type used internally to store the optical detectors. More...

using	GeoNodePath_t = geo::WireGeo::GeoNodePath_t

using	ElementIteratorBox = TPCList_t const &
	Type returned by `IterateElements()`. More...

using	Coords_t = geo::Point_t
	Type of the coordinate triplet. More...

using	Coord_t = Coords_t::Scalar
	Type of the coordinate. More...

Types for geometry-local reference vectors.
These types represents points and displacement vectors in the reference frame defined in the cryostat geometry box from the GDML geometry description. No alias is explicitly defined for the LArSoft global vector types, `geo::Point_t` and `geo::Vector_t`. Remember the `LocalPoint_t` and `LocalVector_t` vectors from different instances of `geo::CryostatGeo` have the same type but are not compatible.
using	LocalPoint_t = geo::Point3DBase_t< CryostatGeoCoordinatesTag >
	Type of points in the local GDML cryostat frame. More...

using	LocalVector_t = geo::Vector3DBase_t< CryostatGeoCoordinatesTag >
	Type of displacement vectors in the local GDML cryostat frame. More...

Public Member Functions
	CryostatGeo (TGeoNode const &node, geo::TransformationMatrix &&trans, TPCList_t &&TPCs, OpDetList_t &&OpDets)
	Construct a representation of a single cryostat of the detector. More...

void	SortSubVolumes (geo::GeoObjectSorter const &sorter)
	Method to sort TPCGeo objects. More...

void	UpdateAfterSorting (geo::CryostatID cryoid)
	Performs all needed updates after geometry has sorted the cryostats. More...

TPC access
unsigned int	NTPC () const
	Number of TPCs in this cryostat. More...

unsigned int	NElements () const
	Alias for `NTPC()`. More...

bool	HasTPC (unsigned int itpc) const
	Returns whether a TPC with index itpc is present in this cryostat. More...

bool	HasElement (unsigned int itpc) const
	Alias for `HasTPC()`. More...

bool	HasTPC (geo::TPCID const &tpcid) const
	Returns whether the TPC in tpcid is present in this cryostat. More...

bool	HasElement (geo::TPCID const &tpcid) const
	Alias for `HasTPC(geo::TPCID const&)` More...

const TPCGeo &	TPC (unsigned int itpc) const
	Return the itpc'th TPC in the cryostat. More...

const TPCGeo &	TPC (TPCID const &tpcid) const
	Returns the TPC in tpcid from this cryostat. More...

const TPCGeo &	GetElement (TPCID const &tpcid) const
	Alias for `TPC()`. More...

ElementIteratorBox	IterateElements () const
	Returns an object suitable for iterating through all TPCs. More...

ElementIteratorBox	IterateTPCs () const
	Returns an object suitable for iterating through all TPCs. More...

TPCGeo const *	TPCPtr (unsigned int itpc) const
	Returns the TPC number itpc from this cryostat. More...

TPCGeo const *	TPCPtr (TPCID const &tpcid) const
	Returns the TPC in tpcid from this cryostat. More...

TPCGeo const *	GetElementPtr (TPCID const &tpcid) const
	Alias for `TPCPtr()`. More...

geo::TPCID	PositionToTPCID (geo::Point_t const &point, double wiggle) const
	Returns the ID of the TPC at specified location. More...

TPCGeo const &	PositionToTPC (geo::Point_t const &point, double wiggle) const
	Returns the ID of the TPC at specified location. More...

TPCGeo const &	PositionToTPC (double const worldLoc[3], double wiggle) const
	Returns the ID of the TPC at specified location. More...

geo::TPCGeo const *	PositionToTPCptr (geo::Point_t const &point, double wiggle) const
	Returns a pointer to the TPC at specified location. More...

unsigned int	MaxPlanes () const
	Returns the largest number of planes among the TPCs in this cryostat. More...

unsigned int	MaxWires () const
	Returns the largest number of wires among the TPCs in this cryostat. More...

Optical detector access
unsigned int	NOpDet () const
	Number of optical detectors in this TPC. More...

const OpDetGeo &	OpDet (unsigned int iopdet) const
	Return the iopdet'th optical detector in the cryostat. More...

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

unsigned int	GetClosestOpDet (double const *point) const

geo::OpDetGeo const *	GetClosestOpDetPtr (geo::Point_t const &point) const

std::string	OpDetGeoName () const
	Get name of opdet geometry element. More...

Coordinate transformation
geo::Point_t	toWorldCoords (LocalPoint_t const &local) const
	Transform point from local cryostat frame to world frame. More...

geo::Vector_t	toWorldCoords (LocalVector_t const &local) const
	Transform direction vector from local to world. More...

LocalPoint_t	toLocalCoords (geo::Point_t const &world) const
	Transform point from world frame to local cryostat frame. More...

LocalVector_t	toLocalCoords (geo::Vector_t const &world) const
	Transform direction vector from world to local. More...

Dimension queries
double	MinX () const
	Returns the world x coordinate of the start of the box. More...

double	MaxX () const
	Returns the world x coordinate of the end of the box. More...

double	CenterX () const
	Returns the world x coordinate of the center of the box. More...

double	SizeX () const
	Returns the full size in the X dimension. More...

double	HalfSizeX () const
	Returns the size from the center to the border on X dimension. More...

double	MinY () const
	Returns the world y coordinate of the start of the box. More...

double	MaxY () const
	Returns the world y coordinate of the end of the box. More...

double	CenterY () const
	Returns the world y coordinate of the center of the box. More...

double	SizeY () const
	Returns the full size in the Y dimension. More...

double	HalfSizeY () const
	Returns the size from the center to the border on Y dimension. More...

double	MinZ () const
	Returns the world z coordinate of the start of the box. More...

double	MaxZ () const
	Returns the world z coordinate of the end of the box. More...

double	CenterZ () const
	Returns the world z coordinate of the center of the box. More...

double	SizeZ () const
	Returns the full size in the Z dimension. More...

double	HalfSizeZ () const
	Returns the size from the center to the border on Z dimension. More...

geo::Point_t	Min () const
	Returns the corner point with the smallest coordinates. More...

geo::Point_t	Max () const
	Returns the corner point with the largest coordinates. More...

geo::Point_t	Center () const
	Returns the center point of the box. More...

Containment in the full volume
bool	ContainsX (double x, double const wiggle=1) const
	Returns whether this TPC contains the specified world x coordinate. More...

bool	ContainsY (double y, double const wiggle=1) const
	Returns whether this TPC contains the specified world y coordinate. More...

bool	ContainsZ (double z, double const wiggle=1) const
	Returns whether this TPC contains the specified world z coordinate. More...

bool	ContainsYZ (double y, double z, double const wiggle=1) const
	Returns if TPC contains the specified world y and z coordinates. More...

bool	ContainsPosition (geo::Point_t const &point, double wiggle=1.0) const
	Returns whether this volume contains the specified point. More...

bool	ContainsPosition (TVector3 const &point, double wiggle=1.0) const

bool	ContainsPosition (double const *point, double wiggle=1.0) const

Containment in a fiducial volume
bool	InFiducialX (double x, double neg_margin, double pos_margin) const
	Returns whether TPC fiducial volume contains world x coordinate. More...

bool	InFiducialX (double x, double margin) const
	Returns whether TPC fiducial volume contains world x coordinate. More...

bool	InFiducialY (double y, double neg_margin, double pos_margin) const
	Returns whether TPC fiducial volume contains world y coordinate. More...

bool	InFiducialY (double y, double margin) const
	Returns whether TPC fiducial volume contains world y coordinate. More...

bool	InFiducialZ (double z, double neg_margin, double pos_margin) const
	Returns whether TPC fiducial volume contains world z coordinate. More...

bool	InFiducialZ (double z, double margin) const
	Returns whether TPC fiducial volume contains world z coordinate. More...

Overlaps
bool	OverlapsX (geo::BoxBoundedGeo const &other) const
	Returns if the x coordinates covered by this and `other` box overlap. More...

bool	OverlapsY (geo::BoxBoundedGeo const &other) const
	Returns if the y coordinates covered by this and `other` box overlap. More...

bool	OverlapsZ (geo::BoxBoundedGeo const &other) const
	Returns if the z coordinates covered by this and `other` box overlap. More...

bool	Overlaps (geo::BoxBoundedGeo const &other) const
	Returns if this and `other` box overlap. More...

Setting dimensions
void	SetBoundaries (Coord_t x_min, Coord_t x_max, Coord_t y_min, Coord_t y_max, Coord_t z_min, Coord_t z_max)
	Sets the boundaries in world coordinates as specified. More...

void	SetBoundaries (Coords_t lower, Coords_t upper)
	Sets the boundaries in world coordinates as specified. More...

void	ExtendToInclude (Coord_t x, Coord_t y, Coord_t z)
	Extends the current box to also include the specified point. More...

void	ExtendToInclude (geo::Point_t const &point)
	Extends the current box to also include the specified point. More...

void	ExtendToInclude (BoxBoundedGeo const &box)
	Extends the current box to also include the specified one. More...


std::vector< TVector3 >	GetIntersections (TVector3 const &TrajectoryStart, TVector3 const &TrajectoryDirect) const
	Calculates the entry and exit points of a trajectory on the box surface. More...

std::vector< geo::Point_t >	GetIntersections (geo::Point_t const &TrajectoryStart, geo::Vector_t const &TrajectoryDirect) const
	Calculates the entry and exit points of a trajectory on the box surface. More...

Static Public Member Functions
static bool	CoordinateContained (double c, double min, double max, double wiggle=1.)
	Returns whether the specified coordinate is in a range. More...

static bool	CoordinateContained (double c, double const *range, double wiggle=1.)
	Returns whether the specified coordinate is in a range. More...

static void	set_min (Coord_t &var, Coord_t value)
	Sets var to value if value is smaller than the current var value. More...

static void	set_min (Coords_t &var, geo::Point_t const &value)
	Sets each coordinate of var to the one in value if the latter is smaller. More...

static void	set_max (Coord_t &var, Coord_t value)
	Sets var to value if value is larger than the current var value. More...

static void	set_max (Coords_t &var, geo::Point_t const &value)
	Sets each coordinate of var to the one in value if the latter is larger. More...

Private Types
using	LocalTransformation_t = geo::LocalTransformationGeo< ROOT::Math::Transform3D, LocalPoint_t, LocalVector_t >

Private Member Functions
void	FindTPC (std::vector< const TGeoNode * > &path, unsigned int depth)

void	MakeTPC (std::vector< const TGeoNode * > &path, int depth)

void	FindOpDet (std::vector< const TGeoNode * > &path, unsigned int depth)

void	MakeOpDet (std::vector< const TGeoNode * > &path, int depth)

void	InitCryoBoundaries ()
	Fill the boundary information of the cryostat. More...

Private Attributes
LocalTransformation_t	fTrans
	Cryostat-to-world transformation. More...

TPCList_t	fTPCs
	List of tpcs in this cryostat. More...

OpDetList_t	fOpDets
	List of opdets in this cryostat. More...

TGeoVolume *	fVolume
	Total volume of cryostat, called volCryostat in GDML file. More...

std::string	fOpDetGeoName
	Name of opdet geometry elements in gdml. More...

geo::CryostatID	fID
	ID of this cryostat. More...

Cryostat geometry information
static constexpr unsigned int	MaxVerbosity = 3
	Maximum verbosity supported by `PrintCryostatInfo()`. More...

double	HalfWidth () const
	Half width of the cryostat [cm]. More...

double	HalfHeight () const
	Half height of the cryostat [cm]. More...

double	HalfLength () const
	Half height of the cryostat [cm]. More...

double	Width () const
	Full width of the cryostat [cm]. More...

double	Height () const
	Full height of the cryostat [cm]. More...

double	Length () const
	Length of the cryostat [cm]. More...

double	Mass () const
	Mass of the cryostat. More...

const TGeoVolume *	Volume () const
	Pointer to ROOT's volume descriptor. More...

geo::BoxBoundedGeo const &	Boundaries () const
	Returns boundaries of the cryostat (in centimetres). More...

void	Boundaries (double *boundaries) const
	Fills boundaries of the cryostat (in centimetres). More...

geo::Point_t	GetCenter () const
	Returns the geometrical center of the cryostat. More...

geo::BoxBoundedGeo const &	BoundingBox () const
	Returns the bounding box of this cryostat. More...

geo::CryostatID const &	ID () const
	Returns the identifier of this cryostat. More...

template<typename Stream >
void	PrintCryostatInfo (Stream &&out, std::string indent="", unsigned int verbosity=1) const
	Prints information about this cryostat. More...

std::string	CryostatInfo (std::string indent="", unsigned int verbosity=1) const
	Returns a string with cryostat information. More...

Detailed Description

Geometry information for a single cryostat.

Definition at line 43 of file CryostatGeo.h.

Member Typedef Documentation

using geo::BoxBoundedGeo::Coord_t = Coords_t::Scalar

inherited

Type of the coordinate.

Definition at line 36 of file BoxBoundedGeo.h.

using geo::BoxBoundedGeo::Coords_t = geo::Point_t

inherited

Type of the coordinate triplet.

Definition at line 35 of file BoxBoundedGeo.h.

using geo::CryostatGeo::ElementIteratorBox = TPCList_t const&

Type returned by IterateElements().

Definition at line 57 of file CryostatGeo.h.

using geo::CryostatGeo::GeoNodePath_t = geo::WireGeo::GeoNodePath_t

Definition at line 54 of file CryostatGeo.h.

using geo::CryostatGeo::ID_t = CryostatID

Definition at line 46 of file CryostatGeo.h.

using geo::CryostatGeo::LocalPoint_t = geo::Point3DBase_t<CryostatGeoCoordinatesTag>

Type of points in the local GDML cryostat frame.

Definition at line 79 of file CryostatGeo.h.

using geo::CryostatGeo::LocalTransformation_t = geo::LocalTransformationGeo<ROOT::Math::Transform3D, LocalPoint_t, LocalVector_t>

private

Definition at line 391 of file CryostatGeo.h.

using geo::CryostatGeo::LocalVector_t = geo::Vector3DBase_t<CryostatGeoCoordinatesTag>

Type of displacement vectors in the local GDML cryostat frame.

Definition at line 82 of file CryostatGeo.h.

using geo::CryostatGeo::OpDetList_t = std::vector<geo::OpDetGeo>

Type used internally to store the optical detectors.

Definition at line 52 of file CryostatGeo.h.

using geo::CryostatGeo::TPCList_t = std::vector<geo::TPCGeo>

Type used internally to store the TPCs.

Definition at line 49 of file CryostatGeo.h.

Constructor & Destructor Documentation

geo::CryostatGeo::CryostatGeo	(	TGeoNode const &	node,
		geo::TransformationMatrix &&	trans,
		TPCList_t &&	TPCs,
		OpDetList_t &&	OpDets
	)

Construct a representation of a single cryostat of the detector.

Definition at line 32 of file CryostatGeo.cxx.

References fOpDetGeoName, fVolume, InitCryoBoundaries(), and MF_LOG_DEBUG.

     : fTrans(std::move(trans)), fTPCs(std::move(TPCs)), fOpDets(std::move(OpDets)), fVolume(nullptr)
   {
 
     // all planes are going to be contained in the volume named volCryostat
     // now get the total volume of the Cryostat
     fVolume = node.GetVolume();
     if (!fVolume) throw cet::exception("CryostatGeo") << "cannot find cryostat outline volume\n";
 
     MF_LOG_DEBUG("Geometry") << "cryostat  volume is " << fVolume->GetName();
 
     // set the bounding box
     InitCryoBoundaries();
 
     // Set OpDetName;
     fOpDetGeoName = "volOpDetSensitive";
   }

Member Function Documentation

geo::BoxBoundedGeo const& geo::CryostatGeo::Boundaries ( ) const

inline

Returns boundaries of the cryostat (in centimetres).

Returns: boundaries in a geo::BoxBoundedGeo

Definition at line 114 of file CryostatGeo.h.

References BoundingBox().

Referenced by opdet::SimPhotonCounter::beginJob(), evgen::PhotonGen::beginRun(), GetCenter(), and phot::PhotonVisibilityService::reconfigure().

114 { return BoundingBox(); }

geo::CryostatGeo::BoundingBox

geo::BoxBoundedGeo const & BoundingBox() const

Returns the bounding box of this cryostat.

Definition: CryostatGeo.h:124

void geo::CryostatGeo::Boundaries ( double * boundaries ) const

Fills boundaries of the cryostat (in centimetres).

Parameters

boundaries filled as: [0] -x [1] +x [2] -y [3] +y [4] -z [5] +z

Definition at line 181 of file CryostatGeo.cxx.

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

   {
     boundaries[0] = MinX();
     boundaries[1] = MaxX();
     boundaries[2] = MinY();
     boundaries[3] = MaxY();
     boundaries[4] = MinZ();
     boundaries[5] = MaxZ();
   } // CryostatGeo::CryostatBoundaries(double*)

geo::BoxBoundedGeo const& geo::CryostatGeo::BoundingBox ( ) const

inline

Returns the bounding box of this cryostat.

Definition at line 124 of file CryostatGeo.h.

Referenced by Boundaries(), PrintCryostatInfo(), and phot::PhotonVisibilityService::reconfigure().

     {
       return static_cast<geo::BoxBoundedGeo const&>(*this);
     }

geo::Point_t geo::BoxBoundedGeo::Center ( ) const

inlineinherited

Returns the center point of the box.

Definition at line 141 of file BoxBoundedGeo.h.

References geo::BoxBoundedGeo::CenterX(), geo::BoxBoundedGeo::CenterY(), and geo::BoxBoundedGeo::CenterZ().

Referenced by geo::buildDriftVolumes(), GetCenter(), and geo::PlaneGeo::UpdatePlaneNormal().

141 { return {CenterX(), CenterY(), CenterZ()}; }

geo::BoxBoundedGeo::CenterX

double CenterX() const

Returns the world x coordinate of the center of the box.

Definition: BoxBoundedGeo.h:96

geo::BoxBoundedGeo::CenterZ

double CenterZ() const

Returns the world z coordinate of the center of the box.

Definition: BoxBoundedGeo.h:126

geo::BoxBoundedGeo::CenterY

double CenterY() const

Returns the world y coordinate of the center of the box.

Definition: BoxBoundedGeo.h:111

double geo::BoxBoundedGeo::CenterX ( ) const

inlineinherited

Returns the world x coordinate of the center of the box.

Definition at line 96 of file BoxBoundedGeo.h.

References geo::BoxBoundedGeo::MaxX(), and geo::BoxBoundedGeo::MinX().

Referenced by geo::BoxBoundedGeo::Center().

96 { return (MinX() + MaxX()) / 2.; }

geo::BoxBoundedGeo::MinX

double MinX() const

Returns the world x coordinate of the start of the box.

Definition: BoxBoundedGeo.h:90

geo::BoxBoundedGeo::MaxX

double MaxX() const

Returns the world x coordinate of the end of the box.

Definition: BoxBoundedGeo.h:93

double geo::BoxBoundedGeo::CenterY ( ) const

inlineinherited

Returns the world y coordinate of the center of the box.

Definition at line 111 of file BoxBoundedGeo.h.

References geo::BoxBoundedGeo::MaxY(), and geo::BoxBoundedGeo::MinY().

Referenced by geo::BoxBoundedGeo::Center().

111 { return (MinY() + MaxY()) / 2.; }

geo::BoxBoundedGeo::MaxY

double MaxY() const

Returns the world y coordinate of the end of the box.

Definition: BoxBoundedGeo.h:108

geo::BoxBoundedGeo::MinY

double MinY() const

Returns the world y coordinate of the start of the box.

Definition: BoxBoundedGeo.h:105

double geo::BoxBoundedGeo::CenterZ ( ) const

inlineinherited

Returns the world z coordinate of the center of the box.

Definition at line 126 of file BoxBoundedGeo.h.

References geo::BoxBoundedGeo::MaxZ(), and geo::BoxBoundedGeo::MinZ().

Referenced by geo::BoxBoundedGeo::Center().

126 { return (MinZ() + MaxZ()) / 2.; }

geo::BoxBoundedGeo::MinZ

double MinZ() const

Returns the world z coordinate of the start of the box.

Definition: BoxBoundedGeo.h:120

geo::BoxBoundedGeo::MaxZ

double MaxZ() const

Returns the world z coordinate of the end of the box.

Definition: BoxBoundedGeo.h:123

bool geo::BoxBoundedGeo::ContainsPosition	(	geo::Point_t const &	point,
		double	wiggle = `1.0`
	)		const

inlineinherited

Returns whether this volume contains the specified point.

Parameters

point	the point [cm]
wiggle	expansion factor for the range

Returns: whether the specified coordinate is in this volume

If the wiggle is larger than 1, each size of the volume is expanded by the wiggle factor. If the wiggle is less than 1, each size is shrinked.

Definition at line 210 of file BoxBoundedGeo.h.

References geo::BoxBoundedGeo::ContainsX(), and geo::BoxBoundedGeo::ContainsYZ().

Referenced by geo::BoxBoundedGeo::ContainsPosition(), and geo::GeometryCore::MaterialName().

     {
       return ContainsX(point.X(), wiggle) && ContainsYZ(point.Y(), point.Z(), wiggle);
     } // ContainsPosition()

bool geo::BoxBoundedGeo::ContainsPosition	(	TVector3 const &	point,
		double	wiggle = `1.0`
	)		const

inherited

See also: ContainsPosition(geo::Point_t const&, double) const.

Definition at line 24 of file BoxBoundedGeo.cxx.

References geo::BoxBoundedGeo::ContainsPosition(), and geo::vect::toPoint().

   {
     return ContainsPosition(geo::vect::toPoint(point), wiggle);
   }

bool geo::BoxBoundedGeo::ContainsPosition	(	double const *	point,
		double	wiggle = `1.0`
	)		const

inherited

See also: ContainsPosition(geo::Point_t const&, double) const.

Definition at line 30 of file BoxBoundedGeo.cxx.

References geo::BoxBoundedGeo::ContainsPosition(), and geo::vect::makePointFromCoords().

   {
     return ContainsPosition(geo::vect::makePointFromCoords(point), wiggle);
   }

bool geo::BoxBoundedGeo::ContainsX	(	double	x,
		double const	wiggle = `1`
	)		const

inlineinherited

Returns whether this TPC contains the specified world x coordinate.

Parameters

x	the absolute ("world") coordinate x
wiggle	expansion factor for the range (see ContainsPosition())

Returns: whether the specified coordinate is in this TPC

See also: ContainsPosition()

Note that x is by definition the drift direction, and a reconstructed x typically depends on an assumption respect to the event time.

Definition at line 158 of file BoxBoundedGeo.h.

References geo::BoxBoundedGeo::CoordinateContained(), geo::BoxBoundedGeo::MaxX(), and geo::BoxBoundedGeo::MinX().

Referenced by geo::BoxBoundedGeo::ContainsPosition().

     {
       return CoordinateContained(x, MinX(), MaxX(), wiggle);
     }

bool geo::BoxBoundedGeo::ContainsY	(	double	y,
		double const	wiggle = `1`
	)		const

inlineinherited

Returns whether this TPC contains the specified world y coordinate.

Parameters

y	the absolute ("world") coordinate y
wiggle	expansion factor for the range (see ContainsPosition())

Returns: whether the specified coordinate is in this TPC

See also: ContainsPosition()

Definition at line 170 of file BoxBoundedGeo.h.

References geo::BoxBoundedGeo::CoordinateContained(), geo::BoxBoundedGeo::MaxY(), and geo::BoxBoundedGeo::MinY().

Referenced by geo::BoxBoundedGeo::ContainsYZ().

     {
       return CoordinateContained(y, MinY(), MaxY(), wiggle);
     }

bool geo::BoxBoundedGeo::ContainsYZ	(	double	y,
		double	z,
		double const	wiggle = `1`
	)		const

inlineinherited

Returns if TPC contains the specified world y and z coordinates.

Parameters

y	the absolute ("world") coordinate y
z	the absolute ("world") coordinate z
wiggle	expansion factor for the range (see ContainsPosition())

Returns: whether the specified coordinate is in this TPC

See also: ContainsPosition()

Definition at line 195 of file BoxBoundedGeo.h.

References geo::BoxBoundedGeo::ContainsY(), and geo::BoxBoundedGeo::ContainsZ().

Referenced by geo::BoxBoundedGeo::ContainsPosition().

     {
       return ContainsY(y, wiggle) && ContainsZ(z, wiggle);
     }

bool geo::BoxBoundedGeo::ContainsZ	(	double	z,
		double const	wiggle = `1`
	)		const

inlineinherited

Returns whether this TPC contains the specified world z coordinate.

Parameters

z	the absolute ("world") coordinate z
wiggle	expansion factor for the range (see ContainsPosition())

Returns: whether the specified coordinate is in this TPC

See also: ContainsPosition()

Definition at line 182 of file BoxBoundedGeo.h.

References geo::BoxBoundedGeo::CoordinateContained(), geo::BoxBoundedGeo::MaxZ(), and geo::BoxBoundedGeo::MinZ().

Referenced by geo::BoxBoundedGeo::ContainsYZ().

     {
       return CoordinateContained(z, MinZ(), MaxZ(), wiggle);
     }

static bool geo::BoxBoundedGeo::CoordinateContained	(	double	c,
		double	min,
		double	max,
		double	wiggle = `1.`
	)

inlinestaticinherited

Returns whether the specified coordinate is in a range.

Parameters

c	the coordinate
min	lower boundary of the range
max	upper boundary of the range
wiggle	expansion factor for the range

Returns: whether the specified coordinate is in a range

If the wiggle is larger than 1, the range is expanded by the wiggle factor. If the wiggle is less than 1, the range is shrinked.

Definition at line 359 of file BoxBoundedGeo.h.

Referenced by geo::BoxBoundedGeo::ContainsX(), geo::BoxBoundedGeo::ContainsY(), geo::BoxBoundedGeo::ContainsZ(), geo::BoxBoundedGeo::CoordinateContained(), geo::BoxBoundedGeo::InFiducialX(), geo::BoxBoundedGeo::InFiducialY(), and geo::BoxBoundedGeo::InFiducialZ().

     {
       return (c >= (min > 0 ? min / wiggle : min * wiggle)) &&
              (c <= (max < 0 ? max / wiggle : max * wiggle));
     } // CoordinateContained()

static bool geo::BoxBoundedGeo::CoordinateContained	(	double	c,
		double const *	range,
		double	wiggle = `1.`
	)

inlinestaticinherited

Returns whether the specified coordinate is in a range.

Parameters

c	the coordinate
range	pointer to [ lower boundary, upper boundary ] of the range
wiggle	expansion factor for the range

Returns: whether the specified coordinate is in a range

See also: CoordinateContained(double, double, double, double)

If the wiggle is larger than 1, the range is expanded by the wiggle factor. If the wiggle is less than 1, the range is shrinked.

Definition at line 376 of file BoxBoundedGeo.h.

References geo::BoxBoundedGeo::CoordinateContained().

     {
       return CoordinateContained(c, range[0], range[1], wiggle);
     }

std::string geo::CryostatGeo::CryostatInfo	(	std::string	indent = `""`,
		unsigned int	verbosity = `1`
	)		const

Returns a string with cryostat information.

See also: PrintCryostatInfo()

The arguments and provided information are the same as in PrintCryostatInfo().

Definition at line 192 of file CryostatGeo.cxx.

References PrintCryostatInfo().

Referenced by ID().

   {
     std::ostringstream sstr;
     PrintCryostatInfo(sstr, indent, verbosity);
     return sstr.str();
   } // CryostatGeo::CryostatInfo()

void geo::BoxBoundedGeo::ExtendToInclude	(	Coord_t	x,
		Coord_t	y,
		Coord_t	z
	)

inlineinherited

Extends the current box to also include the specified point.

Parameters

x	x coordinate of the point to include
y	y coordinate of the point to include
z	z coordinate of the point to include

Definition at line 423 of file BoxBoundedGeo.h.

Referenced by geo::PlaneGeo::BoundingBox(), evd_tool::ProtoDUNEDrawer::DetOutline3D(), evd_tool::StandardDrawer::DetOutline3D(), larg4::ISTPC::extractActiveLArVolume(), larg4::OpFastScintillation::extractActiveVolumes(), and phot::PhotonVisibilityService::reconfigure().

     {
       ExtendToInclude(geo::Point_t(x, y, z));
     }

void geo::BoxBoundedGeo::ExtendToInclude ( geo::Point_t const & point )

inlineinherited

Extends the current box to also include the specified point.

Parameters

point coordinates of the point to include

Definition at line 432 of file BoxBoundedGeo.h.

References geo::BoxBoundedGeo::c_max, geo::BoxBoundedGeo::c_min, geo::BoxBoundedGeo::set_max(), and geo::BoxBoundedGeo::set_min().

     {
       set_min(c_min, point);
       set_max(c_max, point);
     }

void geo::BoxBoundedGeo::ExtendToInclude ( BoxBoundedGeo const & box )

inlineinherited

Extends the current box to also include the specified one.

Parameters

box	the box to include

It is assumed that the box has its boundaries properly sorted.

Definition at line 444 of file BoxBoundedGeo.h.

References geo::BoxBoundedGeo::c_max, geo::BoxBoundedGeo::c_min, geo::BoxBoundedGeo::GetIntersections(), geo::BoxBoundedGeo::Max(), geo::BoxBoundedGeo::Min(), geo::BoxBoundedGeo::set_max(), and geo::BoxBoundedGeo::set_min().

     {
       set_min(c_min, box.Min());
       set_max(c_max, box.Max());
     } // ExtendToInclude()

void geo::CryostatGeo::FindOpDet	(	std::vector< const TGeoNode * > &	path,
		unsigned int	depth
	)

private

Referenced by toLocalCoords().

void geo::CryostatGeo::FindTPC	(	std::vector< const TGeoNode * > &	path,
		unsigned int	depth
	)

private

Referenced by toLocalCoords().

geo::Point_t geo::CryostatGeo::GetCenter ( ) const

inline

Returns the geometrical center of the cryostat.

Definition at line 121 of file CryostatGeo.h.

References Boundaries(), and geo::BoxBoundedGeo::Center().

Referenced by PrintCryostatInfo().

121 { return Boundaries().Center(); }

geo::CryostatGeo::Boundaries

geo::BoxBoundedGeo const & Boundaries() const

Returns boundaries of the cryostat (in centimetres).

Definition: CryostatGeo.h:114

geo::BoxBoundedGeo::Center

geo::Point_t Center() const

Returns the center point of the box.

Definition: BoxBoundedGeo.h:141

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

Returns the index of the optical detector in this cryostat closest to point.

Definition at line 210 of file CryostatGeo.cxx.

References geo::OpDetGeo::DistanceToPoint(), NOpDet(), and OpDet().

Referenced by GetClosestOpDet(), geo::GeometryCore::GetClosestOpDet(), GetClosestOpDetPtr(), and NOpDet().

   {
     unsigned int ClosestDet = std::numeric_limits<unsigned int>::max();
     double ClosestDist = std::numeric_limits<double>::max();
 
     for (unsigned int o = 0U; o < NOpDet(); ++o) {
       double const ThisDist = OpDet(o).DistanceToPoint(point);
       if (ThisDist < ClosestDist) {
         ClosestDist = ThisDist;
         ClosestDet = o;
       }
     } // for
     return ClosestDet;
   } // CryostatGeo::GetClosestOpDet(geo::Point_t)

unsigned int geo::CryostatGeo::GetClosestOpDet ( double const * point ) const

See also: GetClosestOpDet(geo::Point_t const&) const

Definition at line 226 of file CryostatGeo.cxx.

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

   {
     return GetClosestOpDet(geo::vect::makePointFromCoords(point));
   }

geo::OpDetGeo const * geo::CryostatGeo::GetClosestOpDetPtr ( geo::Point_t const & point ) const

Returns the optical detector det in this cryostat nearest to point. If there are no optical detectors, nullptr is returned.

Definition at line 203 of file CryostatGeo.cxx.

References GetClosestOpDet(), and OpDet().

Referenced by NOpDet().

   {
     unsigned int iOpDet = GetClosestOpDet(point);
     return (iOpDet == std::numeric_limits<double>::max()) ? nullptr : &OpDet(iOpDet);
   }

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

inline

Alias for TPC().

Definition at line 216 of file CryostatGeo.h.

References IterateElements(), and TPC().

216 { return TPC(tpcid); }

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::CryostatGeo::GetElementPtr ( TPCID const & tpcid ) const

inline

Alias for TPCPtr().

Definition at line 271 of file CryostatGeo.h.

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

271 { return TPCPtr(tpcid); }

geo::CryostatGeo::TPCPtr

TPCGeo const * TPCPtr(unsigned int itpc) const

Returns the TPC number itpc from this cryostat.

Definition: CryostatGeo.h:256

std::vector< TVector3 > geo::BoxBoundedGeo::GetIntersections	(	TVector3 const &	TrajectoryStart,
		TVector3 const &	TrajectoryDirect
	)		const

inherited

Calculates the entry and exit points of a trajectory on the box surface.

Author: Christoph Rudolf von Rohr (crohr.nosp@m.@fna.nosp@m.l.gov)

Date: July 27th, 2015

Parameters

TrajectoryStart	position of the trajectory source
TrajectoryDirect	direction vector of the trajectory

This member is public since it just gives an output and does not change any member. The algorithm works only for a box shaped active volume with facing walls parallel to axis. If the return std::vector is empty the trajectory does not intersect with the box. Normally the return value should have one (if the trajectory originates in the box) or two (else) entries. If the return value has two entries the first represents the entry point and the second the exit point

Definition at line 125 of file BoxBoundedGeo.cxx.

Referenced by geo::BoxBoundedGeo::ExtendToInclude().

   {
     std::vector<TVector3> intersections;
     for (auto const& point :
          GetIntersections(geo::Point_t(TrajectoryStart), geo::Vector_t(TrajectoryDirect)))
       intersections.emplace_back(point.X(), point.Y(), point.Z());
     return intersections;
   } // GetIntersections(TVector3)

std::vector< geo::Point_t > geo::BoxBoundedGeo::GetIntersections	(	geo::Point_t const &	TrajectoryStart,
		geo::Vector_t const &	TrajectoryDirect
	)		const

inherited

Calculates the entry and exit points of a trajectory on the box surface.

Author: Christoph Rudolf von Rohr (crohr.nosp@m.@fna.nosp@m.l.gov)

Date: July 27th, 2015

Parameters

TrajectoryStart	position of the trajectory source
TrajectoryDirect	direction vector of the trajectory

This member is public since it just gives an output and does not change any member. The algorithm works only for a box shaped active volume with facing walls parallel to axis. If the return std::vector is empty the trajectory does not intersect with the box. Normally the return value should have one (if the trajectory originates in the box) or two (else) entries. If the return value has two entries the first represents the entry point and the second the exit point

Definition at line 36 of file BoxBoundedGeo.cxx.

References geo::vect::bindCoord(), geo::BoxBoundedGeo::c_max, geo::BoxBoundedGeo::c_min, geo::vect::coord(), geo::BoxBoundedGeo::Max(), and geo::BoxBoundedGeo::Min().

   {
 
     std::vector<geo::Point_t> IntersectionPoints;
     std::vector<double> LineParameters;
 
     // Generate normal vectors and offsets for every plane of the box
     // All normal vectors are headed outwards
     // BUG the double brace syntax is required to work around clang bug 21629
     // (https://bugs.llvm.org/show_bug.cgi?id=21629)
     static std::array<geo::Vector_t, 6U> const NormalVectors = {{
       -geo::Xaxis<geo::Vector_t>(),
       geo::Xaxis<geo::Vector_t>(), // anode, cathode,
       -geo::Yaxis<geo::Vector_t>(),
       geo::Yaxis<geo::Vector_t>(), // bottom, top,
       -geo::Zaxis<geo::Vector_t>(),
       geo::Zaxis<geo::Vector_t>() // upstream, downstream
     }};
     // BUG the double brace syntax is required to work around clang bug 21629
     // (https://bugs.llvm.org/show_bug.cgi?id=21629)
     std::array<geo::Point_t, 6U> const NormalVectorOffsets = {{
       geo::Point_t{Min().X(), Min().Y(), Min().Z()}, // Anode offset
       geo::Point_t{Max().X(), Min().Y(), Min().Z()}, // Cathode
       geo::Point_t{Min().X(), Min().Y(), Min().Z()}, // Bottom
       geo::Point_t{Min().X(), Max().Y(), Min().Z()}, // Top
       geo::Point_t{Min().X(), Min().Y(), Min().Z()}, // upstream
       geo::Point_t{Min().X(), Min().Y(), Max().Z()}  // downstream
     }};
 
     // Loop over all surfaces of the box
     for (unsigned int face_no = 0; face_no < NormalVectors.size(); face_no++) {
       // Check if trajectory and surface are not parallel
       if (NormalVectors[face_no].Dot(TrajectoryDirect)) {
         // Calculate the line parameter for the intersection points
         LineParameters.push_back(
           NormalVectors[face_no].Dot(NormalVectorOffsets.at(face_no) - TrajectoryStart) /
           NormalVectors[face_no].Dot(TrajectoryDirect));
       }
       else
         continue;
 
       // Calculate intersection point using the line parameter
       IntersectionPoints.push_back(TrajectoryStart + LineParameters.back() * TrajectoryDirect);
 
       // Coordinate which should be ignored when checking for limits added by Christoph Rudolf von Rohr 05/21/2016
       unsigned int NoCheckCoord;
 
       // Calculate NoCheckCoord out of the face_no
       if (face_no % 2) {
         // Convert odd face number to coordinate
         NoCheckCoord = (face_no - 1) / 2;
       }
       else {
         // Convert even face number to coordinate
         NoCheckCoord = face_no / 2;
       }
 
       // Loop over all three space coordinates
       unsigned int coord = 0;
       for (auto extractCoord : geo::vect::coordReaders<geo::Point_t>()) {
         auto const lastPointCoord = geo::vect::bindCoord(IntersectionPoints.back(), extractCoord);
         auto const minCoord = geo::vect::bindCoord(c_min, extractCoord);
         auto const maxCoord = geo::vect::bindCoord(c_max, extractCoord);
 
         // Changed by Christoph Rudolf von Rohr 05/21/2016
         // Then check if point is not within the surface limits at this coordinate, without looking
         // at the plane normal vector coordinate. We can assume, that our algorithm already found this coordinate correctily.
         // In rare cases, looking for boundaries in this coordinate causes unexpected behavior due to floating point inaccuracies.
         if (coord++ != NoCheckCoord &&
             ((lastPointCoord() > maxCoord()) || (lastPointCoord() < minCoord))) {
           // if off limits, get rid of the useless data and break the coordinate loop
           LineParameters.pop_back();
           IntersectionPoints.pop_back();
           break;
         }
       } // coordinate loop
     }   // Surcaces loop
 
     // sort points according to their parameter value (first is entry, second is exit)
     if (LineParameters.size() == 2 && LineParameters.front() > LineParameters.back()) {
       std::swap(IntersectionPoints.front(), IntersectionPoints.back());
     }
 
     return IntersectionPoints;
   } // GetIntersections()

double geo::CryostatGeo::HalfHeight ( ) const

Half height of the cryostat [cm].

Definition at line 169 of file CryostatGeo.cxx.

References fVolume.

Referenced by geo::GeometryCore::CryostatHalfHeight(), Height(), and InitCryoBoundaries().

   {
     return static_cast<TGeoBBox const*>(fVolume->GetShape())->GetDY();
   }

double geo::CryostatGeo::HalfLength ( ) const

Half height of the cryostat [cm].

Definition at line 175 of file CryostatGeo.cxx.

References fVolume.

Referenced by InitCryoBoundaries(), and Length().

   {
     return static_cast<TGeoBBox const*>(fVolume->GetShape())->GetDZ();
   }

double geo::BoxBoundedGeo::HalfSizeX ( ) const

inlineinherited

Returns the size from the center to the border on X dimension.

Definition at line 102 of file BoxBoundedGeo.h.

References geo::BoxBoundedGeo::SizeX().

102 { return SizeX() / 2.0; }

geo::BoxBoundedGeo::SizeX

double SizeX() const

Returns the full size in the X dimension.

Definition: BoxBoundedGeo.h:99

double geo::BoxBoundedGeo::HalfSizeY ( ) const

inlineinherited

Returns the size from the center to the border on Y dimension.

Definition at line 117 of file BoxBoundedGeo.h.

References geo::BoxBoundedGeo::SizeY().

117 { return SizeY() / 2.0; }

geo::BoxBoundedGeo::SizeY

double SizeY() const

Returns the full size in the Y dimension.

Definition: BoxBoundedGeo.h:114

double geo::BoxBoundedGeo::HalfSizeZ ( ) const

inlineinherited

Returns the size from the center to the border on Z dimension.

Definition at line 132 of file BoxBoundedGeo.h.

References geo::BoxBoundedGeo::SizeZ().

132 { return SizeZ() / 2.0; }

geo::BoxBoundedGeo::SizeZ

double SizeZ() const

Returns the full size in the Z dimension.

Definition: BoxBoundedGeo.h:129

double geo::CryostatGeo::HalfWidth ( ) const

Half width of the cryostat [cm].

Definition at line 163 of file CryostatGeo.cxx.

References fVolume.

Referenced by geo::GeometryCore::CryostatHalfWidth(), InitCryoBoundaries(), and Width().

   {
     return static_cast<TGeoBBox const*>(fVolume->GetShape())->GetDX();
   }

bool geo::CryostatGeo::HasElement ( unsigned int itpc ) const

inline

Alias for HasTPC().

Definition at line 187 of file CryostatGeo.h.

References HasTPC().

187 { return HasTPC(itpc); }

geo::CryostatGeo::HasTPC

bool HasTPC(unsigned int itpc) const

Returns whether a TPC with index itpc is present in this cryostat.

Definition: CryostatGeo.h:184

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

inline

Alias for HasTPC(geo::TPCID const&)

Definition at line 199 of file CryostatGeo.h.

References HasTPC(), and TPC().

199 { return HasTPC(tpcid); }

geo::CryostatGeo::HasTPC

bool HasTPC(unsigned int itpc) const

Returns whether a TPC with index itpc is present in this cryostat.

Definition: CryostatGeo.h:184

bool geo::CryostatGeo::HasTPC ( unsigned int itpc ) const

inline

Returns whether a TPC with index itpc is present in this cryostat.

Parameters

itpc	index of TPC in this cryostat

Returns: whether the TPC with index itpc is present in this cryostat

Definition at line 184 of file CryostatGeo.h.

References NTPC().

Referenced by HasElement(), geo::GeometryCore::HasTPC(), and TPCPtr().

184 { return itpc < NTPC(); }

geo::CryostatGeo::NTPC

unsigned int NTPC() const

Number of TPCs in this cryostat.

Definition: CryostatGeo.h:175

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

inline

Returns whether the TPC in tpcid is present in this cryostat.

Parameters

tpcid full TPC ID

Returns: whether the TPC in tpcid is present in this cryostat

The cryostat number in tpcid is ignored, as it is ignored whether tpcid is invalid.

Definition at line 197 of file CryostatGeo.h.

References HasTPC(), and geo::TPCID::TPC.

Referenced by HasTPC().

197 { return HasTPC(tpcid.TPC); }

geo::CryostatGeo::HasTPC

bool HasTPC(unsigned int itpc) const

Returns whether a TPC with index itpc is present in this cryostat.

Definition: CryostatGeo.h:184

double geo::CryostatGeo::Height ( ) const

inline

Full height of the cryostat [cm].

Definition at line 104 of file CryostatGeo.h.

References HalfHeight().

Referenced by PrintCryostatInfo().

104 { return 2. * HalfHeight(); }

geo::CryostatGeo::HalfHeight

double HalfHeight() const

Half height of the cryostat [cm].

Definition: CryostatGeo.cxx:169

geo::CryostatID const& geo::CryostatGeo::ID ( ) const

inline

Returns the identifier of this cryostat.

Definition at line 130 of file CryostatGeo.h.

References CryostatInfo(), fID, art::detail::indent(), and PrintCryostatInfo().

Referenced by geo::GeometryCore::FindTPCAtPosition(), geo::GeometryCore::GetClosestOpDet(), geo::GeometryCore::PositionToCryostatID(), PositionToTPC(), and PrintCryostatInfo().

130 { return fID; }

geo::CryostatGeo::fID

geo::CryostatID fID

ID of this cryostat.

Definition: CryostatGeo.h:398

bool geo::BoxBoundedGeo::InFiducialX	(	double	x,
		double	neg_margin,
		double	pos_margin
	)		const

inlineinherited

Returns whether TPC fiducial volume contains world x coordinate.

Parameters

x	the absolute ("world") coordinate x
neg_margin	how far within the TPC the fiducial region starts
pos_margin	how far before the TPC the fiducial region ends

Returns: whether the specified coordinate is in this TPC fiducial volume

The fiducial volume is defined by the specified margins, that denote how much of the coordinate is not fiducial. For example,

bool bWithin = tpc->InFiducialX(x, 5., 8.);

on a TPC with x from 0 to 100 (cm, presumably) will return true for all x between 5 and 92. If positive margin is not specified, it's assumed to be the same as the negative one. Specifying a negative mergin effectively extends the TPC volume. Note that x is by definition the drift direction, and a reconstructed x typically depends on an assumption respect to the event time.

Definition at line 243 of file BoxBoundedGeo.h.

References geo::BoxBoundedGeo::CoordinateContained(), geo::BoxBoundedGeo::MaxX(), and geo::BoxBoundedGeo::MinX().

     {
       return CoordinateContained(x, MinX() + neg_margin, MaxX() - pos_margin);
     }

bool geo::BoxBoundedGeo::InFiducialX	(	double	x,
		double	margin
	)		const

inlineinherited

Returns whether TPC fiducial volume contains world x coordinate.

See also: InFiducialX(double, double, double) const

Margins are symmetric.

Definition at line 253 of file BoxBoundedGeo.h.

References geo::BoxBoundedGeo::InFiducialX().

Referenced by geo::BoxBoundedGeo::InFiducialX().

253 { return InFiducialX(x, margin, margin); }

x

Float_t x

Definition: compare.C:6

geo::BoxBoundedGeo::InFiducialX

bool InFiducialX(double x, double neg_margin, double pos_margin) const

Returns whether TPC fiducial volume contains world x coordinate.

Definition: BoxBoundedGeo.h:243

bool geo::BoxBoundedGeo::InFiducialY	(	double	y,
		double	neg_margin,
		double	pos_margin
	)		const

inlineinherited

Returns whether TPC fiducial volume contains world y coordinate.

Parameters

y	the absolute ("world") coordinate y
neg_margin	how far within the TPC the fiducial region starts
pos_margin	how far before the TPC the fiducial region ends

Returns: whether the specified coordinate is in this TPC fiducial volume

The fiducial volume is defined by the specified margins, that denote how much of the coordinate is not fiducial. For example,

bool bWithin = tpc->InFiducialY(y, 5., 8.);

on a TPC with y from 0 to 100 (cm, presumably) will return true for all y between 5 and 92. If positive margin is not specified, it's assumed to be the same as the negative one. Specifying a negative mergin effectively extends the TPC volume.

Definition at line 273 of file BoxBoundedGeo.h.

References geo::BoxBoundedGeo::CoordinateContained(), geo::BoxBoundedGeo::MaxY(), and geo::BoxBoundedGeo::MinY().

     {
       return CoordinateContained(y, MinY() + neg_margin, MaxY() - pos_margin);
     }

bool geo::BoxBoundedGeo::InFiducialY	(	double	y,
		double	margin
	)		const

inlineinherited

Returns whether TPC fiducial volume contains world y coordinate.

See also: InFiducialY(double, double, double) const

Margins are symmetric.

Definition at line 283 of file BoxBoundedGeo.h.

References geo::BoxBoundedGeo::InFiducialY().

Referenced by geo::BoxBoundedGeo::InFiducialY().

283 { return InFiducialY(y, margin, margin); }

y

Float_t y

Definition: compare.C:6

geo::BoxBoundedGeo::InFiducialY

bool InFiducialY(double y, double neg_margin, double pos_margin) const

Returns whether TPC fiducial volume contains world y coordinate.

Definition: BoxBoundedGeo.h:273

bool geo::BoxBoundedGeo::InFiducialZ	(	double	z,
		double	neg_margin,
		double	pos_margin
	)		const

inlineinherited

Returns whether TPC fiducial volume contains world z coordinate.

Parameters

z	the absolute ("world") coordinate y
neg_margin	how far within the TPC the fiducial region starts
pos_margin	how far before the TPC the fiducial region ends

Returns: whether the specified coordinate is in this TPC fiducial volume

The fiducial volume is defined by the specified margins, that denote how much of the coordinate is not fiducial. For example,

bool bWithin = tpc->InFiducialZ(z, 5., 8.);

on a TPC with z from 0 to 100 (cm, presumably) will return true for all z between 5 and 92. If positive margin is not specified, it's assumed to be the same as the negative one. Specifying a negative mergin effectively extends the TPC volume.

Definition at line 303 of file BoxBoundedGeo.h.

References geo::BoxBoundedGeo::CoordinateContained(), geo::BoxBoundedGeo::MaxZ(), and geo::BoxBoundedGeo::MinZ().

     {
       return CoordinateContained(z, MinZ() + neg_margin, MaxZ() - pos_margin);
     }

bool geo::BoxBoundedGeo::InFiducialZ	(	double	z,
		double	margin
	)		const

inlineinherited

Returns whether TPC fiducial volume contains world z coordinate.

See also: InFiducialZ(double, double, double) const

Margins are symmetric.

Definition at line 313 of file BoxBoundedGeo.h.

References geo::BoxBoundedGeo::InFiducialZ().

Referenced by geo::BoxBoundedGeo::InFiducialZ().

313 { return InFiducialZ(z, margin, margin); }

z

Double_t z

Definition: plot.C:276

geo::BoxBoundedGeo::InFiducialZ

bool InFiducialZ(double z, double neg_margin, double pos_margin) const

Returns whether TPC fiducial volume contains world z coordinate.

Definition: BoxBoundedGeo.h:303

void geo::CryostatGeo::InitCryoBoundaries ( )

private

Fill the boundary information of the cryostat.

Definition at line 232 of file CryostatGeo.cxx.

References HalfHeight(), HalfLength(), HalfWidth(), geo::BoxBoundedGeo::SetBoundaries(), toWorldCoords(), and Volume().

Referenced by CryostatGeo(), and toLocalCoords().

   {
 
     // check that this is indeed a box
     if (!dynamic_cast<TGeoBBox*>(Volume()->GetShape())) {
       // at initialisation time we don't know yet our real ID
       throw cet::exception("CryostatGeo")
         << "Cryostat is not a box! (it is a " << Volume()->GetShape()->IsA()->GetName() << ")\n";
     }
 
     // get the half width, height, etc of the cryostat
     const double halflength = HalfLength();
     const double halfwidth = HalfWidth();
     const double halfheight = HalfHeight();
 
     SetBoundaries(toWorldCoords(LocalPoint_t{-halfwidth, -halfheight, -halflength}),
                   toWorldCoords(LocalPoint_t{+halfwidth, +halfheight, +halflength}));
 
   } // CryostatGeo::InitCryoBoundaries()

auto geo::CryostatGeo::IterateElements ( ) const

Returns an object suitable for iterating through all TPCs.

See also: IterateTPCs()

The returned value can be used in a range-for loop like:

for (geo::TPCGeo const& tpc: cryo.IterateElements()) { ... }

The resulting sequence exposes the TPCs within the cryostat in their ID order, from TPC 0 to NTPC() - 1.

This method is designed for templated code, where the object obj.IterateElements() may be a geo::CryostatGeo or some other one. For non-template code, prefer IterateTPCs() for clarity.

Definition at line 105 of file CryostatGeo.cxx.

References fTPCs.

Referenced by GetElement(), and IterateTPCs().

   {
     return fTPCs;
   }

ElementIteratorBox geo::CryostatGeo::IterateTPCs ( ) const

inline

Returns an object suitable for iterating through all TPCs.

See also: IterateElements()

The returned value can be used in a range-for loop like:

for (geo::TPCGeo const& tpc: cryo.IterateTPCs()) { ... }

The resulting sequence exposes the TPCs within the cryostat in their ID order, from TPC 0 to NTPC() - 1.

A version of this functionality designed for template code is provided under the generic name IterateElements().

Definition at line 249 of file CryostatGeo.h.

References IterateElements().

Referenced by PositionToTPCptr().

249 { return IterateElements(); }

geo::CryostatGeo::IterateElements

ElementIteratorBox IterateElements() const

Returns an object suitable for iterating through all TPCs.

Definition: CryostatGeo.cxx:105

double geo::CryostatGeo::Length ( ) const

inline

Length of the cryostat [cm].

Definition at line 106 of file CryostatGeo.h.

References HalfLength().

Referenced by geo::GeometryCore::CryostatLength(), and PrintCryostatInfo().

106 { return 2. * HalfLength(); }

geo::CryostatGeo::HalfLength

double HalfLength() const

Half height of the cryostat [cm].

Definition: CryostatGeo.cxx:175

void geo::CryostatGeo::MakeOpDet	(	std::vector< const TGeoNode * > &	path,
		int	depth
	)

private

Referenced by toLocalCoords().

void geo::CryostatGeo::MakeTPC	(	std::vector< const TGeoNode * > &	path,
		int	depth
	)

private

Referenced by toLocalCoords().

double geo::CryostatGeo::Mass ( ) const

inline

Mass of the cryostat.

Definition at line 108 of file CryostatGeo.h.

References fVolume.

108 { return fVolume->Weight(); }

geo::CryostatGeo::fVolume

TGeoVolume * fVolume

Total volume of cryostat, called volCryostat in GDML file.

Definition: CryostatGeo.h:396

geo::Point_t geo::BoxBoundedGeo::Max ( ) const

inlineinherited

Returns the corner point with the largest coordinates.

Definition at line 138 of file BoxBoundedGeo.h.

References geo::BoxBoundedGeo::c_max.

Referenced by geo::BoxBoundedGeo::ExtendToInclude(), geo::BoxBoundedGeo::GetIntersections(), geo::GeometryCore::MaterialName(), PrintCryostatInfo(), and geo::TPCGeo::PrintTPCInfo().

138 { return c_max; }

geo::BoxBoundedGeo::c_max

Coords_t c_max

maximum coordinates (x, y, z)

Definition: BoxBoundedGeo.h:503

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

Returns the largest number of planes among the TPCs in this cryostat.

Definition at line 141 of file CryostatGeo.cxx.

References fTPCs, geo::TPCGeo::Nplanes(), and TPC().

Referenced by ems::MultiEMShowers::convCluster(), geo::GeometryCore::GetEndPlaneID(), ems::EMShower3D::LinkCandidates(), PositionToTPC(), and PrintCryostatInfo().

   {
     unsigned int maxPlanes = 0;
     for (geo::TPCGeo const& TPC : fTPCs) {
       unsigned int maxPlanesInTPC = TPC.Nplanes();
       if (maxPlanesInTPC > maxPlanes) maxPlanes = maxPlanesInTPC;
     } // for
     return maxPlanes;
   } // CryostatGeo::MaxPlanes()

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

Returns the largest number of wires among the TPCs in this cryostat.

Definition at line 152 of file CryostatGeo.cxx.

References fTPCs, geo::TPCGeo::MaxWires(), and TPC().

Referenced by geo::GeometryCore::GetEndWireID(), PositionToTPC(), and PrintCryostatInfo().

   {
     unsigned int maxWires = 0;
     for (geo::TPCGeo const& TPC : fTPCs) {
       unsigned int maxWiresInTPC = TPC.MaxWires();
       if (maxWiresInTPC > maxWires) maxWires = maxWiresInTPC;
     } // for
     return maxWires;
   } // CryostatGeo::MaxWires()

double geo::BoxBoundedGeo::MaxX ( ) const

inlineinherited

Returns the world x coordinate of the end of the box.

Definition at line 93 of file BoxBoundedGeo.h.

References geo::BoxBoundedGeo::c_max.

Referenced by Boundaries(), geo::BoxBoundedGeo::CenterX(), geo::BoxBoundedGeo::ContainsX(), evd_tool::ProtoDUNEDrawer::DrawBoxBoundedGeoOutline(), evd_tool::StandardDrawer::DrawBoxBoundedGeoOutline(), geo::BoxBoundedGeo::InFiducialX(), evd::SimulationDrawer::MCTruthOrtho(), geo::BoxBoundedGeo::OverlapsX(), geo::BoxBoundedGeo::SizeX(), TPCarea(), and geo::GeometryCore::WorldBox().

93 { return c_max.X(); }

geo::BoxBoundedGeo::c_max

Coords_t c_max

maximum coordinates (x, y, z)

Definition: BoxBoundedGeo.h:503

double geo::BoxBoundedGeo::MaxY ( ) const

inlineinherited

Returns the world y coordinate of the end of the box.

Definition at line 108 of file BoxBoundedGeo.h.

References geo::BoxBoundedGeo::c_max.

Referenced by Boundaries(), geo::BoxBoundedGeo::CenterY(), geo::BoxBoundedGeo::ContainsY(), evd_tool::ProtoDUNEDrawer::DrawBoxBoundedGeoOutline(), evd_tool::StandardDrawer::DrawBoxBoundedGeoOutline(), geo::BoxBoundedGeo::InFiducialY(), pma::Node3D::Node3D(), geo::BoxBoundedGeo::OverlapsY(), tca::SaveCRInfo(), geo::BoxBoundedGeo::SizeY(), TPCarea(), and geo::GeometryCore::WorldBox().

108 { return c_max.Y(); }

geo::BoxBoundedGeo::c_max

Coords_t c_max

maximum coordinates (x, y, z)

Definition: BoxBoundedGeo.h:503

double geo::BoxBoundedGeo::MaxZ ( ) const

inlineinherited

Returns the world z coordinate of the end of the box.

Definition at line 123 of file BoxBoundedGeo.h.

References geo::BoxBoundedGeo::c_max.

Referenced by Boundaries(), geo::BoxBoundedGeo::CenterZ(), geo::BoxBoundedGeo::ContainsZ(), evd_tool::ProtoDUNEDrawer::DrawBoxBoundedGeoOutline(), evd_tool::StandardDrawer::DrawBoxBoundedGeoOutline(), geo::BoxBoundedGeo::InFiducialZ(), pma::Node3D::Node3D(), geo::BoxBoundedGeo::OverlapsZ(), tca::SaveCRInfo(), geo::BoxBoundedGeo::SizeZ(), TPCarea(), and geo::GeometryCore::WorldBox().

123 { return c_max.Z(); }

geo::BoxBoundedGeo::c_max

Coords_t c_max

maximum coordinates (x, y, z)

Definition: BoxBoundedGeo.h:503

geo::Point_t geo::BoxBoundedGeo::Min ( ) const

inlineinherited

Returns the corner point with the smallest coordinates.

Definition at line 135 of file BoxBoundedGeo.h.

References geo::BoxBoundedGeo::c_min.

Referenced by geo::BoxBoundedGeo::ExtendToInclude(), geo::BoxBoundedGeo::GetIntersections(), geo::GeometryCore::MaterialName(), PrintCryostatInfo(), and geo::TPCGeo::PrintTPCInfo().

135 { return c_min; }

geo::BoxBoundedGeo::c_min

Coords_t c_min

minimum coordinates (x, y, z)

Definition: BoxBoundedGeo.h:502

double geo::BoxBoundedGeo::MinX ( ) const

inlineinherited

Returns the world x coordinate of the start of the box.

Definition at line 90 of file BoxBoundedGeo.h.

References geo::BoxBoundedGeo::c_min.

Referenced by opdet::SimPhotonCounter::beginJob(), Boundaries(), geo::BoxBoundedGeo::CenterX(), geo::BoxBoundedGeo::ContainsX(), evd_tool::ProtoDUNEDrawer::DrawBoxBoundedGeoOutline(), evd_tool::StandardDrawer::DrawBoxBoundedGeoOutline(), geo::BoxBoundedGeo::InFiducialX(), pma::Track3D::InitFromMiddle(), evd::SimulationDrawer::MCTruthOrtho(), geo::BoxBoundedGeo::OverlapsX(), evgen::ActiveVolumeVertexSampler::sample_vertex_pos(), geo::BoxBoundedGeo::SizeX(), TPCarea(), and geo::GeometryCore::WorldBox().

90 { return c_min.X(); }

geo::BoxBoundedGeo::c_min

Coords_t c_min

minimum coordinates (x, y, z)

Definition: BoxBoundedGeo.h:502

double geo::BoxBoundedGeo::MinY ( ) const

inlineinherited

Returns the world y coordinate of the start of the box.

Definition at line 105 of file BoxBoundedGeo.h.

References geo::BoxBoundedGeo::c_min.

Referenced by Boundaries(), geo::BoxBoundedGeo::CenterY(), geo::BoxBoundedGeo::ContainsY(), evd_tool::ProtoDUNEDrawer::DrawBoxBoundedGeoOutline(), evd_tool::StandardDrawer::DrawBoxBoundedGeoOutline(), geo::BoxBoundedGeo::InFiducialY(), pma::Node3D::Node3D(), geo::BoxBoundedGeo::OverlapsY(), tca::SaveCRInfo(), geo::BoxBoundedGeo::SizeY(), TPCarea(), and geo::GeometryCore::WorldBox().

105 { return c_min.Y(); }

geo::BoxBoundedGeo::c_min

Coords_t c_min

minimum coordinates (x, y, z)

Definition: BoxBoundedGeo.h:502

double geo::BoxBoundedGeo::MinZ ( ) const

inlineinherited

Returns the world z coordinate of the start of the box.

Definition at line 120 of file BoxBoundedGeo.h.

References geo::BoxBoundedGeo::c_min.

Referenced by Boundaries(), geo::BoxBoundedGeo::CenterZ(), geo::BoxBoundedGeo::ContainsZ(), evd_tool::ProtoDUNEDrawer::DrawBoxBoundedGeoOutline(), evd_tool::StandardDrawer::DrawBoxBoundedGeoOutline(), geo::BoxBoundedGeo::InFiducialZ(), pma::Node3D::Node3D(), geo::BoxBoundedGeo::OverlapsZ(), tca::SaveCRInfo(), geo::BoxBoundedGeo::SizeZ(), TPCarea(), and geo::GeometryCore::WorldBox().

120 { return c_min.Z(); }

geo::BoxBoundedGeo::c_min

Coords_t c_min

minimum coordinates (x, y, z)

Definition: BoxBoundedGeo.h:502

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

inline

Alias for NTPC().

Definition at line 177 of file CryostatGeo.h.

References fTPCs.

Referenced by geo::GeometryCore::NTPC().

177 { return fTPCs.size(); }

geo::CryostatGeo::fTPCs

TPCList_t fTPCs

List of tpcs in this cryostat.

Definition: CryostatGeo.h:394

unsigned int geo::CryostatGeo::NOpDet ( ) const

inline

Number of optical detectors in this TPC.

Definition at line 321 of file CryostatGeo.h.

References fOpDets, GetClosestOpDet(), GetClosestOpDetPtr(), and OpDet().

Referenced by phot::PDFastSimANN::beginJob(), opdet::SimPhotonCounter::beginJob(), evgen::PhotonGen::beginRun(), GetClosestOpDet(), geo::GeometryCore::OpDetFromCryo(), geo::GeometryCore::OpDetGeoFromOpDet(), PrintCryostatInfo(), and UpdateAfterSorting().

321 { return fOpDets.size(); }

geo::CryostatGeo::fOpDets

OpDetList_t fOpDets

List of opdets in this cryostat.

Definition: CryostatGeo.h:395

unsigned int geo::CryostatGeo::NTPC ( ) const

inline

Number of TPCs in this cryostat.

Definition at line 175 of file CryostatGeo.h.

References fTPCs.

Referenced by larg4::LArVoxelReadoutGeometry::Construct(), geo::GeometryCore::GetEndTPCID(), groupTPCsByDriftDir(), HasTPC(), geo::ChannelMapStandardAlg::Initialize(), trkf::SpacePointAlg::makeSpacePoints(), PrintCryostatInfo(), larg4::LArG4::produce(), geo::GeometryCore::TotalNTPC(), and UpdateAfterSorting().

175 { return fTPCs.size(); }

geo::CryostatGeo::fTPCs

TPCList_t fTPCs

List of tpcs in this cryostat.

Definition: CryostatGeo.h:394

const OpDetGeo & geo::CryostatGeo::OpDet ( unsigned int iopdet ) const

Return the iopdet'th optical detector in the cryostat.

Definition at line 95 of file CryostatGeo.cxx.

References fOpDets.

Referenced by cosmic::BeamFlashTrackMatchTaggerAlg::FillFlashProperties(), opdet::FlashHypothesisAnaAlg::FillOpDetPositions(), GetClosestOpDet(), GetClosestOpDetPtr(), NOpDet(), and geo::GeometryCore::OpDetGeoFromOpDet().

   {
     if (iopdet >= fOpDets.size()) {
       throw cet::exception("OpDetOutOfRange") << "Request for non-existant OpDet " << iopdet;
     }
 
     return fOpDets[iopdet];
   }

std::string geo::CryostatGeo::OpDetGeoName ( ) const

inline

Get name of opdet geometry element.

Definition at line 337 of file CryostatGeo.h.

References fOpDetGeoName.

Referenced by geo::GeometryCore::OpDetGeoName().

337 { return fOpDetGeoName; }

geo::CryostatGeo::fOpDetGeoName

std::string fOpDetGeoName

Name of opdet geometry elements in gdml.

Definition: CryostatGeo.h:397

bool geo::BoxBoundedGeo::Overlaps ( geo::BoxBoundedGeo const & other ) const

inlineinherited

Returns if this and other box overlap.

Definition at line 340 of file BoxBoundedGeo.h.

References geo::BoxBoundedGeo::OverlapsX(), geo::BoxBoundedGeo::OverlapsY(), and geo::BoxBoundedGeo::OverlapsZ().

     {
       return OverlapsX(other) && OverlapsY(other) && OverlapsZ(other);
     }

bool geo::BoxBoundedGeo::OverlapsX ( geo::BoxBoundedGeo const & other ) const

inlineinherited

Returns if the x coordinates covered by this and other box overlap.

Definition at line 322 of file BoxBoundedGeo.h.

References geo::BoxBoundedGeo::MaxX(), and geo::BoxBoundedGeo::MinX().

Referenced by geo::BoxBoundedGeo::Overlaps().

     {
       return std::min(MaxX(), other.MaxX()) > std::max(MinX(), other.MinX());
     }

bool geo::BoxBoundedGeo::OverlapsY ( geo::BoxBoundedGeo const & other ) const

inlineinherited

Returns if the y coordinates covered by this and other box overlap.

Definition at line 328 of file BoxBoundedGeo.h.

References geo::BoxBoundedGeo::MaxY(), and geo::BoxBoundedGeo::MinY().

Referenced by geo::BoxBoundedGeo::Overlaps().

     {
       return std::min(MaxY(), other.MaxY()) > std::max(MinY(), other.MinY());
     }

bool geo::BoxBoundedGeo::OverlapsZ ( geo::BoxBoundedGeo const & other ) const

inlineinherited

Returns if the z coordinates covered by this and other box overlap.

Definition at line 334 of file BoxBoundedGeo.h.

References geo::BoxBoundedGeo::MaxZ(), and geo::BoxBoundedGeo::MinZ().

Referenced by geo::BoxBoundedGeo::Overlaps().

     {
       return std::min(MaxZ(), other.MaxZ()) > std::max(MinZ(), other.MinZ());
     }

TPCGeo const & geo::CryostatGeo::PositionToTPC	(	geo::Point_t const &	point,
		double	wiggle
	)		const

Returns the ID of the TPC at specified location.

Parameters

point	the location (world reference frame)
wiggle	a small factor (like 1+epsilon) to avoid rounding errors

Returns: the ID of the TPC at the specified point (invalid ID if none)

Definition at line 122 of file CryostatGeo.cxx.

References ID(), and PositionToTPCptr().

Referenced by GetElementPtr(), and PositionToTPC().

   {
     geo::TPCGeo const* tpc = PositionToTPCptr(point, wiggle);
     if (!tpc) {
       throw cet::exception("CryostatGeo")
         << "Can't find any TPC for position " << point << " within " << ID() << "\n";
     }
     return *tpc;
   }

TPCGeo const& geo::CryostatGeo::PositionToTPC	(	double const	worldLoc[3],
		double	wiggle
	)		const

inline

Returns the ID of the TPC at specified location.

Parameters

worldLoc	3D coordinates of the point (world reference frame)
wiggle	a small factor (like 1+epsilon) to avoid rounding errors

Returns: the ID of the TPC at the specified point (invalid ID if none)

Definition at line 294 of file CryostatGeo.h.

References geo::vect::makePointFromCoords(), MaxPlanes(), MaxWires(), PositionToTPC(), and PositionToTPCptr().

     {
       return PositionToTPC(geo::vect::makePointFromCoords(worldLoc), wiggle);
     }

geo::TPCID geo::CryostatGeo::PositionToTPCID	(	geo::Point_t const &	point,
		double	wiggle
	)		const

Returns the ID of the TPC at specified location.

Parameters

point	3D coordinates of the point (world reference frame)
wiggle	a small factor (like 1+epsilon) to avoid rounding errors

Returns: the ID of the TPC at the specified point (invalid ID if none)

Definition at line 113 of file CryostatGeo.cxx.

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

Referenced by geo::GeometryCore::FindTPCAtPosition(), and GetElementPtr().

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

geo::TPCGeo const * geo::CryostatGeo::PositionToTPCptr	(	geo::Point_t const &	point,
		double	wiggle
	)		const

Returns a pointer to the TPC at specified location.

Parameters

point	position in space [cm]
wiggle	a small factor (like 1+ε) to avoid rounding errors

Returns: a pointer to the geo::TPCGeo at point (nullptr if none)

Definition at line 133 of file CryostatGeo.cxx.

References IterateTPCs().

Referenced by PositionToTPC(), PositionToTPCID(), and geo::GeometryCore::PositionToTPCptr().

   {
     for (auto const& tpc : IterateTPCs())
       if (tpc.ContainsPosition(point, wiggle)) return &tpc;
     return nullptr;
   } // CryostatGeo::PositionToTPCptr()

template<typename Stream >

void geo::CryostatGeo::PrintCryostatInfo	(	Stream &&	out,
		std::string	indent = `""`,
		unsigned int	verbosity = `1`
	)		const

Prints information about this cryostat.

Template Parameters

Stream type of output stream to use

Parameters

out	stream to send the information to
indent	prepend each line with this string
verbosity	amount of information printed

Note that the first line out the output is not indented.

Verbosity levels

0: only cryostat ID
1 _(default)_: also center and size
2: also number of TPCs, optical detectors, and maximum wires per plane
and of planes for TPC
3: also information on bounding box

The constant MaxVerbosity is set to the highest supported verbosity level.

Definition at line 406 of file CryostatGeo.h.

References BoundingBox(), GetCenter(), Height(), ID(), Length(), geo::BoxBoundedGeo::Max(), MaxPlanes(), MaxWires(), geo::BoxBoundedGeo::Min(), NOpDet(), NTPC(), and Width().

Referenced by CryostatInfo(), and ID().

 {
 
   //----------------------------------------------------------------------------
   out << "Cryostat " << std::string(ID());
 
   if (verbosity-- <= 0) return; // 0
 
   //----------------------------------------------------------------------------
   out << " (" << Width() << " x " << Height() << " x " << Length() << ") cm^3 at " << GetCenter();
 
   if (verbosity-- <= 0) return; // 1
 
   //----------------------------------------------------------------------------
 
   out << "\n"
       << indent << "hosts " << NTPC() << " TPCs (largest number of planes: " << MaxPlanes()
       << ", of wires: " << MaxWires() << ") and " << NOpDet() << " optical detectors";
 
   if (verbosity-- <= 0) return; // 2
 
   //----------------------------------------------------------------------------
   // print also the containing box
   geo::BoxBoundedGeo const& box = BoundingBox();
   out << "\n" << indent << "bounding box: " << box.Min() << " -- " << box.Max();
 
   //  if (verbosity-- <= 0) return; // 3
 
   //----------------------------------------------------------------------------
 } // geo::CryostatGeo::PrintCryostatInfo()

static void geo::BoxBoundedGeo::set_max	(	Coord_t &	var,
		Coord_t	value
	)

inlinestaticinherited

Sets var to value if value is larger than the current var value.

Definition at line 479 of file BoxBoundedGeo.h.

References value.

Referenced by geo::BoxBoundedGeo::ExtendToInclude().

     {
       if (value > var) var = value;
     }

static void geo::BoxBoundedGeo::set_max	(	Coords_t &	var,
		geo::Point_t const &	value
	)

inlinestaticinherited

Sets each coordinate of var to the one in value if the latter is larger.

Definition at line 493 of file BoxBoundedGeo.h.

     {
       if (value.X() > var.X()) var.SetX(value.X());
       if (value.Y() > var.Y()) var.SetY(value.Y());
       if (value.Z() > var.Z()) var.SetZ(value.Z());
     }

static void geo::BoxBoundedGeo::set_min	(	Coord_t &	var,
		Coord_t	value
	)

inlinestaticinherited

Sets var to value if value is smaller than the current var value.

Definition at line 473 of file BoxBoundedGeo.h.

References value.

Referenced by geo::BoxBoundedGeo::ExtendToInclude().

     {
       if (value < var) var = value;
     }

static void geo::BoxBoundedGeo::set_min	(	Coords_t &	var,
		geo::Point_t const &	value
	)

inlinestaticinherited

Sets each coordinate of var to the one in value if the latter is smaller.

Definition at line 485 of file BoxBoundedGeo.h.

     {
       if (value.X() < var.X()) var.SetX(value.X());
       if (value.Y() < var.Y()) var.SetY(value.Y());
       if (value.Z() < var.Z()) var.SetZ(value.Z());
     }

void geo::BoxBoundedGeo::SetBoundaries	(	Coord_t	x_min,
		Coord_t	x_max,
		Coord_t	y_min,
		Coord_t	y_max,
		Coord_t	z_min,
		Coord_t	z_max
	)

inlineinherited

Sets the boundaries in world coordinates as specified.

Parameters

x_min	lower x coordinate
x_max	upper x coordinate
y_min	lower y coordinate
y_max	upper y coordinate
z_min	lower z coordinate
z_max	upper z coordinate

Definition at line 393 of file BoxBoundedGeo.h.

References geo::BoxBoundedGeo::c_max, geo::BoxBoundedGeo::c_min, and geo::BoxBoundedGeo::SortCoordinates().

Referenced by geo::PlaneGeo::BoundingBox(), InitCryoBoundaries(), and geo::TPCGeo::InitTPCBoundaries().

     {
       c_min.SetXYZ(x_min, y_min, z_min);
       c_max.SetXYZ(x_max, y_max, z_max);
       SortCoordinates();
     }

void geo::BoxBoundedGeo::SetBoundaries	(	Coords_t	lower,
		Coords_t	upper
	)

inlineinherited

Sets the boundaries in world coordinates as specified.

Parameters

lower	lower coordinates (x, y, z)
upper	upper coordinates (x, y, z)

Definition at line 410 of file BoxBoundedGeo.h.

References geo::BoxBoundedGeo::c_max, geo::BoxBoundedGeo::c_min, and geo::BoxBoundedGeo::SortCoordinates().

     {
       c_min = lower;
       c_max = upper;
       SortCoordinates();
     }

double geo::BoxBoundedGeo::SizeX ( ) const

inlineinherited

Returns the full size in the X dimension.

Definition at line 99 of file BoxBoundedGeo.h.

References geo::BoxBoundedGeo::MaxX(), and geo::BoxBoundedGeo::MinX().

Referenced by geo::BoxBoundedGeo::HalfSizeX().

99 { return MaxX() - MinX(); }

geo::BoxBoundedGeo::MinX

double MinX() const

Returns the world x coordinate of the start of the box.

Definition: BoxBoundedGeo.h:90

geo::BoxBoundedGeo::MaxX

double MaxX() const

Returns the world x coordinate of the end of the box.

Definition: BoxBoundedGeo.h:93

double geo::BoxBoundedGeo::SizeY ( ) const

inlineinherited

Returns the full size in the Y dimension.

Definition at line 114 of file BoxBoundedGeo.h.

References geo::BoxBoundedGeo::MaxY(), and geo::BoxBoundedGeo::MinY().

Referenced by geo::BoxBoundedGeo::HalfSizeY().

114 { return MaxY() - MinY(); }

geo::BoxBoundedGeo::MaxY

double MaxY() const

Returns the world y coordinate of the end of the box.

Definition: BoxBoundedGeo.h:108

geo::BoxBoundedGeo::MinY

double MinY() const

Returns the world y coordinate of the start of the box.

Definition: BoxBoundedGeo.h:105

double geo::BoxBoundedGeo::SizeZ ( ) const

inlineinherited

Returns the full size in the Z dimension.

Definition at line 129 of file BoxBoundedGeo.h.

References geo::BoxBoundedGeo::MaxZ(), and geo::BoxBoundedGeo::MinZ().

Referenced by geo::BoxBoundedGeo::HalfSizeZ().

129 { return MaxZ() - MinZ(); }

geo::BoxBoundedGeo::MinZ

double MinZ() const

Returns the world z coordinate of the start of the box.

Definition: BoxBoundedGeo.h:120

geo::BoxBoundedGeo::MaxZ

double MaxZ() const

Returns the world z coordinate of the end of the box.

Definition: BoxBoundedGeo.h:123

void geo::CryostatGeo::SortSubVolumes ( geo::GeoObjectSorter const & sorter )

Method to sort TPCGeo objects.

Definition at line 55 of file CryostatGeo.cxx.

References fOpDets, fTPCs, geo::GeoObjectSorter::SortOpDets(), geo::TPCGeo::SortSubVolumes(), geo::GeoObjectSorter::SortTPCs(), and TPC().

Referenced by toLocalCoords().

   {
     sorter.SortTPCs(fTPCs);
 
     for (geo::TPCGeo& TPC : fTPCs) {
       TPC.SortSubVolumes(sorter);
     }
 
     sorter.SortOpDets(fOpDets);
   } // CryostatGeo::SortSubVolumes()

LocalPoint_t geo::CryostatGeo::toLocalCoords ( geo::Point_t const & world ) const

inline

Transform point from world frame to local cryostat frame.

Definition at line 359 of file CryostatGeo.h.

References fTrans, and geo::LocalTransformationGeo< StoredMatrix, LocalPoint, LocalVector >::toLocalCoords().

     {
       return fTrans.toLocalCoords(world);
     }

LocalVector_t geo::CryostatGeo::toLocalCoords ( geo::Vector_t const & world ) const

inline

Transform direction vector from world to local.

Definition at line 365 of file CryostatGeo.h.

References FindOpDet(), FindTPC(), fTrans, InitCryoBoundaries(), MakeOpDet(), MakeTPC(), SortSubVolumes(), geo::LocalTransformationGeo< StoredMatrix, LocalPoint, LocalVector >::toLocalCoords(), and UpdateAfterSorting().

     {
       return fTrans.toLocalCoords(world);
     }

geo::Point_t geo::CryostatGeo::toWorldCoords ( LocalPoint_t const & local ) const

inline

Transform point from local cryostat frame to world frame.

Definition at line 347 of file CryostatGeo.h.

References fTrans, and geo::LocalTransformationGeo< StoredMatrix, LocalPoint, LocalVector >::toWorldCoords().

Referenced by InitCryoBoundaries(), and geo::sortCryoStandard().

     {
       return fTrans.toWorldCoords(local);
     }

geo::Vector_t geo::CryostatGeo::toWorldCoords ( LocalVector_t const & local ) const

inline

Transform direction vector from local to world.

Definition at line 353 of file CryostatGeo.h.

References fTrans, and geo::LocalTransformationGeo< StoredMatrix, LocalPoint, LocalVector >::toWorldCoords().

     {
       return fTrans.toWorldCoords(local);
     }

const TPCGeo & geo::CryostatGeo::TPC ( unsigned int itpc ) const

Return the itpc'th TPC in the cryostat.

Exceptions

cet::exception (category "TPCOutOfRange") if no such TPC

Definition at line 84 of file CryostatGeo.cxx.

References TPCPtr().

Referenced by geo::buildDriftVolumes(), GetElement(), groupTPCsByDriftDir(), HasElement(), geo::ChannelMapStandardAlg::Initialize(), trkf::SpacePointAlg::makeSpacePoints(), MaxPlanes(), MaxWires(), phot::PhotonVisibilityService::reconfigure(), SortSubVolumes(), and geo::GeometryCore::TPC().

   {
     TPCGeo const* pTPC = TPCPtr(itpc);
     if (!pTPC) {
       throw cet::exception("TPCOutOfRange") << "Request for non-existant TPC " << itpc << "\n";
     }
 
     return *pTPC;
   }

const TPCGeo& geo::CryostatGeo::TPC ( TPCID const & tpcid ) const

inline

Returns the TPC in tpcid from this cryostat.

Parameters

tpcid full TPC ID

Returns: a constant reference to the TPC in tpcid

Exceptions

cet::exception (category "TPCOutOfRange") if no such TPC

The cryostat number in tpcid is ignored, as it is ignored whether tpcid is invalid.

Definition at line 214 of file CryostatGeo.h.

References TPC(), and geo::TPCID::TPC.

Referenced by TPC().

214 { return TPC(tpcid.TPC); }

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::CryostatGeo::TPCPtr ( unsigned int itpc ) const

inline

Returns the TPC number itpc from this cryostat.

Parameters

itpc	the number of local TPC

Returns: a constant pointer to the TPC, or nullptr if it does not exist

Definition at line 256 of file CryostatGeo.h.

References fTPCs, and HasTPC().

Referenced by GetElementPtr(), TPC(), and geo::GeometryCore::TPCPtr().

     {
       return HasTPC(itpc) ? &(fTPCs[itpc]) : nullptr;
     }

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

inline

Returns the TPC in tpcid from this cryostat.

Parameters

tpcid full TPC ID

Returns: a constant pointer to the TPC, or nullptr if it does not exist

The cryostat number in tpcid is ignored, as it is ignored whether tpcid is invalid.

Definition at line 269 of file CryostatGeo.h.

References geo::TPCID::TPC, and TPCPtr().

Referenced by TPCPtr().

269 { return TPCPtr(tpcid.TPC); }

geo::CryostatGeo::TPCPtr

TPCGeo const * TPCPtr(unsigned int itpc) const

Returns the TPC number itpc from this cryostat.

Definition: CryostatGeo.h:256

void geo::CryostatGeo::UpdateAfterSorting ( geo::CryostatID cryoid )

Performs all needed updates after geometry has sorted the cryostats.

Definition at line 67 of file CryostatGeo.cxx.

References fID, fOpDets, fTPCs, NOpDet(), and NTPC().

Referenced by toLocalCoords().

   {
 
     // update the cryostat ID
     fID = cryoid;
 
     // trigger all the optical detectors to update
     for (unsigned int opdet = 0; opdet < NOpDet(); ++opdet)
       fOpDets[opdet].UpdateAfterSorting(geo::OpDetID(fID, opdet));
 
     // trigger all the TPCs to update as well
     for (unsigned int tpc = 0; tpc < NTPC(); ++tpc)
       fTPCs[tpc].UpdateAfterSorting(geo::TPCID(fID, tpc));
 
   } // CryostatGeo::UpdateAfterSorting()