Cylinder Class Reference

#include <Cylinder.h>

Inheritance diagram for Cylinder:

Public Types
typedef ReferenceCountingPointer< Cylinder >	BoundCylinderPointer
typedef ConstReferenceCountingPointer< Cylinder >	ConstBoundCylinderPointer
typedef ConstReferenceCountingPointer< Cylinder >	ConstCylinderPointer
typedef ReferenceCountingPointer< Cylinder >	CylinderPointer
Public Types inherited from Surface
using	Base = GloballyPositioned< float >
using	Side = SurfaceOrientation::Side
Public Types inherited from GloballyPositioned< float >
typedef Point3DBase< float, GlobalTag >	GlobalPoint
typedef Vector3DBase< float, GlobalTag >	GlobalVector
typedef Point3DBase< float, LocalTag >	LocalPoint
typedef Vector3DBase< float, LocalTag >	LocalVector
typedef Point3DBase< float, GlobalTag >	PositionType
typedef TkRotation< float >	RotationType
typedef float	Scalar

Public Member Functions
template<typename... Args>
	Cylinder (Scalar radius, Args &&... args)
	Cylinder (const PositionType &pos, const RotationType &rot, SimpleCylinderBounds const &bounds)
Plane	fastTangent (const GlobalPoint &aPoint) const
	tangent plane to surface from global point More...
Plane	fastTangent (const LocalPoint &aPoint) const
	tangent plane to surface from local point More...
Scalar	radius () const
	Radius of the cylinder. More...
virtual Side	side (const GlobalPoint &p, Scalar tolerance=0) const
virtual Side	side (const LocalPoint &p, Scalar tolerance=0) const=0
Side	side (const LocalPoint &p, Scalar toler) const override
ConstReferenceCountingPointer< TangentPlane >	tangentPlane (const GlobalPoint &) const override
	tangent plane to surface from global point More...
ConstReferenceCountingPointer< TangentPlane >	tangentPlane (const LocalPoint &) const override
	tangent plane to surface from local point More...
	~Cylinder () override
Public Member Functions inherited from Surface
const Bounds &	bounds () const
const MediumProperties &	mediumProperties () const
std::pair< float, float > const &	phiSpan () const
std::pair< float, float > const &	rSpan () const
void	setMediumProperties (const MediumProperties &mp)
virtual Side	side (const LocalPoint &p, Scalar tolerance=0) const =0
virtual Side	side (const GlobalPoint &p, Scalar tolerance=0) const
GlobalPoint	toGlobal (const Point2DBase< Scalar, LocalTag > lp) const
std::pair< float, float > const &	zSpan () const
	~Surface () override
Public Member Functions inherited from BasicReferenceCounted
void	addReference () const
	BasicReferenceCounted ()
	BasicReferenceCounted (const BasicReferenceCounted &)
	BasicReferenceCounted (BasicReferenceCounted &&)
BasicReferenceCounted &	operator= (BasicReferenceCounted &&)
BasicReferenceCounted &	operator= (const BasicReferenceCounted &)
unsigned int	references () const
void	removeReference () const
virtual	~BasicReferenceCounted ()
Public Member Functions inherited from GloballyPositioned< float >
float	eta () const
	GloballyPositioned ()
	GloballyPositioned (const PositionType &pos, const RotationType &rot)
void	move (const GlobalVector &displacement)
float	phi () const
const PositionType &	position () const
void	rotate (const RotationType &rotation)
const RotationType &	rotation () const
GlobalPoint	toGlobal (const LocalPoint &lp) const
Point3DBase< U, GlobalTag >	toGlobal (const Point3DBase< U, LocalTag > &lp) const
GlobalVector	toGlobal (const LocalVector &lv) const
Vector3DBase< U, GlobalTag >	toGlobal (const Vector3DBase< U, LocalTag > &lv) const
LocalPoint	toLocal (const GlobalPoint &gp) const
Point3DBase< U, LocalTag >	toLocal (const Point3DBase< U, GlobalTag > &gp) const
LocalVector	toLocal (const GlobalVector &gv) const
Vector3DBase< U, LocalTag >	toLocal (const Vector3DBase< U, GlobalTag > &gv) const
virtual	~GloballyPositioned ()

Static Public Member Functions
static CylinderPointer	build (const PositionType &pos, const RotationType &rot, Scalar radius, Bounds *bounds=nullptr)
static CylinderPointer	build (Scalar radius, const PositionType &pos, const RotationType &rot, Bounds *bounds=nullptr)
static float	computeRadius (Bounds const &bounds)
Static Public Member Functions inherited from GloballyPositioned< float >
static float	iniEta ()
static float	iniPhi ()

Private Attributes
Scalar	theRadius

