geo::AuxDetSensitiveGeo Class Reference

#include "AuxDetSensitiveGeo.h"

Classes
struct	AuxDetSensitiveGeoCoordinatesTag

Public Types
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::AuxDetSensitiveGeo have the same type but are not compatible.
using	LocalPoint_t = Point3DBase_t< AuxDetSensitiveGeoCoordinatesTag >
	Type of points in the local GDML auxiliary detector frame. More...
using	LocalVector_t = Vector3DBase_t< AuxDetSensitiveGeoCoordinatesTag >
	Type of displacement vectors in the local GDML auxiliary detector frame. More...

Public Member Functions
	AuxDetSensitiveGeo (TGeoNode const *node, TransformationMatrix &&trans)
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...
double	Length () const
double	HalfLength () const
double	HalfWidth1 () const
double	HalfWidth2 () const
double	HalfCenterWidth () const
double	HalfHeight () const
const TGeoVolume *	TotalVolume () const
template<typename Stream >
void	PrintAuxDetInfo (Stream &&out, std::string indent="", unsigned int verbosity=0) const
	Prints information about this auxiliary sensitive detector. More...
std::string	AuxDetInfo (std::string indent="", unsigned int verbosity=1) const
	Returns a string with auxiliary sensitive detector information. More...
Length_t	DistanceToPoint (Point_t const &point) const
	Returns the distance of point from the center of the detector. More...
