PndFieldMap Class Reference

#include <PndFieldMap.h>

Inheritance diagram for PndFieldMap:

Public Member Functions
	PndFieldMap ()
	PndFieldMap (const char *mapName, const char *fileType="R")
	PndFieldMap (PndFieldPar *fieldPar)
virtual	~PndFieldMap ()
virtual void	Init ()
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	WriteAsciiFile (const char *fileName)
void	WriteRootFile (const char *fileName, const char *mapName)
void	SetPosition (Double_t x, Double_t y, Double_t z)
void	SetScale (Double_t factor)
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	GetUnit () const
Double_t	GetPositionX () const
Double_t	GetPositionY () const
Double_t	GetPositionZ () const
Double_t	GetScale () const
TArrayF *	GetBx () const
TArrayF *	GetBy () const
TArrayF *	GetBz () const
const char *	GetFileName ()
virtual void	Print ()

Protected Member Functions
void	Reset ()
void	ReadAsciiFile (const char *fileName)
void	ReadRootFile (const char *fileName, const char *mapName)
void	SetField (const PndFieldMapData *data)
Double_t	Interpolate (Double_t dx, Double_t dy, Double_t dz)

Protected Attributes
TString	fFileName
Double_t	fScale
Double_t	funit
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	fHa [2][2][2]
Double_t	fHb [2][2]
	Field at corners of a grid cell. More...
Double_t	fHc [2]
	Interpolated field (2-dim) More...

Private Member Functions
	PndFieldMap (const PndFieldMap &L)
PndFieldMap &	operator= (const PndFieldMap &)

Detailed Description

Definition at line 23 of file PndFieldMap.h.

Constructor & Destructor Documentation

PndFieldMap::PndFieldMap

(

)

Default constructor

Definition at line 23 of file PndFieldMap.cxx.

References SetName.

  : FairField(),
        fFileName(""),
    fScale(1.0),
    funit(10.0),
    fPosX(0), fPosY(0), fPosZ(0),
    fXmin(0), fXmax(0), fXstep(0),
        fYmin(0), fYmax(0), fYstep(0),
    fZmin(0), fZmax(0), fZstep(0),
    fNx(0),fNy(0),fNz(0),
    fBx(NULL), fBy(NULL), fBz(NULL)
{
  SetName("");
  fType = 1;
}

PndFieldMap::PndFieldMap	(	const char *	mapName,
		const char *	fileType = "R"
	)

Standard constructor

Parameters

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

Definition at line 43 of file PndFieldMap.cxx.

References fFileName, SetName, and TString.

  : FairField(mapName),
    fFileName(TString("")),
    fScale(1.0),
    funit(10.0),
    fPosX(0), fPosY(0), fPosZ(0),
    fXmin(0), fXmax(0), fXstep(0),
    fYmin(0), fYmax(0), fYstep(0),
    fZmin(0), fZmax(0), fZstep(0),
    fNx(0),fNy(0),fNz(0),
    fBx(NULL), fBy(NULL), fBz(NULL)
{
  SetName(mapName);
  TString dir = getenv("VMCWORKDIR");
  fFileName = dir + "/input/fieldmaps/" + mapName;
  if ( fileType[0] == 'R' ) fFileName += ".root";
  else                      fFileName += ".dat";
  fType = 1;
}

PndFieldMap::PndFieldMap

(

PndFieldPar *

fieldPar

)

Constructor from PndFieldPar

Definition at line 67 of file PndFieldMap.cxx.

References fFileName, fPosX, fPosY, fPosZ, fScale, PndFieldPar::GetPositionX(), PndFieldPar::GetPositionY(), PndFieldPar::GetPositionZ(), PndFieldPar::GetScale(), PndFieldPar::GetType(), PndFieldPar::MapName(), SetName, and TString.

  : FairField(),
        fFileName(TString("")),
    fScale(1.0),
    funit(10.0),
    fPosX(0), fPosY(0), fPosZ(0),
    fXmin(0), fXmax(0), fXstep(0),
    fYmin(0), fYmax(0), fYstep(0),
    fZmin(0), fZmax(0), fZstep(0),
    fNx(0),fNy(0),fNz(0),
    fBx(NULL), fBy(NULL), fBz(NULL)
{
  fType = 1;
  if ( ! fieldPar ) {
    LOG(ERROR) << "PndConstField::PndConstField: empty parameter container!"  ;
    SetName("");
        fType     = -1;
  }
  else {
    TString Name=GetName();
    fieldPar->MapName(Name);
    fPosX  = fieldPar->GetPositionX();
    fPosY  = fieldPar->GetPositionY();
    fPosZ  = fieldPar->GetPositionZ();
    fScale = fieldPar->GetScale();
    TString dir = getenv("VMCWORKDIR");
    fFileName = dir + "/input/fieldmaps/" + Name + ".root";
    fType = fieldPar->GetType();
  }
}

PndFieldMap::~PndFieldMap ( )

virtual

Destructor

Definition at line 132 of file PndFieldMap.cxx.

References fBx, fBy, and fBz.

                          {

        //printf("PndFieldMap::~PndFieldMap() \n");
  if ( fBx ) delete fBx;
  if ( fBy ) delete fBy;
  if ( fBz ) delete fBz;
}

PndFieldMap::PndFieldMap ( const PndFieldMap &  L )

private

Definition at line 100 of file PndFieldMap.cxx.

