Trk::TrapezoidVolumeBounds Class Reference

Bounds for a trapezoidal shaped Volume, the decomposeToSurfaces method creates a vector of 6 surfaces: More...

#include <TrapezoidVolumeBounds.h>

Inheritance diagram for Trk::TrapezoidVolumeBounds:

Collaboration diagram for Trk::TrapezoidVolumeBounds:

Public Member Functions
	TrapezoidVolumeBounds ()
	Default Constructor.
	TrapezoidVolumeBounds (double minhlenghtx, double maxhlengthx, double hlenghty, double hlengthz)
	Constructor - the trapezoid boundaries (symmetric trapezoid)
	TrapezoidVolumeBounds (double minhlenghtx, double hlenghty, double hlengthz, double alpha, double beta)
	Constructor - the trapezoid boundaries (arbitrary trapezoid)
	TrapezoidVolumeBounds (const TrapezoidVolumeBounds &bobo)
	Copy Constructor.
virtual	~TrapezoidVolumeBounds ()
	Destructor.
TrapezoidVolumeBounds &	operator= (const TrapezoidVolumeBounds &bobo)
	Assignment operator.
TrapezoidVolumeBounds *	clone () const override final
	Virtual constructor.
bool	inside (const Amg::Vector3D &, double tol=0.) const override final
	This method checks if position in the 3D volume frame is inside the cylinder.
virtual std::vector< std::unique_ptr< Trk::Surface > >	decomposeToSurfaces (const Amg::Transform3D &transform) override final
	Method to decompose the Bounds into Surfaces.
ObjectAccessor	boundarySurfaceAccessor (const Amg::Vector3D &gp, const Amg::Vector3D &dir, bool forceInside=false) const override
	Provide accessor for BoundarySurfaces.
double	minHalflengthX () const
	This method returns the minimal halflength in local x.
double	maxHalflengthX () const
	This method returns the maximal halflength in local x.
double	halflengthY () const
	This method returns the halflength in local y.
double	halflengthZ () const
	This method returns the halflength in local z.
double	alpha () const
	This method returns the opening angle in point A (negative local x)
double	beta () const
	This method returns the opening angle in point B (negative local x)
MsgStream &	dump (MsgStream &sl) const override final
	Output Method for MsgStream.
std::ostream &	dump (std::ostream &sl) const override final
	Output Method for std::ostream.

Private Member Functions
std::shared_ptr< TrapezoidBounds >	faceXYTrapezoidBounds () const
	This method returns the associated TrapezoidBounds of the face PlaneSurface parallel to local xy plane.
std::shared_ptr< RectangleBounds >	faceAlphaRectangleBounds () const
	This method returns the associated RecantleBounds of the face PlaneSurface attached to alpha (negative local x)
std::shared_ptr< RectangleBounds >	faceBetaRectangleBounds () const
	This method returns the associated RecantleBounds of the face PlaneSurface attached to beta (positive local x)
std::shared_ptr< RectangleBounds >	faceZXRectangleBoundsBottom () const
	This method returns the associated RecantleBounds of the face PlaneSurface parallel to local zx plane, negative local y.
std::shared_ptr< RectangleBounds >	faceZXRectangleBoundsTop () const
	This method returns the associated RecantleBounds of the face PlaneSurface parallel to local zx plane, positive local y.

Private Attributes
double	m_minHalfX
	minimal halflength in x
double	m_maxHalfX
	maximal halflength in x
double	m_halfY
	halflength in y
double	m_halfZ
	halflength in z
double	m_alpha
	opening angle alpha (in point A)
double	m_beta
	opening angle beta (in point B)
SixObjectsAccessor	m_objectAccessor
	There's only one single object Acessor for the moment has to be implemented if Cuboids are used more widely.

Detailed Description

Bounds for a trapezoidal shaped Volume, the decomposeToSurfaces method creates a vector of 6 surfaces:

BoundarySurfaceFace [index]:

