OAEParametrizedMagneticField Class Reference

#include <OAEParametrizedMagneticField.h>

Inheritance diagram for OAEParametrizedMagneticField:

Public Member Functions
GlobalVector	inTesla (const GlobalPoint &gp) const
	Field value ad specified global point, in Tesla. More...
GlobalVector	inTeslaUnchecked (const GlobalPoint &gp) const
bool	isDefined (const GlobalPoint &gp) const
	True if the point is within the region where the concrete field. More...
	OAEParametrizedMagneticField (float B)
	Constructor, pass value for nominal field. More...
	OAEParametrizedMagneticField (std::string T="3_8T")
	Constructor, pass string for nominal field [deprecated]. More...
	OAEParametrizedMagneticField (const edm::ParameterSet &parameters)
	Constructor. Parameters taken from a PSet [deprecated]. More...
virtual	~OAEParametrizedMagneticField ()
	Destructor. More...
Public Member Functions inherited from MagneticField
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...
	MagneticField ()
	MagneticField (const MagneticField &orig)
int	nominalValue () const
	The nominal field value for this map in kGauss. More...
virtual	~MagneticField ()

Private Attributes
magfieldparam::TkBfield	theParam

Detailed Description

Magnetic Field engine wrapper for V. Karimaki's "off-axis expansion" of the TOSCA field version 1103l_071212 (2, 3, 3.4, 3.8, 4 T) valid in the region r<1.15 m and |z|<2.8 m For details, cf TkBfield.h

Author

N. Amapane - Torino

Definition at line 21 of file OAEParametrizedMagneticField.h.

Constructor & Destructor Documentation

OAEParametrizedMagneticField::OAEParametrizedMagneticField ( float  B )

explicit

Constructor, pass value for nominal field.

Definition at line 15 of file OAEParametrizedMagneticField.cc.

                                                                  : 
  theParam(B){}

OAEParametrizedMagneticField::OAEParametrizedMagneticField ( std::string  T = "3_8T" )

explicit

Constructor, pass string for nominal field [deprecated].

OAEParametrizedMagneticField::OAEParametrizedMagneticField ( const edm::ParameterSet &  parameters )

explicit

Constructor. Parameters taken from a PSet [deprecated].

Definition at line 22 of file OAEParametrizedMagneticField.cc.

                                                                                            : 
  theParam(parameters.getParameter<string>("BValue")) {}

OAEParametrizedMagneticField::~OAEParametrizedMagneticField ( )

virtual

Destructor.

Definition at line 26 of file OAEParametrizedMagneticField.cc.

{}

Member Function Documentation

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

virtual

Field value ad specified global point, in Tesla.

Implements MagneticField.

Definition at line 30 of file OAEParametrizedMagneticField.cc.

References inTeslaUnchecked(), and isDefined().

                                                                 {
  if (isDefined(gp)) {
    return inTeslaUnchecked(gp);
  } else {
    edm::LogWarning("MagneticField|FieldOutsideValidity") << " Point " << gp << " is outside the validity region of OAEParametrizedMagneticField";
    return GlobalVector();
  }
}

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

virtual

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

Reimplemented from MagneticField.

Definition at line 44 of file OAEParametrizedMagneticField.cc.

References magfieldparam::TkBfield::getBxyz(), theParam, x, PV3DBase< T, PVType, FrameType >::x(), PV3DBase< T, PVType, FrameType >::y(), and PV3DBase< T, PVType, FrameType >::z().

Referenced by inTesla().

                                                                          {
  float x[3] = {gp.x()*ooh, gp.y()*ooh, gp.z()*ooh};
  float B[3];
  theParam.getBxyz(x,B);
  return GlobalVector(B[0], B[1], B[2]);
}

bool OAEParametrizedMagneticField::isDefined ( const GlobalPoint &  ) const

virtual

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

Reimplemented from MagneticField.

Definition at line 53 of file OAEParametrizedMagneticField.cc.

References f, PV3DBase< T, PVType, FrameType >::perp2(), and PV3DBase< T, PVType, FrameType >::z().

Referenced by inTesla().

                                                                   {
  return (gp.perp2()<(115.f*115.f) && fabs(gp.z())<280.f);
}

Member Data Documentation

magfieldparam::TkBfield OAEParametrizedMagneticField::theParam

private

Definition at line 42 of file OAEParametrizedMagneticField.h.

Referenced by inTeslaUnchecked().