Trk::PrismVolumeBounds Class Reference

Bounds for the transcript of triangular prism. More...

#include <PrismVolumeBounds.h>

Inheritance diagram for Trk::PrismVolumeBounds:

Collaboration diagram for Trk::PrismVolumeBounds:

Public Member Functions
	PrismVolumeBounds ()
	Default Constructor.
	PrismVolumeBounds (std::vector< std::pair< float, float > > xyvtx, float hlengthz)
	Constructor - generic case (from float)
	PrismVolumeBounds (std::vector< std::pair< double, double > > xyvtx, double hlengthz)
	Constructor - generic case from (double)
	PrismVolumeBounds (const PrismVolumeBounds &bobo)
	Copy Constructor.
virtual	~PrismVolumeBounds ()
	Destructor.
PrismVolumeBounds &	operator= (const PrismVolumeBounds &bobo)
	Assignment operator.
PrismVolumeBounds *	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 volume.
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 final
	Provide accessor for BoundarySurfaces.
const std::vector< std::pair< double, double > > &	xyVertices () const
	This method returns the set of xy generating vertices.
double	halflengthZ () const
	This method returns the halflength in local z.
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::unique_ptr< Trk::PlaneSurface >	sideSurf (const Amg::Transform3D &, unsigned int, unsigned int) const
	method to construct side boundary planes
std::vector< std::pair< double, double > >	mirror_xyVtx () const
	mirror the input vertices for down-side boundary
int	ordering () const
	assess ordering of vertices

Private Attributes
std::vector< std::pair< double, double > >	m_xyVtx
	generating xy vertices
double	m_halfZ
	halflength in z
Trk::TriangleBounds *	m_baseBounds
	base xy bounds
CxxUtils::CachedValue< int >	m_ordering
	cache vertex ordering
Trk::EightObjectsAccessor	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 the transcript of triangular prism.

BoundarySurfaceFace [index]:

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

\( - positiveFaceXY [1] : Triangular Trk::PlaneSurface, parallel to \) xy \( plane at positive \) z

Definition at line 44 of file PrismVolumeBounds.h.

Constructor & Destructor Documentation

PrismVolumeBounds() [1/4]

Trk::PrismVolumeBounds::PrismVolumeBounds

(

)

Default Constructor.

Definition at line 24 of file PrismVolumeBounds.cxx.

  : VolumeBounds()
  , m_halfZ()
  , m_baseBounds(nullptr)
  , m_ordering()
  , // invalid cache
  m_objectAccessor()
{}

PrismVolumeBounds() [2/4]

Trk::PrismVolumeBounds::PrismVolumeBounds	(	std::vector< std::pair< float, float > >	xyvtx,
		float	hlengthz )

Constructor - generic case (from float)

Definition at line 33 of file PrismVolumeBounds.cxx.

  : VolumeBounds()
  , m_halfZ(halez)
  , m_baseBounds(nullptr)
  , m_ordering()
  , // invalid cache
  m_objectAccessor()
{
  m_xyVtx.resize(xyVtx.size());
  m_xyVtx.assign(xyVtx.begin(), xyVtx.end());
  m_baseBounds = new Trk::TriangleBounds(m_xyVtx);
}

PrismVolumeBounds() [3/4]

Trk::PrismVolumeBounds::PrismVolumeBounds	(	std::vector< std::pair< double, double > >	xyvtx,
		double	hlengthz )

Constructor - generic case from (double)

Definition at line 48 of file PrismVolumeBounds.cxx.

  : VolumeBounds()
  , m_halfZ(halez)
  , m_baseBounds(nullptr)
  , m_ordering()
  , // invalid cache
  m_objectAccessor()
{
  m_xyVtx.resize(xyVtx.size());
  m_xyVtx.assign(xyVtx.begin(), xyVtx.end());
  m_baseBounds = new Trk::TriangleBounds(m_xyVtx);
}

PrismVolumeBounds() [4/4]

Trk::PrismVolumeBounds::PrismVolumeBounds

(

const PrismVolumeBounds &

bobo

)

Copy Constructor.

