Trk::RectangleBounds Class Reference

Bounds for a rectangular, planar surface. More...

#include <RectangleBounds.h>

Inheritance diagram for Trk::RectangleBounds:

Collaboration diagram for Trk::RectangleBounds:

Public Types
enum	BoundValues { bv_halfX = 0 , bv_halfY = 1 , bv_length = 2 }
	for readability More...
enum	BoundsType {   Cone = 0 , Cylinder = 1 , Diamond = 2 , Disc = 3 ,   Ellipse = 5 , Rectangle = 6 , RotatedTrapezoid = 7 , Trapezoid = 8 ,   Triangle = 9 , DiscTrapezoidal = 10 , Annulus = 11 , Other = 12 }
	This enumerator simplifies the persistency, by saving a dynamic_cast to happen. More...

Public Member Functions
	RectangleBounds ()
	Default Constructor - needed for persistency.
	RectangleBounds (const RectangleBounds &recbo)
	Copy constructor.
RectangleBounds &	operator= (const RectangleBounds &recbo)
	Assignment Operator.
	RectangleBounds (RectangleBounds &&recbo) noexcept=default
	Move constructor.
RectangleBounds &	operator= (RectangleBounds &&recbo) noexcept=default
	Move Assignment Operator.
virtual	~RectangleBounds ()=default
	Destructor.
	RectangleBounds (double halex, double haley)
	Constructor with halflength in x (phi) and halflength in y (eta)
virtual bool	operator== (const SurfaceBounds &sbo) const override final
	Equality operator.
virtual RectangleBounds *	clone () const override
	Virtual constructor.
virtual BoundsType	type () const override final
	Return the type of the bounds for persistency.
virtual bool	inside (const Amg::Vector2D &locpo, double tol1=0., double tol2=0.) const override final
	This method checks if the provided local coordinates are inside the surface bounds.
virtual bool	inside (const Amg::Vector2D &locpo, const BoundaryCheck &bchk) const override final
	This method checks if the provided local coordinates are inside the surface bounds.
virtual bool	insideLoc1 (const Amg::Vector2D &locpo, double tol1=0.) const override final
	This method checks inside bounds in loc1.
virtual bool	insideLoc2 (const Amg::Vector2D &locpo, double tol2=0.) const override final
	This method checks inside bounds in loc2.
virtual double	minDistance (const Amg::Vector2D &pos) const override final
	Minimal distance to boundary ( > 0 if outside and <=0 if inside)
double	halflengthPhi () const
	This method returns the halflength in phi (first coordinate of local surface frame)
double	halflengthEta () const
	This method returns the halflength in Eta (second coordinate of local surface frame)
double	halflengthX () const
	for consistant naming
double	halflengthY () const
	for consitant naming
virtual double	r () const override
	This method returns the maximal extension on the local plane, i.e.
virtual MsgStream &	dump (MsgStream &sl) const override
	Output Method for MsgStream.
virtual std::ostream &	dump (std::ostream &sl) const override
	Output Method for std::ostream.
virtual bool	operator!= (const SurfaceBounds &sb) const
	Non-Equality operator.

Protected Member Functions
void	swap (double &b1, double &b2)
	Swap method to be called from DiscBounds or TrapezoidalBounds.
virtual void	initCache ()
	virtual initCache method for object persistency

Private Attributes
std::vector< TDD_real_t >	m_boundValues
	The internal version of the bounds can be float/double.

Detailed Description

Bounds for a rectangular, planar surface.

The two local coordinates locX, locY are for legacy reasons also called \( phi \) respectively \( eta \). The orientation with respect to the local surface framce can be seen in the attached illustration.

Author

Andre.nosp@m.as.S.nosp@m.alzbu.nosp@m.rger.nosp@m.@cern.nosp@m..ch

Definition at line 37 of file RectangleBounds.h.

Member Enumeration Documentation

BoundsType

enum Trk::SurfaceBounds::BoundsType

inherited

This enumerator simplifies the persistency, by saving a dynamic_cast to happen.

Other is reserved for the GeometrySurfaces implementation.