References fHa, fHb, fHc, and jj.

  : FairField(),
    fFileName(L.fFileName),
    fScale(L.fScale),
    funit(L.fScale),
    fPosX(L.fPosX), fPosY(L.fPosY), fPosZ(L.fPosZ),
    fXmin(L.fXmin), fXmax(L.fXmax), fXstep(L.fXstep),
    fYmin(L.fYmin), fYmax(L.fYmax), fYstep(L.fYstep),
    fZmin(L.fZmin), fZmax(L.fZmax), fZstep(L.fZstep),
    fNx(L.fNx),fNy(L.fNy),fNz(L.fNz),
    fBx(L.fBx), fBy(L.fBy), fBz(L.fBz)
{
  fType = L.fType;
  for (Int_t ii=0; ii<2; ii++)
    {
      fHc[ii] = L.fHc[ii];
      for (Int_t jj=0; jj<2; jj++)
        {
          fHb[ii][jj] = L.fHb[ii][jj];
            for (Int_t kk=0; kk<2; kk++)
              {
                fHa[ii][jj][kk] = L.fHa[ii][jj][kk];
              }
        }
    }

}

Member Function Documentation

Double_t PndFieldMap::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] Bx,By,Bz Field components [kG]

Definition at line 157 of file PndFieldMap.cxx.

References Double_t, dx, dy, dz, fBx, fHa, fNy, fNz, Interpolate(), and IsInside().

Referenced by interpolate_fieldmap().

                                                              {

  Int_t ix    = 0;
  Int_t iy    = 0;
  Int_t iz    = 0;
  Double_t dx = 0.;
  Double_t dy = 0.;
  Double_t dz = 0.;

  if ( IsInside(x, y, z, ix, iy, iz, dx, dy, dz) ) {

  // Get Bx field values at grid cell corners
  fHa[0][0][0] = fBx->At(ix    *fNy*fNz + iy    *fNz + iz);
  fHa[1][0][0] = fBx->At((ix+1)*fNy*fNz + iy    *fNz + iz);
  fHa[0][1][0] = fBx->At(ix    *fNy*fNz + (iy+1)*fNz + iz);
  fHa[1][1][0] = fBx->At((ix+1)*fNy*fNz + (iy+1)*fNz + iz);
  fHa[0][0][1] = fBx->At(ix    *fNy*fNz + iy    *fNz + (iz+1));
  fHa[1][0][1] = fBx->At((ix+1)*fNy*fNz + iy    *fNz + (iz+1));
  fHa[0][1][1] = fBx->At(ix    *fNy*fNz + (iy+1)*fNz + (iz+1));
  fHa[1][1][1] = fBx->At((ix+1)*fNy*fNz + (iy+1)*fNz + (iz+1));

  // Return interpolated field value
  return Interpolate(dx, dy, dz);

  }

  return 0.;
}

TArrayF* PndFieldMap::GetBx ( ) const

inline

Accessors to the field value arrays

Definition at line 114 of file PndFieldMap.h.

References fBx.

Referenced by Print().

{ return fBx; }

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

virtual

Definition at line 190 of file PndFieldMap.cxx.

References Double_t, dx, dy, dz, fBy, fHa, fNy, fNz, Interpolate(), and IsInside().

Referenced by interpolate_fieldmap().

                                                              {

  Int_t ix    = 0;
  Int_t iy    = 0;
  Int_t iz    = 0;
  Double_t dx = 0.;
  Double_t dy = 0.;
  Double_t dz = 0.;

  if ( IsInside(x, y, z, ix, iy, iz, dx, dy, dz) ) {

  // Get By field values at grid cell corners
  fHa[0][0][0] = fBy->At(ix    *fNy*fNz + iy    *fNz + iz);
  fHa[1][0][0] = fBy->At((ix+1)*fNy*fNz + iy    *fNz + iz);
  fHa[0][1][0] = fBy->At(ix    *fNy*fNz + (iy+1)*fNz + iz);
  fHa[1][1][0] = fBy->At((ix+1)*fNy*fNz + (iy+1)*fNz + iz);
  fHa[0][0][1] = fBy->At(ix    *fNy*fNz + iy    *fNz + (iz+1));
  fHa[1][0][1] = fBy->At((ix+1)*fNy*fNz + iy    *fNz + (iz+1));
  fHa[0][1][1] = fBy->At(ix    *fNy*fNz + (iy+1)*fNz + (iz+1));
  fHa[1][1][1] = fBy->At((ix+1)*fNy*fNz + (iy+1)*fNz + (iz+1));

  // Return interpolated field value
  return Interpolate(dx, dy, dz);

  }

  return 0.;
}

TArrayF* PndFieldMap::GetBy ( ) const

inline

Definition at line 115 of file PndFieldMap.h.

References fBy.

Referenced by Print().

{ return fBy; }

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

virtual

Definition at line 223 of file PndFieldMap.cxx.

References Double_t, dx, dy, dz, fBz, fHa, fNy, fNz, Interpolate(), and IsInside().