- negativeFaceXY     [0] : Trazpezoidal Trk::PlaneSurface,
                           parallel to \f$ xy \f$ plane at negative \f$ z

\( - positiveFaceXY [1] : Trazpezoidal Trk::PlaneSurface, parallel to \) xy \( plane at positive \) z \( - trapezoidFaceAlpha [2] : Rectangular Trk::PlaneSurface, attached to [0] and [1] at negative \) x \((associated to alpha) - trapezoidFaceBeta [3] : Rectangular Trk::PlaneSurface, attached to [0] and [1] at positive \) x \((associated to beta) - negativeFaceZX [4] : Rectangular Trk::PlaneSurface, parallel to \) zx \( plane at negative \) y \( - positiveFaceZX [5] : Rectangular Trk::PlaneSurface, parallel to \) zx \( plane at positive \) y

Definition at line 57 of file TrapezoidVolumeBounds.h.

Constructor & Destructor Documentation

TrapezoidVolumeBounds() [1/4]

Trk::TrapezoidVolumeBounds::TrapezoidVolumeBounds

(

)

Default Constructor.

Definition at line 26 of file TrapezoidVolumeBounds.cxx.

  : VolumeBounds()
  , m_minHalfX(0.)
  , m_maxHalfX(0.)
  , m_halfY(0.)
  , m_halfZ(0.)
  , m_alpha(0.)
  , m_beta(0.)
  , m_objectAccessor()
{}

TrapezoidVolumeBounds() [2/4]

Trk::TrapezoidVolumeBounds::TrapezoidVolumeBounds	(	double	minhlenghtx,
		double	maxhlengthx,
		double	hlenghty,
		double	hlengthz )

Constructor - the trapezoid boundaries (symmetric trapezoid)

Definition at line 37 of file TrapezoidVolumeBounds.cxx.

  : VolumeBounds()
  , m_minHalfX(minhalex)
  , m_maxHalfX(maxhalex)
  , m_halfY(haley)
  , m_halfZ(halez)
  , m_alpha(0.)
  , m_beta(0.)
  , m_objectAccessor()
{
  m_alpha = atan((m_maxHalfX - m_minHalfX) / 2 / m_halfY) + 0.5 * M_PI;
  m_beta = m_alpha;
}

TrapezoidVolumeBounds() [3/4]

Trk::TrapezoidVolumeBounds::TrapezoidVolumeBounds	(	double	minhlenghtx,
		double	hlenghty,
		double	hlengthz,
		double	alpha,
		double	beta )

Constructor - the trapezoid boundaries (arbitrary trapezoid)

Definition at line 55 of file TrapezoidVolumeBounds.cxx.

  : VolumeBounds()
  , m_minHalfX(minhalex)
  , m_maxHalfX(0.)
  , m_halfY(haley)
  , m_halfZ(halez)
  , m_alpha(alpha)
  , m_beta(beta)
  , m_objectAccessor()
{
  double gamma = (alpha > beta) ? (alpha - 0.5 * M_PI) : (beta - 0.5 * M_PI);
  m_maxHalfX = m_minHalfX + (2. * m_halfY) * tan(gamma);
}

TrapezoidVolumeBounds() [4/4]

Trk::TrapezoidVolumeBounds::TrapezoidVolumeBounds

(

const TrapezoidVolumeBounds &

bobo

)

Copy Constructor.

Definition at line 74 of file TrapezoidVolumeBounds.cxx.

  : VolumeBounds()
  , m_minHalfX(trabo.m_minHalfX)
  , m_maxHalfX(trabo.m_maxHalfX)
  , m_halfY(trabo.m_halfY)
  , m_halfZ(trabo.m_halfZ)
  , m_alpha(trabo.m_alpha)
  , m_beta(trabo.m_beta)
  , m_objectAccessor(trabo.m_objectAccessor)
{}

~TrapezoidVolumeBounds()

Trk::TrapezoidVolumeBounds::~TrapezoidVolumeBounds ( )