Enumerator
Cone
Cylinder
Diamond
Disc
Ellipse
Rectangle
RotatedTrapezoid
Trapezoid
Triangle
DiscTrapezoidal
Annulus
Other

Definition at line 58 of file SurfaceBounds.h.

  {
    Cone = 0,
    Cylinder = 1,
    Diamond = 2,
    Disc = 3,
    Ellipse = 5,
    Rectangle = 6,
    RotatedTrapezoid = 7,
    Trapezoid = 8,
    Triangle = 9,
    DiscTrapezoidal = 10,
    Annulus = 11,
    Other = 12
 
  };

BoundValues

enum Trk::RectangleBounds::BoundValues

for readability

Enumerator
bv_halfX
bv_halfY
bv_length

Definition at line 42 of file RectangleBounds.h.

  {
    bv_halfX = 0,
    bv_halfY = 1,
    bv_length = 2
  };

Constructor & Destructor Documentation

RectangleBounds() [1/4]

Trk::RectangleBounds::RectangleBounds

(

)

Default Constructor - needed for persistency.

Definition at line 18 of file RectangleBounds.cxx.

  : m_boundValues(RectangleBounds::bv_length, 0.)
{}

RectangleBounds() [2/4]

Trk::RectangleBounds::RectangleBounds

(

const RectangleBounds &

recbo

)

Copy constructor.

Definition at line 31 of file RectangleBounds.cxx.

  : Trk::SurfaceBounds()
  , m_boundValues(recbo.m_boundValues)
{}

RectangleBounds() [3/4]

Trk::RectangleBounds::RectangleBounds ( RectangleBounds && recbo )

defaultnoexcept

Move constructor.

~RectangleBounds()

virtual Trk::RectangleBounds::~RectangleBounds ( )

virtualdefault

Destructor.

RectangleBounds() [4/4]

Trk::RectangleBounds::RectangleBounds	(	double	halex,
		double	haley )

Constructor with halflength in x (phi) and halflength in y (eta)

Definition at line 23 of file RectangleBounds.cxx.

  : m_boundValues(RectangleBounds::bv_length, 0.)
{
  m_boundValues[RectangleBounds::bv_halfX] = halex;
  m_boundValues[RectangleBounds::bv_halfY] = haley;
}

Member Function Documentation

clone()

virtual RectangleBounds * Trk::RectangleBounds::clone ( ) const

overridevirtual

Virtual constructor.

Implements Trk::SurfaceBounds.

dump() [1/2]

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

overridevirtual

Output Method for MsgStream.

Implements Trk::SurfaceBounds.

Definition at line 134 of file RectangleBounds.cxx.

{
  sl << std::setiosflags(std::ios::fixed);
  sl << std::setprecision(7);
  sl << "Trk::RectangleBounds:  (halflenghtX, halflengthY) = "
     << "(" << m_boundValues[RectangleBounds::bv_halfX] << ", " << m_boundValues[RectangleBounds::bv_halfY] << ")";
  sl << std::setprecision(-1);
  return sl;
}

dump() [2/2]

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

overridevirtual

Output Method for std::ostream.

Implements Trk::SurfaceBounds.

Definition at line 145 of file RectangleBounds.cxx.

{
  sl << std::setiosflags(std::ios::fixed);
  sl << std::setprecision(7);
  sl << "Trk::RectangleBounds:  (halflenghtX, halflengthY) = "
     << "(" << m_boundValues[RectangleBounds::bv_halfX] << ", " << m_boundValues[RectangleBounds::bv_halfY] << ")";
  sl << std::setprecision(-1);
  return sl;
}

halflengthEta()

double Trk::RectangleBounds::halflengthEta

(

)

const

This method returns the halflength in Eta (second coordinate of local surface frame)

halflengthPhi()

double Trk::RectangleBounds::halflengthPhi

(

)

const

This method returns the halflength in phi (first coordinate of local surface frame)

halflengthX()

double Trk::RectangleBounds::halflengthX

(

)

const

for consistant naming

halflengthY()

double Trk::RectangleBounds::halflengthY

