geo::OpDetGeo Class Reference

#include <OpDetGeo.h>

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::OpticalPoint_t
	Type of points in the local GDML TPC frame. More...
using	LocalVector_t = geo::OpticalVector_t
	Type of displacement vectors in the local GDML TPC frame. More...

Public Member Functions
	OpDetGeo (TGeoNode const &node, geo::TransformationMatrix &&trans)
geo::OpDetID const &	ID () const
	Returns the geometry ID of this optical detector. More...
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...
void	UpdateAfterSorting (geo::OpDetID opdetid)
	Performs all updates after cryostat has sorted the optical detectors. More...
template<typename Stream >
void	PrintOpDetInfo (Stream &&out, std::string indent="", unsigned int verbosity=0) const
	Prints information about this optical detector. More...
std::string	OpDetInfo (std::string indent="", unsigned int verbosity=0) const
	Returns a string with optical detector information. 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
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
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...
Detector shape
TGeoShape const *	Shape () const
	Returns the geometry object as TGeoShape. More...
template<typename ShapeObj >
bool	isShape () const
	Returns whether the detector has the specified shape. More...
template<typename ShapeObj >
bool	isShapeLike () const
	Returns whether the detector inherits from the specified shape. More...
bool	isTube () const
	Returns whether the detector shape is a cylinder (TGeoTube). More...
bool	isBar () const
	Returns whether the detector shape is a bar (TGeoBBox). More...
bool	isSphere () const
	Returns whether the detector shape is a hemisphere (TGeoSphere). More...

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

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

Private Member Functions
TGeoTube const *	asTube () const
	Returns the geometry object as TGeoTube, nullptr if not a tube. More...
TGeoSphere const *	asSphere () const
	Returns the geometry object as TGeoSphere, nullptr if not a sphere. More...
TGeoBBox const *	asBox () const
	Returns the geometry object as TGeoBBox, nullptr if not box-derived. 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...
geo::OpDetID	fID
	Identifier of this optical detector. More...

Detailed Description

Definition at line 43 of file OpDetGeo.h.

Member Typedef Documentation

using geo::OpDetGeo::LocalPoint_t = geo::OpticalPoint_t

Type of points in the local GDML TPC frame.

Definition at line 62 of file OpDetGeo.h.

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

private

Definition at line 244 of file OpDetGeo.h.

using geo::OpDetGeo::LocalVector_t = geo::OpticalVector_t

Type of displacement vectors in the local GDML TPC frame.

Definition at line 65 of file OpDetGeo.h.

Constructor & Destructor Documentation

geo::OpDetGeo::OpDetGeo	(	TGeoNode const &	node,
		geo::TransformationMatrix &&	trans
	)

