Trk::ConeBounds Class Reference

Bounds for a conical Surface, the opening angle is stored in \( \tan(\alpha) \) and always positively defined. More...

#include <ConeBounds.h>

Inheritance diagram for Trk::ConeBounds:

Collaboration diagram for Trk::ConeBounds:

Public Types
enum	BoundValues {   bv_alpha = 0 , bv_minZ = 1 , bv_maxZ = 2 , bv_averagePhi = 3 ,   bv_halfPhiSector = 4 , bv_length = 5 }
	BoundValues for readablility. 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
	ConeBounds ()
	Default Constructor.
	ConeBounds (double alpha, bool symm, double halfphi=M_PI, double avphi=0.)
	Constructor - open cone with alpha, by default a full cone but optionally can make a conical section.
	ConeBounds (double alpha, double zmin, double zmax, double halfphi=M_PI, double avphi=0.)
	Constructor - open cone with alpha, minz and maxz, by default a full cone but can optionally make it a conical section.
	ConeBounds (const ConeBounds &cylbo)=default
	Copy Constructor.
ConeBounds &	operator= (const ConeBounds &cylbo)=default
	Assignment operator.
	ConeBounds (ConeBounds &&annbo)=default
	Move constructor.
ConeBounds &	operator= (ConeBounds &&sbo)=default
	Move assignment.
virtual	~ConeBounds ()=default
	Destructor.
virtual bool	operator== (const SurfaceBounds &sbo) const override
	Equality operator.
bool	operator== (const ConeBounds &bo) const
virtual ConeBounds *	clone () const override
	Virtual constructor.
virtual BoundsType	type () const override
	Return the bounds type.
virtual bool	inside (const Amg::Vector2D &locpo, double tol1, double tol2) const override final
	This method checks if a LocalPosition is inside z bounds and rphi value- interface method.
virtual bool	inside (const Amg::Vector2D &locpo, const BoundaryCheck &bchk=true) const override final
virtual bool	inside (const Amg::Vector3D &gp, double tol1=0., double tol2=0.) const final
	This method checks if a GlobalPosition is inside the Cylinder - not an interface method, assumes that GlobalPosition is in the right frame.
virtual bool	inside (const Amg::Vector3D &locpo, const BoundaryCheck &bchk) const final
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 loc1.
virtual double	minDistance (const Amg::Vector2D &pos) const override
	Minimal distance to boundary ( > 0 if outside and <=0 if inside)
virtual double	r () const override
	This method returns the maximal radius - for an unbound cone it returns MAXBOUNDVALUE.
double	r (double z) const
	Return the radius at a specific z values.
double	tanAlpha () const
	This method returns the average phi.
double	sinAlpha () const
double	cosAlpha () const
double	alpha () const
double	minZ () const
	This method returns the minimum z value in the local framee.
double	maxZ () const
	This method returns the maximum z value in the local framee.