(

)

const

for consitant naming

initCache()

virtual void Trk::SurfaceBounds::initCache ( )

inlineprotectedvirtualinherited

virtual initCache method for object persistency

Reimplemented in Trk::ConeBounds, Trk::DiamondBounds, Trk::RotatedDiamondBounds, and Trk::RotatedTrapezoidBounds.

Definition at line 129 of file SurfaceBounds.h.

{}

inside() [1/2]

bool Trk::RectangleBounds::inside ( const Amg::Vector2D & locpo, const BoundaryCheck & bchk ) const

finaloverridevirtual

This method checks if the provided local coordinates are inside the surface bounds.

Implements Trk::SurfaceBounds.

Definition at line 56 of file RectangleBounds.cxx.

{
  if (bchk.bcType == 0)
    return RectangleBounds::inside(
      locpo, bchk.toleranceLoc1, bchk.toleranceLoc2);
 
  // a fast FALSE
  double max_ell = bchk.lCovariance(0, 0) > bchk.lCovariance(1, 1)
                     ? bchk.lCovariance(0, 0)
                     : bchk.lCovariance(1, 1);
  double limit = bchk.nSigmas * sqrt(max_ell);
  if (!RectangleBounds::inside(locpo, limit, limit))
    return false;
  // a fast TRUE
  double min_ell = bchk.lCovariance(0, 0) < bchk.lCovariance(1, 1)
                     ? bchk.lCovariance(0, 0)
                     : bchk.lCovariance(1, 1);
  limit = bchk.nSigmas * sqrt(min_ell);
  if (RectangleBounds::inside(locpo, limit, limit))
    return true;
 
  // compute KDOP and axes for surface polygon
  std::vector<KDOP> elementKDOP(4);
  std::vector<Amg::Vector2D> elementP(4);
  float theta =
    (bchk.lCovariance(1, 0) != 0 &&
     (bchk.lCovariance(1, 1) - bchk.lCovariance(0, 0)) != 0)
      ? .5 * bchk.FastArcTan(2 * bchk.lCovariance(1, 0) /
                             (bchk.lCovariance(1, 1) - bchk.lCovariance(0, 0)))
      : 0.;
  sincosCache scResult = bchk.FastSinCos(theta);
  AmgMatrix(2, 2) rotMatrix;
  rotMatrix << scResult.cosC, scResult.sinC, -scResult.sinC, scResult.cosC;
  // ellipse is always at (0,0), surface is moved to ellipse position and then
  // rotated
  Amg::Vector2D p;
  p = Amg::Vector2D (m_boundValues[RectangleBounds::bv_halfX],
                     m_boundValues[RectangleBounds::bv_halfY]);
  elementP[0] = (rotMatrix * (p - locpo));
  p = Amg::Vector2D (m_boundValues[RectangleBounds::bv_halfX],
                     -m_boundValues[RectangleBounds::bv_halfY]);
  elementP[1] = (rotMatrix * (p - locpo));
  p = Amg::Vector2D (-m_boundValues[RectangleBounds::bv_halfX],
                     m_boundValues[RectangleBounds::bv_halfY]);
  elementP[2] = (rotMatrix * (p - locpo));
  p = Amg::Vector2D (-m_boundValues[RectangleBounds::bv_halfX],
                     -m_boundValues[RectangleBounds::bv_halfY]);
  elementP[3] = (rotMatrix * (p - locpo));
  std::vector<Amg::Vector2D> axis = { elementP[0] - elementP[1],
                                      elementP[0] - elementP[2],
                                      elementP[0] - elementP[3],
                                      elementP[1] - elementP[2] };
  bchk.ComputeKDOP(elementP, axis, elementKDOP);
  // compute KDOP for error ellipse
  std::vector<KDOP> errelipseKDOP(4);
  bchk.ComputeKDOP(bchk.EllipseToPoly(3), axis, errelipseKDOP);
  // check if KDOPs overlap and return result
  return bchk.TestKDOPKDOP(elementKDOP, errelipseKDOP);
}

inside() [2/2]

