#include <MagneticField.h>

Inheritance diagram for MagneticField:

Public Member Functions
virtual MagneticField *	clone () const

GlobalVector	inInverseGeV (const GlobalPoint &gp) const
	Field value ad specified global point, in 1/Gev. More...

GlobalVector	inKGauss (const GlobalPoint &gp) const
	Field value ad specified global point, in KGauss. More...

virtual GlobalVector	inTesla (const GlobalPoint &gp) const =0
	Field value ad specified global point, in Tesla. More...

virtual GlobalVector	inTeslaUnchecked (const GlobalPoint &gp) const

virtual bool	isDefined (const GlobalPoint &gp) const
	True if the point is within the region where the concrete field. More...

	MagneticField ()

	MagneticField (const MagneticField &orig)

int	nominalValue () const
	The nominal field value for this map in kGauss. More...

virtual	~MagneticField ()

Private Types
enum	FooStates { kUnset, kSetting, kSet }

Private Member Functions
virtual int	computeNominalValue () const

Private Attributes
std::atomic< char >	nominalValueCompiuted

int	theNominalValue

Detailed Description

Base class for the different implementation of magnetic field engines.

Author: N. Amapane - CERN

Definition at line 17 of file MagneticField.h.

Member Enumeration Documentation

enum MagneticField::FooStates

private

Enumerator
kUnset
kSetting
kSet

Definition at line 63 of file MagneticField.h.

63 {kUnset, kSetting, kSet};

MagneticField::kSetting

Definition: MagneticField.h:63

MagneticField::kSet

Definition: MagneticField.h:63

MagneticField::kUnset

Definition: MagneticField.h:63

Constructor & Destructor Documentation

MagneticField::MagneticField ( )

Definition at line 8 of file MagneticField.cc.

References kUnset, and nominalValueCompiuted.

8 { nominalValueCompiuted.store(kUnset, std::memory_order_release); }

MagneticField::nominalValueCompiuted

std::atomic< char > nominalValueCompiuted

Definition: MagneticField.h:61

MagneticField::kUnset

Definition: MagneticField.h:63

MagneticField::MagneticField ( const MagneticField & orig )

Definition at line 10 of file MagneticField.cc.

References nominalValueCompiuted.

10 : theNominalValue (orig.theNominalValue)

11 { nominalValueCompiuted.store(orig.nominalValueCompiuted.load(std::memory_order_acquire), std::memory_order_release); }

MagneticField::nominalValueCompiuted

std::atomic< char > nominalValueCompiuted

Definition: MagneticField.h:61

MagneticField::theNominalValue

int theNominalValue

Definition: MagneticField.h:62

MagneticField::~MagneticField ( )

virtual

Definition at line 13 of file MagneticField.cc.

13 {}

Member Function Documentation

virtual MagneticField* MagneticField::clone ( void ) const

inlinevirtual

Derived classes can implement cloning without ownership of the underlying engines.

Definition at line 26 of file MagneticField.h.

                                        {
     return 0;
   }

int MagneticField::computeNominalValue ( ) const

privatevirtual

Definition at line 15 of file MagneticField.cc.

References f, inTesla(), and detailsBasic3DVector::z.

Referenced by nominalValue().

                                              {
   return int((inTesla(GlobalPoint(0.f,0.f,0.f))).z() * 10.f + 0.5f);
 }

GlobalVector MagneticField::inInverseGeV ( const GlobalPoint & gp ) const

inline

Field value ad specified global point, in 1/Gev.

Definition at line 39 of file MagneticField.h.

References F(), and inTesla().

Referenced by SingleTrackVertexConstraint::constrain(), tauImpactParameter::ParticleBuilder::createTrackParticle(), JacobianCurvilinearToLocal::JacobianCurvilinearToLocal(), JacobianLocalToCurvilinear::JacobianLocalToCurvilinear(), PerigeeConversions::jacobianParameters2Cartesian(), KinematicPerigeeConversions::kinematicParametersFromExPerigee(), KinematicPerigeeConversions::momentumFromPerigee(), PerigeeConversions::momentumFromPerigee(), and TwoTrackMinimumDistanceHelixHelix::updateCoeffs().

                                                          {
     return inTesla(gp) * 2.99792458e-3F;
   }

GlobalVector MagneticField::inKGauss ( const GlobalPoint & gp ) const

inline

Field value ad specified global point, in KGauss.

Definition at line 34 of file MagneticField.h.

References inTesla().

Referenced by CSCDriftSim::getWireHit().

                                                       {
     return inTesla(gp) * 10.F;
   }

virtual GlobalVector MagneticField::inTesla ( const GlobalPoint & gp ) const

pure virtual

Field value ad specified global point, in Tesla.

