BmnFieldMapSym3 Class Reference

#include <BmnFieldMapSym3.h>

Inheritance diagram for BmnFieldMapSym3:

Collaboration diagram for BmnFieldMapSym3:

Public Member Functions
	BmnFieldMapSym3 ()
	BmnFieldMapSym3 (const char *mapName)
	BmnFieldMapSym3 (BmnFieldPar *fieldPar)
virtual	~BmnFieldMapSym3 ()
virtual Double_t	GetBx (Double_t x, Double_t y, Double_t z)
virtual Double_t	GetBy (Double_t x, Double_t y, Double_t z)
virtual Double_t	GetBz (Double_t x, Double_t y, Double_t z)
virtual Bool_t	IsInside (Double_t x, Double_t y, Double_t z, Int_t &ix, Int_t &iy, Int_t &iz, Double_t &dx, Double_t &dy, Double_t &dz)
void	FillParContainer ()
	BmnFieldMapSym3 ()
	BmnFieldMapSym3 (const char *mapName)
	BmnFieldMapSym3 (BmnFieldPar *fieldPar)
virtual	~BmnFieldMapSym3 ()
virtual Double_t	GetBx (Double_t x, Double_t y, Double_t z)
virtual Double_t	GetBy (Double_t x, Double_t y, Double_t z)
virtual Double_t	GetBz (Double_t x, Double_t y, Double_t z)
virtual Bool_t	IsInside (Double_t x, Double_t y, Double_t z, Int_t &ix, Int_t &iy, Int_t &iz, Double_t &dx, Double_t &dy, Double_t &dz)
void	FillParContainer ()
Public Member Functions inherited from BmnFieldMap
	BmnFieldMap ()
	BmnFieldMap (const char *mapFileName)
	BmnFieldMap (BmnFieldPar *fieldPar)
virtual	~BmnFieldMap ()
virtual void	Init ()
void	WriteAsciiFile (const char *asciiFileName)
void	WriteRootFile (const char *rootFileName, const char *mapFileName)
void	SetPosition (Double_t x, Double_t y, Double_t z)
void	SetScale (Double_t factor)
void	SetFieldOff (Bool_t is_off=kTRUE)
void	SetFileName (const char *map_file_name)
Double_t	GetXmin () const
Double_t	GetYmin () const
Double_t	GetZmin () const
Double_t	GetXmax () const
Double_t	GetYmax () const
Double_t	GetZmax () const
Double_t	GetXstep () const
Double_t	GetYstep () const
Double_t	GetZstep () const
Int_t	GetNx () const
Int_t	GetNy () const
Int_t	GetNz () const
Double_t	GetPositionX () const
Double_t	GetPositionY () const
Double_t	GetPositionZ () const
Double_t	GetScale () const
Bool_t	IsFieldOff () const
TArrayF *	GetBx () const
TArrayF *	GetBy () const
TArrayF *	GetBz () const
const char *	GetFileName ()
virtual void	Print (Option_t *) const
void	Reset ()
	BmnFieldMap ()
	BmnFieldMap (const char *mapFileName)
	BmnFieldMap (BmnFieldPar *fieldPar)
virtual	~BmnFieldMap ()
virtual void	Init ()
void	WriteAsciiFile (const char *asciiFileName)
void	WriteRootFile (const char *rootFileName, const char *mapFileName)
void	SetPosition (Double_t x, Double_t y, Double_t z)
void	SetScale (Double_t factor)
void	SetFieldOff (Bool_t is_off=kTRUE)
void	SetFileName (const char *map_file_name)
Double_t	GetXmin () const
Double_t	GetYmin () const
Double_t	GetZmin () const
Double_t	GetXmax () const
Double_t	GetYmax () const
Double_t	GetZmax () const
Double_t	GetXstep () const
Double_t	GetYstep () const
Double_t	GetZstep () const
Int_t	GetNx () const
Int_t	GetNy () const
Int_t	GetNz () const
Double_t	GetPositionX () const
Double_t	GetPositionY () const
Double_t	GetPositionZ () const
Double_t	GetScale () const
Bool_t	IsFieldOff () const
TArrayF *	GetBx () const
TArrayF *	GetBy () const
TArrayF *	GetBz () const
const char *	GetFileName ()
virtual void	Print (Option_t *) const
void	Reset ()