Length_t	DistanceToPoint (double 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...

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

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

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

Private Attributes
LocalTransformation_t	fTrans
	Auxiliary detector-to-world transformation. More...
const TGeoVolume *	fTotalVolume
	Total volume of AuxDet, called vol*. 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...

Detailed Description

Definition at line 32 of file AuxDetSensitiveGeo.h.

Member Typedef Documentation

using geo::AuxDetSensitiveGeo::LocalPoint_t = Point3DBase_t<AuxDetSensitiveGeoCoordinatesTag>

Type of points in the local GDML auxiliary detector frame.

Definition at line 55 of file AuxDetSensitiveGeo.h.

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

private

Definition at line 143 of file AuxDetSensitiveGeo.h.

using geo::AuxDetSensitiveGeo::LocalVector_t = Vector3DBase_t<AuxDetSensitiveGeoCoordinatesTag>

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

Definition at line 58 of file AuxDetSensitiveGeo.h.

Constructor & Destructor Documentation

geo::AuxDetSensitiveGeo::AuxDetSensitiveGeo	(	TGeoNode const *	node,
		TransformationMatrix &&	trans
	)

Definition at line 27 of file AuxDetSensitiveGeo.cxx.

References fTotalVolume, InitShapeSize(), and MF_LOG_DEBUG.

    : fTrans(std::move(trans)), fTotalVolume(node->GetVolume())
  {

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

    InitShapeSize();
  }

Member Function Documentation

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

Returns a string with auxiliary sensitive detector information.

See also

PrintAuxDetInfo()

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

Definition at line 57 of file AuxDetSensitiveGeo.cxx.

References PrintAuxDetInfo().

Referenced by toLocalCoords().

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

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

inline

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

Definition at line 86 of file AuxDetSensitiveGeo.h.

Referenced by DistanceToPoint(), and TotalVolume().

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

Length_t geo::AuxDetSensitiveGeo::DistanceToPoint

(

double const *

point

)

const

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

Definition at line 51 of file AuxDetSensitiveGeo.cxx.

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

  {
    return DistanceToPoint(vect::makePointFromCoords(point));
  }

Point_t geo::AuxDetSensitiveGeo::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 37 of file AuxDetSensitiveGeo.cxx.

References toWorldCoords().

Referenced by PrintAuxDetInfo(), and TotalVolume().

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

Vector_t geo::AuxDetSensitiveGeo::GetNormalVector

(

)

const

Returns the unit normal vector to the detector.

Definition at line 45 of file AuxDetSensitiveGeo.cxx.

References toWorldCoords().

Referenced by PrintAuxDetInfo().

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

double geo::AuxDetSensitiveGeo::HalfCenterWidth ( ) const

inline

Definition at line 80 of file AuxDetSensitiveGeo.h.

References HalfWidth1(), and HalfWidth2().

{ return (HalfWidth1() + HalfWidth2()) / 2.0; }

double geo::AuxDetSensitiveGeo::HalfHeight ( ) const

inline

Definition at line 81 of file AuxDetSensitiveGeo.h.

References fHalfHeight.

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

{ return fHalfHeight; }

double geo::AuxDetSensitiveGeo::HalfLength ( ) const

inline

Definition at line 77 of file AuxDetSensitiveGeo.h.

References Length().

{ return Length() / 2.0; }

double geo::AuxDetSensitiveGeo::HalfWidth1 ( ) const

inline

Definition at line 78 of file AuxDetSensitiveGeo.h.

References fHalfWidth1.

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

{ return fHalfWidth1; }

double geo::AuxDetSensitiveGeo::HalfWidth2 ( ) const

inline

Definition at line 79 of file AuxDetSensitiveGeo.h.

References fHalfWidth2.

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

{ return fHalfWidth2; }

void geo::AuxDetSensitiveGeo::InitShapeSize ( )

private

Extracts the size of the detector from the geometry information.

Definition at line 66 of file AuxDetSensitiveGeo.cxx.

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

Referenced by AuxDetSensitiveGeo().

  {
    // 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::AuxDetSensitiveGeo::Length ( ) const

inline

Definition at line 76 of file AuxDetSensitiveGeo.h.

References fLength.

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

{ return fLength; }

template<typename Stream >

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

Prints information about this auxiliary sensitive 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 _(default)_: only center
• 1: also size
• 2: also normal direction

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

Definition at line 166 of file AuxDetSensitiveGeo.h.

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

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

{

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

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

  //----------------------------------------------------------------------------
  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; // 1

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

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

  //----------------------------------------------------------------------------

} // geo::AuxDetSensitiveGeo::PrintAuxDetInfo()

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

inline

Transform point from world frame to local auxiliary detector frame.

Definition at line 100 of file AuxDetSensitiveGeo.h.

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

Referenced by geo::AuxDetReadoutGeom::NearestSensitiveAuxDet().

{ return fTrans.toLocalCoords(world); }

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

inline

Transform direction vector from world to local.

Definition at line 103 of file AuxDetSensitiveGeo.h.

References AuxDetInfo(), fTrans, art::detail::indent(), PrintAuxDetInfo(), and geo::LocalTransformationGeo< StoredMatrix, LocalPoint, LocalVector >::toLocalCoords().

{ return fTrans.toLocalCoords(world); }

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

inline

Definition at line 82 of file AuxDetSensitiveGeo.h.

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

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

{ return fTotalVolume; }

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

inline

Transform point from local auxiliary detector frame to world frame.

Definition at line 94 of file AuxDetSensitiveGeo.h.

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

Referenced by GetCenter(), and GetNormalVector().

{ return fTrans.toWorldCoords(local); }

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

inline

Transform direction vector from local to world.

Definition at line 97 of file AuxDetSensitiveGeo.h.

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

{ return fTrans.toWorldCoords(local); }

Member Data Documentation

double geo::AuxDetSensitiveGeo::fHalfHeight

private

half height of volume

Definition at line 150 of file AuxDetSensitiveGeo.h.

Referenced by HalfHeight(), and InitShapeSize().

double geo::AuxDetSensitiveGeo::fHalfWidth1

private

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

Definition at line 148 of file AuxDetSensitiveGeo.h.

Referenced by HalfWidth1(), and InitShapeSize().

double geo::AuxDetSensitiveGeo::fHalfWidth2

private

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

Definition at line 149 of file AuxDetSensitiveGeo.h.

Referenced by HalfWidth2(), and InitShapeSize().

double geo::AuxDetSensitiveGeo::fLength

private

length of volume, along z direction in local

Definition at line 147 of file AuxDetSensitiveGeo.h.

Referenced by InitShapeSize(), and Length().

const TGeoVolume* geo::AuxDetSensitiveGeo::fTotalVolume

private

Total volume of AuxDet, called vol*.

Definition at line 146 of file AuxDetSensitiveGeo.h.

Referenced by AuxDetSensitiveGeo(), InitShapeSize(), and TotalVolume().

LocalTransformation_t geo::AuxDetSensitiveGeo::fTrans

private

Auxiliary detector-to-world transformation.

Definition at line 145 of file AuxDetSensitiveGeo.h.

Referenced by toLocalCoords(), and toWorldCoords().

constexpr unsigned int geo::AuxDetSensitiveGeo::MaxVerbosity = 2

static

Maximum verbosity supported by PrintAuxDetInfo().

Definition at line 139 of file AuxDetSensitiveGeo.h.

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

---

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

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