CMS 3D CMS Logo

 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Pages
List of all members | Public Types | Public Member Functions | Protected Member Functions | Protected Attributes
Surface Class Referenceabstract

#include <Surface.h>

Inheritance diagram for Surface:
GloballyPositioned< float > BasicReferenceCounted Cone Cylinder Plane BoundaryPlane BoundDiskSector Disk

Public Types

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

const Boundsbounds () const
 
const MediumPropertiesmediumProperties () 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
 
virtual
ConstReferenceCountingPointer
< TangentPlane
tangentPlane (const GlobalPoint &) const =0
 
virtual
ConstReferenceCountingPointer
< TangentPlane
tangentPlane (const LocalPoint &) const =0
 
GlobalPoint toGlobal (const Point2DBase< Scalar, LocalTag > lp) const
 
std::pair< float, float > const & zSpan () const
 
virtual ~Surface ()
 
- 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 PositionTypeposition () const
 
void rotate (const RotationType &rotation)
 
const RotationTyperotation () const
 
GlobalPoint toGlobal (const LocalPoint &lp) const
 
Point3DBase< U, GlobalTagtoGlobal (const Point3DBase< U, LocalTag > &lp) const
 
GlobalVector toGlobal (const LocalVector &lv) const
 
Vector3DBase< U, GlobalTagtoGlobal (const Vector3DBase< U, LocalTag > &lv) const
 
LocalPoint toLocal (const GlobalPoint &gp) const
 
Point3DBase< U, LocalTagtoLocal (const Point3DBase< U, GlobalTag > &gp) const
 
LocalVector toLocal (const GlobalVector &gv) const
 
Vector3DBase< U, LocalTagtoLocal (const Vector3DBase< U, GlobalTag > &gv) const
 
virtual ~GloballyPositioned ()
 
- Public Member Functions inherited from BasicReferenceCounted
void addReference () const
 
 BasicReferenceCounted ()
 
 BasicReferenceCounted (const BasicReferenceCounted &)
 
 BasicReferenceCounted (BasicReferenceCounted &&)=default
 
BasicReferenceCountedoperator= (BasicReferenceCounted &&)=default
 
BasicReferenceCountedoperator= (const BasicReferenceCounted &)
 
unsigned int references () const
 
void removeReference () const
 
virtual ~BasicReferenceCounted ()
 

Protected Member Functions

 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

extstd::clone_ptr< BoundstheBounds
 
MediumProperties theMediumProperties
 

Additional Inherited Members

- Static Public Member Functions inherited from GloballyPositioned< float >
static float iniEta ()
 
static float iniPhi ()
 

Detailed Description

Base class for 2D surfaces in 3D space. May have MediumProperties. may have bounds The Bounds define a region AROUND the surface. Surfaces which differ only by the shape of their bounds are of the same "surface" type (e.g. Plane or Cylinder).

Definition at line 42 of file Surface.h.

Member Typedef Documentation

Definition at line 48 of file Surface.h.

Definition at line 46 of file Surface.h.

Constructor & Destructor Documentation

virtual Surface::~Surface ( )
inlinevirtual

Definition at line 50 of file Surface.h.

50 {}
Surface::Surface ( )
inlineprotected

Definition at line 53 of file Surface.h.

53 {}
Surface::Surface ( const PositionType pos,
const RotationType rot 
)
inlineprotected

Definition at line 54 of file Surface.h.

54  :
55  Base( pos, rot) {}
GloballyPositioned< float > Base
Definition: Surface.h:48
Surface::Surface ( const PositionType pos,
const RotationType rot,
Bounds bounds 
)
inlineprotected

Definition at line 57 of file Surface.h.

58  :
59  Base( pos, rot),
60  theBounds(bounds)
61  {}
GloballyPositioned< float > Base
Definition: Surface.h:48
extstd::clone_ptr< Bounds > theBounds
Definition: Surface.h:141
Surface::Surface ( const PositionType pos,
const RotationType rot,
MediumProperties  mp 
)
inlineprotected

Definition at line 64 of file Surface.h.

65  :
66  Base( pos, rot),
68  {}
MediumProperties theMediumProperties
Definition: Surface.h:140
GloballyPositioned< float > Base
Definition: Surface.h:48
Surface::Surface ( const PositionType pos,
const RotationType rot,
MediumProperties  mp,
Bounds bounds 
)
inlineprotected

Definition at line 70 of file Surface.h.

72  :
73  Base( pos, rot),
75  theBounds(bounds)
76  {}
MediumProperties theMediumProperties
Definition: Surface.h:140
GloballyPositioned< float > Base
Definition: Surface.h:48
extstd::clone_ptr< Bounds > theBounds
Definition: Surface.h:141
Surface::Surface ( const Surface iSurface)
inlineprotected