Referenced by interpolate_fieldmap().

                                                              {

  Int_t ix    = 0;
  Int_t iy    = 0;
  Int_t iz    = 0;
  Double_t dx = 0.;
  Double_t dy = 0.;
  Double_t dz = 0.;

  if ( IsInside(x, y, z, ix, iy, iz, dx, dy, dz) ) {

  // Get Bz field values at grid cell corners
  fHa[0][0][0] = fBz->At(ix    *fNy*fNz + iy    *fNz + iz);
  fHa[1][0][0] = fBz->At((ix+1)*fNy*fNz + iy    *fNz + iz);
  fHa[0][1][0] = fBz->At(ix    *fNy*fNz + (iy+1)*fNz + iz);
  fHa[1][1][0] = fBz->At((ix+1)*fNy*fNz + (iy+1)*fNz + iz);
  fHa[0][0][1] = fBz->At(ix    *fNy*fNz + iy    *fNz + (iz+1));
  fHa[1][0][1] = fBz->At((ix+1)*fNy*fNz + iy    *fNz + (iz+1));
  fHa[0][1][1] = fBz->At(ix    *fNy*fNz + (iy+1)*fNz + (iz+1));
  fHa[1][1][1] = fBz->At((ix+1)*fNy*fNz + (iy+1)*fNz + (iz+1));

  // Return interpolated field value
  return Interpolate(dx, dy, dz);

  }

  return 0.;
}

TArrayF* PndFieldMap::GetBz ( ) const

inline

Definition at line 116 of file PndFieldMap.h.

References fBz.

Referenced by Print().

{ return fBz; }

const char* PndFieldMap::GetFileName ( )

inline

Accessor to field map file

Definition at line 120 of file PndFieldMap.h.

References fFileName.

{ return fFileName.Data(); }

Int_t PndFieldMap::GetNx ( ) const

inline

Definition at line 97 of file PndFieldMap.h.

References fNx.

Referenced by interpolate_fieldmap(), and transform_jost_fieldmap().

{ return fNx; }

Int_t PndFieldMap::GetNy ( ) const

inline

Definition at line 98 of file PndFieldMap.h.

References fNy.

Referenced by interpolate_fieldmap(), and transform_jost_fieldmap().

{ return fNy; }

Int_t PndFieldMap::GetNz ( ) const

inline

Definition at line 99 of file PndFieldMap.h.

References fNz.

Referenced by interpolate_fieldmap(), and transform_jost_fieldmap().

{ return fNz; }

Double_t PndFieldMap::GetPositionX ( ) const

inline

Accessor to field centre position in global system

Definition at line 104 of file PndFieldMap.h.

References fPosX.

Referenced by PndFieldPar::SetParameters(), and PndMapPar::SetParameters().

{ return fPosX; }

Double_t PndFieldMap::GetPositionY ( ) const

inline

Definition at line 105 of file PndFieldMap.h.

References fPosY.

Referenced by PndFieldPar::SetParameters(), and PndMapPar::SetParameters().

{ return fPosY; }

Double_t PndFieldMap::GetPositionZ ( ) const

inline

Definition at line 106 of file PndFieldMap.h.

References fPosZ.

Referenced by PndFieldPar::SetParameters(), and PndMapPar::SetParameters().

{ return fPosZ; }

Double_t PndFieldMap::GetScale ( ) const

inline

Accessor to global scaling factor

Definition at line 110 of file PndFieldMap.h.

References fScale.

Referenced by interpolate_fieldmap(), PndFieldMapData::PndFieldMapData(), PndFieldPar::SetParameters(), and PndMapPar::SetParameters().

{ return fScale; }

Double_t PndFieldMap::GetUnit ( ) const

inline

Definition at line 101 of file PndFieldMap.h.

References funit.

Referenced by interpolate_fieldmap().

{return funit; }

Double_t PndFieldMap::GetXmax ( ) const

inline

Definition at line 91 of file PndFieldMap.h.

References fXmax.

Referenced by interpolate_fieldmap().

{ return fXmax; }  

Double_t PndFieldMap::GetXmin ( ) const

inline

Accessors to field parameters in local coordinate system

Definition at line 88 of file PndFieldMap.h.

References fXmin.

Referenced by interpolate_fieldmap().

{ return fXmin; } 

Double_t PndFieldMap::GetXstep ( ) const

inline

Definition at line 94 of file PndFieldMap.h.

References fXstep.

{ return fXstep; }  

Double_t PndFieldMap::GetYmax ( ) const

inline

Definition at line 92 of file PndFieldMap.h.

References fYmax.

Referenced by interpolate_fieldmap().

{ return fYmax; }

Double_t PndFieldMap::GetYmin ( ) const

inline

Definition at line 89 of file PndFieldMap.h.

References fYmin.

Referenced by interpolate_fieldmap().

{ return fYmin; }

Double_t PndFieldMap::GetYstep ( ) const

inline

Definition at line 95 of file PndFieldMap.h.

References fYstep.

{ return fYstep; }

Double_t PndFieldMap::GetZmax ( ) const

inline

Definition at line 93 of file PndFieldMap.h.

References fZmax.

Referenced by PndMultiField::Init(), and interpolate_fieldmap().

{ return fZmax; }

Double_t PndFieldMap::GetZmin ( ) const

inline

Definition at line 90 of file PndFieldMap.h.

References fZmin.

Referenced by PndMultiField::Init(), and interpolate_fieldmap().

{ return fZmin; }

Double_t PndFieldMap::GetZstep ( ) const

inline

Definition at line 96 of file PndFieldMap.h.

References fZstep.

{ return fZstep; }

void PndFieldMap::Init ( )

virtual

Initialisation (read map from file)

Definition at line 144 of file PndFieldMap.cxx.

References fFileName, ReadAsciiFile(), and ReadRootFile().