Protected Attributes
Double_t	fHemiX
Double_t	fHemiY
Double_t	fHemiZ
Protected Attributes inherited from BmnFieldMap
Double_t	fScale
Double_t	fPosX
Double_t	fPosY
Double_t	fPosZ
Double_t	fPosBx
Double_t	fPosBy
Double_t	fPosBz
Double_t	fXmin
Double_t	fXmax
Double_t	fXstep
Double_t	fYmin
Double_t	fYmax
Double_t	fYstep
Double_t	fZmin
Double_t	fZmax
Double_t	fZstep
Int_t	fNx
Int_t	fNy
Int_t	fNz
TArrayF *	fBx
TArrayF *	fBy
TArrayF *	fBz
Double_t	fHa [2][2][2]
Double_t	fHb [2][2]
	Field at corners of a grid cell.
Double_t	fHc [2]
	Interpolated field (2-dim)
Bool_t	fDebugInfo
	Interpolated field (1-dim)
Bool_t	fIsOff

Additional Inherited Members
Protected Member Functions inherited from BmnFieldMap
void	ReadAsciiFile (const char *asciiFileName)
void	ReadRootFile (const char *rootFileName)
void	ReadRootFileNewFormat (const char *rootFileName)
void	ReadRootFileNewFormatExtrap (const char *rootFileName)
void	SetField (const BmnFieldMapData *data)
Double_t	Interpolate (Double_t dx, Double_t dy, Double_t dz)
void	ReadAsciiFile (const char *asciiFileName)
void	ReadRootFile (const char *rootFileName)
void	ReadRootFileNewFormat (const char *rootFileName)
void	ReadRootFileNewFormatExtrap (const char *rootFileName)
void	SetField (const BmnFieldMapData *data)
Double_t	Interpolate (Double_t dx, Double_t dy, Double_t dz)

Detailed Description

BmnFieldMapSym3.h

Author

M.Al/Turany m.al-.nosp@m.tura.nosp@m.ny@gs.nosp@m.i.de

V.Friese v.fri.nosp@m.ese@.nosp@m.gsi.d.nosp@m.e

Since

12.01.2004 @version1.0

Magnetic field map on a 3-D grid with symmetries w.r.t. the three coordinate axes. The map is only stored in the octant x>0, y>0, z>0. The symmetries are:

• Bx is antisymmetric in x and symmetric in y and z
• By is symmetric in x, y and z
• Bz is antisymmetric in x and z and symmetric in y

Field values are hold and returned in kG.

Definition at line 30 of file BmnFieldMapSym3.h.

Constructor & Destructor Documentation

BmnFieldMapSym3() [1/6]

BmnFieldMapSym3::BmnFieldMapSym3

(

)

Default constructor

Definition at line 16 of file BmnFieldMapSym3.cxx.

BmnFieldMapSym3() [2/6]

BmnFieldMapSym3::BmnFieldMapSym3

(

const char *

mapName

)

Standard constructor

Parameters

name	Name of field map
fileType	R = ROOT file, A = ASCII

Definition at line 26 of file BmnFieldMapSym3.cxx.

BmnFieldMapSym3() [3/6]

BmnFieldMapSym3::BmnFieldMapSym3

(

BmnFieldPar *

fieldPar

)

Constructor from BmnFieldPar

Definition at line 36 of file BmnFieldMapSym3.cxx.

~BmnFieldMapSym3() [1/2]

BmnFieldMapSym3::~BmnFieldMapSym3 ( )

virtual

Destructor

Definition at line 46 of file BmnFieldMapSym3.cxx.

BmnFieldMapSym3() [4/6]

BmnFieldMapSym3::BmnFieldMapSym3

(

)

Default constructor

BmnFieldMapSym3() [5/6]

BmnFieldMapSym3::BmnFieldMapSym3

(

const char *

mapName

)

Standard constructor

Parameters

name	Name of field map
fileType	R = ROOT file, A = ASCII

BmnFieldMapSym3() [6/6]

BmnFieldMapSym3::BmnFieldMapSym3

(

BmnFieldPar *

fieldPar

)

Constructor from BmnFieldPar

~BmnFieldMapSym3() [2/2]

virtual BmnFieldMapSym3::~BmnFieldMapSym3 ( )

virtual

Destructor

Member Function Documentation

FillParContainer() [1/2]

void BmnFieldMapSym3::FillParContainer ( )

virtual

Implements BmnFieldMap.

Definition at line 182 of file BmnFieldMapSym3.cxx.

References BmnFieldPar::SetParameters().

FillParContainer() [2/2]

void BmnFieldMapSym3::FillParContainer ( )

virtual

Implements BmnFieldMap.

GetBx() [1/2]

Double_t BmnFieldMapSym3::GetBx ( Double_t  x, Double_t  y, Double_t  z  )

virtual

Get the field components at a certain point

Parameters

x,y,z