virtualdefault

Destructor.

Member Function Documentation

alpha()

double Trk::TrapezoidVolumeBounds::alpha ( ) const

inline

This method returns the opening angle in point A (negative local x)

Definition at line 165 of file TrapezoidVolumeBounds.h.

{ return m_alpha; }

beta()

double Trk::TrapezoidVolumeBounds::beta ( ) const

inline

This method returns the opening angle in point B (negative local x)

Definition at line 166 of file TrapezoidVolumeBounds.h.

{ return m_beta; }

boundarySurfaceAccessor()

ObjectAccessor Trk::TrapezoidVolumeBounds::boundarySurfaceAccessor ( const Amg::Vector3D & gp, const Amg::Vector3D & dir, bool forceInside = false ) const

inlineoverridevirtual

Provide accessor for BoundarySurfaces.

Implements Trk::VolumeBounds.

Definition at line 168 of file TrapezoidVolumeBounds.h.

                                                        {
  return Trk::ObjectAccessor(m_objectAccessor);
}

clone()

TrapezoidVolumeBounds * Trk::TrapezoidVolumeBounds::clone ( ) const

inlinefinaloverridevirtual

Virtual constructor.

Implements Trk::VolumeBounds.

Definition at line 153 of file TrapezoidVolumeBounds.h.

                                                                 {
  return new TrapezoidVolumeBounds(*this);
}

decomposeToSurfaces()

std::vector< std::unique_ptr< Trk::Surface > > Trk::TrapezoidVolumeBounds::decomposeToSurfaces ( const Amg::Transform3D & transform )

finaloverridevirtual

Method to decompose the Bounds into Surfaces.

Implements Trk::VolumeBounds.

Definition at line 104 of file TrapezoidVolumeBounds.cxx.