Definition at line 26 of file OpDetGeo.cxx.

    : fTrans(std::move(trans))
  {
    fOpDetNode = &node;

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

Definition at line 261 of file OpDetGeo.h.

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

TGeoSphere const* geo::OpDetGeo::asSphere ( ) const

inlineprivate

Returns the geometry object as TGeoSphere, nullptr if not a sphere.

Definition at line 257 of file OpDetGeo.h.

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

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

inlineprivate

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

Definition at line 253 of file OpDetGeo.h.

      { 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 138 of file OpDetGeo.cxx.

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

double geo::OpDetGeo::CosThetaFromNormal

(

double const *

xyz

)

const

Definition at line 142 of file OpDetGeo.cxx.

    { 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 123 of file OpDetGeo.cxx.

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

double geo::OpDetGeo::DistanceToPoint

(

double const *

xyz

)

const

Definition at line 125 of file OpDetGeo.cxx.

    { 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 40 of file OpDetGeo.cxx.

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

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

inline

Definition at line 75 of file OpDetGeo.h.

{ return fCenter; }

double geo::OpDetGeo::HalfH

(

)

const

Definition at line 79 of file OpDetGeo.cxx.

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

double geo::OpDetGeo::HalfL

(

)

const

Definition at line 63 of file OpDetGeo.cxx.

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

double geo::OpDetGeo::HalfW

(

)

const

Definition at line 71 of file OpDetGeo.cxx.

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

double geo::OpDetGeo::Height ( ) const

inline

Definition at line 83 of file OpDetGeo.h.

{ return 2.0 * HalfH(); }

geo::OpDetID const& geo::OpDetGeo::ID ( ) const

inline

Returns the geometry ID of this optical detector.

Definition at line 72 of file OpDetGeo.h.

{ return fID; }

bool geo::OpDetGeo::isBar ( ) const

inline

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

Definition at line 195 of file OpDetGeo.h.

{ return isShape<TGeoBBox>(); }

template<typename ShapeObj >

bool geo::OpDetGeo::isShape

(

)

const

Returns whether the detector has the specified shape.

Template Parameters

ShapeObj

type of ROOT geometry object representing the shape

Returns

whether this detector has the specified shape

See also

isShapeLike(), isBox(), isSphere(), isTube()

Example:

bool const isSphere = opDet.isShape<TGeoSphere>();
bool const isBox = opDet.isShape<TGeoBBox>();

will have isSphere true only if the shape of this object is a sphere (TGeoSphere), and isBox true only if the shape of this object is a box (TGeoBBox).

Definition at line 274 of file OpDetGeo.h.

                                {
  static_assert(std::is_base_of_v<TGeoShape, std::decay_t<ShapeObj>>);
  
  // C++ understanding of the business instead of ROOT's (no strong reason)
  TGeoShape const* shape = Shape(); // needed to convince Clang 7 I really mean it
  return typeid(*shape) == typeid(std::decay_t<ShapeObj>);
  
} // geo::OpDetGeo::isShape()

template<typename ShapeObj >

bool geo::OpDetGeo::isShapeLike

(

)

const

Returns whether the detector inherits from the specified shape.

Template Parameters

ShapeObj

type of ROOT geometry object representing the shape

Returns

whether this detector has a shape derived from the specified one

See also

isShape(), isBox(), isSphere(), isTube()

Example:

bool const isTubeLike = opDet.isShapeLike<TGeoTube>();

isTubeLike will be true if its shape is either a box (TGeoTube) or any other whose shape object is derived from TGeoTube (including for example a C-shape, half-cylinder).

Definition at line 285 of file OpDetGeo.h.

                                    {
  static_assert(std::is_base_of_v<TGeoShape, std::decay_t<ShapeObj>>);
  
  // C++ understanding of the business instead of ROOT's (no strong reason)
  return dynamic_cast<std::decay_t<ShapeObj> const*>(Shape()) != nullptr;
  
} // geo::OpDetGeo::isShapeLike()

bool geo::OpDetGeo::isSphere ( ) const

inline

Returns whether the detector shape is a hemisphere (TGeoSphere).

Definition at line 198 of file OpDetGeo.h.

{ return isShape<TGeoSphere>(); }

bool geo::OpDetGeo::isTube ( ) const

inline

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

Definition at line 192 of file OpDetGeo.h.

{ return isShapeLike<TGeoTube>(); }

double geo::OpDetGeo::Length ( ) const

inline

Definition at line 81 of file OpDetGeo.h.

{ 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 112 of file OpDetGeo.h.

      { 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 120 of file OpDetGeo.h.

      { fTrans.LocalToWorldVect(opdet, world); }

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

inline

Returns the ROOT object describing the detector geometry.

Definition at line 146 of file OpDetGeo.h.

{ return fOpDetNode; }

std::string geo::OpDetGeo::OpDetInfo	(	std::string	indent = "",
		unsigned int	verbosity = 0
	)		const

Returns a string with optical detector information.

See also

PrintOpDetInfo()

Arguments and provided information are the same as in PrintOpDetInfo().

Definition at line 130 of file OpDetGeo.cxx.

  {
    std::ostringstream sstr;
    PrintOpDetInfo(sstr, indent, verbosity);
    return sstr.str();
  } // OpDetGeo::OpDetInfo()

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 296 of file OpDetGeo.h.

        {
  
  lar::util::RealComparisons<double> cmp(1e-5);  
  
  //----------------------------------------------------------------------------
  out << "optical detector " << ID() << " centered at " << GetCenter() << " cm";

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

  //----------------------------------------------------------------------------
  if (isTube()) {
    out << ", radius: " << RMax() << " cm";
    if (cmp.nonZero(RMin())) out << " (inner: " << RMin() << " cm)";
    out << ", length: " << Length() << " cm";
  }
  else if (isBar()) {
    out << ", bar size " << Width() << " x " << Height() << " x " << Length()
      << " cm";
  }
  else if (TGeoSphere const* sphere = asSphere(); sphere) {
    assert(isSphere());
    auto const [ th1, th2 ]
      = std::minmax({ sphere->GetTheta1(), sphere->GetTheta2() });
    out << ", ";
    // some information out of the interface
    if (cmp.zero(th1) && cmp.equal(th2, 180.0)) out << "spherical";
    else if ((cmp.zero(th1) && cmp.equal(th2, 90.0))
      || (cmp.equal(th1, 90.0) && cmp.equal(th2, 180.0)))
    {
      out << "hemispherical";
    }
    else out << "spherical portion (" << th1 << " -> " << th2 << " degree)";
    out << " with external radius " << RMax() << " 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 48 of file OpDetGeo.cxx.

  {
    if (TGeoSphere const* sphere = asSphere(); sphere) {
      return sphere->GetRmax();
    }
    else if (TGeoTube const* tube = asTube(); tube) {
      return tube->GetRmax();
    }
    else {
      throw std::bad_cast{};
    }
  }

double geo::OpDetGeo::RMin

(

)

const

Definition at line 87 of file OpDetGeo.cxx.

  {
    if (TGeoSphere const* sphere = asSphere(); sphere) {
      return sphere->GetRmin();
    }
    else if (TGeoTube const* tube = asTube(); tube) {
      return tube->GetRmin();
    }
    else {
      throw std::bad_cast{};
    }
  }

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

inline

Returns the geometry object as TGeoShape.

Definition at line 154 of file OpDetGeo.h.

{ 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 101 of file OpDetGeo.cxx.

  {
    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 adding 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 117 of file OpDetGeo.cxx.

    { 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 132 of file OpDetGeo.h.

      { 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 140 of file OpDetGeo.h.

      { 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 116 of file OpDetGeo.h.

      { 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 124 of file OpDetGeo.h.

      { return fTrans.toWorldCoords(local); }

void geo::OpDetGeo::UpdateAfterSorting

(

geo::OpDetID

opdetid

)

Performs all updates after cryostat has sorted the optical detectors.

Definition at line 146 of file OpDetGeo.cxx.

                                                      {

    fID = opdetid;

  } // OpDetGeo::UpdateAfterSorting()

double geo::OpDetGeo::Width ( ) const

inline

Definition at line 82 of file OpDetGeo.h.

{ 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 128 of file OpDetGeo.h.

      { 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 136 of file OpDetGeo.h.

      { fTrans.WorldToLocalVect(world, opdet); }

Member Data Documentation

geo::Point_t geo::OpDetGeo::fCenter

private

Stored geometric center of the optical detector.

Definition at line 248 of file OpDetGeo.h.

geo::OpDetID geo::OpDetGeo::fID

private

Identifier of this optical detector.

Definition at line 250 of file OpDetGeo.h.

const TGeoNode* geo::OpDetGeo::fOpDetNode

private

Pointer to theopdet node.

Definition at line 247 of file OpDetGeo.h.

LocalTransformation_t geo::OpDetGeo::fTrans

private

Optical-detector-to-world transformation.

Definition at line 246 of file OpDetGeo.h.

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

static

Maximum verbosity supported by PrintOpDetInfo().

Definition at line 240 of file OpDetGeo.h.

---

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

• larcorealg/larcorealg/Geometry/OpDetGeo.h
• larcorealg/larcorealg/Geometry/OpDetGeo.cxx