Referenced by PndMultiField::Init(), interpolate_fieldmap(), and transform_jost_fieldmap().

                       {
  if      (fFileName.EndsWith(".root")) ReadRootFile(fFileName, fName);
  else if (fFileName.EndsWith(".dat"))  ReadAsciiFile(fFileName);
  else {
    LOG(ERROR) << "-E- PndFieldMap::Init: No proper file name defined!  "<<fFileName.Data()  ;
    Fatal("Init", "No proper file name");
  }
}

Double_t PndFieldMap::Interpolate ( Double_t  dx, Double_t  dy, Double_t  dz  )

protected

Get field values by interpolation of the grid.

Parameters

dx,dy,dz

Relative distance from grid point [cell units]

Definition at line 621 of file PndFieldMap.cxx.

References fHa, fHb, and fHc.

Referenced by GetBx(), PndTransMap::GetBxyz(), PndDipoleMap::GetBxyz(), PndSolenoidMap::GetBxyz(), GetBy(), and GetBz().

                                                                       {

  // Interpolate in x coordinate
  fHb[0][0] = fHa[0][0][0] + ( fHa[1][0][0]-fHa[0][0][0] ) * dx;
  fHb[1][0] = fHa[0][1][0] + ( fHa[1][1][0]-fHa[0][1][0] ) * dx;
  fHb[0][1] = fHa[0][0][1] + ( fHa[1][0][1]-fHa[0][0][1] ) * dx;
  fHb[1][1] = fHa[0][1][1] + ( fHa[1][1][1]-fHa[0][1][1] ) * dx;

  // Interpolate in y coordinate
  fHc[0] = fHb[0][0] + ( fHb[1][0] - fHb[0][0] ) * dy;
  fHc[1] = fHb[0][1] + ( fHb[1][1] - fHb[0][1] ) * dy;

  // Interpolate in z coordinate
  return fHc[0] + ( fHc[1] - fHc[0] ) * dz;

}

Bool_t PndFieldMap::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 kTRUE if inside map, else kFALSE

Reimplemented in PndDipoleMap, PndSolenoidMap, and PndTransMap.

Definition at line 256 of file PndFieldMap.cxx.

References Double_t, fPosX, fPosY, fPosZ, fXmin, fXstep, fYmax, fYmin, fYstep, fZmax, fZmin, and fZstep.

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

                                                                       {

  // --- Transform into local coordinate system
  Double_t xl = x - fPosX;
  Double_t yl = y - fPosY;
  Double_t zl = z - fPosZ;

  // ---  Check for being outside the map range
  if ( ! ( xl >= fXmin && xl < fXmax && yl >= fYmin && yl < fYmax &&
           zl >= fZmin && zl < fZmax ) ) {
    ix = iy = iz = 0;
    dx = dy = dz = 0.;
    return kFALSE;
  }

  // --- Determine grid cell
  ix = Int_t( xl / fXstep );
  iy = Int_t( yl / fYstep );
  iz = Int_t( zl / fZstep );


  // Relative distance from grid point (in units of cell size)
  dx = xl / fXstep - Double_t(ix);
  dy = yl / fYstep - Double_t(iy);
  dz = zl / fZstep - Double_t(iz);

  return kTRUE;

}

PndFieldMap& PndFieldMap::operator= ( const PndFieldMap &  )

inlineprivate

Definition at line 128 of file PndFieldMap.h.

{return *this;};

void PndFieldMap::Print ( )

virtual

Screen output

Definition at line 378 of file PndFieldMap.cxx.

References Double_t, fNx, fNy, fNz, fPosX, fPosY, fPosZ, fScale, fXmax, fXmin, fXstep, fYmax, fYmin, fYstep, fZmax, fZmin, fZstep, GetBx(), GetBy(), GetBz(), and TString.

                        {
  TString type = "Map";
  if ( fType == 2 ) type = "Soleniod Map ";
  if ( fType == 3 ) type = "Dipole Map ";
  if ( fType == 4 ) type = "Trans Map ";
  cout << "======================================================" << endl;
  cout.precision(4);
  cout << showpoint;
  cout << "----  " << fTitle << " : " << fName << endl;
  cout << "----" << endl;
  cout << "----  Field type     : " << type << endl;
  cout << "----" << endl;
  cout << "----  Field map grid : " << endl;
  cout << "----  x = " << setw(4) << fXmin << " to " << setw(4) << fXmax
       << " cm, " << fNx << " grid points, dx = " << fXstep << " cm" << endl;
  cout << "----  y = " << setw(4) << fYmin << " to " << setw(4) << fYmax
       << " cm, " << fNy << " grid points, dy = " << fYstep << " cm" << endl;
  cout << "----  z = " << setw(4) << fZmin << " to " << setw(4) << fZmax
       << " cm, " << fNz << " grid points, dz = " << fZstep << " cm" << endl;
  cout << endl;
  cout << "----  Field centre position: ( " << setw(6) << fPosX << ", "
       << setw(6) << fPosY << ", " << setw(6) << fPosZ << ") cm" << endl;
  cout << "----  Field scaling factor: " << fScale << endl;
  Double_t bx = GetBx(0.,0.,0.);
  Double_t by = GetBy(0.,0.,0.);
  Double_t bz = GetBz(0.,0.,0.);
  cout << "----" << endl;
  cout << "----  Field at origin is ( " << setw(6) << bx << ", " << setw(6)
       << by << ", " << setw(6) << bz << ") kG" << endl;
 cout << "======================================================" << endl;
}