Implemented in OAE85lParametrizedMagneticField, VolumeBasedMagneticField, OAEParametrizedMagneticField, PolyFit2DParametrizedMagneticField, PolyFit3DParametrizedMagneticField, ParabolicParametrizedMagneticField, LocalMagneticField, and UniformMagneticField.

Referenced by PhotonConversionTrajectorySeedProducerFromSingleLegAlgo::analyze(), SiStripLAProfileBooker::beginRun(), ConvBremSeedProducer::beginRun(), SiTrackerGaussianSmearingRecHitConverter::beginRun(), TwoTrackMinimumDistanceLineLine::calculate(), TangentApproachInRPhi::circleParameters(), computeNominalValue(), shallow::drift(), StripCPE::driftDirection(), ECALPositionCalculator::ecalPhi(), ZeeCandidateFilter::filter(), HSCPTreeBuilder::filter(), FTSFromVertexToPointFactory::get(), sim::Field::GetFieldValue(), GlobalTrajectoryParameters::GlobalTrajectoryParameters(), ConversionFastHelix::helixStateAtVertex(), inInverseGeV(), inKGauss(), MagneticFieldMap::inTesla(), inTeslaUnchecked(), MagneticFieldMap::inTeslaZ(), StripCPEfromTemplate::localParameters(), GlobalTrajectoryParameters::magneticFieldInInverseGeV(), PixelCPEBase::param(), SiStripElectronAlgo::projectPhiBand(), PixelFitterByHelixProjections::run(), SeedFromNuclearInteraction::stateWithError(), and MonopoleSteppingAction::update().

virtual GlobalVector MagneticField::inTeslaUnchecked ( const GlobalPoint & gp ) const

inlinevirtual

Optional implementation that derived classes can implement to provide faster query by skipping the check to isDefined.

Reimplemented in OAE85lParametrizedMagneticField, VolumeBasedMagneticField, OAEParametrizedMagneticField, PolyFit2DParametrizedMagneticField, PolyFit3DParametrizedMagneticField, ParabolicParametrizedMagneticField, and UniformMagneticField.

Definition at line 51 of file MagneticField.h.

References inTesla().

Referenced by VolumeBasedMagneticField::inTesla(), and VolumeBasedMagneticField::inTeslaUnchecked().

                                                                       {
     return inTesla(gp);  // default dummy implementation
   }

virtual bool MagneticField::isDefined ( const GlobalPoint & gp ) const

inlinevirtual

True if the point is within the region where the concrete field.

Reimplemented in VolumeBasedMagneticField, OAE85lParametrizedMagneticField, OAEParametrizedMagneticField, ParabolicParametrizedMagneticField, PolyFit2DParametrizedMagneticField, PolyFit3DParametrizedMagneticField, and UniformMagneticField.

Definition at line 45 of file MagneticField.h.

Referenced by VolumeBasedMagneticField::inTesla(), and VolumeBasedMagneticField::inTeslaUnchecked().

                                                       {
     return true;
   }

int MagneticField::nominalValue ( ) const

The nominal field value for this map in kGauss.

Definition at line 19 of file MagneticField.cc.

References computeNominalValue(), kSet, kSetting, kUnset, nominalValueCompiuted, std::swap(), theNominalValue, and tmp.

Referenced by TrackProducerAlgorithm< reco::Track >::buildTrack(), TrackProducerAlgorithm< reco::GsfTrack >::buildTrack(), MultiHitGeneratorFromChi2::hitSets(), FreeTrajectoryState::rescaleError(), BasicTrajectoryState::rescaleError(), and SeedFromGenericPairOrTriplet::seedFromTriplet().

                                       {
   if(kSet==nominalValueCompiuted.load(std::memory_order_acquire)) return theNominalValue;
 
   //need to make one
   int tmp = computeNominalValue();
 
   //Try to cache
   char expected = kUnset;
   if(nominalValueCompiuted.compare_exchange_strong(expected, kSetting) ) {
     //it is our job to set the value
     std::swap(theNominalValue,tmp);
 
     //this must be after the swap
     nominalValueCompiuted.store(kSet, std::memory_order_release);
     return theNominalValue;
   }
   //another thread beat us to trying to set theNominalValue
   // since we don't know when the other thread will finish
   // we just return tmp
   return tmp;
 }

Member Data Documentation

std::atomic<char> MagneticField::nominalValueCompiuted

mutableprivate

Definition at line 61 of file MagneticField.h.

Referenced by MagneticField(), and nominalValue().

int MagneticField::theNominalValue

mutableprivate

Definition at line 62 of file MagneticField.h.

Referenced by nominalValue().

Public Member Functions

Private Types

Private Member Functions

Private Attributes

Detailed Description

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation