CbmFieldMapDistorted Class Reference

#include <CbmFieldMapDistorted.h>

Inheritance diagram for CbmFieldMapDistorted:

Collaboration diagram for CbmFieldMapDistorted:

Public Member Functions
	CbmFieldMapDistorted ()
	CbmFieldMapDistorted (const char *mapName, const char *pfDistortionFilename, const char *parentName, const char *fileTypeParent="R", Int_t pfTypeOfParent=3)
	CbmFieldMapDistorted (Double_t xMin, Double_t xMax, Double_t yMin, Double_t yMax, Double_t zMin, Double_t zMax, Double_t bX, Double_t bY, Double_t bZ, const char *mapName, const char *pfDistortionFilename, const char *parentName="")
	CbmFieldMapDistorted (CbmFieldPar *fieldPar)
virtual	~CbmFieldMapDistorted ()
virtual void	Init () override
void	ReadDistortionInformation (const char *filename=0)
void	WriteDistortionInformation (const char *filename=0)
virtual Double_t	GetBx (Double_t x, Double_t y, Double_t z) override
virtual Double_t	GetBy (Double_t x, Double_t y, Double_t z) override
virtual Double_t	GetBz (Double_t x, Double_t y, Double_t z) override
virtual void	GetFieldValue (const Double_t point[3], Double_t *bField) override
	Get the field value at a point.
void	SetType (Int_t pfType=0)
const char *	GetDistortionFilename ()
Bool_t	SetDistortionFilename (const char *filename)
TFormula *	GetDistortionFormula (const char *component_option="y", const char *action_option="m")
Bool_t	SetDistortionFormula (TFormula *parDistortionFormula, const char *component_option="y", const char *action_option="m")
Bool_t	SetDistortionFormula (const char *parDistortionFormulaText, const char *component_option="y", const char *action_option="m")
void	SetFromParent (FairField *field)
FairField *	GetParent ()
virtual void	Print (Option_t *="") const override
virtual void	SetPosition (Double_t x, Double_t y, Double_t z) override
virtual void	SetScale (Double_t factor) override
void	PlotBy (Int_t n=250, Double_t zmin=-50, Double_t zmax=450)
virtual void	Init (Int_t nX, Double_t xMin, Double_t xMax, Int_t nY, Double_t yMin, Double_t yMax, Int_t nZ, Double_t zMin, Double_t zMax, TArrayF *bx, TArrayF *by, TArrayF *bz)
TArrayF *	GetBx () const
TArrayF *	GetBy () const
TArrayF *	GetBz () const
void	WriteAsciiFile (const char *fileName)
void	WriteRootFile (const char *fileName, const char *mapName)
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
const char *	GetFileName ()

Protected Member Functions
LocalCoordinates	Global2Local (Double_t x, Double_t y, Double_t z) const
	Transform global coordinates into local coordinates.
GridCoordinates	Local2Grid (const LocalCoordinates &local) const
	Transform local coordinates into grid cell coordinates.
Double_t	Interpolate (const TArrayF *B, const GridCoordinates &point) const
	Get field values by interpolation of the grid.
void	Reset ()
void	ReadAsciiFile (const char *fileName)
void	ReadAsciiFile2018 (const char *fileName)
void	ReadRootFile (const char *fileName, const char *mapName)
void	SetField (const CbmFieldMapData *data)

Protected Attributes
FairField *	fParentField
Int_t	fTypeOfParent
TString	fDistortionFilename
TFormula *	fBxDistortionFormulaMult
TFormula *	fBxDistortionFormulaAdd
TFormula *	fByDistortionFormulaMult
	getter/setter options: ("x","m"), ("x","a")
TFormula *	fByDistortionFormulaAdd
TFormula *	fBzDistortionFormulaMult
	getter/setter options: ("y","m"), ("y","a")
TFormula *	fBzDistortionFormulaAdd
TString	fFileName
Double_t	fScale
Double_t	fPosX
Double_t	fPosY
Double_t	fPosZ
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	fBxOrigin
Double_t	fByOrigin
	x-component of the field at the origin
Double_t	fBzOrigin
	y-component of the field at the origin

Private Member Functions
	CbmFieldMapDistorted (const CbmFieldMapDistorted &)
	getter/setter options: ("z","m"), ("z","a")
CbmFieldMapDistorted &	operator= (const CbmFieldMapDistorted &)
GridCoordinates	Global2Grid (Double_t x, Double_t y, Double_t z) const
	Get grid cell coordinates for a point in global coordinates.

Detailed Description

Definition at line 24 of file CbmFieldMapDistorted.h.

Constructor & Destructor Documentation

CbmFieldMapDistorted() [1/5]

CbmFieldMapDistorted::CbmFieldMapDistorted

(

)

Default constructor

Definition at line 32 of file CbmFieldMapDistorted.cxx.

References CbmFieldMap::CbmFieldMap(), fBxDistortionFormulaAdd, fBxDistortionFormulaMult, fByDistortionFormulaAdd, fByDistortionFormulaMult, fBzDistortionFormulaAdd, fBzDistortionFormulaMult, fDistortionFilename, fParentField, fTypeOfParent, and kTypeDistorted.

Referenced by CbmFieldMapDistorted(), and operator=().

CbmFieldMapDistorted() [2/5]

CbmFieldMapDistorted::CbmFieldMapDistorted	(	const char *	mapName,
		const char *	pfDistortionFilename,
		const char *	parentName,
		const char *	fileTypeParent = "R",
		Int_t	pfTypeOfParent = 3 )

Standard constructor (with FieldMap Parent Field )

Parameters

mapName	Name of distorted field map
pfDistortionFilename	root file with distortion information
parentName	Name of parent field map
fileTypeParent	R = ROOT file, A = ASCII for parent field map
pfTypeOfParent	3 = parent is CbmFieldMapSym3, 2 = CbmFieldMapSym2, 1 = CbmFieldMap

Definition at line 50 of file CbmFieldMapDistorted.cxx.

References CbmFieldMap::CbmFieldMap(), fBxDistortionFormulaAdd, fBxDistortionFormulaMult, fByDistortionFormulaAdd, fByDistortionFormulaMult, fBzDistortionFormulaAdd, fBzDistortionFormulaMult, fDistortionFilename, fParentField, fTypeOfParent, and kTypeDistorted.

CbmFieldMapDistorted() [3/5]

CbmFieldMapDistorted::CbmFieldMapDistorted	(	Double_t	xMin,
		Double_t	xMax,
		Double_t	yMin,
		Double_t	yMax,
		Double_t	zMin,
		Double_t	zMax,
		Double_t	bX,
		Double_t	bY,
		Double_t	bZ,
		const char *	mapName,
		const char *	pfDistortionFilename,
		const char *	parentName = "" )

Constructor (with Constant Parent Field )

Parameters

xMin..zMax	the rectangular region boundaries (X,Y,Z)
bX,By,Bz	field component values inside the region
mapName	Name of distorted field map
pfDistortionFilename	root file with distortion information
parentName	Name of parent constant field

Definition at line 76 of file CbmFieldMapDistorted.cxx.

References CbmFieldMap::CbmFieldMap(), fBxDistortionFormulaAdd, fBxDistortionFormulaMult, fByDistortionFormulaAdd, fByDistortionFormulaMult, fBzDistortionFormulaAdd, fBzDistortionFormulaMult, fDistortionFilename, fParentField, fTypeOfParent, and kTypeDistorted.

CbmFieldMapDistorted() [4/5]

CbmFieldMapDistorted::CbmFieldMapDistorted

(

CbmFieldPar *

fieldPar

)

Constructor from CbmFieldPar

Definition at line 96 of file CbmFieldMapDistorted.cxx.

References CbmFieldMap::CbmFieldMap(), fBxDistortionFormulaAdd, fBxDistortionFormulaMult, fByDistortionFormulaAdd, fByDistortionFormulaMult, fBzDistortionFormulaAdd, fBzDistortionFormulaMult, fDistortionFilename, fParentField, fTypeOfParent, CbmFieldPar::GetBx(), CbmFieldPar::GetBy(), CbmFieldPar::GetBz(), CbmFieldPar::GetDistortionFilename(), CbmFieldPar::GetParentName(), CbmFieldPar::GetPositionX(), CbmFieldPar::GetPositionY(), CbmFieldPar::GetPositionZ(), CbmFieldPar::GetScale(), CbmFieldPar::GetType(), CbmFieldPar::GetTypeOfParent(), CbmFieldPar::GetXmax(), CbmFieldPar::GetXmin(), CbmFieldPar::GetYmax(), CbmFieldPar::GetYmin(), CbmFieldPar::GetZmax(), CbmFieldPar::GetZmin(), kTypeDistorted, and CbmFieldPar::MapName().

~CbmFieldMapDistorted()

CbmFieldMapDistorted::~CbmFieldMapDistorted ( )

virtual

Destructor

Definition at line 156 of file CbmFieldMapDistorted.cxx.

CbmFieldMapDistorted() [5/5]

CbmFieldMapDistorted::CbmFieldMapDistorted ( const CbmFieldMapDistorted & )

private

getter/setter options: ("z","m"), ("z","a")

References CbmFieldMapDistorted().

Member Function Documentation

GetBx() [1/2]

TArrayF * CbmFieldMap::GetBx ( ) const

inlineinherited

Accessors to the field value arrays

Definition at line 141 of file CbmFieldMap.h.

References fBx.

Referenced by Init(), and Init().

GetBx() [2/2]

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

overridevirtual

Get the field components at a certain point

Parameters

x,y,z

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

Reimplemented from CbmFieldMap.

Definition at line 411 of file CbmFieldMapDistorted.cxx.

References fBxDistortionFormulaAdd, fBxDistortionFormulaMult, fParentField, x, and y.

GetBy() [1/2]

TArrayF * CbmFieldMap::GetBy ( ) const

inlineinherited

Definition at line 142 of file CbmFieldMap.h.

References fBy.

Referenced by Init(), and Init().

GetBy() [2/2]

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

overridevirtual

Reimplemented from CbmFieldMap.

Definition at line 427 of file CbmFieldMapDistorted.cxx.

References fByDistortionFormulaAdd, fByDistortionFormulaMult, fParentField, x, and y.

Referenced by PlotBy().

GetBz() [1/2]

TArrayF * CbmFieldMap::GetBz ( ) const

inlineinherited

Definition at line 143 of file CbmFieldMap.h.

References fBz.

Referenced by Init(), and Init().

GetBz() [2/2]

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

overridevirtual

Reimplemented from CbmFieldMap.

Definition at line 442 of file CbmFieldMapDistorted.cxx.

References fBzDistortionFormulaAdd, fBzDistortionFormulaMult, fParentField, x, and y.

GetDistortionFilename()

const char * CbmFieldMapDistorted::GetDistortionFilename ( )

inline

Definition at line 83 of file CbmFieldMapDistorted.h.

References fDistortionFilename.

GetDistortionFormula()

TFormula * CbmFieldMapDistorted::GetDistortionFormula	(	const char *	component_option = "y",
		const char *	action_option = "m" )

Definition at line 318 of file CbmFieldMapDistorted.cxx.

References fBxDistortionFormulaAdd, fBxDistortionFormulaMult, fByDistortionFormulaAdd, fByDistortionFormulaMult, fBzDistortionFormulaAdd, and fBzDistortionFormulaMult.

GetFieldValue()

void CbmFieldMapDistorted::GetFieldValue ( const Double_t point[3], Double_t * bField )

overridevirtual

Get the field value at a point.

Parameters

point	Point coordinates (global) [cm]
bField	Array with field components [kG]

Get the field value at a point in global coordinates point[0] = x, point[1] = y, point[2] = z bField[0] = Bx, bField[1] = By, bField[2] = Bz bField is in kG

Reimplemented from CbmFieldMap.

Definition at line 458 of file CbmFieldMapDistorted.cxx.

References fBxDistortionFormulaAdd, fBxDistortionFormulaMult, fByDistortionFormulaAdd, fByDistortionFormulaMult, fBzDistortionFormulaAdd, fBzDistortionFormulaMult, fParentField, x, and y.

Referenced by Init().

GetFileName()

const char * CbmFieldMap::GetFileName ( )

inlineinherited

Accessor to field map file

Definition at line 147 of file CbmFieldMap.h.

References fFileName.

GetNx()

Int_t CbmFieldMap::GetNx ( ) const

inlineinherited

Definition at line 125 of file CbmFieldMap.h.

References fNx.

Referenced by CbmFieldMapDistorted::SetFromParent().

GetNy()

Int_t CbmFieldMap::GetNy ( ) const

inlineinherited

Definition at line 126 of file CbmFieldMap.h.

References fNy.

Referenced by CbmFieldMapDistorted::SetFromParent().

GetNz()

Int_t CbmFieldMap::GetNz ( ) const

inlineinherited

Definition at line 127 of file CbmFieldMap.h.

References fNz.

Referenced by CbmFieldMapDistorted::SetFromParent().

GetParent()

FairField * CbmFieldMapDistorted::GetParent ( )

inline

Get parent Field

Definition at line 102 of file CbmFieldMapDistorted.h.

References fParentField.

GetPositionX()

Double_t CbmFieldMap::GetPositionX ( ) const

inlineinherited

Accessor to field centre position in global system

Definition at line 131 of file CbmFieldMap.h.

References fPosX.

Referenced by CbmFieldMapDistorted::SetFromParent(), and CbmFieldPar::SetParameters().

GetPositionY()

Double_t CbmFieldMap::GetPositionY ( ) const

inlineinherited

Definition at line 132 of file CbmFieldMap.h.

References fPosY.

Referenced by CbmFieldMapDistorted::SetFromParent(), and CbmFieldPar::SetParameters().

GetPositionZ()

Double_t CbmFieldMap::GetPositionZ ( ) const

inlineinherited

Definition at line 133 of file CbmFieldMap.h.

References fPosZ.

Referenced by CbmFieldMapDistorted::SetFromParent(), and CbmFieldPar::SetParameters().

GetScale()

Double_t CbmFieldMap::GetScale ( ) const

inlineinherited

Accessor to global scaling factor

Definition at line 137 of file CbmFieldMap.h.

References fScale.

Referenced by CbmFieldMapData::CbmFieldMapData(), CbmFieldMapDistorted::SetFromParent(), and CbmFieldPar::SetParameters().

GetXmax()

Double_t CbmFieldMap::GetXmax ( ) const

inlineinherited

Definition at line 119 of file CbmFieldMap.h.

References fXmax.

Referenced by CbmFieldMapDistorted::SetFromParent().

GetXmin()

Double_t CbmFieldMap::GetXmin ( ) const

inlineinherited

Accessors to field parameters in local coordinate system

Definition at line 116 of file CbmFieldMap.h.

References fXmin.

Referenced by CbmFieldMapDistorted::SetFromParent().

GetXstep()

Double_t CbmFieldMap::GetXstep ( ) const

inlineinherited

Definition at line 122 of file CbmFieldMap.h.

References fXstep.

Referenced by CbmFieldMapDistorted::SetFromParent().

GetYmax()

Double_t CbmFieldMap::GetYmax ( ) const

inlineinherited

Definition at line 120 of file CbmFieldMap.h.

References fYmax.

Referenced by CbmFieldMapDistorted::SetFromParent().

GetYmin()

Double_t CbmFieldMap::GetYmin ( ) const

inlineinherited

Definition at line 117 of file CbmFieldMap.h.

References fYmin.

Referenced by CbmFieldMapDistorted::SetFromParent().

GetYstep()

Double_t CbmFieldMap::GetYstep ( ) const

inlineinherited

Definition at line 123 of file CbmFieldMap.h.

References fYstep.

Referenced by CbmFieldMapDistorted::SetFromParent().

GetZmax()

Double_t CbmFieldMap::GetZmax ( ) const

inlineinherited

Definition at line 121 of file CbmFieldMap.h.

References fZmax.

Referenced by CbmFieldMapDistorted::SetFromParent().

GetZmin()

Double_t CbmFieldMap::GetZmin ( ) const

inlineinherited

Definition at line 118 of file CbmFieldMap.h.

References fZmin.

Referenced by CbmFieldMapDistorted::SetFromParent().

GetZstep()

Double_t CbmFieldMap::GetZstep ( ) const

inlineinherited

Definition at line 124 of file CbmFieldMap.h.

References fZstep.

Referenced by CbmFieldMapDistorted::SetFromParent().

Global2Grid()

GridCoordinates CbmFieldMap::Global2Grid ( Double_t x, Double_t y, Double_t z ) const

inlineprivateinherited

Get grid cell coordinates for a point in global coordinates.

Parameters

x,y,z

Point coordinates (global) [cm]

Returns

GridCoordinates structure

Definition at line 253 of file CbmFieldMap.h.

References Global2Local(), Local2Grid(), x, and y.

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

Global2Local()

LocalCoordinates CbmFieldMap::Global2Local ( Double_t x, Double_t y, Double_t z ) const

inlineprotectedinherited

Transform global coordinates into local coordinates.

Definition at line 168 of file CbmFieldMap.h.

References fPosX, fPosY, fPosZ, x, and y.

Referenced by Global2Grid(), CbmFieldMapSym1::Global2LocalReflected(), CbmFieldMapSym2::Global2LocalReflected(), and CbmFieldMapSym3::Global2LocalReflected().

Init() [1/2]

void CbmFieldMap::Init ( Int_t nX, Double_t xMin, Double_t xMax, Int_t nY, Double_t yMin, Double_t yMax, Int_t nZ, Double_t zMin, Double_t zMax, TArrayF * bx, TArrayF * by, TArrayF * bz )