void PndFieldMap::ReadAsciiFile ( const char *  fileName )

protected

Read the field map from an ASCII file

Definition at line 431 of file PndFieldMap.cxx.

References Double_t, fBx, fBy, fBz, fNx, fNy, fNz, fScale, funit, fXmax, fXmin, fXstep, fYmax, fYmin, fYstep, fZmax, fZmin, fZstep, CAMath::Nint(), and TString.

Referenced by Init().

                                                    {

  Double_t bx=0., by=0., bz=0.;
  // Open file
  cout << "-I- PndFieldMap: Reading field map from ASCII file "
       << fileName << endl;
  ifstream mapFile(fileName);
  if ( ! mapFile.is_open() ) {
    cerr << "-E- PndFieldMap:ReadAsciiFile: Could not open file! " << endl;
    Fatal("ReadAsciiFile","Could not open file");
  }

  // Read map type
  TString type;
  mapFile >> type;

  Int_t iType = 0;
  if ( type == "nosym" ) iType = 1;
  if ( type == "Solenoid") iType = 2;
  if ( type == "Dipole"  ) iType = 3;
  if ( type == "Trans"  ) iType = 4;
  if ( fType != iType ) {
    cout << "-E- PndFieldMap::ReadAsciiFile: Incompatible map types!"
         << endl;
    cout << "    Field map is of type " << fType
         << " but map on file is of type " << iType << endl;
    Fatal("ReadAsciiFile","Incompatible map types");
  }
  // Read Units
  TString unit;
  mapFile >> unit;
  if ( unit == "G" ) funit = 0.001;
  else if ( unit == "T"  ) funit = 10.0;
  else if ( unit == "kG"  ) funit=1.0;
  else {
    cout << "-E- FieldMap::ReadAsciiFile: No units!"
         << endl;
        Fatal("ReadAsciiFile","No units defined");
  }


  // Read grid parameters

  mapFile >>fXmin >> fXmax >> fNx;
  mapFile >>fYmin >> fYmax >> fNy;
  mapFile >>fZmin >> fZmax >> fNz;
  fXstep = ( fXmax - fXmin ) / Double_t( fNx - 1 );
  fYstep = ( fYmax - fYmin ) / Double_t( fNy - 1 );
  fZstep = ( fZmax - fZmin ) / Double_t( fNz - 1 );

  // Create field arrays
  fBx = new TArrayF(fNx * fNy * fNz);
  fBy = new TArrayF(fNx * fNy * fNz);
  fBz = new TArrayF(fNx * fNy * fNz);

  // Read the field values
  Double_t factor = fScale * funit;   // Factor 1/1000 for G -> kG
  cout << right;
  Int_t nTot = fNx * fNy * fNz;
  cout << "-I- PndFieldMap: " << nTot << " entries to read... "
       << setw(3) << 0 << " % ";
  Int_t index = 0;
  div_t modul;
  Int_t iDiv = TMath::Nint(nTot/100.);
  for (Int_t ix=0; ix<fNx; ix++) {
    for (Int_t iy = 0; iy<fNy; iy++) {
      for (Int_t iz = 0; iz<fNz; iz++) {
        if (! mapFile.good()) cerr << "-E- PndFieldMap::ReadAsciiFile: "
                                   << "I/O Error at " << ix << " "
                                   << iy << " " << iz << endl;
        index = ix*fNy*fNz + iy*fNz + iz;
        if (iDiv!=0)
          {
            modul = div(index,iDiv);
            if ( modul.rem == 0 ) {
              Double_t perc = TMath::Nint(100.*index/nTot);
              cout << "\b\b\b\b\b\b" << setw(3) << perc << " % " << flush;
            }
          }
        //mapFile >> xx>>yy>>zz>>  bx >> by >> bz ;
        mapFile >>  bx >> by >> bz ;
        //cout  << " x= " <<xx <<" y= " << yy<<" z= " << zz<<" bx= " <<  bx <<" by= " <<by <<" bz= " << bz<< endl;
        fBx->AddAt(factor*bx, index);
        fBy->AddAt(factor*by, index);
        fBz->AddAt(factor*bz, index);
        if ( mapFile.eof() ) {
          cerr << endl << "-E- PndFieldMap::ReadAsciiFile: EOF"
               << " reached at " << ix << " " << iy << " " << iz << endl;
          mapFile.close();
          break;
        }
      }   // z-Loop
    }     // y-Loop0)
  }       // x-Loop

  cout << "   " << index+1 << " read" << endl;

  mapFile.close();

}

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

protected

Read field map from a ROOT file

Definition at line 536 of file PndFieldMap.cxx.

References exit(), file, and SetField().

Referenced by Init().

                                                    {

  // Store gFile pointer
  TFile* oldFile = gFile;

  // Open root file
  LOG(INFO) <<"PndFieldMap: Reading field map from ROOT file  "<<fileName  ;
  TFile* file = new TFile(fileName, "READ");
  if (file->IsZombie()) {
    LOG(ERROR) << "-E- PndFieldMap::ReadRootfile: Cannot read from file! "  ;
    Fatal("ReadRootFile","Cannot read from file");
  }

  // Get the field data object
  PndFieldMapData* data = NULL;
  file->GetObject(mapName, data);
  if ( ! data ) {
     LOG(ERROR)<<"PndFieldMap::ReadRootFile: data object %s not found in file! "<< fileName  ;
     exit(-1);
  }

  // Get the field parameters
  SetField(data);

  // Close the root file and delete the data object
  file->Close();
  delete data;
  delete file;
  if ( oldFile ) oldFile->cd();

}

