geo::OpDetGeo Class Reference

#include "OpDetGeo.h"

Classes
struct	OpDetGeoCoordinatesTag
	Tag for vectors in the "local" GDML coordinate frame of the TPC. More...

Public Types
Types for geometry-local reference vectors.
These types represents points and displacement vectors in the reference frame defined in the optical 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::OpDetGeo have the same type but are not compatible.
using	LocalPoint_t = geo::Point3DBase_t< OpDetGeoCoordinatesTag >
	Type of points in the local GDML TPC frame. More...
using	LocalVector_t = geo::Vector3DBase_t< OpDetGeoCoordinatesTag >
	Type of displacement vectors in the local GDML TPC frame. More...

Public Member Functions
	OpDetGeo (std::vector< const TGeoNode * > &path, int depth)
void	GetCenter (double *xyz, double localz=0.0) const
geo::Point_t const &	GetCenter () const
double	RMin () const
double	RMax () const
double	HalfL () const
double	HalfW () const
double	HalfH () const
double	Length () const
double	Width () const
double	Height () const
double	ThetaZ () const
double	ThetaZ (bool degrees) const
const TGeoNode *	Node () const
	Returns the ROOT object describing the detector geometry. More...
TGeoShape const *	Shape () const
	Returns the geometry object as TGeoShape. More...
bool	isTube () const
	Returns whether the detector shape is a cilynder (TGeoTube). More...
bool	isBar () const
	Returns whether the detector shape is a bar (TGeoBBox). More...
template<typename Stream >
void	PrintOpDetInfo (Stream &&out, std::string indent="", unsigned int verbosity=0) const
	Prints information about this optical detector. More...
double	CosThetaFromNormal (geo::Point_t const &point) const
	Get cos(angle) to normal of this detector - used for solid angle calcs. More...
double	CosThetaFromNormal (double const *xyz) const
	Get cos(angle) to normal of this detector - used for solid angle calcs. More...
double	DistanceToPoint (geo::Point_t const &point) const
	Returns the distance of the specified point from detector center [cm]. More...
double	DistanceToPoint (double const *xyz) const
	Returns the distance of the specified point from detector center [cm]. More...
Coordinate transformation
Local points and displacement vectors are described by the types geo::OpDetGeo::LocalPoint_t and geo::OpDetGeo::LocalVector_t, respectively.
void	LocalToWorld (const double *opdet, double *world) const
	Transform point from local optical detector frame to world frame. More...
geo::Point_t	toWorldCoords (LocalPoint_t const &local) const
	Transform point from local optical detector frame to world frame. More...
void	LocalToWorldVect (const double *opdet, double *world) const
	Transform direction vector from local to world. More...
geo::Vector_t	toWorldCoords (LocalVector_t const &local) const
	Transform direction vector from local to world. More...
void	WorldToLocal (const double *world, double *opdet) const
	Transform point from world frame to local optical detector frame. More...
LocalPoint_t	toLocalCoords (geo::Point_t const &world) const
	Transform point from world frame to local optical detector frame. More...
void	WorldToLocalVect (const double *world, double *opdet) const
	Transform direction vector from world to local. More...