virtualinherited

Initialisation with arrays. To be used e.g.for reading from ASCII.

Parameters

xMin	Minimum x coordinate
xMax	Maximum x coordinate
yMin	Minimum y coordinate
yMax	Maximum y coordinate
zMin	Minimum z coordinate
zMax	Maximum z coordinate
bx	Pointer to array with Bx values [T]
by	Pointer to array with By values [T]
bz	Pointer to array with Bz values [T]

Definition at line 260 of file CbmFieldMap.cxx.

References fBx, fBxOrigin, fBy, fByOrigin, fBz, fBzOrigin, fNx, fNy, fNz, fXmax, fXmin, fXstep, fYmax, fYmin, fYstep, fZmax, fZmin, fZstep, GetBx(), GetBy(), GetBz(), Print(), and Reset().

Init() [2/2]

void CbmFieldMapDistorted::Init ( )

overridevirtual

Initialisation (read map from mapfile and distortion information from distortion file)

Reimplemented from CbmFieldMap.

Definition at line 161 of file CbmFieldMapDistorted.cxx.

References CbmFieldMap::fBxOrigin, CbmFieldMap::fByOrigin, CbmFieldMap::fBzOrigin, fDistortionFilename, fParentField, GetFieldValue(), ReadDistortionInformation(), and SetFromParent().

Interpolate()

Double_t CbmFieldMap::Interpolate ( const TArrayF * B, const GridCoordinates & point ) const

inlineprotectedinherited

Get field values by interpolation of the grid.

Parameters

B	Array with field values - fBx, fBy, or fBz
point	GridCoordinates structure

Returns

Interpolated field value

Definition at line 289 of file CbmFieldMap.h.

References CbmFieldMap::GridCoordinates::dx, CbmFieldMap::GridCoordinates::dy, CbmFieldMap::GridCoordinates::dz, fNy, fNz, CbmFieldMap::GridCoordinates::isValid, CbmFieldMap::GridCoordinates::ix, CbmFieldMap::GridCoordinates::iy, and CbmFieldMap::GridCoordinates::iz.

Referenced by GetBx(), CbmFieldMapSym1::GetBx(), CbmFieldMapSym2::GetBx(), CbmFieldMapSym3::GetBx(), GetBy(), CbmFieldMapSym1::GetBy(), CbmFieldMapSym2::GetBy(), CbmFieldMapSym3::GetBy(), GetBz(), CbmFieldMapSym1::GetBz(), CbmFieldMapSym2::GetBz(), CbmFieldMapSym3::GetBz(), GetFieldValue(), CbmFieldMapSym1::GetFieldValue(), CbmFieldMapSym2::GetFieldValue(), and CbmFieldMapSym3::GetFieldValue().

Local2Grid()

CbmFieldMap::GridCoordinates CbmFieldMap::Local2Grid ( const LocalCoordinates & local ) const

inlineprotectedinherited

Transform local coordinates into grid cell coordinates.

Definition at line 264 of file CbmFieldMap.h.

References fNx, fNy, fNz, fXmin, fXstep, fYmin, fYstep, fZmin, fZstep, CbmFieldMap::LocalCoordinates::x, x, CbmFieldMap::LocalCoordinates::y, y, and CbmFieldMap::LocalCoordinates::z.

Referenced by CbmFieldMapSym1::GetBx(), CbmFieldMapSym2::GetBx(), CbmFieldMapSym3::GetBx(), CbmFieldMapSym1::GetBy(), CbmFieldMapSym2::GetBy(), CbmFieldMapSym3::GetBy(), CbmFieldMapSym1::GetBz(), CbmFieldMapSym2::GetBz(), CbmFieldMapSym3::GetBz(), CbmFieldMapSym1::GetFieldValue(), CbmFieldMapSym2::GetFieldValue(), CbmFieldMapSym3::GetFieldValue(), and Global2Grid().

operator=()

CbmFieldMapDistorted & CbmFieldMapDistorted::operator= ( const CbmFieldMapDistorted & )

private

References CbmFieldMapDistorted().

PlotBy()

void CbmFieldMapDistorted::PlotBy	(	Int_t	n = 250,
		Double_t	zmin = -50,
		Double_t	zmax = 450 )

Plot distorted and parend field (By component)

Definition at line 538 of file CbmFieldMapDistorted.cxx.

References fParentField, and GetBy().

Print()

void CbmFieldMapDistorted::Print ( Option_t * = "" ) const

overridevirtual

Screen output

Reimplemented from CbmFieldMap.

Definition at line 479 of file CbmFieldMapDistorted.cxx.

References fBxDistortionFormulaAdd, fBxDistortionFormulaMult, CbmFieldMap::fBxOrigin, fByDistortionFormulaAdd, fByDistortionFormulaMult, CbmFieldMap::fByOrigin, fBzDistortionFormulaAdd, fBzDistortionFormulaMult, CbmFieldMap::fBzOrigin, fDistortionFilename, and fParentField.

ReadAsciiFile()

void CbmFieldMap::ReadAsciiFile ( const char * fileName )

protectedinherited

Read the field map from an ASCII file

Definition at line 475 of file CbmFieldMap.cxx.

References fBx, fBy, fBz, fNx, fNy, fNz, fScale, fXmax, fXmin, fXstep, fYmax, fYmin, fYstep, fZmax, fZmin, and fZstep.

Referenced by Init().

ReadAsciiFile2018()

void CbmFieldMap::ReadAsciiFile2018 ( const char * fileName )

protectedinherited

Read the field map from an ASCII file. Updated version.

ReadDistortionInformation()

void CbmFieldMapDistorted::ReadDistortionInformation

(

const char *

filename = 0

)

Save old global file and folder pointer to avoid messing with FairRoot

Restore old global file and folder pointer to avoid messing with FairRoot

Definition at line 234 of file CbmFieldMapDistorted.cxx.

