Plane Class Reference

#include <Plane.h>

Inheritance diagram for Plane:

Public Types
typedef ConstReferenceCountingPointer < Plane >	ConstPlanePointer
typedef ReferenceCountingPointer < Plane >	PlanePointer
Public Types inherited from Surface
typedef GloballyPositioned< float >	Base
typedef SurfaceOrientation::Side	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
float	localZ (const GlobalPoint &gp) const
	Fast access to distance from plane for a point. More...
float	localZ (const GlobalVector &gv) const
	Fast access to component perpendicular to plane for a vector. More...
GlobalVector	normalVector () const
	Plane (const PositionType &pos, const RotationType &rot)
	Plane (const PositionType &pos, const RotationType &rot, MediumProperties *mp)
virtual SurfaceOrientation::Side	side (const LocalPoint &p, Scalar toler) const
virtual SurfaceOrientation::Side	side (const GlobalPoint &p, Scalar toler) const
virtual ReferenceCountingPointer < TangentPlane >	tangentPlane (const GlobalPoint &) const
	tangent plane to surface from global point More...
virtual ReferenceCountingPointer < TangentPlane >	tangentPlane (const LocalPoint &) const
	tangent plane to surface from local point More...
Public Member Functions inherited from Surface
const MediumProperties *	mediumProperties () const
void	setMediumProperties (const MediumProperties &mp)
void	setMediumProperties (MediumProperties *mp)
	Surface (const PositionType &pos, const RotationType &rot)
	Surface (const PositionType &pos, const RotationType &rot, MediumProperties *mp)
	Surface (const PositionType &pos, const RotationType &rot, MediumProperties mp)
	Surface (const Surface &iSurface)
GlobalPoint	toGlobal (const Point2DBase< Scalar, LocalTag > lp) const
virtual	~Surface ()=0
Public Member Functions inherited from GloballyPositioned< float >
float	eta () const
	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 ()
Public Member Functions inherited from BasicReferenceCounted
void	addReference () const
	BasicReferenceCounted ()
	BasicReferenceCounted (const BasicReferenceCounted &iRHS)
const BasicReferenceCounted &	operator= (const BasicReferenceCounted &)
unsigned int	references () const
void	removeReference () const
virtual	~BasicReferenceCounted ()

Static Public Member Functions
static PlanePointer	build (const PositionType &pos, const RotationType &rot, MediumProperties *mp=0)
Static Public Member Functions inherited from GloballyPositioned< float >
static float	iniEta ()
static float	iniPhi ()

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 17 of file Plane.h.

Member Typedef Documentation

typedef ConstReferenceCountingPointer<Plane> Plane::ConstPlanePointer

Definition at line 20 of file Plane.h.

typedef ReferenceCountingPointer<Plane> Plane::PlanePointer

Definition at line 19 of file Plane.h.

Constructor & Destructor Documentation

Plane::Plane ( const PositionType &  pos, const RotationType &  rot  )

inline

Do not use this constructor directly; use the static build method, which returns a ReferenceCountingPointer. This constructor will soon become private

Definition at line 36 of file Plane.h.

Referenced by build().

                                                           :
    Surface( pos, rot) {}

Plane::Plane ( const PositionType &  pos, const RotationType &  rot, MediumProperties *  mp  )

inline

Do not use this constructor directly; use the static build method, which returns a ReferenceCountingPointer. This constructor will soon become private

Definition at line 42 of file Plane.h.

                                                                                 : 
    Surface( pos, rot, mp) {}

Member Function Documentation

static PlanePointer Plane::build ( const PositionType &  pos, const RotationType &  rot, MediumProperties *  mp = 0  )

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 25 of file Plane.h.

References Plane().

