geo::AuxDetGeo Class Reference

#include "AuxDetGeo.h"

Classes
struct	AuxDetGeoCoordinatesTag
	Tag for vectors in the "local" GDML coordinate frame of the auxiliary detector. More...

Public Types
using	AuxDetSensitiveList_t = std::vector< AuxDetSensitiveGeo >
	Type of list of sensitive volumes. More...
Types for geometry-local reference vectors.
These types represents points and displacement vectors in the reference frame defined in the auxiliary detector 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::AuxDetGeo have the same type but are not compatible.
using	LocalPoint_t = Point3DBase_t< AuxDetGeoCoordinatesTag >
	Type of points in the local GDML auxiliary detector frame. More...
using	LocalVector_t = Vector3DBase_t< AuxDetGeoCoordinatesTag >
	Type of displacement vectors in the local GDML auxiliary detector frame. More...

Public Member Functions
	AuxDetGeo (TGeoNode const *node, TransformationMatrix &&trans, AuxDetSensitiveList_t &&sensitive)
Point_t	GetCenter (double localz=0.0) const
	Returns the geometric center of the sensitive volume. More...
Vector_t	GetNormalVector () const
	Returns the unit normal vector to the detector. More...
std::string	Name () const
AuxDetSensitiveGeo const &	SensitiveVolume (size_t sv) const
size_t	NSensitiveVolume () const
void	SortSubVolumes (AuxDetGeoObjectSorter &sorter)
template<typename Stream >
void	PrintAuxDetInfo (Stream &&out, std::string indent="", unsigned int verbosity=1) const
	Prints information about this auxiliary detector. More...
std::string	AuxDetInfo (std::string indent="", unsigned int verbosity=1) const
	Returns a string with auxiliary detector information. More...
Box geometry
double	Length () const
	Returns the distance of point from the center of the detector. More...
double	HalfWidth1 () const
	Returns the distance of point from the center of the detector. More...
double	HalfWidth2 () const
	Returns the distance of point from the center of the detector. More...
double	HalfHeight () const
	Returns the distance of point from the center of the detector. More...
const TGeoVolume *	TotalVolume () const
	Returns the distance of point from the center of the detector. More...
Length_t	DistanceToPoint (Point_t const &point) const
	Returns the distance of point from the center of the detector. More...
Coordinate transformation
Point_t	toWorldCoords (LocalPoint_t const &local) const
	Transform point from local auxiliary detector frame to world frame. More...
Vector_t	toWorldCoords (LocalVector_t const &local) const
	Transform direction vector from local to world. More...
LocalPoint_t	toLocalCoords (Point_t const &world) const
	Transform point from world frame to local auxiliary detector frame. More...
LocalVector_t	toLocalCoords (Vector_t const &world) const
	Transform direction vector from world to local. More...
Access to the sensitive volumes in the detector
std::size_t	FindSensitiveVolume (Point_t const &point) const
AuxDetSensitiveGeo const &	PositionToSensitiveVolume (Point_t const &point, size_t &sv) const

Static Public Attributes
static constexpr unsigned int	MaxVerbosity = 4
	Maximum verbosity supported by PrintAuxDetInfo(). More...

Private Types
using	LocalTransformation_t = LocalTransformationGeo< TransformationMatrix, LocalPoint_t, LocalVector_t >

Private Member Functions
void	InitShapeSize ()
	Extracts the size of the detector from the geometry information. More...

Private Attributes
TGeoVolume const *	fTotalVolume
	Total volume of AuxDet, called vol*. More...
LocalTransformation_t	fTrans
	Auxiliary detector-to-world transformation. More...
double	fLength
	length of volume, along z direction in local More...
double	fHalfWidth1
	1st half width of volume, at -z/2 in local coordinates More...
double	fHalfWidth2
	2nd half width (width1==width2 for boxes), at +z/2 More...
double	fHalfHeight
	half height of volume More...