void PndFieldMap::Reset ( )

protected

Reset the field parameters and data

Definition at line 414 of file PndFieldMap.cxx.

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

                        {
  fPosX = fPosY = fPosZ = 0.;
  fXmin = fYmin = fZmin = 0.;
  fXmax = fYmax = fZmax = 0.;
  fXstep = fYstep = fZstep = 0.;
  fNx = fNy = fNz = 0;
  fScale = 1.;
  funit = 10.0;
  if ( fBx ) { delete fBx; fBx = NULL; }
  if ( fBy ) { delete fBy; fBy = NULL; }
  if ( fBz ) { delete fBz; fBz = NULL; }
}

void PndFieldMap::SetField ( const PndFieldMapData *  data )

protected

Set field parameters and data

Definition at line 573 of file PndFieldMap.cxx.

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

Referenced by ReadRootFile().

                                                      {

  // Check compatibility
  if ( data->GetType() != fType ) {
    LOG(ERROR)<<"PndFieldMap::SetField: Incompatible map types Field map is of type "<<fType<<" \n but map on file is of type "<<data->GetType()  ;
    Fatal("SetField","Incompatible map types");
  }


  fXmin = data->GetXmin();
  fYmin = data->GetYmin();
  fZmin = data->GetZmin();
  fXmax = data->GetXmax();
  fYmax = data->GetYmax();
  fZmax = data->GetZmax();
  fNx = data->GetNx();
  fNy = data->GetNy();
  fNz = data->GetNz();
  fXstep = ( fXmax - fXmin ) / Double_t( fNx - 1 );
  fYstep = ( fYmax - fYmin ) / Double_t( fNy - 1 );
  fZstep = ( fZmax - fZmin ) / Double_t( fNz - 1 );
  if ( fBx ) delete fBx;
  if ( fBy ) delete fBy;
  if ( fBz ) delete fBz;
  fBx = new TArrayF(*(data->GetBx()));
  fBy = new TArrayF(*(data->GetBy()));
  fBz = new TArrayF(*(data->GetBz()));

  // Scale and convert from G(or T) to kG
  Double_t factor = fScale * funit;
  Int_t index = 0;
  for (Int_t ix=0; ix<fNx; ix++) {
    for (Int_t iy=0; iy<fNy; iy++) {
      for (Int_t iz=0; iz<fNz; iz++) {
        index = ix*fNy*fNz + iy*fNz + iz;
        if ( fBx ) (*fBx)[index] = (*fBx)[index] * factor;
        if ( fBy ) (*fBy)[index] = (*fBy)[index] * factor;
        if ( fBz ) (*fBz)[index] = (*fBz)[index] * factor;
      }
    }
  }

}

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

Set the position of the field centre

Definition at line 368 of file PndFieldMap.cxx.

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

                                                                {
  fPosX = x;
  fPosY = y;
  fPosZ = z;
}

void PndFieldMap::SetScale ( Double_t  factor )

inline

Set a global field scaling factor

Definition at line 84 of file PndFieldMap.h.

References fScale.

{ fScale = factor; }

void PndFieldMap::WriteAsciiFile

(

const char *

fileName

)

Write the field map to an ASCII file

Definition at line 292 of file PndFieldMap.cxx.

References Double_t, fBx, fBy, fBz, fNx, fNy, fNz, fScale, funit, fXmax, fXmin, fYmax, fYmin, fZmax, fZmin, and CAMath::Nint().

                                                     {

  // Open file
  LOG(INFO) <<"PndFieldMap: Writing field map to ASCII file " <<fileName  ;
  ofstream mapFile(fileName);
  if ( ! mapFile.is_open() ) {
    LOG(ERROR) << "PndFieldMap:ReadAsciiFile: Could not open file! "  ;
    return;
  }

  // Write field map grid parameters
  mapFile.precision(4);
  mapFile << showpoint;
  if ( fType == 1 ) mapFile << "nosym" << endl;
  if ( fType == 2 ) mapFile << "Solenoid" << endl;
  if ( fType == 3 ) mapFile << "Dipole" << endl;
  if ( fType == 4 ) mapFile << "Trans" << endl;
  if ( funit == 10.0  ) mapFile << "T" << endl;
  if ( funit == 0.001 ) mapFile << "G" << endl;
  if ( funit == 1.0   ) mapFile << "kG" << endl;

  mapFile << fXmin << " " << fXmax << " " << fNx << endl;
  mapFile << fYmin << " " << fYmax << " " << fNy << endl;
  mapFile << fZmin << " " << fZmax << " " << fNz << endl;

  // Write field values
  Double_t factor = funit * fScale;  // Takes out scaling
  cout << right;
  Int_t nTot = fNx * fNy * fNz;
  cout << "-I- PndFieldMap: " << fNx*fNy*fNz << " entries to write... "
       << setw(3) << 0 << " % ";
  Int_t index=0;
  div_t modul;
  Int_t iDiv = TMath::Nint(nTot/100.);
  for(Int_t ix=0; ix<fNx; ix++) {
    for(Int_t iy=0; iy<fNy; iy++) {
      for(Int_t iz=0; iz<fNz; iz++) {
        index =ix*fNy*fNz + iy*fNz + iz;
        if (iDiv!=0)
          {
            modul = div(index,iDiv);
            if ( modul.rem == 0 ) {
              Double_t perc = TMath::Nint(100.*index/nTot);
              cout << "\b\b\b\b\b\b" << setw(3) << perc << " % " << flush;
            }
          }
        mapFile << fBx->At(index)/factor << " " << fBy->At(index)/factor
                << " " << fBz->At(index)/factor << endl;
      } // z-Loop
    }   // y-Loop
  }     // x-Loop
  cout << "   " << index+1 << " written" << endl;
  mapFile.close();

}

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