double	averagePhi () const
	This method returns the average phi value (i.e.
double	halfPhiSector () const
	This method returns the half-phi width of the sector (so that averagePhi +/- halfPhiSector gives the phi bounds of the cone)
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.

Private Member Functions
virtual void	initCache () override final
	Helper function for angle parameter initialization.
double	minPhi () const
	Helpers for inside() functions.
double	maxPhi () const

Private Attributes
std::vector< TDD_real_t >	m_boundValues
	internal storage of the geometry parameters
TDD_real_t	m_tanAlpha
TDD_real_t	m_sinAlpha
TDD_real_t	m_cosAlpha

Detailed Description

Bounds for a conical Surface, the opening angle is stored in \( \tan(\alpha) \) and always positively defined.

The cone can open to both sides, steered by \( z_min \) and \( z_max \).

Author

Ian.W.nosp@m.atso.nosp@m.n@cer.nosp@m.n.ch, Andre.nosp@m.as.S.nosp@m.alzbu.nosp@m.rger.nosp@m.@cern.nosp@m..ch, Rober.nosp@m.t.La.nosp@m.ngenb.nosp@m.erg@.nosp@m.cern..nosp@m.ch

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

BoundValues for readablility.

Enumerator
bv_alpha
bv_minZ
bv_maxZ
bv_averagePhi
bv_halfPhiSector
bv_length

Definition at line 47 of file ConeBounds.h.

  {
    bv_alpha = 0,
    bv_minZ = 1,
    bv_maxZ = 2,
    bv_averagePhi = 3,
    bv_halfPhiSector = 4,
    bv_length = 5
  };

Constructor & Destructor Documentation

ConeBounds() [1/5]

Trk::ConeBounds::ConeBounds

(

)

Default Constructor.

Definition at line 18 of file ConeBounds.cxx.

  : m_boundValues(ConeBounds::bv_length, 0.)
  , m_tanAlpha(0.)
  , m_sinAlpha(0.)
  , m_cosAlpha(0.)
{}

ConeBounds() [2/5]

Trk::ConeBounds::ConeBounds	(	double	alpha,
		bool	symm,
		double	halfphi = M_PI,
		double	avphi = 0. )

Constructor - open cone with alpha, by default a full cone but optionally can make a conical section.

Definition at line 25 of file ConeBounds.cxx.

  : m_boundValues(ConeBounds::bv_length, 0.)
  , m_tanAlpha(0.)
  , m_sinAlpha(0.)
  , m_cosAlpha(0.)
{
  m_boundValues[ConeBounds::bv_alpha] = alpha;
  m_boundValues[ConeBounds::bv_minZ] = symm ? -MAXBOUNDVALUE : 0.;
  m_boundValues[ConeBounds::bv_maxZ] = MAXBOUNDVALUE;
  m_boundValues[ConeBounds::bv_averagePhi] = avphi;
  m_boundValues[ConeBounds::bv_halfPhiSector] = halfphi;
  ConeBounds::initCache();
}

ConeBounds() [3/5]

Trk::ConeBounds::ConeBounds	(	double	alpha,
		double	zmin,
		double	zmax,
		double	halfphi = M_PI,
		double	avphi = 0. )

Constructor - open cone with alpha, minz and maxz, by default a full cone but can optionally make it a conical section.

Definition at line 39 of file ConeBounds.cxx.

    : m_boundValues(ConeBounds::bv_length, 0.),
      m_tanAlpha(0.),
      m_sinAlpha(0.),
      m_cosAlpha(0.) {
  m_boundValues[ConeBounds::bv_alpha] = alpha;
  m_boundValues[ConeBounds::bv_minZ] = zmin;
  m_boundValues[ConeBounds::bv_maxZ] = zmax;
  m_boundValues[ConeBounds::bv_averagePhi] = avphi;
  m_boundValues[ConeBounds::bv_halfPhiSector] = halfphi;
  ConeBounds::initCache();
}

ConeBounds() [4/5]

Trk::ConeBounds::ConeBounds ( const ConeBounds & cylbo )

default

Copy Constructor.

ConeBounds() [5/5]

Trk::ConeBounds::ConeBounds ( ConeBounds && annbo )

default

Move constructor.

~ConeBounds()

virtual Trk::ConeBounds::~ConeBounds ( )

virtualdefault

Destructor.

Member Function Documentation

alpha()

double Trk::ConeBounds::alpha

(

)

const

averagePhi()

double Trk::ConeBounds::averagePhi

(

)

const

This method returns the average phi value (i.e.

the "middle" phi value for the conical sector we are describing)

clone()

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

overridevirtual

Virtual constructor.

Implements Trk::SurfaceBounds.

cosAlpha()

double Trk::ConeBounds::cosAlpha

(

)

const

dump() [1/2]

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

overridevirtual

Output Method for MsgStream.

Implements Trk::SurfaceBounds.

Definition at line 145 of file ConeBounds.cxx.

{
  sl << std::setiosflags(std::ios::fixed);
  sl << std::setprecision(7);
  sl << "Trk::ConeBounds: (tanAlpha, minZ, maxZ, averagePhi, halfPhiSector) = ";
  sl << "(" << this->tanAlpha() << ", " << this->minZ() << ", " << this->maxZ() << ", " << this->averagePhi() << ", "
     << this->halfPhiSector() << ")";
  sl << std::setprecision(-1);
  return sl;
}

dump() [2/2]

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

overridevirtual

Output Method for std::ostream.

Implements Trk::SurfaceBounds.

Definition at line 157 of file ConeBounds.cxx.

{
  sl << std::setiosflags(std::ios::fixed);
  sl << std::setprecision(7);
  sl << "Trk::ConeBounds: (tanAlpha, minZ, maxZ, averagePhi, halfPhiSector) = ";
  sl << "(" << this->tanAlpha() << ", " << this->minZ() << ", " << this->maxZ() << ", " << this->averagePhi() << ", "
     << this->halfPhiSector() << ")";
  sl << std::setprecision(-1);
  return sl;
}

halfPhiSector()

double Trk::ConeBounds::halfPhiSector

(

)

const

This method returns the half-phi width of the sector (so that averagePhi +/- halfPhiSector gives the phi bounds of the cone)

initCache()

void Trk::ConeBounds::initCache ( )

finaloverrideprivatevirtual

Helper function for angle parameter initialization.

Reimplemented from Trk::SurfaceBounds.

Definition at line 53 of file ConeBounds.cxx.

                              {
  m_tanAlpha = tan(m_boundValues[ConeBounds::bv_alpha]);
  m_sinAlpha = sin(m_boundValues[ConeBounds::bv_alpha]);
  m_cosAlpha = cos(m_boundValues[ConeBounds::bv_alpha]);
  // validate the halfphi
  if (m_boundValues[ConeBounds::bv_halfPhiSector] < 0.)
    m_boundValues[ConeBounds::bv_halfPhiSector] =
        -m_boundValues[ConeBounds::bv_halfPhiSector];
  if (m_boundValues[ConeBounds::bv_halfPhiSector] > M_PI)
    m_boundValues[ConeBounds::bv_halfPhiSector] = M_PI;
}

inside() [1/4]

virtual bool Trk::ConeBounds::inside ( const Amg::Vector2D & locpo, const BoundaryCheck & bchk = true ) const

finaloverridevirtual

Implements Trk::SurfaceBounds.

inside() [2/4]

virtual bool Trk::ConeBounds::inside ( const Amg::Vector2D & locpo, double tol1, double tol2 ) const

finaloverridevirtual

This method checks if a LocalPosition is inside z bounds and rphi value- interface method.

Implements Trk::SurfaceBounds.

inside() [3/4]

virtual bool Trk::ConeBounds::inside ( const Amg::Vector3D & gp, double tol1 = 0., double tol2 = 0. ) const

finalvirtual

This method checks if a GlobalPosition is inside the Cylinder - not an interface method, assumes that GlobalPosition is in the right frame.

inside() [4/4]

virtual bool Trk::ConeBounds::inside ( const Amg::Vector3D & locpo, const BoundaryCheck & bchk ) const

finalvirtual

insideLoc1()

virtual bool Trk::ConeBounds::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::ConeBounds::insideLoc2 ( const Amg::Vector2D & locpo, double tol2 = 0. ) const

finaloverridevirtual

This method checks inside bounds in loc1.

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

Implements Trk::SurfaceBounds.

maxPhi()

double Trk::ConeBounds::maxPhi ( ) const

inlineprivate

Definition at line 164 of file ConeBounds.h.

  {
    return m_boundValues[ConeBounds::bv_averagePhi] + m_boundValues[ConeBounds::bv_halfPhiSector];
  }

maxZ()

double Trk::ConeBounds::maxZ

(

)

const

This method returns the maximum z value in the local framee.

• for an unbound cone, it returns MAXBOUNDVALUE

minDistance()

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

overridevirtual

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

Implements Trk::SurfaceBounds.

Definition at line 74 of file ConeBounds.cxx.

{
  // This needs to be split based on where pos is with respect to the
  // cone. Inside, its easy, inside the z-region or inside the phi
  // region, just get the difference from the outside quantity, for
  // outside both the z and dphi regions, need to get the distance to
  // the cone corner, but remember, the cone piece will be symmetric
  // about the center of phi
 
  // TODO: The whole scheme here assumes that the local position is in
  // a half of R^3 where the cone is defined. If the local position is
  // in say the z < 0 half, and the cone is only defined for z > 0,
  // then it won't work
 
  // find the minimum distance along the z direction
  double toMinZ = m_boundValues[ConeBounds::bv_minZ] - pos[locZ];
  double toMaxZ = pos[locZ] - m_boundValues[ConeBounds::bv_maxZ];
  double toZ = (fabs(toMinZ) < fabs(toMaxZ)) ? toMinZ : toMaxZ;
 
  // NB this works only if the localPos is in the same hemisphere as
  // the cone (i.e. if the localPos has z < 0 and the cone only
  // defined for z > z_min where z_min > 0, this is wrong)
  double zDist = sqrt(toZ * toZ * (1. + m_tanAlpha * m_tanAlpha));
  if (toZ < 0.) // positive if outside the cone only
    zDist = -zDist;
 
  // if the cone is complete, or pos is in the same phi range as the
  // cone piece then its just the distance along the cone.
  if (m_boundValues[ConeBounds::bv_halfPhiSector] >= M_PI)
    return zDist;
 
  // we have a conical segment, so find also the phi distance
  // Note that here we take the phi distance as the distance from
  // going to the correct phi by a straight line at the point that was
  // input by the user (not at the point of closest approach to the
  // cone)
  double posR = pos[locZ] * m_tanAlpha;
  double deltaPhi = pos[locRPhi] / posR - m_boundValues[ConeBounds::bv_averagePhi]; // from center
  if (deltaPhi > M_PI)
    deltaPhi = 2 * M_PI - deltaPhi;
  if (deltaPhi < -M_PI)
    deltaPhi = 2 * M_PI + deltaPhi;
 
  // straight line distance (goes off cone)
  double phiDist = 2 * posR * sin(.5 * (deltaPhi - m_boundValues[ConeBounds::bv_halfPhiSector]));
 
  // if inside the cone, return the smaller length (since both are
  // negative, the *larger* of the 2 is the *smaller* distance)
  if (phiDist <= 0. && zDist <= 0) {
    if (phiDist > zDist){
      return phiDist;
    }
    return zDist;
  }
 
  // if inside the phi or z boundary, return the other
  if (phiDist <= 0.){
    return zDist;
  }
  if (zDist <= 0.){
    return phiDist;
  }
 
  // otherwise, return both (this should be the distance to the corner
  // closest to the cone
  return sqrt(zDist * zDist + phiDist * phiDist);
}

minPhi()

double Trk::ConeBounds::minPhi ( ) const

inlineprivate

Helpers for inside() functions.

Definition at line 160 of file ConeBounds.h.

  {
    return m_boundValues[ConeBounds::bv_averagePhi] - m_boundValues[ConeBounds::bv_halfPhiSector];
  }

minZ()

double Trk::ConeBounds::minZ

(

)

const

This method returns the minimum z value in the local framee.

• for an unbound symmetric cone, it returns -MAXBOUNDVALUE

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]