{
  auto retsf = std::vector<std::unique_ptr<Trk::Surface>>();
 
  // face surfaces xy
  Amg::RotationMatrix3D trapezoidRotation(transform.rotation());
  Amg::Vector3D trapezoidX(trapezoidRotation.col(0));
  Amg::Vector3D trapezoidY(trapezoidRotation.col(1));
  Amg::Vector3D trapezoidZ(trapezoidRotation.col(2));
  Amg::Vector3D trapezoidCenter(transform.translation());
 
  //   (1) - at negative local z
  retsf.push_back(std::make_unique<Trk::PlaneSurface>(
    Amg::Transform3D(
      transform *
      Amg::AngleAxis3D(180 * Gaudi::Units::deg, Amg::Vector3D(0., 1., 0.)) *
      Amg::Translation3D(Amg::Vector3D(0., 0., this->halflengthZ()))),
    this->faceXYTrapezoidBounds()));
  //   (2) - at positive local z
  retsf.push_back(std::make_unique<Trk::PlaneSurface>(
    Amg::Transform3D(
      transform *
      Amg::Translation3D(Amg::Vector3D(0., 0., this->halflengthZ()))),
    this->faceXYTrapezoidBounds()));
  // face surfaces yz
  // transmute cyclical
  //   (3) - at point A, attached to alpha opening angle
  //  the yz bound are created in such a way that the surface y-direction has to
  //  become the z-direction. The resulting surface normal has to point in
  //  y-direction. This is achieved by rotating the plane surface by -90
  //  degrees around the x-axis.
  //  Then, the plane has to be rotated around the z-axis by alpha.
  //
  //  double c=cos(M_PI/2);
  //  double s=sin(M_PI/2);
  //  Amg::RotationMatrix3D rotate_to_xz;
  //  rotate_to_xz << 1.f, 0.f, 0.f, // 1 0  0
  //                  0.f, c,  -s,   // 0 0 -1
  //                  0.f, s,   c;   // 0 1  0
  //
  //  s=sin(-alpha());
  //  c=cos(-alpha());
  //  Amg::RotationMatrix3D rotate_left;
  //  rotate_left <<   c,   s,   0.f,
  //                  -s,   c,   0.f,
  //                 0.f, 0.f,   1.f;
  //
  //  Amg::RotationMatrix3D rotateToFaceAlpha( rotate_left * rotate_to_xz);
  Amg::RotationMatrix3D rotateToFaceAlpha;
  {
  double s=sin(-alpha());
  double c=cos(-alpha());
  rotateToFaceAlpha <<   c,  0.f,   s,
                        -s,  0.f,   c,
                       0.f, -1.f, 0.f;
  }
 
  std::shared_ptr<RectangleBounds> faceAlphaBounds = this->faceAlphaRectangleBounds();
  Amg::Vector3D faceAlphaPosition0(
    -0.5 * (this->minHalflengthX() + this->maxHalflengthX()), 0., 0.);
  Amg::Vector3D faceAlphaPosition = transform * faceAlphaPosition0;
  retsf.push_back(std::make_unique<Trk::PlaneSurface>( Amg::Translation3D(faceAlphaPosition)
                                                       * Amg::Transform3D(trapezoidRotation * rotateToFaceAlpha),
                                                       faceAlphaBounds));
  //   (4) - at point B, attached to beta opening angle
  //  same as above but rotate to the right by beta
  Amg::RotationMatrix3D rotateToFaceBeta;
  {
  double s=sin(beta());
  double c=cos(beta());
  rotateToFaceBeta  <<   c,  0.f,   s,
                        -s,  0.f,   c,
                       0.f, -1.f, 0.f;
  }
 
  std::shared_ptr<RectangleBounds> faceBetaBounds = this->faceBetaRectangleBounds();
  // Amg::Vector3D
  // faceBetaPosition(B+faceBetaRotation.colX()*faceBetaBounds->halflengthX());
  Amg::Vector3D faceBetaPosition0(
    0.5 * (this->minHalflengthX() + this->maxHalflengthX()), 0., 0.);
  Amg::Vector3D faceBetaPosition = transform * faceBetaPosition0;
  retsf.push_back(std::make_unique<Trk::PlaneSurface>( Amg::Translation3D(faceBetaPosition)
                                                       * Amg::Transform3D(trapezoidRotation * rotateToFaceBeta),
                                                       faceBetaBounds));
  retsf.push_back(std::make_unique<Trk::PlaneSurface>(
    Amg::Transform3D(
      transform *
      Amg::AngleAxis3D(180. * Gaudi::Units::deg, Amg::Vector3D(1., 0., 0.)) *
      Amg::Translation3D(Amg::Vector3D(0., this->halflengthY(), 0.)) *
      Amg::AngleAxis3D(-90 * Gaudi::Units::deg, Amg::Vector3D(0., 1., 0.)) *
      Amg::AngleAxis3D(-90. * Gaudi::Units::deg, Amg::Vector3D(1., 0., 0.))),
    this->faceZXRectangleBoundsBottom()));
  //   (6) - at positive local x
  retsf.push_back(std::make_unique<Trk::PlaneSurface>(
    Amg::Transform3D(
      transform *
      Amg::Translation3D(Amg::Vector3D(0., this->halflengthY(), 0.)) *
      Amg::AngleAxis3D(-90 * Gaudi::Units::deg, Amg::Vector3D(0., 1., 0.)) *
      Amg::AngleAxis3D(-90. * Gaudi::Units::deg, Amg::Vector3D(1., 0., 0.))),
    this->faceZXRectangleBoundsTop()));
 
  return retsf;
}

dump() [1/2]

MsgStream & Trk::TrapezoidVolumeBounds::dump ( MsgStream & sl ) const

finaloverridevirtual

Output Method for MsgStream.

Implements Trk::VolumeBounds.

Definition at line 258 of file TrapezoidVolumeBounds.cxx.

