VolumeBasedMagneticField Class Reference

#include <VolumeBasedMagneticField.h>

Inheritance diagram for VolumeBasedMagneticField:

Public Member Functions
MagneticField *	clone () const override
	Returns a shallow copy. More...
const MagVolume *	findVolume (const GlobalPoint &gp) const
GlobalVector	inTesla (const GlobalPoint &g) const override
	Field value ad specified global point, in Tesla. More...
GlobalVector	inTeslaUnchecked (const GlobalPoint &g) const override
bool	isDefined (const GlobalPoint &gp) const override
	True if the point is within the region where the concrete field. More...
	VolumeBasedMagneticField (const VolumeBasedMagneticField &vbf)
	Copy constructor implement a shallow copy (ie no ownership of actual engines) More...
	VolumeBasedMagneticField (int geomVersion, const std::vector< MagBLayer * > &theBLayers, const std::vector< MagESector * > &theESectors, const std::vector< MagVolume6Faces * > &theBVolumes, const std::vector< MagVolume6Faces * > &theEVolumes, float rMax, float zMax, const MagneticField *param=nullptr, bool isParamFieldOwned=false)
	~VolumeBasedMagneticField () override
Public Member Functions inherited from MagneticField
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...
	MagneticField ()
	MagneticField (const MagneticField &orig)
int	nominalValue () const
	The nominal field value for this map in kGauss. More...
virtual	~MagneticField ()

Private Attributes
const MagGeometry *	field
bool	magGeomOwned
float	maxRsq
float	maxZ
const MagneticField *	paramField
bool	paramFieldOwned

Friends
class	testMagGeometryAnalyzer
class	testMagneticField

Detailed Description

Field engine providing interpolation within the full CMS region.

Author

N. Amapane - CERN

Definition at line 18 of file VolumeBasedMagneticField.h.

Constructor & Destructor Documentation

VolumeBasedMagneticField() [1/2]

VolumeBasedMagneticField::VolumeBasedMagneticField	(	int	geomVersion,
		const std::vector< MagBLayer * > &	theBLayers,
		const std::vector< MagESector * > &	theESectors,
		const std::vector< MagVolume6Faces * > &	theBVolumes,
		const std::vector< MagVolume6Faces * > &	theEVolumes,
		float	rMax,
		float	zMax,
		const MagneticField *	param = nullptr,
		bool	isParamFieldOwned = false
	)

Definition at line 4 of file VolumeBasedMagneticField.cc.

    : field(new MagGeometry(geomVersion, theBLayers, theESectors, theBVolumes, theEVolumes)),
      maxRsq(rMax * rMax),
      maxZ(zMax),
      paramField(param),
      magGeomOwned(true),
      paramFieldOwned(isParamFieldOwned) {}

Referenced by clone().

~VolumeBasedMagneticField()

VolumeBasedMagneticField::~VolumeBasedMagneticField ( )

override

Definition at line 33 of file VolumeBasedMagneticField.cc.

                                                    {
  if (magGeomOwned)
    delete field;
  if (paramFieldOwned)
    delete paramField;
}

References field, magGeomOwned, paramField, and paramFieldOwned.

VolumeBasedMagneticField() [2/2]

VolumeBasedMagneticField::VolumeBasedMagneticField

(

const VolumeBasedMagneticField &

vbf

)

Copy constructor implement a shallow copy (ie no ownership of actual engines)

Definition at line 20 of file VolumeBasedMagneticField.cc.

    : MagneticField::MagneticField(vbf),
      field(vbf.field),
      maxRsq(vbf.maxRsq),
      maxZ(vbf.maxZ),
      paramField(vbf.paramField),
      magGeomOwned(false),
      paramFieldOwned(false) {
  // std::cout << "VolumeBasedMagneticField::clone() (shallow copy)" << std::endl;
}

Member Function Documentation

clone()

MagneticField * VolumeBasedMagneticField::clone ( void  ) const

overridevirtual

Returns a shallow copy.

Reimplemented from MagneticField.