Definition at line 80 of file Surface.h.

80  :
81  Base( iSurface),
83  theBounds(iSurface.theBounds)
84  {}
MediumProperties theMediumProperties
Definition: Surface.h:140
GloballyPositioned< float > Base
Definition: Surface.h:48
extstd::clone_ptr< Bounds > theBounds
Definition: Surface.h:141
Surface::Surface ( Surface &&  iSurface)
inlineprotected

Definition at line 86 of file Surface.h.

86  :
87  Base(iSurface),
89  theBounds(std::move(iSurface.theBounds))
90  {}
MediumProperties theMediumProperties
Definition: Surface.h:140
GloballyPositioned< float > Base
Definition: Surface.h:48
def move
Definition: eostools.py:510
extstd::clone_ptr< Bounds > theBounds
Definition: Surface.h:141

Member Function Documentation

const Bounds& Surface::bounds ( ) const
inline

Definition at line 120 of file Surface.h.

References theBounds.

Referenced by SiStripHitEffFromCalibTree::algoAnalyze(), SiStripCalibLorentzAngle::algoBeginJob(), SiStripLAProfileBooker::analyze(), TkLayerLess::barrelForwardLess(), SiStripDetInfoFileWriter::beginRun(), BoundDiskSector::bounds(), Cylinder::build(), CSCGeometryBuilder::buildChamber(), MuonTrackLoader::buildTrackExtra(), ValidateGeometry::compareShape(), MuRodBarrelLayer::compatibleDets(), BoundSpan::compute(), TIBLayer::computeWindowSize(), FWTGeoRecoGeometryESProducer::createShape(), SiPixelLorentzAngleCalibration::derivatives(), SiStripBackplaneCalibration::derivatives(), SiPixelDigitizerAlgorithm::digitize(), shallow::drift(), SiPixelDigitizerAlgorithm::drift(), SiStripLorentzAngleCalibration::effectiveThickness(), InsideBoundsMeasurementEstimator::estimate(), Chi2MeasurementEstimatorBase::estimate(), RectangularEtaPhiTrackingRegion::estimator(), ApeEstimator::fillHitVariables(), StripCPE::fillParams(), ClusterShapeHitFilter::getCotangent(), MuonDetIdAssociator::getDetIdPoints(), HitPairGeneratorFromLayerPairForPhotonConversion::getLayerRadius(), HitPairGeneratorFromLayerPairForPhotonConversion::getLayerZ(), TrackDetectorAssociator::getTAMuonChamberMatches(), GlobalDetRodRangeZPhi::GlobalDetRodRangeZPhi(), PixelTripletNoTipGenerator::hitTriplets(), ThirdHitCorrection::init(), InnerDeltaPhi::initBarrelLayer(), InnerDeltaPhi::initBarrelMS(), InnerDeltaPhi::initForwardLayer(), ThirdHitRZPredictionBase::initLayer(), ThirdHitPrediction::initLayer(), Disk::innerRadius(), MuonDetIdAssociator::insideElement(), DeDxTools::IsFarFromBorder(), ShallowGainCalibration::IsFarFromBorder(), SiStripGainFromData::IsFarFromBorder(), SimpleNavigationSchool::linkNextForwardLayer(), TrajectoryManager::makeSinglePSimHit(), SiStripGainCosmicCalculator::moduleThickness(), SiStripGainCosmicCalculator::moduleWidth(), MSLayer::MSLayer(), MuonResidualsFromTrack::MuonResidualsFromTrack(), CylinderBuilderFromDet::operator()(), Disk::outerRadius(), TIBLayer::overlap(), PixelBlade::overlap(), Phase1PixelBlade::overlap(), phiSpan(), MuonNavigationPrinter::printLayer(), StandaloneTrackMonitor::processClusters(), StandaloneTrackMonitor::processHit(), DeDxHitInfoProducer::processHit(), HSCPDeDxInfoProducer::processHit(), SiHitDigitizer::processHit(), DeDxEstimatorProducer::processHit(), MuonSimHitProducer::produce(), SiStripTrackingRecHitsValid::rechitanalysis(), SiStripTrackingRecHitsValid::rechitanalysis_matched(), rSpan(), SETPatternRecognition::segmentCleaning(), StripSubClusterShapeFilterBase::testLastHit(), TrajectoryAtInvalidHit::TrajectoryAtInvalidHit(), ValidateGeometry::validateDTLayerGeometry(), SimpleNavigableLayer::wellInside(), and zSpan().

