Trk::EllipseBounds Class Reference

Class to describe the bounds for a planar EllipseSurface, i.e. More...

#include <EllipseBounds.h>

Inheritance diagram for Trk::EllipseBounds:

Collaboration diagram for Trk::EllipseBounds:

Public Types
enum	BoundValues {   bv_rMinX = 0 , bv_rMinY = 1 , bv_rMaxX = 2 , bv_rMaxY = 3 ,   bv_averagePhi = 4 , bv_halfPhiSector = 5 , bv_length = 6 }
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
	EllipseBounds ()
	Default Constructor.
	EllipseBounds (const EllipseBounds &discbo)=default
	Copy constructor.
EllipseBounds &	operator= (const EllipseBounds &discbo)=default
	Assignment operator.
	EllipseBounds (EllipseBounds &&discbo) noexcept=default
	Move constructor.
EllipseBounds &	operator= (EllipseBounds &&discbo) noexcept=default
	Move assignment operator.
virtual	~EllipseBounds ()=default
	Destructor.
	EllipseBounds (double minrad1, double minrad2, double maxrad1, double maxrad2, double hphisec=M_PI)
	Constructor for full of an ellipsoid disc around phi=0.
	EllipseBounds (double minrad1, double minrad2, double maxrad1, double maxrad2, double avephi, double hphisec)
	Constructor for an ellipsoid disc around phi != 0.
virtual bool	operator== (const SurfaceBounds &sbo) const override
	Equality operator.
virtual EllipseBounds *	clone () const override final
	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 point given in the local coordinates is between two ellipsoids if only tol1 is given and additional in the phi sector is tol2 is given.
virtual bool	inside (const Amg::Vector2D &locpo, const BoundaryCheck &bchk) const override final
virtual bool	insideLoc1 (const Amg::Vector2D &locpo, double tol1=0.) const override final
	Check for inside first local coordinate.
virtual bool	insideLoc2 (const Amg::Vector2D &locpo, double tol2=0.) const override final
	Check for inside second local coordinate.
virtual double	minDistance (const Amg::Vector2D &pos) const override final
	Minimal distance to boundary ( > 0 if outside and <=0 if inside)
double	rMinX () const
	This method returns first inner radius.
double	rMinY () const
	This method returns second inner radius.
double	rMaxX () const
	This method returns first outer radius.
double	rMaxY () const
	This method returns second outer radius.
virtual double	r () const override final
	This method returns the maximum expansion on the plane (=max(rMaxX,rMaxY))
double	averagePhi () const
	This method returns the average phi.
double	halfPhiSector () const
	This method returns the halfPhiSector which is covered by the disc.
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 Member Functions
double	square (double x) const
	helper function for squaring

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

Detailed Description

Class to describe the bounds for a planar EllipseSurface, i.e.

the surface between two ellipses. By providing an argument for hphisec, the bounds can be restricted to a phirange around the center position.

Author

Marci.nosp@m.n.Wo.nosp@m.lter@.nosp@m.cern.nosp@m..ch

Definition at line 37 of file EllipseBounds.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::EllipseBounds::BoundValues

Enumerator
bv_rMinX
bv_rMinY
bv_rMaxX
bv_rMaxY
bv_averagePhi
bv_halfPhiSector
bv_length

Definition at line 41 of file EllipseBounds.h.

  {
    bv_rMinX = 0,
    bv_rMinY = 1,
    bv_rMaxX = 2,
    bv_rMaxY = 3,
    bv_averagePhi = 4,
    bv_halfPhiSector = 5,
    bv_length = 6
  };

Constructor & Destructor Documentation

EllipseBounds() [1/5]

Trk::EllipseBounds::EllipseBounds

(

)

Default Constructor.

Definition at line 20 of file EllipseBounds.cxx.

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

EllipseBounds() [2/5]

Trk::EllipseBounds::EllipseBounds ( const EllipseBounds & discbo )

default

Copy constructor.

EllipseBounds() [3/5]

Trk::EllipseBounds::EllipseBounds ( EllipseBounds && discbo )

defaultnoexcept

Move constructor.

~EllipseBounds()

virtual Trk::EllipseBounds::~EllipseBounds ( )

virtualdefault

Destructor.

EllipseBounds() [4/5]

Trk::EllipseBounds::EllipseBounds	(	double	minrad1,
		double	minrad2,
		double	maxrad1,
		double	maxrad2,
		double	hphisec = M_PI )

Constructor for full of an ellipsoid disc around phi=0.