Point coordinates (global) [cm] @value Bx,By,Bz Field components [kG]

Implements BmnFieldMap.

Definition at line 50 of file BmnFieldMapSym3.cxx.

References BmnFieldMap::fBx, BmnFieldMap::fHa, fHemiX, fHemiY, BmnFieldMap::fNy, BmnFieldMap::fNz, BmnFieldMap::Interpolate(), and IsInside().

GetBx() [2/2]

virtual Double_t BmnFieldMapSym3::GetBx ( Double_t  x, Double_t  y, Double_t  z  )

virtual

Get the field components at a certain point

Parameters

x,y,z

Point coordinates (global) [cm] @value Bx,By,Bz Field components [kG]

Implements BmnFieldMap.

GetBy() [1/2]

Double_t BmnFieldMapSym3::GetBy ( Double_t  x, Double_t  y, Double_t  z  )

virtual

Implements BmnFieldMap.

Definition at line 79 of file BmnFieldMapSym3.cxx.

References BmnFieldMap::fBy, BmnFieldMap::fHa, BmnFieldMap::fNy, BmnFieldMap::fNz, BmnFieldMap::Interpolate(), and IsInside().

GetBy() [2/2]

virtual Double_t BmnFieldMapSym3::GetBy ( Double_t  x, Double_t  y, Double_t  z  )

virtual

Implements BmnFieldMap.

GetBz() [1/2]

Double_t BmnFieldMapSym3::GetBz ( Double_t  x, Double_t  y, Double_t  z  )

virtual

Implements BmnFieldMap.

Definition at line 107 of file BmnFieldMapSym3.cxx.

References BmnFieldMap::fBz, BmnFieldMap::fHa, fHemiY, fHemiZ, BmnFieldMap::fNy, BmnFieldMap::fNz, BmnFieldMap::Interpolate(), and IsInside().

GetBz() [2/2]

virtual Double_t BmnFieldMapSym3::GetBz ( Double_t  x, Double_t  y, Double_t  z  )

virtual

Implements BmnFieldMap.

IsInside() [1/2]

Bool_t BmnFieldMapSym3::IsInside ( Double_t  x, Double_t  y, Double_t  z, Int_t &  ix, Int_t &  iy, Int_t &  iz, Double_t &  dx, Double_t &  dy, Double_t &  dz  )

virtual

Determine whether a point is inside the field map

Parameters

x,y,z	Point coordinates (global) [cm]
ix,iy,iz	(return) Grid cell
dx,dy,dz	(return) Distance from grid point [cm] if inside @value kTRUE if inside map, else kFALSE

Implements BmnFieldMap.

Definition at line 137 of file BmnFieldMapSym3.cxx.

References fHemiX, fHemiY, fHemiZ, BmnFieldMap::fPosX, BmnFieldMap::fPosY, BmnFieldMap::fPosZ, BmnFieldMap::fXmin, BmnFieldMap::fXstep, BmnFieldMap::fYmax, BmnFieldMap::fYmin, BmnFieldMap::fYstep, BmnFieldMap::fZmax, BmnFieldMap::fZmin, and BmnFieldMap::fZstep.

Referenced by GetBx(), GetBy(), and GetBz().

IsInside() [2/2]

virtual Bool_t BmnFieldMapSym3::IsInside ( Double_t  x, Double_t  y, Double_t  z, Int_t &  ix, Int_t &  iy, Int_t &  iz, Double_t &  dx, Double_t &  dy, Double_t &  dz  )

virtual

Determine whether a point is inside the field map

Parameters

x,y,z	Point coordinates (global) [cm]
ix,iy,iz	(return) Grid cell
dx,dy,dz	(return) Distance from grid point [cm] if inside @value kTRUE if inside map, else kFALSE

Implements BmnFieldMap.

Member Data Documentation

fHemiX

Double_t BmnFieldMapSym3::fHemiX

mutableprotected

Hemispheres of a point (for temporary use)

Definition at line 70 of file BmnFieldMapSym3.h.

Referenced by GetBx(), and IsInside().

fHemiY

Double_t BmnFieldMapSym3::fHemiY

protected

Definition at line 70 of file BmnFieldMapSym3.h.

Referenced by GetBx(), GetBz(), and IsInside().

fHemiZ

Double_t BmnFieldMapSym3::fHemiZ

protected

Definition at line 70 of file BmnFieldMapSym3.h.

Referenced by GetBz(), and IsInside().

---

The documentation for this class was generated from the following files:

• field/BmnFieldMapSym3.h
• install/include/BmnFieldMapSym3.h
• field/BmnFieldMapSym3.cxx