References fBxDistortionFormulaAdd, fBxDistortionFormulaMult, fByDistortionFormulaAdd, fByDistortionFormulaMult, fBzDistortionFormulaAdd, fBzDistortionFormulaMult, and fDistortionFilename.

Referenced by Init().

ReadRootFile()

void CbmFieldMap::ReadRootFile ( const char * fileName, const char * mapName )

protectedinherited

Read field map from a ROOT file

Save old global file and folder pointer to avoid messing with FairRoot

Restore old global file and folder pointer to avoid messing with FairRoot

Definition at line 557 of file CbmFieldMap.cxx.

References SetField().

Referenced by Init().

Reset()

void CbmFieldMap::Reset ( )

protectedinherited

Reset the field parameters and data

Definition at line 450 of file CbmFieldMap.cxx.

References fBx, fBy, fBz, fNx, fNy, fNz, fPosX, fPosY, fPosZ, fScale, fXmax, fXmin, fXstep, fYmax, fYmin, fYstep, fZmax, fZmin, and fZstep.

Referenced by Init().

SetDistortionFilename()

Bool_t CbmFieldMapDistorted::SetDistortionFilename ( const char * filename )

inline

Definition at line 84 of file CbmFieldMapDistorted.h.

References fDistortionFilename.

SetDistortionFormula() [1/2]

Bool_t CbmFieldMapDistorted::SetDistortionFormula	(	const char *	parDistortionFormulaText,
		const char *	component_option = "y",
		const char *	action_option = "m" )

Definition at line 373 of file CbmFieldMapDistorted.cxx.

References counter, fBxDistortionFormulaAdd, fBxDistortionFormulaMult, fByDistortionFormulaAdd, fByDistortionFormulaMult, fBzDistortionFormulaAdd, and fBzDistortionFormulaMult.

SetDistortionFormula() [2/2]

Bool_t CbmFieldMapDistorted::SetDistortionFormula	(	TFormula *	parDistortionFormula,
		const char *	component_option = "y",
		const char *	action_option = "m" )

Definition at line 337 of file CbmFieldMapDistorted.cxx.

References counter, fBxDistortionFormulaAdd, fBxDistortionFormulaMult, fByDistortionFormulaAdd, fByDistortionFormulaMult, fBzDistortionFormulaAdd, and fBzDistortionFormulaMult.

SetField()

void CbmFieldMap::SetField ( const CbmFieldMapData * data )

protectedinherited

Set field parameters and data

Definition at line 594 of file CbmFieldMap.cxx.

References fBx, fBy, fBz, fNx, fNy, fNz, fScale, fXmax, fXmin, fXstep, fYmax, fYmin, fYstep, fZmax, fZmin, fZstep, CbmFieldMapData::GetBx(), CbmFieldMapData::GetBy(), CbmFieldMapData::GetBz(), CbmFieldMapData::GetNx(), CbmFieldMapData::GetNy(), CbmFieldMapData::GetNz(), CbmFieldMapData::GetType(), CbmFieldMapData::GetXmax(), CbmFieldMapData::GetXmin(), CbmFieldMapData::GetYmax(), CbmFieldMapData::GetYmin(), CbmFieldMapData::GetZmax(), and CbmFieldMapData::GetZmin().

Referenced by ReadRootFile().

SetFromParent()

void CbmFieldMapDistorted::SetFromParent

(

FairField *

field

)

Fill main part of distorted field map from parent CbmField

Definition at line 183 of file CbmFieldMapDistorted.cxx.

References CbmFieldMap::CbmFieldMap(), CbmFieldMap::fNx, CbmFieldMap::fNy, CbmFieldMap::fNz, fParentField, CbmFieldMap::fPosX, CbmFieldMap::fPosY, CbmFieldMap::fPosZ, CbmFieldMap::fScale, fTypeOfParent, CbmFieldMap::fXmax, CbmFieldMap::fXmin, CbmFieldMap::fXstep, CbmFieldMap::fYmin, CbmFieldMap::fYstep, CbmFieldMap::fZmax, CbmFieldMap::fZmin, CbmFieldMap::fZstep, CbmFieldMap::GetNx(), CbmFieldMap::GetNy(), CbmFieldMap::GetNz(), CbmFieldMap::GetPositionX(), CbmFieldMap::GetPositionY(), CbmFieldMap::GetPositionZ(), CbmFieldMap::GetScale(), CbmFieldConst::GetXmax(), CbmFieldMap::GetXmax(), CbmFieldConst::GetXmin(), CbmFieldMap::GetXmin(), CbmFieldMap::GetXstep(), CbmFieldConst::GetYmax(), CbmFieldMap::GetYmax(), CbmFieldConst::GetYmin(), CbmFieldMap::GetYmin(), CbmFieldMap::GetYstep(), CbmFieldConst::GetZmax(), CbmFieldMap::GetZmax(), CbmFieldConst::GetZmin(), CbmFieldMap::GetZmin(), and CbmFieldMap::GetZstep().

Referenced by Init().

SetPosition()

void CbmFieldMapDistorted::SetPosition ( Double_t x, Double_t y, Double_t z )

overridevirtual

Set the position of the field centre of the distorted and the parent field

Reimplemented from CbmFieldMap.

Definition at line 520 of file CbmFieldMapDistorted.cxx.

References CbmFieldMap::CbmFieldMap(), fParentField, CbmFieldMap::fPosX, CbmFieldMap::fPosY, CbmFieldMap::fPosZ, fTypeOfParent, x, and y.

SetScale()

void CbmFieldMapDistorted::SetScale ( Double_t factor )

overridevirtual

Set a global field scaling factor of the distorted and the parent field

Reimplemented from CbmFieldMap.

Definition at line 530 of file CbmFieldMapDistorted.cxx.

References CbmFieldMap::CbmFieldMap(), fParentField, CbmFieldMap::fScale, and fTypeOfParent.

SetType()