std::vector< AuxDetSensitiveGeo >	fSensitive
	sensitive volumes in the detector More...

Detailed Description

Definition at line 36 of file AuxDetGeo.h.

Member Typedef Documentation

using geo::AuxDetGeo::AuxDetSensitiveList_t = std::vector<AuxDetSensitiveGeo>

Type of list of sensitive volumes.

Definition at line 39 of file AuxDetGeo.h.

using geo::AuxDetGeo::LocalPoint_t = Point3DBase_t<AuxDetGeoCoordinatesTag>

Type of points in the local GDML auxiliary detector frame.

Definition at line 59 of file AuxDetGeo.h.

using geo::AuxDetGeo::LocalTransformation_t = LocalTransformationGeo<TransformationMatrix, LocalPoint_t, LocalVector_t>

private

Definition at line 166 of file AuxDetGeo.h.

using geo::AuxDetGeo::LocalVector_t = Vector3DBase_t<AuxDetGeoCoordinatesTag>

Type of displacement vectors in the local GDML auxiliary detector frame.

Definition at line 62 of file AuxDetGeo.h.

Constructor & Destructor Documentation

geo::AuxDetGeo::AuxDetGeo	(	TGeoNode const *	node,
		TransformationMatrix &&	trans,
		AuxDetSensitiveList_t &&	sensitive
	)

Definition at line 32 of file AuxDetGeo.cxx.

References fSensitive, fTotalVolume, fTrans, InitShapeSize(), geo::LocalTransformation< StoredMatrix >::Matrix(), and MF_LOG_DEBUG.

    : fTotalVolume(node->GetVolume()), fTrans(std::move(trans)), fSensitive(std::move(sensitive))
  {
    if (!fTotalVolume) throw cet::exception("AuxDetGeo") << "cannot find AuxDet volume\n";

    MF_LOG_DEBUG("Geometry") << "detector total  volume is " << fTotalVolume->GetName();

    // if there are no sensitive volumes then this aux det
    // could be from an older gdml file than the introduction of AuxDetSensitiveGeo
    // in that case assume the full AuxDetGeo is sensitive and copy its information
    // into a single AuxDetSensitive
    if (fSensitive.empty()) fSensitive.emplace_back(node, TransformationMatrix(fTrans.Matrix()));

    InitShapeSize();
  }

Member Function Documentation

std::string geo::AuxDetGeo::AuxDetInfo	(	std::string	indent = "",
		unsigned int	verbosity = 1
	)		const

Returns a string with auxiliary detector information.

See also

PrintAuxDetInfo()

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

Definition at line 108 of file AuxDetGeo.cxx.

References PrintAuxDetInfo().

Referenced by NSensitiveVolume().

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

Length_t geo::AuxDetGeo::DistanceToPoint ( Point_t const &  point ) const

inline

Returns the distance of point from the center of the detector.

Definition at line 92 of file AuxDetGeo.h.

Referenced by TotalVolume().

{ return (point - GetCenter()).R(); }

std::size_t geo::AuxDetGeo::FindSensitiveVolume

(

Point_t const &

point

)

const

Definition at line 65 of file AuxDetGeo.cxx.

References fSensitive, and SensitiveVolume().

Referenced by Name(), and PositionToSensitiveVolume().

  {
    for (std::size_t a = 0; a < fSensitive.size(); ++a) {
      auto const& sensVol = SensitiveVolume(a);

      auto const local = sensVol.toLocalCoords(point);

      double const HalfCenterWidth = sensVol.HalfCenterWidth();

      double const deltaWidth =
        local.Z() * (HalfCenterWidth - sensVol.HalfWidth2()) / sensVol.HalfLength();

      if (local.Z() >= -sensVol.HalfLength() && local.Z() <= sensVol.HalfLength() &&
          local.Y() >= -sensVol.HalfHeight() && local.Y() <= sensVol.HalfHeight() &&
          // if SensitiveVolume a is a box, then HalfSmallWidth = HalfWidth
          local.X() >= -HalfCenterWidth + deltaWidth && local.X() <= HalfCenterWidth - deltaWidth)
        return a;

    } // for loop over AuxDetSensitive a

    throw cet::exception("AuxDetGeo")
      << "Can't find AuxDetSensitive for position " << point << "\n";
  } // AuxDetGeo::FindSensitiveVolume(geo::Point_t)