LocalVector_t	toLocalCoords (geo::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 PrintOpDetInfo(). More...

Private Types
using	LocalTransformation_t = geo::LocalTransformationGeo< TGeoHMatrix, LocalPoint_t, LocalVector_t >

Private Member Functions
TGeoTube const *	asTube () const
	Returns the geometry object as TGeoTube, nullptr if not a tube. More...
TGeoBBox const *	asBox () const
	Returns the geometry object as TGeoBBox, nullptr if not a tube. More...

Private Attributes
LocalTransformation_t	fTrans
	Optical-detector-to-world transformation. More...
const TGeoNode *	fOpDetNode
	Pointer to theopdet node. More...
geo::Point_t	fCenter
	Stored geometric center of the optical detector. More...

Detailed Description

Definition at line 33 of file OpDetGeo.h.

Member Typedef Documentation

using geo::OpDetGeo::LocalPoint_t = geo::Point3DBase_t<OpDetGeoCoordinatesTag>

Type of points in the local GDML TPC frame.

Definition at line 55 of file OpDetGeo.h.

using geo::OpDetGeo::LocalTransformation_t = geo::LocalTransformationGeo<TGeoHMatrix, LocalPoint_t, LocalVector_t>

private

Definition at line 176 of file OpDetGeo.h.

using geo::OpDetGeo::LocalVector_t = geo::Vector3DBase_t<OpDetGeoCoordinatesTag>

Type of displacement vectors in the local GDML TPC frame.

Definition at line 58 of file OpDetGeo.h.

Constructor & Destructor Documentation

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

Definition at line 32 of file OpDetGeo.cxx.

References fCenter, fOpDetNode, and toWorldCoords().

    : fTrans(path, depth)
  {
    fOpDetNode = path[depth];
    
    fCenter = toWorldCoords(geo::origin<LocalPoint_t>());
    
  }

Member Function Documentation

TGeoBBox const* geo::OpDetGeo::asBox ( ) const

inlineprivate

Returns the geometry object as TGeoBBox, nullptr if not a tube.

Definition at line 187 of file OpDetGeo.h.

References Shape().

Referenced by HalfH(), HalfL(), HalfW(), and isBar().

      { return dynamic_cast<TGeoBBox const*>(Shape()); }

TGeoTube const* geo::OpDetGeo::asTube ( ) const

inlineprivate

Returns the geometry object as TGeoTube, nullptr if not a tube.

Definition at line 183 of file OpDetGeo.h.

References Shape().

Referenced by isTube(), RMax(), and RMin().

      { return dynamic_cast<TGeoTube const*>(Shape()); }

double geo::OpDetGeo::CosThetaFromNormal

(

geo::Point_t const &

point

)

const

Get cos(angle) to normal of this detector - used for solid angle calcs.

Definition at line 121 of file OpDetGeo.cxx.

References toLocalCoords().

Referenced by CosThetaFromNormal(), Height(), and phot::PhotonVisibilityService::SolidAngleFactor().

                                                                   {
    auto const& local = toLocalCoords(point);
    return local.Z() / local.R();
  }

double geo::OpDetGeo::CosThetaFromNormal

(

double const *

xyz

)

const

Get cos(angle) to normal of this detector - used for solid angle calcs.

Definition at line 125 of file OpDetGeo.cxx.

References CosThetaFromNormal().

    { return CosThetaFromNormal(geo::vect::makeFromCoords<geo::Point_t>(xyz)); }

double geo::OpDetGeo::DistanceToPoint

(

geo::Point_t const &

point

)

const

Returns the distance of the specified point from detector center [cm].

Definition at line 114 of file OpDetGeo.cxx.

References GetCenter().

Referenced by phot::CreateHybridLibrary::CreateHybridLibrary(), phot::PhotonVisibilityService::DistanceToOpDet(), DistanceToPoint(), geo::CryostatGeo::GetClosestOpDet(), phot::PhotonLibraryHybrid::GetCount(), and Height().

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

double geo::OpDetGeo::DistanceToPoint

(

double const *

xyz

)

const

Returns the distance of the specified point from detector center [cm].

Definition at line 116 of file OpDetGeo.cxx.

References DistanceToPoint().

    { return DistanceToPoint(geo::vect::makeFromCoords<geo::Point_t>(xyz)); }

void geo::OpDetGeo::GetCenter	(	double *	xyz,
		double	localz = 0.0
	)		const

Return the center position of an opdet

Parameters

xyz	: 3-D array. The returned location.
localz	: Distance along the length of the volume (cm). Default is center of wire

Definition at line 47 of file OpDetGeo.cxx.

References LocalToWorld().

Referenced by phot::CreateHybridLibrary::CreateHybridLibrary(), cosmic::BeamFlashTrackMatchTaggerAlg::FillFlashProperties(), opdet::FlashHypothesisAnaAlg::FillOpDetPositions(), larg4::OpDetLookup::FindClosestOpDet(), and larg4::OpFastScintillation::propagation_time().

  {
    double xyzLocal[3] = {0.,0.,localz};
    this->LocalToWorld(xyzLocal, xyz);
  }

geo::Point_t const& geo::OpDetGeo::GetCenter ( ) const

inline

Definition at line 66 of file OpDetGeo.h.

References fCenter, HalfH(), HalfL(), HalfW(), RMax(), and RMin().

Referenced by DistanceToPoint(), PrintOpDetInfo(), and ThetaZ().

{ return fCenter; }

double geo::OpDetGeo::HalfH

(

)

const

Definition at line 78 of file OpDetGeo.cxx.

References asBox().

Referenced by GetCenter(), and Height().

  {
    TGeoBBox const* pBox = asBox();
    return pBox? pBox->GetDY(): 0.0;
  }

double geo::OpDetGeo::HalfL

(

)

const

Definition at line 62 of file OpDetGeo.cxx.

References asBox().

Referenced by GetCenter(), Length(), and ThetaZ().

  {
    TGeoBBox const* pBox = asBox();
    return pBox? pBox->GetDZ(): 0.0;
  }

double geo::OpDetGeo::HalfW

(

)

const

Definition at line 70 of file OpDetGeo.cxx.

References asBox().

Referenced by GetCenter(), and Width().

  {
    TGeoBBox const* pBox = asBox();
    return pBox? pBox->GetDX(): 0.0;
  }

double geo::OpDetGeo::Height ( ) const

inline

Definition at line 74 of file OpDetGeo.h.

References CosThetaFromNormal(), DistanceToPoint(), fTrans, HalfH(), geo::LocalTransformation< StoredMatrix >::LocalToWorld(), LocalToWorld(), and ThetaZ().

Referenced by PrintOpDetInfo().

{ return 2.0 * HalfH(); }

bool geo::OpDetGeo::isBar ( ) const

inline

Returns whether the detector shape is a bar (TGeoBBox).

Definition at line 146 of file OpDetGeo.h.

References asBox(), art::detail::indent(), isTube(), and PrintOpDetInfo().

Referenced by PrintOpDetInfo().

{ return (asBox() != nullptr) && !isTube(); }

bool geo::OpDetGeo::isTube ( ) const

inline

Returns whether the detector shape is a cilynder (TGeoTube).

Definition at line 143 of file OpDetGeo.h.

References asTube().

Referenced by isBar(), and PrintOpDetInfo().

{ return asTube() != nullptr; }

double geo::OpDetGeo::Length ( ) const

inline

Definition at line 72 of file OpDetGeo.h.

References HalfL().

Referenced by PrintOpDetInfo().

{ return 2.0 * HalfL(); }

void geo::OpDetGeo::LocalToWorld ( const double *  opdet, double *  world  ) const

inline

Transform point from local optical detector frame to world frame.

Definition at line 103 of file OpDetGeo.h.

Referenced by geo::DUNE_opdet_sort(), GetCenter(), Height(), and geo::opdet_sort().

      { fTrans.LocalToWorld(opdet, world); }

void geo::OpDetGeo::LocalToWorldVect ( const double *  opdet, double *  world  ) const

inline

Transform direction vector from local to world.

Definition at line 111 of file OpDetGeo.h.

References fTrans, and geo::LocalTransformation< StoredMatrix >::LocalToWorldVect().

      { fTrans.LocalToWorldVect(opdet, world); }

const TGeoNode* geo::OpDetGeo::Node ( ) const

inline

Returns the ROOT object describing the detector geometry.

Definition at line 137 of file OpDetGeo.h.

References fOpDetNode.

Referenced by Shape().

{ return fOpDetNode; }

template<typename Stream >

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

Prints information about this optical 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 angle from z axis

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

Definition at line 199 of file OpDetGeo.h.

References GetCenter(), Height(), isBar(), isTube(), Length(), RMax(), RMin(), Shape(), ThetaZ(), and Width().

Referenced by isBar(), and geo::GeometryCore::Print().

        {
  
  //----------------------------------------------------------------------------
  out << "centered at " << GetCenter() << " cm";
  
  if (verbosity-- <= 0) return; // 0
  
  //----------------------------------------------------------------------------
  if (isTube()) {
    out << ", radius: " << RMax() << " cm";
    if (RMin() != 0.0) out << " (inner: " << RMin() << " cm)";
    out << ", length: " << Length() << " cm";
  }
  else if (isBar()) {
    out << ", bar size " << Width() << " x " << Height() << " x " << Length()
      << " cm";
  }
  else out << ", shape: '" << Shape()->IsA()->GetName() << "'"; 
  
  if (verbosity-- <= 0) return; // 1
  
  //----------------------------------------------------------------------------
  out << ", theta(z): " << ThetaZ() << " rad";
  
//  if (verbosity-- <= 0) return; // 2
  
  //----------------------------------------------------------------------------
  
} // geo::OpDetGeo::PrintOpDetInfo()

double geo::OpDetGeo::RMax

(

)

const

Definition at line 55 of file OpDetGeo.cxx.

References asTube().

Referenced by GetCenter(), and PrintOpDetInfo().

  {
    return asTube()->GetRmax();
  }

double geo::OpDetGeo::RMin

(

)

const

Definition at line 86 of file OpDetGeo.cxx.

References asTube().

Referenced by GetCenter(), and PrintOpDetInfo().

  {
    return asTube()->GetRmin();
  }

TGeoShape const* geo::OpDetGeo::Shape ( ) const

inline

Returns the geometry object as TGeoShape.

Definition at line 140 of file OpDetGeo.h.

References Node().

Referenced by asBox(), asTube(), and PrintOpDetInfo().

{ return Node()->GetVolume()->GetShape(); }

double geo::OpDetGeo::ThetaZ

(

)

const

returns angle of detector with respect to z axis in the Y-Z plane, in radians

Definition at line 92 of file OpDetGeo.cxx.

References evd::details::end(), GetCenter(), HalfL(), util::pi(), and toWorldCoords().

Referenced by Height(), PrintOpDetInfo(), and ThetaZ().

  {
    auto const& center = GetCenter();
    auto const& end = toWorldCoords(LocalPoint_t{ 0.0, 0.0, HalfL() });
    
    // TODO change this into something generic
    //either y or x will be 0, so ading both will always catch the right
    //one
    double angle = (end.Y()-center.Y()+end.X()-center.X()) / 
      std::abs(end.Y()-center.Y()+center.X()-end.X()) * 
      std::acos((end.Z() - center.Z())/HalfL());
    if (angle < 0) angle += util::pi(); 
    return angle;
  }

double geo::OpDetGeo::ThetaZ

(

bool

degrees

)

const

returns angle of detector with respect to z axis in the Y-Z plane

Definition at line 108 of file OpDetGeo.cxx.

References util::RadiansToDegrees(), and ThetaZ().

    { return degree? util::RadiansToDegrees(ThetaZ()): ThetaZ(); }

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

inline

Transform point from world frame to local optical detector frame.

Definition at line 123 of file OpDetGeo.h.

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

Referenced by CosThetaFromNormal().

      { return fTrans.toLocalCoords(world); }

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

inline

Transform direction vector from world to local.

Definition at line 131 of file OpDetGeo.h.

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

      { return fTrans.toLocalCoords(world); }

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

inline

Transform point from local optical detector frame to world frame.

Definition at line 107 of file OpDetGeo.h.

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

Referenced by OpDetGeo(), and ThetaZ().

      { return fTrans.toWorldCoords(local); }

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

inline

Transform direction vector from local to world.

Definition at line 115 of file OpDetGeo.h.

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

      { return fTrans.toWorldCoords(local); }

double geo::OpDetGeo::Width ( ) const

inline

Definition at line 73 of file OpDetGeo.h.

References HalfW().

Referenced by PrintOpDetInfo().

{ return 2.0 * HalfW(); }

void geo::OpDetGeo::WorldToLocal ( const double *  world, double *  opdet  ) const

inline

Transform point from world frame to local optical detector frame.

Definition at line 119 of file OpDetGeo.h.

References fTrans, and geo::LocalTransformation< StoredMatrix >::WorldToLocal().

      { fTrans.WorldToLocal(world, opdet); }

void geo::OpDetGeo::WorldToLocalVect ( const double *  world, double *  opdet  ) const

inline

Transform direction vector from world to local.

Definition at line 127 of file OpDetGeo.h.

References fTrans, and geo::LocalTransformation< StoredMatrix >::WorldToLocalVect().

      { fTrans.WorldToLocalVect(world, opdet); }

Member Data Documentation

geo::Point_t geo::OpDetGeo::fCenter

private

Stored geometric center of the optical detector.

Definition at line 180 of file OpDetGeo.h.

Referenced by GetCenter(), and OpDetGeo().

const TGeoNode* geo::OpDetGeo::fOpDetNode

private

Pointer to theopdet node.

Definition at line 179 of file OpDetGeo.h.

Referenced by Node(), and OpDetGeo().

LocalTransformation_t geo::OpDetGeo::fTrans

private

Optical-detector-to-world transformation.

Definition at line 178 of file OpDetGeo.h.

Referenced by Height(), LocalToWorldVect(), toLocalCoords(), toWorldCoords(), WorldToLocal(), and WorldToLocalVect().

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

static

Maximum verbosity supported by PrintOpDetInfo().

Definition at line 172 of file OpDetGeo.h.

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

---

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

• /cvmfs/larsoft.opensciencegrid.org/products/larcorealg/v07_03_00/source/larcorealg/Geometry/OpDetGeo.h
• /cvmfs/larsoft.opensciencegrid.org/products/larcorealg/v07_03_00/source/larcorealg/Geometry/OpDetGeo.cxx