void CbmFieldMapDistorted::SetType ( Int_t pfType = 0 )

inline

Definition at line 81 of file CbmFieldMapDistorted.h.

WriteAsciiFile()

void CbmFieldMap::WriteAsciiFile ( const char * fileName )

inherited

Write the field map to an ASCII file

Definition at line 337 of file CbmFieldMap.cxx.

References fBx, fBy, fBz, fNx, fNy, fNz, fScale, fXmax, fXmin, fYmax, fYmin, fZmax, and fZmin.

WriteDistortionInformation()

void CbmFieldMapDistorted::WriteDistortionInformation

(

const char *

filename = 0

)

Save old global file and folder pointer to avoid messing with FairRoot

Restore old global file and folder pointer to avoid messing with FairRoot

Definition at line 281 of file CbmFieldMapDistorted.cxx.

References fBxDistortionFormulaAdd, fBxDistortionFormulaMult, fByDistortionFormulaAdd, fByDistortionFormulaMult, fBzDistortionFormulaAdd, fBzDistortionFormulaMult, and fDistortionFilename.

WriteRootFile()

void CbmFieldMap::WriteRootFile ( const char * fileName, const char * mapName )

inherited

Write field map data to a ROOT file

Save old global file and folder pointer to avoid messing with FairRoot

Restore old global file and folder pointer to avoid messing with FairRoot

Definition at line 386 of file CbmFieldMap.cxx.

Referenced by CbmFieldMapCreator::CreateMap().

Member Data Documentation

fBx

TArrayF* CbmFieldMap::fBx

protectedinherited

Arrays with the field values

Definition at line 235 of file CbmFieldMap.h.

Referenced by CbmBsField::CalculateMapFromBs(), CbmFieldMap(), CbmFieldMap(), CbmFieldMap(), CbmFieldMap(), GetBx(), GetBx(), CbmFieldMapSym1::GetBx(), CbmFieldMapSym2::GetBx(), CbmFieldMapSym3::GetBx(), GetFieldValue(), CbmFieldMapSym1::GetFieldValue(), CbmFieldMapSym2::GetFieldValue(), CbmFieldMapSym3::GetFieldValue(), Init(), ReadAsciiFile(), Reset(), SetField(), WriteAsciiFile(), and ~CbmFieldMap().

fBxDistortionFormulaAdd

TFormula * CbmFieldMapDistorted::fBxDistortionFormulaAdd

protected

Definition at line 128 of file CbmFieldMapDistorted.h.

Referenced by CbmFieldMapDistorted(), CbmFieldMapDistorted(), CbmFieldMapDistorted(), CbmFieldMapDistorted(), GetBx(), GetDistortionFormula(), GetFieldValue(), Print(), ReadDistortionInformation(), SetDistortionFormula(), SetDistortionFormula(), and WriteDistortionInformation().

fBxDistortionFormulaMult

TFormula* CbmFieldMapDistorted::fBxDistortionFormulaMult

protected

Formulas for field map distortion

Definition at line 127 of file CbmFieldMapDistorted.h.

Referenced by CbmFieldMapDistorted(), CbmFieldMapDistorted(), CbmFieldMapDistorted(), CbmFieldMapDistorted(), GetBx(), GetDistortionFormula(), GetFieldValue(), Print(), ReadDistortionInformation(), SetDistortionFormula(), SetDistortionFormula(), and WriteDistortionInformation().

fBxOrigin

Double_t CbmFieldMap::fBxOrigin

protectedinherited

Variables for temporary storage

Definition at line 242 of file CbmFieldMap.h.

Referenced by CbmFieldMap(), CbmFieldMap(), CbmFieldMap(), CbmFieldMap(), Init(), Init(), CbmFieldMapDistorted::Init(), Print(), and CbmFieldMapDistorted::Print().

fBy

TArrayF* CbmFieldMap::fBy

protectedinherited

Definition at line 236 of file CbmFieldMap.h.

Referenced by CbmBsField::CalculateMapFromBs(), CbmFieldMap(), CbmFieldMap(), CbmFieldMap(), CbmFieldMap(), GetBy(), GetBy(), CbmFieldMapSym1::GetBy(), CbmFieldMapSym2::GetBy(), CbmFieldMapSym3::GetBy(), GetFieldValue(), CbmFieldMapSym1::GetFieldValue(), CbmFieldMapSym2::GetFieldValue(), CbmFieldMapSym3::GetFieldValue(), Init(), ReadAsciiFile(), Reset(), SetField(), WriteAsciiFile(), and ~CbmFieldMap().

fByDistortionFormulaAdd

TFormula * CbmFieldMapDistorted::fByDistortionFormulaAdd

protected

Definition at line 130 of file CbmFieldMapDistorted.h.

Referenced by CbmFieldMapDistorted(), CbmFieldMapDistorted(), CbmFieldMapDistorted(), CbmFieldMapDistorted(), GetBy(), GetDistortionFormula(), GetFieldValue(), Print(), ReadDistortionInformation(), SetDistortionFormula(), SetDistortionFormula(), and WriteDistortionInformation().

fByDistortionFormulaMult

TFormula* CbmFieldMapDistorted::fByDistortionFormulaMult

protected

getter/setter options: ("x","m"), ("x","a")

Definition at line 129 of file CbmFieldMapDistorted.h.

Referenced by CbmFieldMapDistorted(), CbmFieldMapDistorted(), CbmFieldMapDistorted(), CbmFieldMapDistorted(), GetBy(), GetDistortionFormula(), GetFieldValue(), Print(), ReadDistortionInformation(), SetDistortionFormula(), SetDistortionFormula(), and WriteDistortionInformation().

fByOrigin

Double_t CbmFieldMap::fByOrigin

protectedinherited

x-component of the field at the origin

Definition at line 243 of file CbmFieldMap.h.

Referenced by CbmFieldMap(), CbmFieldMap(), CbmFieldMap(), CbmFieldMap(), Init(), Init(), CbmFieldMapDistorted::Init(), Print(), and CbmFieldMapDistorted::Print().

