MagneticField Class Reference

#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 &) 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 19 of file MagneticField.h.

Member Enumeration Documentation

FooStates

enum MagneticField::FooStates

private

Enumerator
kUnset
kSetting
kSet

Definition at line 62 of file MagneticField.h.

{ kUnset, kSetting, kSet };

Constructor & Destructor Documentation

MagneticField() [1/2]

MagneticField::MagneticField

(

)

Definition at line 8 of file MagneticField.cc.

: nominalValueCompiuted(kUnset), theNominalValue(0) {}

MagneticField() [2/2]

MagneticField::MagneticField

(

const MagneticField &

orig

)

Definition at line 10 of file MagneticField.cc.

                                                      : nominalValueCompiuted(kUnset), theNominalValue(0) {
  if (orig.nominalValueCompiuted.load() == kSet) {
    theNominalValue = orig.theNominalValue;
    nominalValueCompiuted.store(kSet);
  }
}

References kSet, nominalValueCompiuted, and theNominalValue.

~MagneticField()

MagneticField::~MagneticField ( )

virtual

Definition at line 17 of file MagneticField.cc.

{}

Member Function Documentation

clone()

virtual MagneticField* MagneticField::clone ( void  ) const

inlinevirtual

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

Reimplemented in VolumeBasedMagneticField.

Definition at line 27 of file MagneticField.h.

{ return nullptr; }

computeNominalValue()

int MagneticField::computeNominalValue ( ) const

privatevirtual

Definition at line 19 of file MagneticField.cc.

                                             {
  int tmp = int((inTesla(GlobalPoint(0.f, 0.f, 0.f))).z() * 10.f + 0.5f);
 
  //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);
    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;
}

References f, createfilelist::int, inTesla(), kSet, kSetting, kUnset, nominalValueCompiuted, std::swap(), theNominalValue, createJobs::tmp, and z.

Referenced by nominalValue().

inInverseGeV()

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

inline

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

Definition at line 36 of file MagneticField.h.

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

References F(), runTauDisplay::gp, and inTesla().

Referenced by GeneralPurposeTrackAnalyzer::analyze(), PerigeeLinearizedTrackState::computeChargedJacobians(), PerigeeLinearizedTrackState::computeJacobians(), TwoBodyDecayEstimator::constructMatrices(), TSCPBuilderNoMaterial::createFTSatTransverseImpactPointCharged(), tauImpactParameter::ParticleBuilder::createTrackParticle(), JacobianCurvilinearToLocal::JacobianCurvilinearToLocal(), JacobianLocalToCurvilinear::JacobianLocalToCurvilinear(), PerigeeConversions::jacobianParameters2Cartesian(), KinematicPerigeeConversions::kinematicParametersFromExPerigee(), KinematicPerigeeConversions::momentumFromPerigee(), PerigeeConversions::momentumFromPerigee(), PFTau3ProngReco::produce(), and TwoTrackMinimumDistanceHelixHelix::updateCoeffs().

inKGauss()

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

inline

Field value ad specified global point, in KGauss.

Definition at line 33 of file MagneticField.h.

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

References runTauDisplay::gp, and inTesla().

Referenced by CSCDriftSim::getWireHit().

inTesla()

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

pure virtual

Field value ad specified global point, in Tesla.

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