120 { return *theBounds; }
extstd::clone_ptr< Bounds > theBounds
Definition: Surface.h:141
const MediumProperties& Surface::mediumProperties ( ) const
inline
std::pair<float,float> const& Surface::phiSpan ( ) const
inline

Definition at line 123 of file Surface.h.

References bounds(), and Bounds::phiSpan().

Referenced by barrelUtil::overlap(), and tkDetUtil::overlapInPhi().

123 { return bounds().phiSpan(); }
const Bounds & bounds() const
Definition: Surface.h:120
std::pair< float, float > const & phiSpan() const
Definition: Bounds.h:70
std::pair<float,float> const& Surface::rSpan ( ) const
inline

Definition at line 125 of file Surface.h.

References bounds(), and Bounds::rSpan().

125 { return bounds().rSpan(); }
const Bounds & bounds() const
Definition: Surface.h:120
std::pair< float, float > const & rSpan() const
Definition: Bounds.h:72
void Surface::setMediumProperties ( const MediumProperties mp)
inline

Definition at line 116 of file Surface.h.

References theMediumProperties.

116  {
117  theMediumProperties = mp;
118  }
MediumProperties theMediumProperties
Definition: Surface.h:140
virtual Side Surface::side ( const LocalPoint p,
Scalar  tolerance = 0 
) const
pure virtual

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.

Implemented in Cylinder, Plane, and Cone.

Referenced by side().

virtual Side Surface::side ( const GlobalPoint p,
Scalar  tolerance = 0 
) const
inlinevirtual

Reimplemented in Plane, and Cone.

Definition at line 99 of file Surface.h.

References side(), and GloballyPositioned< float >::toLocal().

99  {
100  return side( toLocal(p), tolerance);
101  }
virtual Side side(const LocalPoint &p, Scalar tolerance=0) const =0
LocalPoint toLocal(const GlobalPoint &gp) const
virtual ConstReferenceCountingPointer<TangentPlane> Surface::tangentPlane ( const GlobalPoint ) const
pure virtual

Tangent plane to surface from global point. Returns a plane, tangent to the Surface at a point. The point must be on the surface. The return type is a ReferenceCountingPointer, so the plane will be deleted automatically when no longer needed.

Implemented in Plane, Cylinder, and Cone.

Referenced by GlobalTrackerMuonAlignment::analyzeTrackTrack(), GlobalTrackerMuonAlignment::analyzeTrackTrajectory(), MuonSimHitProducer::applyMaterialEffects(), SteppingHelixStateInfo::getStateOnSurface(), ConvBremSeedProducer::makeTrajectoryState(), TrajectoryManager::makeTrajectoryState(), and GlobalMuonTrackMatcher::samePlane().

virtual ConstReferenceCountingPointer<TangentPlane> Surface::tangentPlane ( const LocalPoint ) const
pure virtual

Tangent plane to surface from local point.

Implemented in Plane, Cylinder, and Cone.

GlobalPoint Surface::toGlobal ( const Point2DBase< Scalar, LocalTag lp) const
inline

Definition at line 106 of file Surface.h.

References PV2DBase< T, PointTag, FrameTag >::basicVector(), PV3DBase< T, PVType, FrameType >::basicVector(), GloballyPositioned< float >::position(), and GloballyPositioned< float >::rotation().