fBz

TArrayF* CbmFieldMap::fBz

protectedinherited

Definition at line 237 of file CbmFieldMap.h.

Referenced by CbmBsField::CalculateMapFromBs(), CbmFieldMap(), CbmFieldMap(), CbmFieldMap(), CbmFieldMap(), GetBz(), GetBz(), CbmFieldMapSym1::GetBz(), CbmFieldMapSym2::GetBz(), CbmFieldMapSym3::GetBz(), GetFieldValue(), CbmFieldMapSym1::GetFieldValue(), CbmFieldMapSym2::GetFieldValue(), CbmFieldMapSym3::GetFieldValue(), Init(), ReadAsciiFile(), Reset(), SetField(), WriteAsciiFile(), and ~CbmFieldMap().

fBzDistortionFormulaAdd

TFormula * CbmFieldMapDistorted::fBzDistortionFormulaAdd

protected

Definition at line 132 of file CbmFieldMapDistorted.h.

Referenced by CbmFieldMapDistorted(), CbmFieldMapDistorted(), CbmFieldMapDistorted(), CbmFieldMapDistorted(), GetBz(), GetDistortionFormula(), GetFieldValue(), Print(), ReadDistortionInformation(), SetDistortionFormula(), SetDistortionFormula(), and WriteDistortionInformation().

fBzDistortionFormulaMult

TFormula* CbmFieldMapDistorted::fBzDistortionFormulaMult

protected

getter/setter options: ("y","m"), ("y","a")

Definition at line 131 of file CbmFieldMapDistorted.h.

Referenced by CbmFieldMapDistorted(), CbmFieldMapDistorted(), CbmFieldMapDistorted(), CbmFieldMapDistorted(), GetBz(), GetDistortionFormula(), GetFieldValue(), Print(), ReadDistortionInformation(), SetDistortionFormula(), SetDistortionFormula(), and WriteDistortionInformation().

fBzOrigin

Double_t CbmFieldMap::fBzOrigin

protectedinherited

y-component of the field at the origin

Definition at line 244 of file CbmFieldMap.h.

Referenced by CbmFieldMap(), CbmFieldMap(), CbmFieldMap(), CbmFieldMap(), Init(), Init(), CbmFieldMapDistorted::Init(), Print(), and CbmFieldMapDistorted::Print().

fDistortionFilename

TString CbmFieldMapDistorted::fDistortionFilename

protected

Filename for field map distortion information

Definition at line 124 of file CbmFieldMapDistorted.h.

Referenced by CbmFieldMapDistorted(), CbmFieldMapDistorted(), CbmFieldMapDistorted(), CbmFieldMapDistorted(), GetDistortionFilename(), Init(), Print(), ReadDistortionInformation(), SetDistortionFilename(), and WriteDistortionInformation().

fFileName

TString CbmFieldMap::fFileName

protectedinherited

Map file name

Definition at line 213 of file CbmFieldMap.h.

Referenced by CbmFieldMap(), CbmFieldMap(), CbmFieldMap(), CbmFieldMap(), GetFileName(), and Init().

fNx

Int_t CbmFieldMap::fNx

protectedinherited

Number of grid points

Definition at line 231 of file CbmFieldMap.h.

Referenced by CbmBsField::CalculateMapFromBs(), CbmFieldMap(), CbmFieldMap(), CbmFieldMap(), CbmFieldMap(), GetNx(), Init(), Local2Grid(), Print(), ReadAsciiFile(), Reset(), SetField(), CbmFieldMapDistorted::SetFromParent(), and WriteAsciiFile().

fNy

Int_t CbmFieldMap::fNy

protectedinherited

Definition at line 231 of file CbmFieldMap.h.

Referenced by CbmBsField::CalculateMapFromBs(), CbmFieldMap(), CbmFieldMap(), CbmFieldMap(), CbmFieldMap(), GetNy(), Init(), Interpolate(), Local2Grid(), Print(), ReadAsciiFile(), Reset(), SetField(), CbmFieldMapDistorted::SetFromParent(), and WriteAsciiFile().

fNz

Int_t CbmFieldMap::fNz

protectedinherited

Definition at line 231 of file CbmFieldMap.h.

Referenced by CbmBsField::CalculateMapFromBs(), CbmFieldMap(), CbmFieldMap(), CbmFieldMap(), CbmFieldMap(), GetNz(), Init(), Interpolate(), Local2Grid(), Print(), ReadAsciiFile(), Reset(), SetField(), CbmFieldMapDistorted::SetFromParent(), and WriteAsciiFile().

fParentField

FairField* CbmFieldMapDistorted::fParentField

protected

Parent field (can be field map or constant field)

Definition at line 118 of file CbmFieldMapDistorted.h.

Referenced by CbmFieldMapDistorted(), CbmFieldMapDistorted(), CbmFieldMapDistorted(), CbmFieldMapDistorted(), GetBx(), GetBy(), GetBz(), GetFieldValue(), GetParent(), Init(), PlotBy(), Print(), SetFromParent(), SetPosition(), and SetScale().

fPosX

Double_t CbmFieldMap::fPosX

protectedinherited

Field centre position in global coordinates

Definition at line 221 of file CbmFieldMap.h.

Referenced by CbmBsField::CalculateMapFromBs(), CbmFieldMap(), CbmFieldMap(), CbmFieldMap(), CbmFieldMap(), CbmBsField::GetFieldValue(), GetPositionX(), Global2Local(), Print(), Reset(), CbmFieldMapDistorted::SetFromParent(), SetPosition(), and CbmFieldMapDistorted::SetPosition().

fPosY

Double_t CbmFieldMap::fPosY

protectedinherited

Definition at line 221 of file CbmFieldMap.h.