Definition at line 24 of file EllipseBounds.cxx.

  : m_boundValues(EllipseBounds::bv_length, 0.)
{
  m_boundValues[EllipseBounds::bv_rMinX] = minradX;
  m_boundValues[EllipseBounds::bv_rMinY] = minradY;
  m_boundValues[EllipseBounds::bv_rMaxX] = maxradX;
  m_boundValues[EllipseBounds::bv_rMaxY] = maxradY;
  m_boundValues[EllipseBounds::bv_averagePhi] = 0.;
  m_boundValues[EllipseBounds::bv_halfPhiSector] = hphisec;
  if (m_boundValues[EllipseBounds::bv_rMinX] > m_boundValues[EllipseBounds::bv_rMaxX]){
    swap(m_boundValues[EllipseBounds::bv_rMinX], m_boundValues[EllipseBounds::bv_rMaxX]);
  }
  if (m_boundValues[EllipseBounds::bv_rMinY] > m_boundValues[EllipseBounds::bv_rMaxY]){
    swap(m_boundValues[EllipseBounds::bv_rMinY], m_boundValues[EllipseBounds::bv_rMaxY]);
  }
  //Make sure we do not get exactly 0 but something else small
  if(std::abs(m_boundValues[EllipseBounds::bv_rMinX])<closeToZero){
    m_boundValues[EllipseBounds::bv_rMinX]= closeToZero;
  }
  if(std::abs(m_boundValues[EllipseBounds::bv_rMinY])<closeToZero){
    m_boundValues[EllipseBounds::bv_rMinY]= closeToZero;
  }
 
 
}

EllipseBounds() [5/5]

Trk::EllipseBounds::EllipseBounds	(	double	minrad1,
		double	minrad2,
		double	maxrad1,
		double	maxrad2,
		double	avephi,
		double	hphisec )

Constructor for an ellipsoid disc around phi != 0.

Definition at line 50 of file EllipseBounds.cxx.

  : m_boundValues(EllipseBounds::bv_length, 0.)
{
 
  m_boundValues[EllipseBounds::bv_rMinX] = minradX;
  m_boundValues[EllipseBounds::bv_rMinY] = minradY;
  m_boundValues[EllipseBounds::bv_rMaxX] = maxradX;
  m_boundValues[EllipseBounds::bv_rMaxY] = maxradY;
  m_boundValues[EllipseBounds::bv_averagePhi] = avephi;
  m_boundValues[EllipseBounds::bv_halfPhiSector] = hphisec;
  if (m_boundValues[EllipseBounds::bv_rMinX] > m_boundValues[EllipseBounds::bv_rMaxX]){
    swap(m_boundValues[EllipseBounds::bv_rMinX], m_boundValues[EllipseBounds::bv_rMaxX]);
  }
  if (m_boundValues[EllipseBounds::bv_rMinY] > m_boundValues[EllipseBounds::bv_rMaxY]){
    swap(m_boundValues[EllipseBounds::bv_rMinY], m_boundValues[EllipseBounds::bv_rMaxY]);
  }
 
  //Make sure we do not get exactly 0 but something else small
  if(std::abs(m_boundValues[EllipseBounds::bv_rMinX])<closeToZero){
    m_boundValues[EllipseBounds::bv_rMinX]= closeToZero;
  }
  if(std::abs(m_boundValues[EllipseBounds::bv_rMinY])<closeToZero){
    m_boundValues[EllipseBounds::bv_rMinY]= closeToZero;
  }
 
 
}

Member Function Documentation

averagePhi()

double Trk::EllipseBounds::averagePhi ( ) const

inline

This method returns the average phi.

Definition at line 213 of file EllipseBounds.h.

{
  return m_boundValues[EllipseBounds::bv_averagePhi];
}

clone()

EllipseBounds * Trk::EllipseBounds::clone ( ) const

inlinefinaloverridevirtual

Virtual constructor.

Implements Trk::SurfaceBounds.

Definition at line 134 of file EllipseBounds.h.

{
  return new EllipseBounds(*this);
}

dump() [1/2]

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

overridevirtual

Output Method for MsgStream.

Implements Trk::SurfaceBounds.

Definition at line 172 of file EllipseBounds.cxx.

{
  sl << std::setiosflags(std::ios::fixed);
  sl << std::setprecision(7);
  sl << "Trk::EllipseBounds:  (innerRadiusX, innerRadiusY, outerRadiusX, outerRadiusY, averagePhi, hPhiSector) = ";
  sl << "(" << this->rMinX() << ", " << this->rMinY() << ", " << this->rMaxX() << ", " << this->rMaxY() << ", "
     << this->averagePhi() << ", " << this->halfPhiSector() << ")";
  sl << std::setprecision(-1);
  return sl;
}

dump() [2/2]

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

overridevirtual

Output Method for std::ostream.

Implements Trk::SurfaceBounds.

Definition at line 184 of file EllipseBounds.cxx.