Point_t geo::AuxDetGeo::GetCenter

(

double

localz = 0.0

)

const

Returns the geometric center of the sensitive volume.

Parameters

localz

(default: 0) distance from the center along the length of the volume (z) [cm]

Returns

the geometric center of the sensitive volume [cm]

Definition at line 51 of file AuxDetGeo.cxx.

References toWorldCoords().

Referenced by PrintAuxDetInfo(), and TotalVolume().

  {
    return toWorldCoords(LocalPoint_t{0.0, 0.0, localz});
  }

Vector_t geo::AuxDetGeo::GetNormalVector

(

)

const

Returns the unit normal vector to the detector.

Definition at line 59 of file AuxDetGeo.cxx.

References toWorldCoords().

Referenced by PrintAuxDetInfo().

  {
    return toWorldCoords(Zaxis<LocalVector_t>());
  }

double geo::AuxDetGeo::HalfHeight ( ) const

inline

Returns the distance of point from the center of the detector.

Definition at line 86 of file AuxDetGeo.h.

References fHalfHeight.

Referenced by PrintAuxDetInfo().

{ return fHalfHeight; }

double geo::AuxDetGeo::HalfWidth1 ( ) const

inline

Returns the distance of point from the center of the detector.

Definition at line 84 of file AuxDetGeo.h.

References fHalfWidth1.

Referenced by PrintAuxDetInfo().

{ return fHalfWidth1; }

double geo::AuxDetGeo::HalfWidth2 ( ) const

inline

Returns the distance of point from the center of the detector.

Definition at line 85 of file AuxDetGeo.h.

References fHalfWidth2.

Referenced by PrintAuxDetInfo().

{ return fHalfWidth2; }

void geo::AuxDetGeo::InitShapeSize ( )

private

Extracts the size of the detector from the geometry information.

Definition at line 117 of file AuxDetGeo.cxx.

References fHalfHeight, fHalfWidth1, fHalfWidth2, fLength, and fTotalVolume.

Referenced by AuxDetGeo().

  {
    // set the ends depending on whether the shape is a box or trapezoid
    std::string volName(fTotalVolume->GetName());
    if (volName.find("Trap") != std::string::npos) {

      //       Small Width
      //          ____          Height is the thickness
      //         /    \     T     of the trapezoid
      //        /      \    |
      //       /        \   | Length
      //      /__________\  _
      //         Width
      fHalfHeight = ((TGeoTrd2*)fTotalVolume->GetShape())->GetDy1(); // same as Dy2()
      fLength = 2.0 * ((TGeoTrd2*)fTotalVolume->GetShape())->GetDz();
      fHalfWidth1 = ((TGeoTrd2*)fTotalVolume->GetShape())->GetDx1(); // at -Dz
      fHalfWidth2 = ((TGeoTrd2*)fTotalVolume->GetShape())->GetDx2(); // at +Dz
    }
    else {
      fHalfWidth1 = ((TGeoBBox*)fTotalVolume->GetShape())->GetDX();
      fHalfHeight = ((TGeoBBox*)fTotalVolume->GetShape())->GetDY();
      fLength = 2.0 * ((TGeoBBox*)fTotalVolume->GetShape())->GetDZ();
      fHalfWidth2 = fHalfWidth1;
    }
  }

double geo::AuxDetGeo::Length ( ) const

inline

Returns the distance of point from the center of the detector.