Additional Inherited Members
Protected Member Functions inherited from Surface
	Surface ()
	Surface (const PositionType &pos, const RotationType &rot)
	Surface (const PositionType &pos, const RotationType &rot, Bounds *bounds)
	Surface (const PositionType &pos, const RotationType &rot, MediumProperties mp)
	Surface (const PositionType &pos, const RotationType &rot, MediumProperties mp, Bounds *bounds)
	Surface (const Surface &iSurface)
	Surface (Surface &&iSurface)
Protected Attributes inherited from Surface
extstd::clone_ptr< Bounds >	theBounds
MediumProperties	theMediumProperties

Detailed Description

A Cylinder.

Warning

Surfaces are reference counted, so only ReferenceCountingPointer should be used to point to them. For this reason, they should be using the static build() methods. (The normal constructor will become private in the future).

Definition at line 19 of file Cylinder.h.

Member Typedef Documentation

BoundCylinderPointer

typedef ReferenceCountingPointer<Cylinder> Cylinder::BoundCylinderPointer

Definition at line 32 of file Cylinder.h.

ConstBoundCylinderPointer

typedef ConstReferenceCountingPointer<Cylinder> Cylinder::ConstBoundCylinderPointer

Definition at line 33 of file Cylinder.h.

ConstCylinderPointer

typedef ConstReferenceCountingPointer<Cylinder> Cylinder::ConstCylinderPointer

Definition at line 31 of file Cylinder.h.

CylinderPointer

typedef ReferenceCountingPointer<Cylinder> Cylinder::CylinderPointer

Definition at line 30 of file Cylinder.h.

Constructor & Destructor Documentation

Cylinder() [1/2]

template<typename... Args>

Cylinder::Cylinder ( Scalar  radius, Args &&...  args  )

inline

Definition at line 22 of file Cylinder.h.

Referenced by build().

: Surface(std::forward<Args>(args)...), theRadius(radius) {}

Cylinder() [2/2]

Cylinder::Cylinder ( const PositionType &  pos, const RotationType &  rot, SimpleCylinderBounds const &  bounds  )

inline

Definition at line 24 of file Cylinder.h.

      : Surface(pos, rot, bounds.clone()), theRadius(computeRadius(bounds)) {}

~Cylinder()

Cylinder::~Cylinder ( )

inlineoverride

Definition at line 59 of file Cylinder.h.

{}

Member Function Documentation

build() [1/2]

static CylinderPointer Cylinder::build ( const PositionType &  pos, const RotationType &  rot, Scalar  radius, Bounds *  bounds = nullptr  )

inlinestatic

Construct a cylinder with the specified radius. The reference frame is defined by pos and rot; the cylinder axis is parallel to the local Z axis.

Definition at line 45 of file Cylinder.h.

References Cylinder(), radius(), and makeMuonMisalignmentScenario::rot.

Referenced by EMEnrichingFilterAlgo::applyBFieldCurv(), CosmicGenFilterHelix::CosmicGenFilterHelix(), L1MuonRecoTreeProducer::cylExtrapTrkSam(), ResidualRefitting::cylExtrapTrkSam(), CachedTrajectory::getTrajectory(), SmartPropagator::initTkVolume(), PropagateToCal::propagate(), spr::propagateCalo(), spr::propagateHCAL(), cms::MuonTCMETValueMapProducer::propagateTrack(), spr::propagateTrackerEnd(), TCMETAlgo::propagateTrackToCalorimeterFace(), TrackExtrapolator::propagateTrackToVolume(), psClasses.BuildThread::run(), and TrackEfficiencyMonitor::trackerAcceptance().

                                                         {
    return CylinderPointer(new Cylinder(radius, pos, rot, bounds));
  }

build() [2/2]

static CylinderPointer Cylinder::build ( Scalar  radius, const PositionType &  pos, const RotationType &  rot, Bounds *  bounds = nullptr  )

inlinestatic

Definition at line 52 of file Cylinder.h.

References Cylinder(), radius(), and makeMuonMisalignmentScenario::rot.

Referenced by psClasses.BuildThread::run().

                                                         {
    return CylinderPointer(new Cylinder(radius, pos, rot, bounds));
  }

computeRadius()

static float Cylinder::computeRadius ( Bounds const &  bounds )

inlinestatic

Definition at line 28 of file Cylinder.h.

Referenced by CylinderBuilderFromDet::build(), BarrelDetLayer::computeSurface(), initCylinder(), CylinderBuilderFromDet::operator()(), and TkConvValidator::recalculateMomentumAtFittedVertex().

{ return 0.5f * (bounds.width() - bounds.thickness()); }

fastTangent() [1/2]

Plane Cylinder::fastTangent ( const GlobalPoint &  aPoint ) const

inline

tangent plane to surface from global point