Referenced by CbmBsField::CalculateMapFromBs(), CbmFieldMap(), CbmFieldMap(), CbmFieldMap(), CbmFieldMap(), CbmBsField::GetFieldValue(), GetPositionY(), Global2Local(), Print(), Reset(), CbmFieldMapDistorted::SetFromParent(), SetPosition(), and CbmFieldMapDistorted::SetPosition().

fPosZ

Double_t CbmFieldMap::fPosZ

protectedinherited

Definition at line 221 of file CbmFieldMap.h.

Referenced by CbmBsField::CalculateMapFromBs(), CbmFieldMap(), CbmFieldMap(), CbmFieldMap(), CbmFieldMap(), CbmBsField::GetFieldValue(), GetPositionZ(), Global2Local(), Print(), Reset(), CbmFieldMapDistorted::SetFromParent(), SetPosition(), and CbmFieldMapDistorted::SetPosition().

fScale

Double_t CbmFieldMap::fScale

protectedinherited

Global scaling factor (w.r.t. map on file)

Definition at line 217 of file CbmFieldMap.h.

Referenced by CbmFieldMap(), CbmFieldMap(), CbmFieldMap(), CbmFieldMap(), CbmBsField::GetFieldValue(), GetScale(), Print(), ReadAsciiFile(), Reset(), SetField(), CbmFieldMapDistorted::SetFromParent(), SetScale(), CbmFieldMapDistorted::SetScale(), and WriteAsciiFile().

fTypeOfParent

Int_t CbmFieldMapDistorted::fTypeOfParent

protected

Field type of parent field.

Definition at line 121 of file CbmFieldMapDistorted.h.

Referenced by CbmFieldMapDistorted(), CbmFieldMapDistorted(), CbmFieldMapDistorted(), CbmFieldMapDistorted(), SetFromParent(), SetPosition(), and SetScale().

fXmax

Double_t CbmFieldMap::fXmax

protectedinherited

Definition at line 225 of file CbmFieldMap.h.

Referenced by CbmBsField::CalculateMapFromBs(), CbmFieldMap(), CbmFieldMap(), CbmFieldMap(), CbmFieldMap(), GetXmax(), Init(), Print(), ReadAsciiFile(), Reset(), SetField(), CbmFieldMapDistorted::SetFromParent(), and WriteAsciiFile().

fXmin

Double_t CbmFieldMap::fXmin

protectedinherited

Field limits in local coordinate system

Definition at line 225 of file CbmFieldMap.h.

Referenced by CbmBsField::CalculateMapFromBs(), CbmFieldMap(), CbmFieldMap(), CbmFieldMap(), CbmFieldMap(), GetXmin(), Init(), Local2Grid(), Print(), ReadAsciiFile(), Reset(), SetField(), CbmFieldMapDistorted::SetFromParent(), and WriteAsciiFile().

fXstep

Double_t CbmFieldMap::fXstep

protectedinherited

Definition at line 225 of file CbmFieldMap.h.

Referenced by CbmBsField::CalculateMapFromBs(), CbmFieldMap(), CbmFieldMap(), CbmFieldMap(), CbmFieldMap(), GetXstep(), Init(), Local2Grid(), Print(), ReadAsciiFile(), Reset(), SetField(), and CbmFieldMapDistorted::SetFromParent().

fYmax

Double_t CbmFieldMap::fYmax

protectedinherited

Definition at line 226 of file CbmFieldMap.h.

Referenced by CbmBsField::CalculateMapFromBs(), CbmFieldMap(), CbmFieldMap(), CbmFieldMap(), CbmFieldMap(), GetYmax(), Init(), Print(), ReadAsciiFile(), Reset(), SetField(), and WriteAsciiFile().

fYmin

Double_t CbmFieldMap::fYmin

protectedinherited

Definition at line 226 of file CbmFieldMap.h.

Referenced by CbmBsField::CalculateMapFromBs(), CbmFieldMap(), CbmFieldMap(), CbmFieldMap(), CbmFieldMap(), GetYmin(), Init(), Local2Grid(), Print(), ReadAsciiFile(), Reset(), SetField(), CbmFieldMapDistorted::SetFromParent(), and WriteAsciiFile().

fYstep

Double_t CbmFieldMap::fYstep

protectedinherited

Definition at line 226 of file CbmFieldMap.h.

Referenced by CbmBsField::CalculateMapFromBs(), CbmFieldMap(), CbmFieldMap(), CbmFieldMap(), CbmFieldMap(), GetYstep(), Init(), Local2Grid(), Print(), ReadAsciiFile(), Reset(), SetField(), and CbmFieldMapDistorted::SetFromParent().

fZmax

Double_t CbmFieldMap::fZmax

protectedinherited

Definition at line 227 of file CbmFieldMap.h.

Referenced by CbmBsField::CalculateMapFromBs(), CbmFieldMap(), CbmFieldMap(), CbmFieldMap(), CbmFieldMap(), GetZmax(), Init(), Print(), ReadAsciiFile(), Reset(), SetField(), CbmFieldMapDistorted::SetFromParent(), and WriteAsciiFile().

fZmin

Double_t CbmFieldMap::fZmin

protectedinherited

Definition at line 227 of file CbmFieldMap.h.

Referenced by CbmBsField::CalculateMapFromBs(), CbmFieldMap(), CbmFieldMap(), CbmFieldMap(), CbmFieldMap(), GetZmin(), Init(), Local2Grid(), Print(), ReadAsciiFile(), Reset(), SetField(), CbmFieldMapDistorted::SetFromParent(), and WriteAsciiFile().

fZstep

Double_t CbmFieldMap::fZstep

protectedinherited

Definition at line 227 of file CbmFieldMap.h.

Referenced by CbmBsField::CalculateMapFromBs(), CbmFieldMap(), CbmFieldMap(), CbmFieldMap(), CbmFieldMap(), GetZstep(), Init(), Local2Grid(), Print(), ReadAsciiFile(), Reset(), SetField(), and CbmFieldMapDistorted::SetFromParent().

---

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

• CbmFieldMapDistorted.h
• CbmFieldMapDistorted.cxx