Plane Class Reference

#include <Plane.h>

Inheritance diagram for Plane:

Public Types
using	BoundPlanePointer = ReferenceCountingPointer< Plane >
using	ConstBoundPlanePointer = ConstReferenceCountingPointer< Plane >
using	ConstPlanePointer = ConstReferenceCountingPointer< Plane >
using	PlanePointer = ReferenceCountingPointer< Plane >
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
void	computeSpan ()
float	localZ (const GlobalPoint &gp) const
float	localZ (const GlobalVector &gv) const
	Fast access to component perpendicular to plane for a vector. More...
float	localZclamped (const GlobalPoint &gp) const
GlobalVector	normalVector () const
template<typename... Args>
	Plane (Args &&... args)
float	posPrec () const
SurfaceOrientation::Side	side (const LocalPoint &p, Scalar toler) const final
SurfaceOrientation::Side	side (const GlobalPoint &p, Scalar toler) const final
ConstReferenceCountingPointer< TangentPlane >	tangentPlane (const GlobalPoint &) const final
	tangent plane to surface from global point More...
ConstReferenceCountingPointer< TangentPlane >	tangentPlane (const LocalPoint &) const final
	tangent plane to surface from local point More...
	~Plane () 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)
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
template<typename... Args>
static PlanePointer	build (Args &&... args)
Static Public Member Functions inherited from GloballyPositioned< float >
static float	iniEta ()
static float	iniPhi ()

Private Member Functions
void	setPosPrec ()

Private Attributes
Scalar	m_posPrec

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 plane in 3D space.

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() method. (The normal constructor will become private in the future).

Definition at line 16 of file Plane.h.

Member Typedef Documentation

BoundPlanePointer

using Plane::BoundPlanePointer = ReferenceCountingPointer<Plane>

Definition at line 26 of file Plane.h.

ConstBoundPlanePointer

using Plane::ConstBoundPlanePointer = ConstReferenceCountingPointer<Plane>

Definition at line 27 of file Plane.h.

ConstPlanePointer

using Plane::ConstPlanePointer = ConstReferenceCountingPointer<Plane>

Definition at line 25 of file Plane.h.

PlanePointer

using Plane::PlanePointer = ReferenceCountingPointer<Plane>

Definition at line 24 of file Plane.h.

Constructor & Destructor Documentation

Plane()

template<typename... Args>

Plane::Plane ( Args &&...  args )

inline

Definition at line 19 of file Plane.h.

References computeSpan(), and setPosPrec().

Referenced by build().

                        : Surface(std::forward<Args>(args)...) {
    setPosPrec();
    computeSpan();
  }

~Plane()

Plane::~Plane ( )

inlineoverride

Definition at line 37 of file Plane.h.

{}

Member Function Documentation

build()

template<typename... Args>

static PlanePointer Plane::build ( Args &&...  args )

inlinestatic

Construct a Plane. The reference frame is defined by pos and rot; the plane is orthogonal to the local Z axis.

Definition at line 33 of file Plane.h.

References writedatasetfile::args, and Plane().

Referenced by EMEnrichingFilterAlgo::applyBFieldCurv(), CSCGeometryBuilder::buildChamber(), ReferenceTrajectory::construct(), CosmicGenFilterHelix::CosmicGenFilterHelix(), CaloDetIdAssociator::crossedElement(), TrajectoryExtrapolatorToLine::extrapolate(), CachedTrajectory::getTrajectory(), RectangularEtaPhiTrackingRegion::hits(), CosmicTrackingRegion::hits_(), HGCalTBGeometry::neighborZ(), HGCalGeometry::neighborZ(), TSGForOIFromL2::produce(), TSGForOIDNN::produce(), SeedGeneratorFromL1TTracksEDProducer::produce(), PropagateToCal::propagate(), spr::propagateCalo(), CachedTrajectory::propagateForward(), spr::propagateHCAL(), cms::MuonTCMETValueMapProducer::propagateTrack(), spr::propagateTrackerEnd(), TCMETAlgo::propagateTrackToCalorimeterFace(), TrackExtrapolator::propagateTrackToVolume(), KFBasedPixelFitter::run(), psClasses.BuildThread::run(), CSCPairResidualsConstraint::setZplane(), L1MuonRecoTreeProducer::surfExtrapTrkSam(), and MuCSCTnPFlatTableProducer::surfExtrapTrkSam().

                                            {
    return PlanePointer(new Plane(std::forward<Args>(args)...));
  }

computeSpan()

void Plane::computeSpan ( )

inline

Definition at line 58 of file Plane.h.

References Surface::theBounds.

Referenced by Plane().

                     {
    if (theBounds)
      theBounds->computeSpan(*this);
  }

localZ() [1/2]

float Plane::localZ ( const GlobalPoint &  gp ) const

inline

Fast access to distance from plane for a point. return 0 if too close

Definition at line 45 of file Plane.h.

References Vector3DBase< T, FrameTag >::dot(), runTauDisplay::gp, normalVector(), and GloballyPositioned< float >::position().