Write field map data to a ROOT file

Definition at line 352 of file PndFieldMap.cxx.

References file.

Referenced by interpolate_fieldmap(), and transform_jost_fieldmap().

                                                     {

  PndFieldMapData* data = new PndFieldMapData(mapName, *this);
  TFile* oldFile = gFile;
  TFile* file = new TFile(fileName, "RECREATE");
  data->Write();
  file->Close();
  if(oldFile) oldFile->cd();

}

Member Data Documentation

TArrayF* PndFieldMap::fBx

protected

Arrays with the field values

Definition at line 182 of file PndFieldMap.h.

Referenced by GetBx(), PndTransMap::GetBxyz(), PndDipoleMap::GetBxyz(), PndSolenoidMap::GetBxyz(), PndDipoleMap::PndDipoleMap(), PndTransMap::PndTransMap(), ReadAsciiFile(), Reset(), SetField(), WriteAsciiFile(), and ~PndFieldMap().

TArrayF* PndFieldMap::fBy

protected

Definition at line 183 of file PndFieldMap.h.

Referenced by PndTransMap::GetBxyz(), PndDipoleMap::GetBxyz(), PndSolenoidMap::GetBxyz(), GetBy(), PndDipoleMap::PndDipoleMap(), PndTransMap::PndTransMap(), ReadAsciiFile(), Reset(), SetField(), WriteAsciiFile(), and ~PndFieldMap().

TArrayF* PndFieldMap::fBz

protected

Definition at line 184 of file PndFieldMap.h.

Referenced by PndTransMap::GetBxyz(), PndDipoleMap::GetBxyz(), PndSolenoidMap::GetBxyz(), GetBz(), PndDipoleMap::PndDipoleMap(), PndTransMap::PndTransMap(), ReadAsciiFile(), Reset(), SetField(), WriteAsciiFile(), and ~PndFieldMap().

TString PndFieldMap::fFileName

protected

Map file name

Definition at line 157 of file PndFieldMap.h.

Referenced by GetFileName(), Init(), PndDipoleMap::PndDipoleMap(), PndFieldMap(), PndSolenoidMap::PndSolenoidMap(), and PndTransMap::PndTransMap().

Double_t PndFieldMap::fHa[2][2][2]

protected

Variables for temporary storage Used in the very frequently called method GetFieldValue

Definition at line 189 of file PndFieldMap.h.

Referenced by GetBx(), PndTransMap::GetBxyz(), PndDipoleMap::GetBxyz(), PndSolenoidMap::GetBxyz(), GetBy(), GetBz(), Interpolate(), and PndFieldMap().

Double_t PndFieldMap::fHb[2][2]

protected

Field at corners of a grid cell.

Definition at line 190 of file PndFieldMap.h.

Referenced by Interpolate(), and PndFieldMap().

Double_t PndFieldMap::fHc[2]

protected

Interpolated field (2-dim)

Definition at line 191 of file PndFieldMap.h.

Referenced by Interpolate(), and PndFieldMap().

Int_t PndFieldMap::fNx

protected

Number of grid points

Definition at line 178 of file PndFieldMap.h.

Referenced by GetNx(), PndDipoleMap::PndDipoleMap(), PndTransMap::PndTransMap(), Print(), ReadAsciiFile(), Reset(), SetField(), and WriteAsciiFile().

Int_t PndFieldMap::fNy

protected

Definition at line 178 of file PndFieldMap.h.

Referenced by GetBx(), PndTransMap::GetBxyz(), PndDipoleMap::GetBxyz(), PndSolenoidMap::GetBxyz(), GetBy(), GetBz(), GetNy(), PndDipoleMap::PndDipoleMap(), PndTransMap::PndTransMap(), Print(), ReadAsciiFile(), Reset(), SetField(), and WriteAsciiFile().

Int_t PndFieldMap::fNz

protected

Definition at line 178 of file PndFieldMap.h.

Referenced by GetBx(), PndTransMap::GetBxyz(), PndDipoleMap::GetBxyz(), PndSolenoidMap::GetBxyz(), GetBy(), GetBz(), GetNz(), PndDipoleMap::PndDipoleMap(), PndTransMap::PndTransMap(), Print(), ReadAsciiFile(), Reset(), SetField(), and WriteAsciiFile().

Double_t PndFieldMap::fPosX

protected

Field centre position in global coordinates

Definition at line 168 of file PndFieldMap.h.

Referenced by GetPositionX(), PndDipoleMap::IsInside(), PndTransMap::IsInside(), PndSolenoidMap::IsInside(), IsInside(), PndDipoleMap::PndDipoleMap(), PndFieldMap(), PndSolenoidMap::PndSolenoidMap(), PndTransMap::PndTransMap(), Print(), Reset(), and SetPosition().

Double_t PndFieldMap::fPosY

protected