{
  std::stringstream temp_sl;
  temp_sl << std::setiosflags(std::ios::fixed);
  temp_sl << std::setprecision(7);
  temp_sl
    << "Trk::TrapezoidVolumeBounds: (minhalfX, halfY, halfZ, alpha, beta) = ";
  temp_sl << "(" << m_minHalfX << ", " << m_halfY << ", " << m_halfZ;
  temp_sl << ", " << m_alpha << ", " << m_beta << ")";
  sl << temp_sl.str();
  return sl;
}

dump() [2/2]

std::ostream & Trk::TrapezoidVolumeBounds::dump ( std::ostream & sl ) const

finaloverridevirtual

Output Method for std::ostream.

Implements Trk::VolumeBounds.

Definition at line 272 of file TrapezoidVolumeBounds.cxx.

{
  std::stringstream temp_sl;
  temp_sl << std::setiosflags(std::ios::fixed);
  temp_sl << std::setprecision(7);
  temp_sl
    << "Trk::TrapezoidVolumeBounds: (minhalfX, halfY, halfZ, alpha, beta) = ";
  temp_sl << "(" << m_minHalfX << ", " << m_halfY << ", " << m_halfZ;
  temp_sl << ", " << m_alpha << ", " << m_beta << ")";
  sl << temp_sl.str();
  return sl;
}

faceAlphaRectangleBounds()

std::shared_ptr< Trk::RectangleBounds > Trk::TrapezoidVolumeBounds::faceAlphaRectangleBounds ( ) const

private

This method returns the associated RecantleBounds of the face PlaneSurface attached to alpha (negative local x)

Definition at line 217 of file TrapezoidVolumeBounds.cxx.

{
  return std::make_shared<Trk::RectangleBounds>(m_halfY / cos(m_alpha - 0.5 * M_PI), m_halfZ);
}

faceBetaRectangleBounds()

std::shared_ptr< Trk::RectangleBounds > Trk::TrapezoidVolumeBounds::faceBetaRectangleBounds ( ) const

private

This method returns the associated RecantleBounds of the face PlaneSurface attached to beta (positive local x)

Definition at line 223 of file TrapezoidVolumeBounds.cxx.

{
  return std::make_shared<Trk::RectangleBounds>(m_halfY / cos(m_beta - 0.5 * M_PI), m_halfZ);
}

faceXYTrapezoidBounds()

std::shared_ptr< Trk::TrapezoidBounds > Trk::TrapezoidVolumeBounds::faceXYTrapezoidBounds ( ) const

private

This method returns the associated TrapezoidBounds of the face PlaneSurface parallel to local xy plane.

Definition at line 211 of file TrapezoidVolumeBounds.cxx.

{
  return std::make_shared<Trk::TrapezoidBounds>(m_minHalfX, m_maxHalfX, m_halfY);
}

faceZXRectangleBoundsBottom()

std::shared_ptr< Trk::RectangleBounds > Trk::TrapezoidVolumeBounds::faceZXRectangleBoundsBottom ( ) const

private

This method returns the associated RecantleBounds of the face PlaneSurface parallel to local zx plane, negative local y.

Definition at line 229 of file TrapezoidVolumeBounds.cxx.

{
  return std::make_shared<Trk::RectangleBounds>(m_halfZ, m_minHalfX);
}

faceZXRectangleBoundsTop()

std::shared_ptr< Trk::RectangleBounds > Trk::TrapezoidVolumeBounds::faceZXRectangleBoundsTop ( ) const

private

This method returns the associated RecantleBounds of the face PlaneSurface parallel to local zx plane, positive local y.

Definition at line 235 of file TrapezoidVolumeBounds.cxx.

{
  // double delta = (m_alpha < m_beta) ? m_alpha - M_PI/2. : m_beta - M_PI/2.;
  // return new Trk::RectangleBounds(m_halfZ,
  // 0.5*(m_minHalfX+m_minHalfX+2.*m_halfY/cos(delta)));
  return std::make_shared<Trk::RectangleBounds>(m_halfZ, m_maxHalfX);
}