{
  sl << std::setiosflags(std::ios::fixed);
  sl << std::setprecision(7);
  sl << "Trk::EllipseBounds:  (innerRadiusX, innerRadiusY, outerRadiusX, outerRadiusY, hPhiSector) = ";
  sl << "(" << this->rMinX() << ", " << this->rMinY() << ", " << this->rMaxX() << ", " << this->rMaxY() << ", "
     << this->averagePhi() << ", " << this->halfPhiSector() << ")";
  sl << std::setprecision(-1);
  return sl;
}

halfPhiSector()

double Trk::EllipseBounds::halfPhiSector ( ) const

inline

This method returns the halfPhiSector which is covered by the disc.

Definition at line 218 of file EllipseBounds.h.

{
  return m_boundValues[EllipseBounds::bv_halfPhiSector];
}

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::EllipseBounds::inside ( const Amg::Vector2D & locpo, const BoundaryCheck & bchk ) const

inlinefinaloverridevirtual

Implements Trk::SurfaceBounds.

Definition at line 158 of file EllipseBounds.h.

{
  return EllipseBounds::inside(locpo, bchk.toleranceLoc1, bchk.toleranceLoc2);
}

inside() [2/2]

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

inlinefinaloverridevirtual

This method checks if the point given in the local coordinates is between two ellipsoids if only tol1 is given and additional in the phi sector is tol2 is given.

Implements Trk::SurfaceBounds.

Definition at line 140 of file EllipseBounds.h.

{
  double alpha = acos(cos(locpo[locPhi] - m_boundValues[EllipseBounds::bv_averagePhi]));
  bool insidePhi = (m_boundValues[EllipseBounds::bv_halfPhiSector] + tol2 < M_PI)
                     ? (alpha <= (m_boundValues[EllipseBounds::bv_halfPhiSector] + tol2))
                     : 1;
  bool insideInner = (m_boundValues[EllipseBounds::bv_rMinX] <= tol1) ||
                     (m_boundValues[EllipseBounds::bv_rMinY] <= tol1) ||
                     (square(locpo[locX] / (m_boundValues[EllipseBounds::bv_rMinX] - tol1)) +
                        square(locpo[locY] / (m_boundValues[EllipseBounds::bv_rMinY] - tol1)) >
                      1);
  bool insideOuter = (square(locpo[locX] / (m_boundValues[EllipseBounds::bv_rMaxX] + tol1)) +
                        square(locpo[locY] / (m_boundValues[EllipseBounds::bv_rMaxY] + tol1)) <
                      1);
  return (insideInner && insideOuter && insidePhi);
}

insideLoc1()

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

inlinefinaloverridevirtual

Check for inside first local coordinate.

Implements Trk::SurfaceBounds.

Definition at line 164 of file EllipseBounds.h.

{
  bool insideInner = (m_boundValues[EllipseBounds::bv_rMinX] <= tol1) ||
                     (m_boundValues[EllipseBounds::bv_rMinY] <= tol1) ||
                     (square(locpo[locX] / (m_boundValues[EllipseBounds::bv_rMinX] - tol1)) +
                        square(locpo[locY] / (m_boundValues[EllipseBounds::bv_rMinY] - tol1)) >
                      1);
  bool insideOuter = (square(locpo[locX] / (m_boundValues[EllipseBounds::bv_rMaxX] + tol1)) +
                        square(locpo[locY] / (m_boundValues[EllipseBounds::bv_rMaxY] + tol1)) <
                      1);
  return (insideInner && insideOuter);
}

insideLoc2()

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

inlinefinaloverridevirtual

Check for inside second local coordinate.

Implements Trk::SurfaceBounds.

Definition at line 178 of file EllipseBounds.h.

{
  double alpha = acos(cos(locpo[locPhi] - m_boundValues[EllipseBounds::bv_averagePhi]));
  bool insidePhi = (m_boundValues[EllipseBounds::bv_halfPhiSector] + tol2 < M_PI)
                     ? (alpha <= (m_boundValues[EllipseBounds::bv_halfPhiSector] + tol2))
                     : 1;
  return insidePhi;
}

minDistance()

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

finaloverridevirtual

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

Implements Trk::SurfaceBounds.

Definition at line 98 of file EllipseBounds.cxx.