Definition at line 83 of file AuxDetGeo.h.

References fLength.

Referenced by PrintAuxDetInfo().

{ return fLength; }

std::string geo::AuxDetGeo::Name ( ) const

inline

Definition at line 112 of file AuxDetGeo.h.

References FindSensitiveVolume(), fTotalVolume, and PositionToSensitiveVolume().

Referenced by PrintAuxDetInfo().

{ return fTotalVolume->GetName(); }

size_t geo::AuxDetGeo::NSensitiveVolume ( ) const

inline

Definition at line 124 of file AuxDetGeo.h.

References AuxDetInfo(), fSensitive, art::detail::indent(), PrintAuxDetInfo(), and SortSubVolumes().

Referenced by geo::WireReadoutDumper::dumpAuxiliaryDetectors(), geo::AuxDetReadoutGeom::NearestSensitiveAuxDet(), and PrintAuxDetInfo().

{ return fSensitive.size(); }

AuxDetSensitiveGeo const & geo::AuxDetGeo::PositionToSensitiveVolume	(	Point_t const &	point,
		size_t &	sv
	)		const

Definition at line 90 of file AuxDetGeo.cxx.

References FindSensitiveVolume(), and SensitiveVolume().

Referenced by Name().

  {
    sv = FindSensitiveVolume(point);
    if (sv == std::numeric_limits<std::size_t>::max()) {
      throw cet::exception("AuxDetGeo")
        << "Can't find AuxDetSensitiveGeo for position " << point << "\n";
    }
    return SensitiveVolume(sv);
  }

template<typename Stream >

void geo::AuxDetGeo::PrintAuxDetInfo	(	Stream &&	out,
		std::string	indent = "",
		unsigned int	verbosity = 1
	)		const

Prints information about this auxiliary detector.

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 detector name
• 1 _(default)_: also center
• 2: also size
• 3: also number of sensitive detectors
• 4: also normal direction

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

Definition at line 189 of file AuxDetGeo.h.

References e, GetCenter(), GetNormalVector(), HalfHeight(), HalfWidth1(), HalfWidth2(), Length(), Name(), lar::util::RealComparisons< RealType >::nonEqual(), and NSensitiveVolume().

Referenced by AuxDetInfo(), geo::WireReadoutDumper::dumpAuxiliaryDetectors(), and NSensitiveVolume().

{
  //----------------------------------------------------------------------------
  out << "\"" << Name() << "\"";

  if (verbosity-- <= 0) return; // 0

  //----------------------------------------------------------------------------
  out << " centered at " << GetCenter() << " cm";

  if (verbosity-- <= 0) return; // 1

  //----------------------------------------------------------------------------
  lar::util::RealComparisons<double> coordIs(1e-4);
  out << ", size ( " << (2.0 * HalfWidth1());
  if (coordIs.nonEqual(HalfWidth1(), HalfWidth2())) out << "/" << (2.0 * HalfWidth2());
  out << " x " << (2.0 * HalfHeight()) << " x " << Length() << " ) cm";

  if (verbosity-- <= 0) return; // 2

  //----------------------------------------------------------------------------
  out << "\n" << indent << "with ";
  switch (NSensitiveVolume()) {
  case 0: out << "no sensitive volume"; break;
  case 1: out << "1 sensitive volume"; break;
  default: out << NSensitiveVolume() << " sensitive volumes"; break;
  } // switch

  if (verbosity-- <= 0) return; // 3

  //----------------------------------------------------------------------------
  out << ", normal facing " << GetNormalVector();

} // geo::AuxDetGeo::PrintAuxDetInfo()

AuxDetSensitiveGeo const& geo::AuxDetGeo::SensitiveVolume ( size_t  sv ) const

inline

Definition at line 123 of file AuxDetGeo.h.

References fSensitive.