Referenced by cms::SiPixelDigitizer::accumulatePixelHits(), cms::Phase2TrackerDigitizer::accumulatePixelHits(), SiStripDigitizer::accumulateStripHits(), SiStripCalibLorentzAngle::algoBeginJob(), DisplayGeom::analyze(), TrackerDpgAnalysis::analyze(), reco::tau::PFRecoTauChargedHadronFromPFCandidatePlugin::beginEvent(), ConvBremSeedProducer::beginRun(), tmtt::TMTrackProducer::beginRun(), L1FPGATrackProducer::beginRun(), GeneralPurposeTrackAnalyzer::beginRun(), TwoTrackMinimumDistanceLineLine::calculate(), ClosestApproachInRPhi::calculate(), TwoTrackMinimumDistance::calculate(), ConvertedPhotonProducer::calculateMinApproachDistance(), trackerDTC::Setup::checkMagneticField(), RPCSeedPattern::checkSimplePattern(), TangentApproachInRPhi::circleParameters(), computeNominalValue(), OutInConversionSeedFinder::createSeedFTS(), Phase2StripCPE::driftDirection(), StripCPE::driftDirection(), egammaTools::ecalPhi(), MFProducer::evaluate(), RPCSeedPattern::extropolateStep(), PixelRecoUtilities::FieldAt0::FieldAt0(), PixelCPEBase::fillDetParams(), ZeeCandidateFilter::filter(), HSCPTreeBuilder::filter(), PhotonConversionTrajectorySeedProducerFromSingleLegAlgo::find(), trackingTools::ftsFromVertexToPoint(), ClusterShapeHitFilter::getDrift(), sim::Field::GetFieldValue(), SteppingHelixPropagator::getNextState(), GlobalTrajectoryParameters::GlobalTrajectoryParameters(), ConversionFastHelix::helixStateAtVertex(), inInverseGeV(), inKGauss(), MagneticFieldMap::inTesla(), inTeslaUnchecked(), MagneticFieldMap::inTeslaZ(), SteppingHelixPropagator::loadState(), GlobalTrajectoryParameters::magneticFieldInInverseGeV(), SteppingHelixPropagator::makeAtomStep(), OutInConversionSeedFinder::makeTrackState(), SimpleCosmicBONSeeder::pqFromHelixFit(), SimpleCosmicBONSeeder::produce(), DTDigitizer::produce(), CtfSpecialSeedGenerator::produce(), LowPtGsfElectronSeedProducer::propagateTrackToCalo(), RPCSeedPattern::SegmentAlgorithmSpecial(), GlobalTrajectoryParameters::setCache(), SiPixelGenErrorDBObjectESProducer::SiPixelGenErrorDBObjectESProducer(), SiPixelTemplateDBObjectESProducer::SiPixelTemplateDBObjectESProducer(), SeedForPhotonConversionFromQuadruplets::trajectorySeed(), SimpleCosmicBONSeeder::triplets(), GeometryProducer::updateMagneticField(), and defaultRKPropagator::TrivialFieldProvider::valueInTesla().

inTeslaUnchecked()

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 OAEParametrizedMagneticField, PolyFit2DParametrizedMagneticField, ParabolicParametrizedMagneticField, UniformMagneticField, and VolumeBasedMagneticField.

Definition at line 44 of file MagneticField.h.

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

References runTauDisplay::gp, and inTesla().

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

isDefined()

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

inlinevirtual

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

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

Definition at line 40 of file MagneticField.h.

{ return true; }

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

nominalValue()

int MagneticField::nominalValue ( ) const

inline

The nominal field value for this map in kGauss.

Definition at line 49 of file MagneticField.h.

                           {
    if (kSet == nominalValueCompiuted.load())
      return theNominalValue;
    return computeNominalValue();
  }

References computeNominalValue(), kSet, nominalValueCompiuted, and theNominalValue.

Referenced by ReferenceTrajectory::construct(), SeedFromConsecutiveHitsCreator::init(), MultiHitGeneratorFromChi2::initES(), SeedForPhotonConversion1Leg::initialKinematic(), SeedForPhotonConversionFromQuadruplets::initialKinematic(), SimpleCosmicBONSeeder::pqFromHelixFit(), Onia2MuMuPAT::produce(), ConvBremSeedProducer::produce(), FreeTrajectoryState::rescaleError(), BasicTrajectoryState::rescaleError(), SeedFromGenericPairOrTriplet::seedFromTriplet(), SeedGeneratorForCosmics::seeds(), DTLinearDriftFromDBAlgo::setES(), and SeedForPhotonConversionFromQuadruplets::trajectorySeed().

Member Data Documentation

nominalValueCompiuted

std::atomic<char> MagneticField::nominalValueCompiuted

mutableprivate

Definition at line 58 of file MagneticField.h.

Referenced by computeNominalValue(), MagneticField(), and nominalValue().

theNominalValue

int MagneticField::theNominalValue

mutableprivate

Definition at line 61 of file MagneticField.h.

Referenced by computeNominalValue(), MagneticField(), and nominalValue().