Definition at line 63 of file PrismVolumeBounds.cxx.

  : VolumeBounds()
  , m_halfZ(trabo.m_halfZ)
  , m_baseBounds(nullptr)
  , m_ordering(trabo.m_ordering)
  , // ordering cache will be valid if trabo/other cache is valid
  m_objectAccessor(trabo.m_objectAccessor)
{
  m_xyVtx.resize(trabo.m_xyVtx.size());
  m_xyVtx.assign(trabo.m_xyVtx.begin(), trabo.m_xyVtx.end());
  m_baseBounds = new Trk::TriangleBounds(m_xyVtx);
}

~PrismVolumeBounds()

Trk::PrismVolumeBounds::~PrismVolumeBounds ( )

virtual

Destructor.

Definition at line 76 of file PrismVolumeBounds.cxx.

{
  delete m_baseBounds;
}

Member Function Documentation

boundarySurfaceAccessor()

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

inlinefinaloverridevirtual

Provide accessor for BoundarySurfaces.

Implements Trk::VolumeBounds.

Definition at line 127 of file PrismVolumeBounds.h.

                                                        {
  return Trk::ObjectAccessor(m_objectAccessor);
}

clone()

PrismVolumeBounds * Trk::PrismVolumeBounds::clone ( ) const

inlinefinaloverridevirtual

Virtual constructor.

Implements Trk::VolumeBounds.

Definition at line 116 of file PrismVolumeBounds.h.

                                                         {
  return new PrismVolumeBounds(*this);
}

decomposeToSurfaces()

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

finaloverridevirtual

Method to decompose the Bounds into Surfaces.

Implements Trk::VolumeBounds.

Definition at line 98 of file PrismVolumeBounds.cxx.

{
  auto retsf = std::vector<std::unique_ptr<Trk::Surface>>();
 
  // face surfaces xy
  //  (1) - at positive local z
  auto xyPlane = std::make_unique<Trk::PlaneSurface>(
    Amg::Transform3D(
      transform * Amg::Translation3D(Amg::Vector3D(0., 0., m_halfZ))),
      std::make_shared<Trk::TriangleBounds>(m_xyVtx));
  retsf.push_back(std::move(xyPlane));
  //  (2) - at negative local z
  auto xymPlane = std::make_unique<Trk::PlaneSurface>(
    Amg::Transform3D(
      transform * Amg::Translation3D(Amg::Vector3D(0., 0., -m_halfZ)) *
      Amg::AngleAxis3D(180 * Gaudi::Units::deg, Amg::Vector3D(1., 0., 0.))),
      std::make_shared<Trk::TriangleBounds>(mirror_xyVtx()));
  retsf.push_back(std::move(xymPlane));
  // loop over xy vertices
  //  (3)
  for (unsigned int iv = 0; iv < m_xyVtx.size(); iv++) {
    if (iv != m_xyVtx.size() - 1)
      retsf.push_back(sideSurf(transform, iv, iv + 1));
    else
      retsf.push_back(sideSurf(transform, iv, 0));
  }
 
  return retsf;
}

dump() [1/2]

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

finaloverridevirtual

Output Method for MsgStream.

Implements Trk::VolumeBounds.

Definition at line 257 of file PrismVolumeBounds.cxx.

{
  std::stringstream temp_sl;
  temp_sl << std::setiosflags(std::ios::fixed);
  temp_sl << std::setprecision(7);
  temp_sl << "Trk::PrismVolumeBounds: (halfZ, generating vtx) = ";
  temp_sl << "( " << m_halfZ << ")";
  for (const auto & myVtx : m_xyVtx)
    temp_sl << "(" << myVtx.first << "," << myVtx.second << ")";
  sl << temp_sl.str();
 
  return sl;
}

dump() [2/2]

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

finaloverridevirtual

Output Method for std::ostream.

Implements Trk::VolumeBounds.

Definition at line 272 of file PrismVolumeBounds.cxx.

{
  std::stringstream temp_sl;
  temp_sl << std::setiosflags(std::ios::fixed);
  temp_sl << std::setprecision(7);
  temp_sl << "Trk::PrismVolumeBounds:  (halfZ, generating vtx) = ";
  temp_sl << "( " << m_halfZ << ")";
  for (const auto & myVtx : m_xyVtx)
    temp_sl << "(" << myVtx.first << "," << myVtx.second << ")";
  sl << temp_sl.str();
 
  return sl;
}

halflengthZ()

double Trk::PrismVolumeBounds::halflengthZ ( ) const

inline

This method returns the halflength in local z.

Definition at line 125 of file PrismVolumeBounds.h.

{ return m_halfZ; }

inside()

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

finaloverridevirtual

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

Implements Trk::VolumeBounds.

Definition at line 196 of file PrismVolumeBounds.cxx.

{
  if (std::abs(pos.z()) > m_halfZ + tol)
    return false;
  // xy plane
  Amg::Vector2D locp(pos.x(), pos.y());
  return (m_baseBounds->inside(locp, tol, tol));
}

mirror_xyVtx()

std::vector< std::pair< double, double > > Trk::PrismVolumeBounds::mirror_xyVtx ( ) const

private

mirror the input vertices for down-side boundary

Definition at line 206 of file PrismVolumeBounds.cxx.

{
  std::vector<std::pair<double, double>> mirrored;
  mirrored.resize(m_xyVtx.size());
 
  for (unsigned int i = 0; i < m_xyVtx.size(); i++)
    mirrored[i] =
      std::pair<double, double>(m_xyVtx[i].first, -m_xyVtx[i].second);
 
  return mirrored;
}

operator=()

Trk::PrismVolumeBounds & Trk::PrismVolumeBounds::operator=

(

const PrismVolumeBounds &

bobo

)

Assignment operator.

Definition at line 82 of file PrismVolumeBounds.cxx.

{
  if (this != &trabo) {
    m_halfZ = trabo.m_halfZ;
    m_objectAccessor = trabo.m_objectAccessor;
    m_xyVtx.resize(trabo.m_xyVtx.size());
    m_xyVtx.assign(trabo.m_xyVtx.begin(), trabo.m_xyVtx.end());
    delete m_baseBounds;
    m_baseBounds = new Trk::TriangleBounds(m_xyVtx);
    m_ordering =
      trabo.m_ordering; // ordering cache will be valid if trabo cache is valid
  }
  return *this;
}

ordering()

int Trk::PrismVolumeBounds::ordering ( ) const

private

assess ordering of vertices

Definition at line 219 of file PrismVolumeBounds.cxx.

{
  if (m_ordering.isValid()) {
    return *(m_ordering.ptr());
  }
 
  int tmp_ordering = 1;
 
  double yd2 = m_xyVtx[2].second - m_xyVtx[1].second;
  double yd0 = m_xyVtx[0].second - m_xyVtx[1].second;
  double xd2 = m_xyVtx[2].first - m_xyVtx[1].first;
  double xd0 = m_xyVtx[0].first - m_xyVtx[1].first;
  double ph2 = yd2 < 0 ? -M_PI / 2 : M_PI / 2;
  if (std::abs(xd2) > 1e-6) {
    ph2 = atan(yd2 / xd2);
    if (xd2 < 0)
      ph2 += M_PI;
  }
  double ph0 = yd0 < 0 ? -M_PI / 2 : M_PI / 2;
  if (std::abs(xd0) > 1e-6) {
    ph0 = atan(yd0 / xd0);
    if (xd0 < 0)
      ph0 += M_PI;
  }
  if (ph0 < 0)
    ph0 += 2 * M_PI;
  if (ph2 < 0)
    ph2 += 2 * M_PI;
 
  if ((ph0 > ph2 && ph0 - ph2 < M_PI) || (ph2 - ph0) > M_PI)
    tmp_ordering = 0;
 
  m_ordering.set(tmp_ordering);
  return *(m_ordering.ptr());
}

sideSurf()

std::unique_ptr< Trk::PlaneSurface > Trk::PrismVolumeBounds::sideSurf ( const Amg::Transform3D & transform, unsigned int iv1, unsigned int iv2 ) const

private

method to construct side boundary planes

Definition at line 131 of file PrismVolumeBounds.cxx.

{
  std::unique_ptr<Trk::PlaneSurface> plane = nullptr;
 
  double xdif = m_xyVtx[iv2].first - m_xyVtx[iv1].first;
  double ydif = m_xyVtx[iv2].second - m_xyVtx[iv1].second;
  double xsize = sqrt(xdif * xdif + ydif * ydif);
 
  double ori = ordering() > 0 ? 1. : -1.;
 
  Amg::Vector3D pos(
    0.5 * (m_xyVtx[iv1].first + m_xyVtx[iv2].first),
    0.5 * (m_xyVtx[iv1].second + m_xyVtx[iv2].second),
    0.);
  double phi = ori * ydif < 0 ? M_PI / 2 : -M_PI / 2;
  if (ori > 0 && ydif > 0)
    phi = M_PI / 2;
  if (std::abs(xdif) > 1e-6) {
    phi = atan(ydif / xdif);
    if (xdif < 0)
      phi += M_PI;
  }
 
  Amg::Transform3D tr(
    transform * Amg::Translation3D(pos) *
    Amg::AngleAxis3D(phi, Amg::Vector3D(0., 0., 1.)) *
    Amg::AngleAxis3D(-ori * 90 * Gaudi::Units::deg, Amg::Vector3D(1., 0., 0.)));
    plane = std::make_unique<Trk::PlaneSurface>(tr, std::make_shared<Trk::RectangleBounds>(0.5 * xsize, m_halfZ));
 
  // verify position of vertices - uncomment for debugging
  // if
  // (!plane->isOnSurface(Trk::GlobalPosition(m_xyVtx[iv1].first,m_xyVtx[iv1].second,m_halfZ),true,0.001,0.001)
  //    ||
  //    !plane->isOnSurface(Trk::GlobalPosition(m_xyVtx[iv2].first,m_xyVtx[iv2].second,-m_halfZ),true,0.001,0.001)
  //    )
  //  std::cout << "ERROR in PRISM side boundary:vertices out of plane"<<
  //  std::endl;
 
  // orientation
  int ivr = (iv1 == 0 || iv2 == 0) ? 1 : 0;
  if (ivr == 1 && (iv1 == 1 || iv2 == 1))
    ivr = 2;
 
  double ox = m_xyVtx[ivr].first - pos[0];
  double oy = m_xyVtx[ivr].second - pos[1];
  Amg::Vector3D d(ox, oy, 0.);
 
  // protect against wrong orientation
  if (d.dot(plane->normal()) > 0.) {
    tr = Amg::Transform3D(
      transform * Amg::Translation3D(pos) *
      Amg::AngleAxis3D(phi + M_PI, Amg::Vector3D(0., 0., 1.)) *
      Amg::AngleAxis3D(
        -ori * 90 * Gaudi::Units::deg, Amg::Vector3D(1., 0., 0.)));
    plane =
      std::make_unique<Trk::PlaneSurface>(tr, std::make_shared<Trk::RectangleBounds>(0.5 * xsize, m_halfZ));
  }
 
  return plane;
}

xyVertices()

const std::vector< std::pair< double, double > > & Trk::PrismVolumeBounds::xyVertices ( ) const

inline

This method returns the set of xy generating vertices.

Definition at line 120 of file PrismVolumeBounds.h.

          {
  return m_xyVtx;
}

Member Data Documentation

m_baseBounds

Trk::TriangleBounds* Trk::PrismVolumeBounds::m_baseBounds

private

base xy bounds

Definition at line 107 of file PrismVolumeBounds.h.

m_halfZ

double Trk::PrismVolumeBounds::m_halfZ

private

halflength in z

Definition at line 106 of file PrismVolumeBounds.h.

m_objectAccessor

Trk::EightObjectsAccessor Trk::PrismVolumeBounds::m_objectAccessor

private

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

this is a real relict,can we get rid of it ?

Definition at line 113 of file PrismVolumeBounds.h.

m_ordering

CxxUtils::CachedValue<int> Trk::PrismVolumeBounds::m_ordering

private

cache vertex ordering

Definition at line 108 of file PrismVolumeBounds.h.

m_xyVtx

std::vector<std::pair<double, double> > Trk::PrismVolumeBounds::m_xyVtx

private

generating xy vertices

Definition at line 105 of file PrismVolumeBounds.h.

---

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

• PrismVolumeBounds.h
• PrismVolumeBounds.cxx