Referenced by SiPixelDigitizerAlgorithm::accumulateSimHits(), SiStripDigitizerAlgorithm::accumulateSimHits(), ElectronSeedAnalyzer::analyze(), SiPixelTrackResidualSource::analyze(), TestHits::analyze(), PixelLumiDQM::analyze(), TestSmoothHits::analyze(), TestTrackHits::analyze(), SiPixelErrorEstimation::analyze(), SiPixelTrackingRecHitsValid::analyze(), TrackerTreeGenerator::analyze(), analyzer::SiPixelLorentzAngle::analyze(), TrackerDpgAnalysis::analyze(), TrackingRecHitLessFromGlobalPosition::barrelForwardLess(), TrackerDpgAnalysis::beginRun(), SeedFromGenericPairOrTriplet::buildSeed(), barrelUtil::calculatePhiWindow(), tkDetUtil::calculatePhiWindow(), CSCLayer::centerOfStrip(), CSCLayer::centerOfWireGroup(), PixelHitMatcher::compatibleHits(), BoundSpan::compute(), SiPixelErrorEstimation::computeAnglesFromDetPosition(), RodPlaneBuilderFromDet::computeBounds(), TIBRing::computeHelicity(), Phase1PixelBlade::computeRadiusRanges(), PlaneBuilderForGluedDet::computeRectBounds(), RodPlaneBuilderFromDet::computeRotation(), SiLinearChargeDivider::DeconvolutionShape(), DTDigiSyncTOFCorr::digitizerOffset(), ForwardMeasurementEstimator::estimate(), BarrelMeasurementEstimator::estimate(), AlignmentMonitorMuonResiduals::event(), AlignmentMonitorTracksFromTrajectories::event(), fastProp(), Cylinder::fastTangent(), SiPixelClusterModule::fill(), SiPixelRecHitsValid::fillBarrel(), TrackerValidationVariables::fillHitQuantities(), TrackerOfflineValidationSummary::fillTree(), DTTrigGeom::getGeom(), CSCSectorReceiverLUT::getGlobalEtaValue(), SiPixelClusterSource::getrococcupancye(), TrackAssociatorByPositionImpl::getState(), CachedTrajectory::getWideTrajectory(), CSCDriftSim::getWireHit(), GlobalDetRodRangeZPhi::GlobalDetRodRangeZPhi(), TValidTrackingRecHit::globalPosition(), TRecHit5DParamConstraint::globalPosition(), TRecHit2DPosConstraint::globalPosition(), BaseTrackerRecHit::globalPosition(), RKPropagatorInS::gtpFromLocal(), HelixBarrelCylinderCrossing::HelixBarrelCylinderCrossing(), TrackingRecHitLessFromGlobalPosition::insideOutLess(), SiPixelGaussianSmearingRecHitConverterAlgorithm::isFlipped(), PixelCPEBase::isFlipped(), JacobianCurvilinearToLocal::JacobianCurvilinearToLocal(), JacobianLocalToCurvilinear::JacobianLocalToCurvilinear(), TrajectoryManager::makeSinglePSimHit(), CosmicParametersDefinerForTP::momentum(), MultiTrajectoryStateMode::momentumFromModeLocal(), GeneralNSurfaceDelimitedBounds::myInside(), RKPropagatorInR::myPropagate(), PropagationDirectionChooser::operator()(), CosmicTrackingParticleSelector::operator()(), SeedFromNuclearInteraction::outerHitPosition(), StraightLineBarrelCylinderCrossing::pathLength(), SiLinearChargeDivider::PeakShape(), MultiTrajectoryStateMode::positionFromModeLocal(), JetCoreClusterSplitter::produce(), PixelClusterSelectorTopBottom::produce(), FastTrackerRecHitMatcher::produce(), DTDigitizer::produce(), TestHits::projectHit(), TestSmoothHits::projectHit(), TestTrackHits::projectHit(), SiStripRecHitsValid::projectHit(), GlobalRecHitsAnalyzer::projectHit(), GlobalRecHitsProducer::projectHit(), SiStripTrackingRecHitsValid::projectHit(), FastTrackerRecHitMatcher::projectOnly(), StraightLinePropagator::propagateParametersOnCylinder(), GEMRecHitMatcher::recHitPosition(), DigiSimLinkAlgorithm::run(), TrackerOfflineValidation::setUpTreeMembers(), Cone::side(), TrackClusterSplitter::splitCluster(), Cylinder::tangentPlane(), GeomDet::toGlobal(), NavSurface::toGlobal(), DTTrigGeom::toGlobal(), Geant4ePropagator::transformToG4SurfaceTarget(), ValidateGeometry::validateCSChamberGeometry(), ValidateGeometry::validateCSCLayerGeometry(), ValidateGeometry::validateDTChamberGeometry(), ValidateGeometry::validateDTLayerGeometry(), ValidateGeometry::validateRPCGeometry(), and CosmicParametersDefinerForTP::vertex().

106  {
107  return GlobalPoint( rotation().multiplyInverse( lp.basicVector()) +
108  position().basicVector());
109  }
const BasicVectorType & basicVector() const
Definition: PV2DBase.h:38
Point3DBase< float, GlobalTag > GlobalPoint
const RotationType & rotation() const
const BasicVectorType & basicVector() const
Definition: PV3DBase.h:56
const PositionType & position() const
std::pair<float,float> const& Surface::zSpan ( ) const
inline

Definition at line 124 of file Surface.h.

References bounds(), and Bounds::zSpan().

124 { return bounds().zSpan(); }
const Bounds & bounds() const
Definition: Surface.h:120
std::pair< float, float > const & zSpan() const
Definition: Bounds.h:71

Member Data Documentation

extstd::clone_ptr<Bounds> Surface::theBounds
protected

Definition at line 141 of file Surface.h.

Referenced by bounds(), and Plane::computeSpan().

MediumProperties Surface::theMediumProperties
protected

Definition at line 140 of file Surface.h.

Referenced by mediumProperties(), and setMediumProperties().