Definition at line 168 of file PndFieldMap.h.

Referenced by GetPositionY(), PndDipoleMap::IsInside(), PndTransMap::IsInside(), PndSolenoidMap::IsInside(), IsInside(), PndDipoleMap::PndDipoleMap(), PndFieldMap(), PndSolenoidMap::PndSolenoidMap(), PndTransMap::PndTransMap(), Print(), Reset(), and SetPosition().

Double_t PndFieldMap::fPosZ

protected

Definition at line 168 of file PndFieldMap.h.

Referenced by GetPositionZ(), PndDipoleMap::IsInside(), PndTransMap::IsInside(), PndSolenoidMap::IsInside(), IsInside(), PndDipoleMap::PndDipoleMap(), PndFieldMap(), PndSolenoidMap::PndSolenoidMap(), PndTransMap::PndTransMap(), Print(), Reset(), and SetPosition().

Double_t PndFieldMap::fScale

protected

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

Definition at line 161 of file PndFieldMap.h.

Referenced by GetScale(), PndDipoleMap::PndDipoleMap(), PndFieldMap(), PndSolenoidMap::PndSolenoidMap(), PndTransMap::PndTransMap(), Print(), ReadAsciiFile(), Reset(), SetField(), SetScale(), and WriteAsciiFile().

Double_t PndFieldMap::funit

protected

Units used in map file

Definition at line 164 of file PndFieldMap.h.

Referenced by GetUnit(), PndDipoleMap::PndDipoleMap(), PndTransMap::PndTransMap(), ReadAsciiFile(), Reset(), SetField(), and WriteAsciiFile().

Double_t PndFieldMap::fXmax

protected

Definition at line 172 of file PndFieldMap.h.

Referenced by GetXmax(), PndDipoleMap::PndDipoleMap(), PndTransMap::PndTransMap(), Print(), ReadAsciiFile(), Reset(), SetField(), and WriteAsciiFile().

Double_t PndFieldMap::fXmin

protected

Field limits in local coordinate system

Definition at line 172 of file PndFieldMap.h.

Referenced by GetXmin(), PndDipoleMap::IsInside(), PndTransMap::IsInside(), PndSolenoidMap::IsInside(), IsInside(), PndDipoleMap::PndDipoleMap(), PndTransMap::PndTransMap(), Print(), ReadAsciiFile(), Reset(), SetField(), and WriteAsciiFile().

Double_t PndFieldMap::fXstep

protected

Definition at line 172 of file PndFieldMap.h.

Referenced by GetXstep(), PndDipoleMap::IsInside(), PndTransMap::IsInside(), PndSolenoidMap::IsInside(), IsInside(), PndDipoleMap::PndDipoleMap(), PndTransMap::PndTransMap(), Print(), ReadAsciiFile(), Reset(), and SetField().

Double_t PndFieldMap::fYmax

protected

Definition at line 173 of file PndFieldMap.h.

Referenced by GetYmax(), PndDipoleMap::IsInside(), PndTransMap::IsInside(), PndSolenoidMap::IsInside(), IsInside(), PndDipoleMap::PndDipoleMap(), PndTransMap::PndTransMap(), Print(), ReadAsciiFile(), Reset(), SetField(), and WriteAsciiFile().

Double_t PndFieldMap::fYmin

protected

Definition at line 173 of file PndFieldMap.h.

Referenced by GetYmin(), PndDipoleMap::IsInside(), PndTransMap::IsInside(), PndSolenoidMap::IsInside(), IsInside(), PndDipoleMap::PndDipoleMap(), PndTransMap::PndTransMap(), Print(), ReadAsciiFile(), Reset(), SetField(), and WriteAsciiFile().

Double_t PndFieldMap::fYstep

protected

Definition at line 173 of file PndFieldMap.h.

Referenced by GetYstep(), PndDipoleMap::IsInside(), PndTransMap::IsInside(), PndSolenoidMap::IsInside(), IsInside(), PndDipoleMap::PndDipoleMap(), PndTransMap::PndTransMap(), Print(), ReadAsciiFile(), Reset(), and SetField().

Double_t PndFieldMap::fZmax

protected

Definition at line 174 of file PndFieldMap.h.

Referenced by GetZmax(), PndDipoleMap::IsInside(), PndTransMap::IsInside(), PndSolenoidMap::IsInside(), IsInside(), PndDipoleMap::PndDipoleMap(), PndTransMap::PndTransMap(), Print(), ReadAsciiFile(), Reset(), SetField(), and WriteAsciiFile().

Double_t PndFieldMap::fZmin

protected

Definition at line 174 of file PndFieldMap.h.

Referenced by GetZmin(), PndDipoleMap::IsInside(), PndTransMap::IsInside(), PndSolenoidMap::IsInside(), IsInside(), PndDipoleMap::PndDipoleMap(), PndTransMap::PndTransMap(), Print(), ReadAsciiFile(), Reset(), SetField(), and WriteAsciiFile().

Double_t PndFieldMap::fZstep

protected

Definition at line 174 of file PndFieldMap.h.

Referenced by GetZstep(), PndDipoleMap::IsInside(), PndTransMap::IsInside(), PndSolenoidMap::IsInside(), IsInside(), PndDipoleMap::PndDipoleMap(), PndTransMap::PndTransMap(), Print(), ReadAsciiFile(), Reset(), and SetField().

---

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

• PndFieldMap.h
• PndFieldMap.cxx