virtual bool Trk::RectangleBounds::inside ( const Amg::Vector2D & locpo, double tol1 = 0., double tol2 = 0. ) const

finaloverridevirtual

This method checks if the provided local coordinates are inside the surface bounds.

Implements Trk::SurfaceBounds.

insideLoc1()

virtual bool Trk::RectangleBounds::insideLoc1 ( const Amg::Vector2D & locpo, double tol1 = 0. ) const

finaloverridevirtual

This method checks inside bounds in loc1.

• loc1/loc2 correspond to the natural coordinates of the surface

Implements Trk::SurfaceBounds.

insideLoc2()

virtual bool Trk::RectangleBounds::insideLoc2 ( const Amg::Vector2D & locpo, double tol2 = 0. ) const

finaloverridevirtual

This method checks inside bounds in loc2.

• loc1/loc2 correspond to the natural coordinates of the surface

Implements Trk::SurfaceBounds.

minDistance()

double Trk::RectangleBounds::minDistance ( const Amg::Vector2D & pos ) const

finaloverridevirtual

Minimal distance to boundary ( > 0 if outside and <=0 if inside)

Implements Trk::SurfaceBounds.

Definition at line 118 of file RectangleBounds.cxx.

{
  double dx = std::abs(pos[0]) - m_boundValues[RectangleBounds::bv_halfX];
  double dy = std::abs(pos[1]) - m_boundValues[RectangleBounds::bv_halfY];
 
  if (dx <= 0. || dy <= 0.) {
    if (dx > dy){
      return dx;
    }
    return dy;
  }
  return sqrt(dx * dx + dy * dy);
}

operator!=()

bool Trk::SurfaceBounds::operator!= ( const SurfaceBounds & sb ) const

inlinevirtualinherited

Non-Equality operator.

Reimplemented in Trk::InvalidBounds.

Definition at line 141 of file SurfaceBounds.h.

{
  return !((*this) == sb);
}

operator=() [1/2]

Trk::RectangleBounds & Trk::RectangleBounds::operator=

(

const RectangleBounds &

recbo

)

Assignment Operator.

Definition at line 38 of file RectangleBounds.cxx.

{
  if (this != &recbo)
    m_boundValues = recbo.m_boundValues;
  return *this;
}

operator=() [2/2]

RectangleBounds & Trk::RectangleBounds::operator= ( RectangleBounds && recbo )

defaultnoexcept

Move Assignment Operator.

operator==()

bool Trk::RectangleBounds::operator== ( const SurfaceBounds & sbo ) const

finaloverridevirtual

Equality operator.

Implements Trk::SurfaceBounds.

Definition at line 46 of file RectangleBounds.cxx.

{
  // check the type first not to compare apples with oranges
  const Trk::RectangleBounds* recbo = dynamic_cast<const Trk::RectangleBounds*>(&sbo);
  if (!recbo)
    return false;
  return (m_boundValues == recbo->m_boundValues);
}

r()

virtual double Trk::RectangleBounds::r ( ) const

overridevirtual

This method returns the maximal extension on the local plane, i.e.

\(s\sqrt{h_{\phi}^2 + h_{\eta}^2}\)

Implements Trk::SurfaceBounds.

swap()

void Trk::SurfaceBounds::swap ( double & b1, double & b2 )

inlineprotectedinherited

Swap method to be called from DiscBounds or TrapezoidalBounds.

Definition at line 133 of file SurfaceBounds.h.

{
  double tmp = b1;
  b1 = b2;
  b2 = tmp;
}

type()

virtual BoundsType Trk::RectangleBounds::type ( ) const

inlinefinaloverridevirtual

Return the type of the bounds for persistency.

Implements Trk::SurfaceBounds.

Definition at line 77 of file RectangleBounds.h.

{ return SurfaceBounds::Rectangle; }

Member Data Documentation

m_boundValues

std::vector<TDD_real_t> Trk::RectangleBounds::m_boundValues

private

The internal version of the bounds can be float/double.

Definition at line 119 of file RectangleBounds.h.

---

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

• RectangleBounds.h
• RectangleBounds.cxx