Definition at line 31 of file VolumeBasedMagneticField.cc.

{ return new VolumeBasedMagneticField(*this); }

References VolumeBasedMagneticField().

findVolume()

const MagVolume * VolumeBasedMagneticField::findVolume

(

const GlobalPoint &

gp

)

const

Definition at line 59 of file VolumeBasedMagneticField.cc.

{ return field->findVolume(gp); }

References field, MagGeometry::findVolume(), and runTauDisplay::gp.

Referenced by SteppingHelixPropagator::getNextState(), and SteppingHelixPropagator::loadState().

inTesla()

GlobalVector VolumeBasedMagneticField::inTesla ( const GlobalPoint &  gp ) const

overridevirtual

Field value ad specified global point, in Tesla.

Implements MagneticField.

Definition at line 40 of file VolumeBasedMagneticField.cc.

                                                                          {
  // If parametrization of the inner region is available, use it.
  if (paramField && paramField->isDefined(gp))
    return paramField->inTeslaUnchecked(gp);
 
  // If point is outside magfield map, return 0 field (not an error)
  if (!isDefined(gp))
    return GlobalVector();
 
  return field->fieldInTesla(gp);
}

References field, MagGeometry::fieldInTesla(), runTauDisplay::gp, MagneticField::inTeslaUnchecked(), MagneticField::isDefined(), isDefined(), and paramField.

Referenced by IsolatedPixelTrackCandidateProducer::beginRun(), and IsolatedPixelTrackCandidateL1TProducer::beginRun().

inTeslaUnchecked()

GlobalVector VolumeBasedMagneticField::inTeslaUnchecked ( const GlobalPoint &  gp ) const

overridevirtual

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

Reimplemented from MagneticField.

Definition at line 52 of file VolumeBasedMagneticField.cc.

                                                                                   {
  //same as above, but do not check range
  if (paramField && paramField->isDefined(gp))
    return paramField->inTeslaUnchecked(gp);
  return field->fieldInTesla(gp);
}

References field, MagGeometry::fieldInTesla(), runTauDisplay::gp, MagneticField::inTeslaUnchecked(), MagneticField::isDefined(), and paramField.

isDefined()

bool VolumeBasedMagneticField::isDefined ( const GlobalPoint &  ) const

overridevirtual

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

Reimplemented from MagneticField.

Definition at line 61 of file VolumeBasedMagneticField.cc.

                                                                    {
  return (fabs(gp.z()) < maxZ && gp.perp2() < maxRsq);
}

References runTauDisplay::gp, maxRsq, and maxZ.

Referenced by inTesla().

Friends And Related Function Documentation

testMagGeometryAnalyzer

friend class testMagGeometryAnalyzer

friend

Definition at line 21 of file VolumeBasedMagneticField.h.

testMagneticField

friend class testMagneticField

friend

Definition at line 20 of file VolumeBasedMagneticField.h.

Member Data Documentation

field

const MagGeometry* VolumeBasedMagneticField::field

private

Definition at line 51 of file VolumeBasedMagneticField.h.

Referenced by findVolume(), inTesla(), inTeslaUnchecked(), and ~VolumeBasedMagneticField().

magGeomOwned

bool VolumeBasedMagneticField::magGeomOwned

private

Definition at line 55 of file VolumeBasedMagneticField.h.

Referenced by ~VolumeBasedMagneticField().

maxRsq

float VolumeBasedMagneticField::maxRsq

private

Definition at line 52 of file VolumeBasedMagneticField.h.

Referenced by isDefined().

maxZ

float VolumeBasedMagneticField::maxZ

private

Definition at line 53 of file VolumeBasedMagneticField.h.

Referenced by isDefined().

paramField

const MagneticField* VolumeBasedMagneticField::paramField

private

Definition at line 54 of file VolumeBasedMagneticField.h.

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

paramFieldOwned

bool VolumeBasedMagneticField::paramFieldOwned

private

Definition at line 56 of file VolumeBasedMagneticField.h.

Referenced by ~VolumeBasedMagneticField().