Referenced by EMEnrichingFilterAlgo::applyBFieldCurv(), doubleEMEnrichingFilterAlgo::applyBFieldCurv(), CosmicGenFilterHelix::CosmicGenFilterHelix(), CaloDetIdAssociator::crossedElement(), EcalShowerProperties::getSurface(), CachedTrajectory::getTrajectory(), CosmicTrackingRegion::hits(), RectangularEtaPhiTrackingRegion::hits(), HLTMuonPointingFilter::HLTMuonPointingFilter(), PlotRecTracks::printRecTracks(), EcalShowerProperties::processTrack(), PropagateToCal::propagate(), spr::propagateCalo(), CachedTrajectory::propagateForward(), cms::MuonTCMETValueMapProducer::propagateTrack(), TCMETAlgo::propagateTrack(), spr::propagateTrackerEnd(), TrackExtrapolator::propagateTrackToVolume(), and CSCPairResidualsConstraint::setZplane().

                                            {
    return PlanePointer(new Plane(pos, rot, mp));
  }

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

inline

Fast access to distance from plane for a point.

Definition at line 52 of file Plane.h.

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

Referenced by NavVolume6Faces::computeBounds(), CachedTrajectory::distance(), RPCSeedPattern::extropolateStep(), HelixArbitraryPlaneCrossing::notAtSurface(), HelixBarrelPlaneCrossingByCircle::pathLength(), HelixArbitraryPlaneCrossing2Order::pathLength(), TrackingRecHitProjector< ResultingHit >::project(), GSRecHitMatcher::projectOnly(), Geant4ePropagator::propagate(), RKPropagatorInS::propagateParametersOnPlane(), AnalyticalPropagator::propagateWithPath(), side(), SETSeedFinder::sortByLayer(), and TkGluedMeasurementDet::testStrips().

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

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

inline

Fast access to component perpendicular to plane for a vector.

Definition at line 57 of file Plane.h.

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

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

GlobalVector Plane::normalVector ( ) const

inline

Definition at line 47 of file Plane.h.

References GloballyPositioned< float >::rotation().

Referenced by GlobalTrackerMuonAlignment::analyzeTrackTrack(), GlobalTrackerMuonAlignment::analyzeTrackTrajectory(), DeDxEstimatorProducerPixelTripplet::beginRun(), NavVolume6Faces::computeBounds(), ThreePlaneCrossing::crossing(), localZ(), OuterDetCompatibility::maximalLocalDisplacement(), MaterialEffects::normalVector(), HelixBarrelPlaneCrossingByCircle::pathLength(), StraightLinePlaneCrossing::pathLength(), HelixArbitraryPlaneCrossing2Order::pathLength(), TrackingRecHitProjector< ResultingHit >::project(), GSRecHitMatcher::projectOnly(), NavPropagator::propagateInVolume(), MagGeoBuilderFromDDD::volumeHandle::sameSurface(), MagGeoBuilderFromDDD::volumeHandle::setSurface(), and TkGluedMeasurementDet::testStrips().

                                    {
    return GlobalVector( rotation().zx(), rotation().zy(), rotation().zz());
  }

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

inlinevirtual

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 63 of file Plane.h.

References abs, SurfaceOrientation::negativeSide, SurfaceOrientation::onSurface, SurfaceOrientation::positiveSide, and PV3DBase< T, PVType, FrameType >::z().

Referenced by NavVolume6Faces::computeBounds(), and NavPropagator::destinationCrossed().

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

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

inlinevirtual

Reimplemented from Surface.

Definition at line 68 of file Plane.h.

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

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

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

virtual

tangent plane to surface from global point

Implements Surface.

Definition at line 9 of file Plane.cc.

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

{
  return ReferenceCountingPointer<TangentPlane>(new TangentPlane(position(),
                                 rotation(),
                                 this));
}

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

virtual

tangent plane to surface from local point

Implements Surface.

Definition at line 17 of file Plane.cc.

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

{
  return ReferenceCountingPointer<TangentPlane>(new TangentPlane(position(),
                                 rotation(),
                                 this));
}