halflengthY()

double Trk::TrapezoidVolumeBounds::halflengthY ( ) const

inline

This method returns the halflength in local y.

Definition at line 163 of file TrapezoidVolumeBounds.h.

{ return m_halfY; }

halflengthZ()

double Trk::TrapezoidVolumeBounds::halflengthZ ( ) const

inline

This method returns the halflength in local z.

Definition at line 164 of file TrapezoidVolumeBounds.h.

{ return m_halfZ; }

inside()

bool Trk::TrapezoidVolumeBounds::inside ( const Amg::Vector3D & pos, double tol = 0. ) const

finaloverridevirtual

This method checks if position in the 3D volume frame is inside the cylinder.

Implements Trk::VolumeBounds.

Definition at line 244 of file TrapezoidVolumeBounds.cxx.

{
  if (std::abs(pos.z()) > m_halfZ + tol)
    return false;
  if (std::abs(pos.y()) > m_halfY + tol)
    return false;
  std::shared_ptr<Trk::TrapezoidBounds> faceXYBounds = this->faceXYTrapezoidBounds();
  Amg::Vector2D locp(pos.x(), pos.y());
  bool inside(faceXYBounds->inside(locp, tol, tol));
  return inside;
}

maxHalflengthX()

double Trk::TrapezoidVolumeBounds::maxHalflengthX ( ) const

inline

This method returns the maximal halflength in local x.

Definition at line 160 of file TrapezoidVolumeBounds.h.

                                                          {
  return m_maxHalfX;
}

minHalflengthX()

double Trk::TrapezoidVolumeBounds::minHalflengthX ( ) const

inline

This method returns the minimal halflength in local x.

Definition at line 157 of file TrapezoidVolumeBounds.h.

                                                          {
  return m_minHalfX;
}

operator=()

Trk::TrapezoidVolumeBounds & Trk::TrapezoidVolumeBounds::operator=

(

const TrapezoidVolumeBounds &

bobo

)

Assignment operator.

Definition at line 89 of file TrapezoidVolumeBounds.cxx.

{
  if (this != &trabo) {
    m_minHalfX = trabo.m_minHalfX;
    m_maxHalfX = trabo.m_maxHalfX;
    m_halfY = trabo.m_halfY;
    m_halfZ = trabo.m_halfZ;
    m_alpha = trabo.m_alpha;
    m_beta = trabo.m_beta;
    m_objectAccessor = trabo.m_objectAccessor;
  }
  return *this;
}

Member Data Documentation

m_alpha

double Trk::TrapezoidVolumeBounds::m_alpha

private

opening angle alpha (in point A)

Definition at line 145 of file TrapezoidVolumeBounds.h.

m_beta

double Trk::TrapezoidVolumeBounds::m_beta

private

opening angle beta (in point B)

Definition at line 146 of file TrapezoidVolumeBounds.h.

m_halfY

double Trk::TrapezoidVolumeBounds::m_halfY

private

halflength in y

Definition at line 142 of file TrapezoidVolumeBounds.h.

m_halfZ

double Trk::TrapezoidVolumeBounds::m_halfZ

private

halflength in z

Definition at line 143 of file TrapezoidVolumeBounds.h.

m_maxHalfX

double Trk::TrapezoidVolumeBounds::m_maxHalfX

private

maximal halflength in x

Definition at line 141 of file TrapezoidVolumeBounds.h.

m_minHalfX

double Trk::TrapezoidVolumeBounds::m_minHalfX

private

minimal halflength in x

Definition at line 140 of file TrapezoidVolumeBounds.h.

m_objectAccessor

SixObjectsAccessor Trk::TrapezoidVolumeBounds::m_objectAccessor

private

There's only one single object Acessor for the moment has to be implemented if Cuboids are used more widely.

Definition at line 150 of file TrapezoidVolumeBounds.h.

---

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

• TrapezoidVolumeBounds.h
• TrapezoidVolumeBounds.cxx