Referenced by geo::AuxDetGeometryCore::ChannelToAuxDetSensitive(), geo::WireReadoutDumper::dumpAuxiliaryDetectors(), FindSensitiveVolume(), geo::AuxDetReadoutGeom::NearestSensitiveAuxDet(), and PositionToSensitiveVolume().

{ return fSensitive[sv]; }

void geo::AuxDetGeo::SortSubVolumes

(

AuxDetGeoObjectSorter &

sorter

)

Definition at line 102 of file AuxDetGeo.cxx.

References fSensitive, and geo::AuxDetGeoObjectSorter::sort().

Referenced by NSensitiveVolume().

  {
    sorter.sort(fSensitive);
  }

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

inline

Transform point from world frame to local auxiliary detector frame.

Definition at line 105 of file AuxDetGeo.h.

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

{ return fTrans.toLocalCoords(world); }

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

inline

Transform direction vector from world to local.

Definition at line 108 of file AuxDetGeo.h.

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

{ return fTrans.toLocalCoords(world); }

const TGeoVolume* geo::AuxDetGeo::TotalVolume ( ) const

inline

Returns the distance of point from the center of the detector.

Definition at line 87 of file AuxDetGeo.h.

References DistanceToPoint(), fTotalVolume, and GetCenter().

Referenced by geo::AuxDetGeoObjectSorterStandard::compareAuxDets().

{ return fTotalVolume; }

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

inline

Transform point from local auxiliary detector frame to world frame.

Definition at line 99 of file AuxDetGeo.h.

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

Referenced by GetCenter(), and GetNormalVector().

{ return fTrans.toWorldCoords(local); }

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

inline

Transform direction vector from local to world.

Definition at line 102 of file AuxDetGeo.h.

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

{ return fTrans.toWorldCoords(local); }

Member Data Documentation

double geo::AuxDetGeo::fHalfHeight

private

half height of volume

Definition at line 173 of file AuxDetGeo.h.

Referenced by HalfHeight(), and InitShapeSize().

double geo::AuxDetGeo::fHalfWidth1

private

1st half width of volume, at -z/2 in local coordinates

Definition at line 171 of file AuxDetGeo.h.

Referenced by HalfWidth1(), and InitShapeSize().

double geo::AuxDetGeo::fHalfWidth2

private

2nd half width (width1==width2 for boxes), at +z/2

Definition at line 172 of file AuxDetGeo.h.

Referenced by HalfWidth2(), and InitShapeSize().

double geo::AuxDetGeo::fLength

private

length of volume, along z direction in local

Definition at line 170 of file AuxDetGeo.h.

Referenced by InitShapeSize(), and Length().

std::vector<AuxDetSensitiveGeo> geo::AuxDetGeo::fSensitive

private

sensitive volumes in the detector

Definition at line 174 of file AuxDetGeo.h.

Referenced by AuxDetGeo(), FindSensitiveVolume(), NSensitiveVolume(), SensitiveVolume(), and SortSubVolumes().

TGeoVolume const* geo::AuxDetGeo::fTotalVolume

private

Total volume of AuxDet, called vol*.

Definition at line 168 of file AuxDetGeo.h.

Referenced by AuxDetGeo(), InitShapeSize(), Name(), and TotalVolume().

LocalTransformation_t geo::AuxDetGeo::fTrans

private

Auxiliary detector-to-world transformation.

Definition at line 169 of file AuxDetGeo.h.

Referenced by AuxDetGeo(), toLocalCoords(), and toWorldCoords().

constexpr unsigned int geo::AuxDetGeo::MaxVerbosity = 4

static

Maximum verbosity supported by PrintAuxDetInfo().

Definition at line 162 of file AuxDetGeo.h.

Referenced by geo::WireReadoutDumper::dumpAuxiliaryDetectors().

---

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

• larcorealg/v10_00_02/source/larcorealg/Geometry/AuxDetGeo.h
• larcorealg/v10_00_02/source/larcorealg/Geometry/AuxDetGeo.cxx