Definition at line 77 of file Cylinder.h.

References Vector3DBase< T, FrameTag >::cross(), GloballyPositioned< float >::position(), GloballyPositioned< float >::rotation(), and z.

                                                     {
    GlobalVector yPlane(rotation().z());
    GlobalVector xPlane(yPlane.cross(aPoint - position()));
    return Plane(aPoint, RotationType(xPlane, yPlane));
  }

fastTangent() [2/2]

Plane Cylinder::fastTangent ( const LocalPoint &  aPoint ) const

inline

tangent plane to surface from local point

Definition at line 84 of file Cylinder.h.

References fastTangent(), and Surface::toGlobal().

Referenced by fastTangent().

{ return fastTangent(toGlobal(aPoint)); }

radius()

Scalar Cylinder::radius ( ) const

inline

Radius of the cylinder.

Definition at line 64 of file Cylinder.h.

References theRadius.

Referenced by build(), MuonShowerInformationFiller::crossingPoint(), HelixBarrelCylinderCrossing::HelixBarrelCylinderCrossing(), MagCylinder::MagCylinder(), RKPropagatorInR::myPropagate(), PropagationDirectionChooser::operator()(), StraightLineBarrelCylinderCrossing::pathLength(), StraightLineCylinderCrossing::pathLength(), SteppingHelixPropagator::propagate(), StraightLinePropagator::propagateParametersOnCylinder(), RKPropagatorInS::propagateParametersOnCylinder(), SteppingHelixPropagator::refToMagVolume(), magneticfield::BaseVolumeHandle::sameSurface(), side(), and Geant4ePropagator::transformToG4SurfaceTarget().

{ return theRadius; }

side() [1/3]

virtual Side Surface::side

Returns the side of the surface on which the point is. Not defined for 1-sided surfaces (Moebius leaf etc.) For normal 2-sided surfaces the meaning of side is surface type dependent.

side() [2/3]

virtual Side Surface::side

inline

Definition at line 74 of file Surface.h.

{ return side(toLocal(p), tolerance); }

side() [3/3]

Surface::Side Cylinder::side ( const LocalPoint &  p, Scalar  toler  ) const

override

Definition at line 9 of file Cylinder.cc.

References SurfaceOrientation::negativeSide, SurfaceOrientation::onSurface, AlCaHLTBitMon_ParallelJobs::p, SurfaceOrientation::positiveSide, and radius().

Referenced by Geant4ePropagator::configureAnyPropagation().

                                                                  {
  Scalar lz = p.perp() - radius();
  return (fabs(lz) < toler ? SurfaceOrientation::onSurface
                           : (lz > 0 ? SurfaceOrientation::positiveSide : SurfaceOrientation::negativeSide));
}

tangentPlane() [1/2]

ConstReferenceCountingPointer< TangentPlane > Cylinder::tangentPlane ( const GlobalPoint &  aPoint ) const

overridevirtual

tangent plane to surface from global point

Implements Surface.

Definition at line 19 of file Cylinder.cc.

References funct::abs(), Vector3DBase< T, FrameTag >::cross(), SiStripPI::max, GloballyPositioned< float >::position(), GloballyPositioned< float >::rotation(), findQualityFiles::size, and z.

Referenced by tangentPlane().

                                                                                                  {
  //
  // Tangent plane at specified point. In order to avoid
  // possible numerical problems currently no attempt is made
  // to verify, if the point is actually on the cylinder.
  //
  // local y parallel to axis
  GlobalVector yPlane(rotation().z());
  // local x normal to y and a vector linking the specified
  // point with the axis
  GlobalVector xPlane(yPlane.cross(aPoint - position()));
  Scalar size = std::max(std::max(std::abs(xPlane.x()), std::abs(xPlane.y())), std::abs(xPlane.z()));
  if (size < FLT_MIN)
    throw GeometryError("Attempt to construct TangentPlane on cylinder axis");
  //   // local z defined by x and y (should point outwards from axis)
  //   GlobalVector zPlane(xPlane.cross(yPlane));
  // rotation constructor will normalize...
  return ConstReferenceCountingPointer<TangentPlane>(new TangentPlane(aPoint, RotationType(xPlane, yPlane)));
}

tangentPlane() [2/2]

ConstReferenceCountingPointer< TangentPlane > Cylinder::tangentPlane ( const LocalPoint &  aPoint ) const

overridevirtual

tangent plane to surface from local point

Implements Surface.

Definition at line 15 of file Cylinder.cc.

References tangentPlane(), and Surface::toGlobal().

                                                                                                 {
  return tangentPlane(toGlobal(aPoint));
}

Member Data Documentation

theRadius

Scalar Cylinder::theRadius

private

Definition at line 87 of file Cylinder.h.

Referenced by radius().