ConeBounds & Trk::ConeBounds::operator= ( ConeBounds && sbo )

default

Move assignment.

operator=() [2/2]

ConeBounds & Trk::ConeBounds::operator= ( const ConeBounds & cylbo )

default

Assignment operator.

operator==() [1/2]

bool Trk::ConeBounds::operator==

(

const ConeBounds &

bo

)

const

operator==() [2/2]

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

overridevirtual

Equality operator.

Implements Trk::SurfaceBounds.

Definition at line 65 of file ConeBounds.cxx.

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

r() [1/2]

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

overridevirtual

This method returns the maximal radius - for an unbound cone it returns MAXBOUNDVALUE.

Implements Trk::SurfaceBounds.

r() [2/2]

double Trk::ConeBounds::r

(

double

z

)

const

Return the radius at a specific z values.

sinAlpha()

double Trk::ConeBounds::sinAlpha

(

)

const

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;
}

tanAlpha()

double Trk::ConeBounds::tanAlpha

(

)

const

This method returns the average phi.

type()

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

inlineoverridevirtual

Return the bounds type.

Implements Trk::SurfaceBounds.

Definition at line 93 of file ConeBounds.h.

{ return SurfaceBounds::Cone; }

Member Data Documentation

m_boundValues

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

private

internal storage of the geometry parameters

Definition at line 151 of file ConeBounds.h.

m_cosAlpha

TDD_real_t Trk::ConeBounds::m_cosAlpha

private

Definition at line 154 of file ConeBounds.h.

m_sinAlpha

TDD_real_t Trk::ConeBounds::m_sinAlpha

private

Definition at line 153 of file ConeBounds.h.

m_tanAlpha

TDD_real_t Trk::ConeBounds::m_tanAlpha

private

Definition at line 152 of file ConeBounds.h.

---

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

• ConeBounds.h
• ConeBounds.cxx