Referenced by Geant4ePropagator::configureAnyPropagation(), Geant4ePropagator::debugReportPlaneSetup(), RPCSeedPattern::extropolateStep(), fastProp(), localZclamped(), HelixArbitraryPlaneCrossing::notAtSurface(), HelixBarrelPlaneCrossingByCircle::pathLength(), HelixArbitraryPlaneCrossing::pathLength(), HelixArbitraryPlaneCrossing2Order::pathLength(), RKPropagatorInS::propagateParametersOnPlane(), side(), and SETSeedFinder::sortByLayer().

{ return normalVector().dot(gp - position()); }

localZ() [2/2]

float Plane::localZ ( const GlobalVector &  gv ) const

inline

Fast access to component perpendicular to plane for a vector.

Definition at line 53 of file Plane.h.

References Vector3DBase< T, FrameTag >::dot(), and normalVector().

{ return normalVector().dot(gv); }

localZclamped()

float Plane::localZclamped ( const GlobalPoint &  gp ) const

inline

Definition at line 47 of file Plane.h.

References funct::abs(), ztail::d, runTauDisplay::gp, localZ(), and posPrec().

                                                   {
    auto d = localZ(gp);
    return std::abs(d) > posPrec() ? d : 0;
  }

normalVector()

GlobalVector Plane::normalVector ( ) const

inline

Definition at line 41 of file Plane.h.

References GloballyPositioned< float >::rotation(), and z.

Referenced by GlobalTrackerMuonAlignment::analyzeTrackTrack(), GlobalTrackerMuonAlignment::analyzeTrackTrajectory(), tkDetUtil::calculatePhiWindow(), localZ(), OptimalHelixPlaneCrossing::OptimalHelixPlaneCrossing(), HelixBarrelPlaneCrossingByCircle::pathLength(), StraightLinePlaneCrossing::pathLength(), and HelixArbitraryPlaneCrossing2Order::pathLength().

{ return GlobalVector(rotation().z()); }

posPrec()

float Plane::posPrec ( ) const

inline

Definition at line 56 of file Plane.h.

References m_posPrec.

Referenced by localZclamped().

{ return m_posPrec; }

setPosPrec()

void Plane::setPosPrec ( )

inlineprivate

Definition at line 84 of file Plane.h.

References funct::abs(), ALPAKA_ACCELERATOR_NAMESPACE::brokenline::constexpr(), MainPageGenerator::l, m_posPrec, SiStripPI::max, AlCaHLTBitMon_ParallelJobs::p, and GloballyPositioned< float >::position().

Referenced by Plane().

                    {
    constexpr auto maxf = std::numeric_limits<float>::max();
    auto p = position();
    float l = std::max(std::max(std::abs(p.x()), std::abs(p.y())), std::abs(p.z()));
    m_posPrec = std::abs(
        l - ::nextafterf(l, maxf));  //  LSB  (can be multiplied by 4 or divided by 4 for safety depending on usage)
  }

side() [1/2]

SurfaceOrientation::Side Plane::side ( const LocalPoint &  p, Scalar  tolerance  ) const

inlinefinalvirtual

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.

Implements Surface.

Definition at line 65 of file Plane.h.

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

                                                                             {
    return (std::abs(p.z()) < toler)
               ? SurfaceOrientation::onSurface
               : (p.z() > 0 ? SurfaceOrientation::positiveSide : SurfaceOrientation::negativeSide);
  }

side() [2/2]

SurfaceOrientation::Side Plane::side ( const GlobalPoint &  p, Scalar  toler  ) const

inlinefinalvirtual

Reimplemented from Surface.

Definition at line 71 of file Plane.h.

References funct::abs(), localZ(), SurfaceOrientation::negativeSide, SurfaceOrientation::onSurface, AlCaHLTBitMon_ParallelJobs::p, and SurfaceOrientation::positiveSide.

                                                                              {
    Scalar lz = localZ(p);
    return (std::abs(lz) < toler ? SurfaceOrientation::onSurface
                                 : (lz > 0 ? SurfaceOrientation::positiveSide : SurfaceOrientation::negativeSide));
  }

tangentPlane() [1/2]

ConstReferenceCountingPointer< TangentPlane > Plane::tangentPlane ( const GlobalPoint &  ) const

finalvirtual

tangent plane to surface from global point

Implements Surface.

Definition at line 4 of file Plane.cc.

                                                                                        {
  return ConstReferenceCountingPointer<TangentPlane>(this);
}

tangentPlane() [2/2]

ConstReferenceCountingPointer< TangentPlane > Plane::tangentPlane ( const LocalPoint &  ) const

finalvirtual

tangent plane to surface from local point

Implements Surface.

Definition at line 8 of file Plane.cc.

                                                                                       {
  return ConstReferenceCountingPointer<TangentPlane>(this);
}

Member Data Documentation

m_posPrec

Scalar Plane::m_posPrec

private

Definition at line 92 of file Plane.h.

Referenced by posPrec(), and setPosPrec().