{
  const double pi2 = 2. * M_PI;
 
  double r = sqrt(pos[0] * pos[0] + pos[1] * pos[1]);
  if (r == 0.) {
    if (m_boundValues[EllipseBounds::bv_rMinX] <= m_boundValues[EllipseBounds::bv_rMinY])
      return m_boundValues[EllipseBounds::bv_rMinX];
    return m_boundValues[EllipseBounds::bv_rMinY];
  }
 
  const double inv_r = 1. / r;
  double sn = pos[1] * inv_r;
  double cs = pos[0] * inv_r;
  double sf = 0.;
  double dF = 0.;
 
  if (m_boundValues[EllipseBounds::bv_halfPhiSector] < M_PI) {
    dF = atan2(cs, sn) - m_boundValues[EllipseBounds::bv_averagePhi];
    dF += (dF > M_PI) ? -pi2 : (dF < -M_PI) ? pi2 : 0;
    double df = std::abs(dF) - m_boundValues[EllipseBounds::bv_halfPhiSector];
    sf = r * sin(df);
    if (df > 0.){
      r *= cos(df);
    }
  } else {
    sf = -1.e+10;
  }
 
  if (sf <= 0.) {
 
    double a = cs / m_boundValues[EllipseBounds::bv_rMaxX];
    double b = sn / m_boundValues[EllipseBounds::bv_rMaxY];
    double sr0 = r - 1. / std::sqrt(a * a + b * b);
    if (sr0 >= 0.)
      return sr0;
    a = cs / m_boundValues[EllipseBounds::bv_rMinX];
    b = sn / m_boundValues[EllipseBounds::bv_rMinY];
    double sr1 = 1. / std::sqrt(a * a + b * b) - r;
    if (sr1 >= 0.){
      return sr1;
    }
    if (sf < sr0){
      sf = sr0;
    }
    if (sf < sr1){
      sf = sr1;
    }
    return sf;
  }
 
  double fb;
  fb = (dF > 0.) ? m_boundValues[EllipseBounds::bv_averagePhi] + m_boundValues[EllipseBounds::bv_halfPhiSector]
                 : m_boundValues[EllipseBounds::bv_averagePhi] - m_boundValues[EllipseBounds::bv_halfPhiSector];
  sn = sin(fb);
  cs = cos(fb);
  double a = cs / m_boundValues[EllipseBounds::bv_rMaxX];
  double b = sn / m_boundValues[EllipseBounds::bv_rMaxY];
  double sr0 = r - 1. / std::sqrt(a * a + b * b);
  if (sr0 >= 0.){
    return std::sqrt(sr0 * sr0 + sf * sf);
  }
  a = cs / m_boundValues[EllipseBounds::bv_rMinX];
  b = sn / m_boundValues[EllipseBounds::bv_rMinY];
  double sr1 = 1. / sqrt(a * a + b * b) - r;
  if (sr1 >= 0.){
    return std::sqrt(sr1 * sr1 + sf * sf);
  }
  return sf;
}

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]

EllipseBounds & Trk::EllipseBounds::operator= ( const EllipseBounds & discbo )

default

Assignment operator.

operator=() [2/2]

EllipseBounds & Trk::EllipseBounds::operator= ( EllipseBounds && discbo )

defaultnoexcept

Move assignment operator.

operator==()

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

overridevirtual

Equality operator.

Implements Trk::SurfaceBounds.

Definition at line 84 of file EllipseBounds.cxx.

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

r()

double Trk::EllipseBounds::r ( ) const

inlinefinaloverridevirtual

This method returns the maximum expansion on the plane (=max(rMaxX,rMaxY))

Implements Trk::SurfaceBounds.

Definition at line 208 of file EllipseBounds.h.

{
  return std::max(m_boundValues[EllipseBounds::bv_rMaxX], m_boundValues[EllipseBounds::bv_rMaxY]);
}

rMaxX()

double Trk::EllipseBounds::rMaxX ( ) const

inline

This method returns first outer radius.

Definition at line 198 of file EllipseBounds.h.

{
  return m_boundValues[EllipseBounds::bv_rMaxX];
}

rMaxY()

double Trk::EllipseBounds::rMaxY ( ) const

inline

This method returns second outer radius.

Definition at line 203 of file EllipseBounds.h.

{
  return m_boundValues[EllipseBounds::bv_rMaxY];
}

rMinX()

double Trk::EllipseBounds::rMinX ( ) const

inline

This method returns first inner radius.

Definition at line 188 of file EllipseBounds.h.

{
  return m_boundValues[EllipseBounds::bv_rMinX];
}

rMinY()

double Trk::EllipseBounds::rMinY ( ) const

inline

This method returns second inner radius.

Definition at line 193 of file EllipseBounds.h.

{
  return m_boundValues[EllipseBounds::bv_rMinY];
}

square()

double Trk::EllipseBounds::square ( double x ) const

inlineprivate

helper function for squaring

Definition at line 130 of file EllipseBounds.h.

{ return x * x; };

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::EllipseBounds::type ( ) const

inlinefinaloverridevirtual

Return the type of the bounds for persistency.

Implements Trk::SurfaceBounds.

Definition at line 83 of file EllipseBounds.h.

{ return SurfaceBounds::Ellipse; }

Member Data Documentation

m_boundValues

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

private

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

Definition at line 127 of file EllipseBounds.h.

---

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

• EllipseBounds.h
• EllipseBounds.cxx