QwMagneticField Class Reference

Magnetic field map object. More...

#include <QwMagneticField.h>

Collaboration diagram for QwMagneticField:

Public Member Functions
	QwMagneticField (QwOptions &options, const bool suppress_read_field_map=false)
	Default constructor. More...
virtual	~QwMagneticField ()
	Virtual destructor. More...
void	ProcessOptions (QwOptions &options)
	Process command line and config file options. More...
void	LoadBeamProperty (const TString &map)
	Load beam property. More...
void	SetFilename (const std::string &filename)
	Set the filename. More...
const std::string	GetFilename () const
	Get the filename. More...
void	SetActualCurrent (const double current)
	Set the actual current. More...
double	GetActualCurrent () const
	Get the actual current. More...
void	SetReferenceCurrent (const double current)
	Set the reference current. More...
double	GetReferenceCurrent () const
	Get the reference current. More...
void	SetRotation (const double rotation)
	Set the field rotation around z (with QwUnits) More...
double	GetRotation () const
	Get the field rotation around z (with QwUnits) More...
void	SetTranslation (const double translation)
	Set the field translation along z. More...
double	GetTranslation () const
	Get the field translation along z. More...
void	GetCartesianFieldValue (const double point_xyz[3], double field_xyz[3]) const
	Get the cartesian components of the field value. More...
void	GetCylindricalFieldValue (const double point_xyz[3], double field_rfz[3]) const
	Get the cylindrical components of the field value. More...
void	GetCartesianFieldValue (const TVector3 &point, TVector3 &field) const
	Get the cartesian components of the field value. More...
bool	ReadFieldMap ()
	Read a field map. More...
bool	ReadFieldMapFile (const std::string &filename)
	Read a field map input file. More...
bool	ReadFieldMapZip (const std::string &filename)
	Read a field map input gzip file. More...
bool	ReadFieldMapStream (std::istream &input)
	Read the field map input stream. More...
bool	TestFieldMap ()
	Test the field map. More...
Expose some functionality of underlying field map
bool	WriteBinaryFile (const std::string &fieldmap) const
	Write a binary field map. More...
bool	WriteTextFile (const std::string &fieldmap) const
	Write a text field map. More...
void	SetInterpolationMethod (const EQwInterpolationMethod method)
	Set interpolation method. More...
EQwInterpolationMethod	GetInterpolationMethod () const
	Get interpolation method. More...

Static Public Member Functions
static void	DefineOptions (QwOptions &options)
	Define command line and config file options. More...

Private Types
typedef float	field_t

Private Member Functions
void	GetFieldValue (const double point[3], double field[value_n]) const
	Get the field value. More...

Private Attributes
std::string	fFilename
	File name. More...
QwInterpolator< field_t, value_n > *	fField
	Field map. More...
std::vector< double >	fMin
	Field map grid min, max, step, wrap. More...
std::vector< double >	fMax
std::vector< double >	fStep
std::vector< size_t >	fWrap
double	fReferenceCurrent
	Field scale factor. More...
double	fActualCurrent
double	fScaleFactor
double	fRotation
	Field rotation and translation with respect to the z axis. More...
double	fRotationDeg
double	fRotationRad
double	fRotationCos
double	fRotationSin
double	fTranslation

Static Private Attributes
static const unsigned int	value_n = 3

Detailed Description

Magnetic field map object.

This class implements a magnetic field object using the QwInterpolator class.

Five magnetic field components are stored (larger memory usage, computationally more intensive on creation, but faster access by avoiding trigonometric operations).

Access to the field components is possible using two functions:

* field->GetCartesianFieldValue(double point_xyz[3], double field_xyz[3]);
* field->GetCylindricalFieldValue(double point_xyz[3], double field_rfz[3]);
* 

Currently no function exists that takes cylindrical coordinates.

Definition at line 50 of file QwMagneticField.h.

Member Typedef Documentation

typedef float QwMagneticField::field_t

private

Definition at line 58 of file QwMagneticField.h.

Constructor & Destructor Documentation

QwMagneticField::QwMagneticField	(	QwOptions &	options,
		const bool	suppress_read_field_map = false
	)

Default constructor.

Default constructor with optional field map

Definition at line 44 of file QwMagneticField.cc.

References QwLog::endl(), fField, ProcessOptions(), QwError, ReadFieldMap(), SetActualCurrent(), SetReferenceCurrent(), SetRotation(), SetTranslation(), and value_n.

{
  // Check number of field components
  if (value_n < 3) {
    QwError << "Number of field components should be at least three!" << QwLog::endl;
  }

  // No field map yet
  fField = 0;

  // Initialize parameters
  SetReferenceCurrent(8960.0);
  SetActualCurrent(8921.0);
  SetTranslation(0.0);
  SetRotation(0.0);

  // Process options
  ProcessOptions(options);

  // Read field map
  if (! suppress_read_field_map) ReadFieldMap();
}

Here is the call graph for this function:

QwMagneticField::~QwMagneticField ( )

virtual

Virtual destructor.

Destructor

Definition at line 70 of file QwMagneticField.cc.

References fField.

{
  if (fField) delete fField;
}

Member Function Documentation

void QwMagneticField::DefineOptions ( QwOptions &  options )

static

Define command line and config file options.

Define the options for this subsystem

Parameters

options

Options object

Definition at line 79 of file QwMagneticField.cc.

References QwOptions::AddOptions().

Referenced by DefineOptionsTracking(), and main().

{
  // Options
  options.AddOptions("Magnetic field map")
    ("QwMagneticField.mapfile",po::value<std::string>()->default_value("peiqing_2011.dat"),
     "Field map file");

  options.AddOptions("Magnetic field map")
    ("QwMagneticField.current",po::value<double>()->default_value(0.0),
     "Actual current of run to analyze");
  options.AddOptions("Magnetic field map")
    ("QwMagneticField.reference",po::value<double>()->default_value(8960.0),
     "Reference current of field map");

  options.AddOptions("Magnetic field map")
    ("QwMagneticField.trans",po::value<double>()->default_value(0),
     "Translation [cm]");
  options.AddOptions("Magnetic field map")
    ("QwMagneticField.rot",po::value<double>()->default_value(0),
     "Rotation [deg]");
  options.AddOptions("Magnetic field map")
    ("QwMagneticField.zmin",po::value<double>()->default_value(-250),
     "Minimum of z [cm]");
  options.AddOptions("Magnetic field map")
    ("QwMagneticField.zmax",po::value<double>()->default_value(+250),
     "Maximum of z [cm]");
  options.AddOptions("Magnetic field map")
    ("QwMagneticField.zstep",po::value<double>()->default_value(2),
     "Step size of z [cm]");
  options.AddOptions("Magnetic field map")
    ("QwMagneticField.rmin",po::value<double>()->default_value(2),
     "Minimum of r [cm]");
  options.AddOptions("Magnetic field map")
    ("QwMagneticField.rmax",po::value<double>()->default_value(260),
     "Maximum of r [cm]");
  options.AddOptions("Magnetic field map")
    ("QwMagneticField.rstep",po::value<double>()->default_value(2),
     "Step size of r [cm]");
  options.AddOptions("Magnetic field map")
    ("QwMagneticField.phimin",po::value<double>()->default_value(0),
     "Minimum of phi [deg]");
  options.AddOptions("Magnetic field map")
    ("QwMagneticField.phimax",po::value<double>()->default_value(360),
     "Maximum of phi [deg]");
  options.AddOptions("Magnetic field map")
    ("QwMagneticField.phistep",po::value<double>()->default_value(1),
     "Step size of phi [deg]");
  options.AddOptions("Magnetic field map")
    ("QwMagneticField.phiwrap",po::value<int>()->default_value(1),
     "Wrap-around of phi (number of equivalent grid points)");
}

Here is the call graph for this function:

Here is the caller graph for this function:

double QwMagneticField::GetActualCurrent ( ) const

inline

Get the actual current.

Definition at line 90 of file QwMagneticField.h.

References fActualCurrent.

Referenced by QwRayTracer::GetMagneticFieldCurrent().

      { return fActualCurrent; }

Here is the caller graph for this function:

void QwMagneticField::GetCartesianFieldValue ( const double  point_xyz[3], double  field_xyz[3]  ) const

inline

Get the cartesian components of the field value.

Definition at line 124 of file QwMagneticField.h.

References GetFieldValue(), and value_n.

Referenced by GetCartesianFieldValue(), QwRayTracer::IntegrateRK(), and main().

                                                                                      {
      double field[value_n];
      GetFieldValue(point_xyz, field);
      if (value_n >= 3) {
        field_xyz[0] = field[0]; // x
        field_xyz[1] = field[1]; // y
        field_xyz[2] = field[2]; // z
      }
    };

Here is the call graph for this function:

Here is the caller graph for this function:

void QwMagneticField::GetCartesianFieldValue ( const TVector3 &  point, TVector3 &  field  ) const

inline

Get the cartesian components of the field value.

Definition at line 154 of file QwMagneticField.h.

References GetCartesianFieldValue().

                                                                              {
      double point_xyz[3], field_xyz[3];
      point.GetXYZ(point_xyz);
      GetCartesianFieldValue(point_xyz, field_xyz);
      field = TVector3(field_xyz);
    }

Here is the call graph for this function:

void QwMagneticField::GetCylindricalFieldValue ( const double  point_xyz[3], double  field_rfz[3]  ) const

inline

Get the cylindrical components of the field value.

Definition at line 134 of file QwMagneticField.h.

References QwLog::endl(), GetFieldValue(), Qw::pi, QwWarning, and value_n.

                                                                                        {
      double field[value_n];
      GetFieldValue(point_xyz, field);
      if (value_n == 3) {
        double r = sqrt(field[0] * field[0] + field[1] * field[1]) ;
        double phi = atan2(field[1],field[0]);
        if (phi < 0) phi += 2.0 * Qw::pi;
        field_rfz[0] = r; // r
        field_rfz[1] = phi; // phi
        field_rfz[2] = field[2]; // z
      } else if (value_n == 5) {
        field_rfz[0] = field[3]; // r
        field_rfz[1] = field[4]; // phi
        field_rfz[2] = field[2]; // z
      } else {
        QwWarning << "Number of field components should be 3 or 5." << QwLog::endl;
      }
    };

Here is the call graph for this function:

void QwMagneticField::GetFieldValue ( const double  coord_xyz[3], double  field[value_n]  ) const

private

Get the field value.

Get a field value

Parameters

coord_xyz[]	Cartesian coordinates (x,y,z)
field[]	Field components (x,y,z,r,phi) (return)

Definition at line 418 of file QwMagneticField.cc.

References QwLog::endl(), fField, fScaleFactor, QwInterpolator< value_t, value_n >::GetValue(), QwInterpolator< value_t, value_n >::InBounds(), Qw::pi, QwWarning, and value_n.

Referenced by GetCartesianFieldValue(), GetCylindricalFieldValue(), and TestFieldMap().

{
  // Convert from cartesian to cylindrical coordinates
  double z   = coord_xyz[2];
  double r   = sqrt(coord_xyz[0] * coord_xyz[0] + coord_xyz[1] * coord_xyz[1]);
  double phi = atan2(coord_xyz[1], coord_xyz[0]); if (phi < 0.0) phi += 2.0*Qw::pi;

  // The ordering is important!  It has to agree with how the ordering is
  // defined on initialization of the field map.  Since tracks are in fairly
  // constant phi planes, it makes sense to keep phi as the most significant
  // index.  The largest changes happen in z, so that should be the least
  // significant index.  This will allow us to use caching more efficiently.
  double coord_zrf[3] = {z, r, phi};

  // The magnetic field object was not defined, return zero field and complain
  if (!this) {
    QwWarning << "No field map defined: assuming zero field!" << QwLog::endl;
    for (unsigned int i = 0; i < value_n; i++) field[i] = 0.0;
    return;
  }

  // Retrieve field value
  bool status = fField->GetValue(coord_zrf,field);

  // Apply scale factor
  for (unsigned int i = 0; i < value_n; i++)
    field[i] *= fScaleFactor;

  // Warn if the coordinate was inside the field boundaries,
  // but we still encountered a problem.
  if (status == false && fField->InBounds(coord_zrf)) {
    QwWarning << "Could not get field value at (z,r,phi) = " << coord_zrf << QwLog::endl;
    QwWarning << "Will use field value (x,y,z) = " << field << QwLog::endl;
  }
}

Here is the call graph for this function:

Here is the caller graph for this function:

const std::string QwMagneticField::GetFilename ( ) const

inline

Get the filename.

Definition at line 80 of file QwMagneticField.h.

References fFilename.

      { return fFilename; };

EQwInterpolationMethod QwMagneticField::GetInterpolationMethod ( ) const

inline

Get interpolation method.

Definition at line 192 of file QwMagneticField.h.

References fField, QwInterpolator< value_t, value_n >::GetInterpolationMethod(), and kInterpolationMethodUnknown.

Referenced by main().

                                                          {
      if (fField) return fField->GetInterpolationMethod();
      else return kInterpolationMethodUnknown;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

double QwMagneticField::GetReferenceCurrent ( ) const

inline

Get the reference current.

Definition at line 100 of file QwMagneticField.h.

References fReferenceCurrent.

    { return fReferenceCurrent; }

double QwMagneticField::GetRotation ( ) const

inline

Get the field rotation around z (with QwUnits)

Definition at line 113 of file QwMagneticField.h.

References fRotationRad, and Qw::rad.

      { return fRotationRad * Qw::rad; };

double QwMagneticField::GetTranslation ( ) const

inline

Get the field translation along z.

Definition at line 120 of file QwMagneticField.h.

References fTranslation.

      { return fTranslation; };

void QwMagneticField::LoadBeamProperty

(

const TString &

map

)

Load beam property.

Definition at line 457 of file QwMagneticField.cc.

References SetActualCurrent(), and QwParameterFile::TrimComment().

Referenced by ProcessOptions().

                                                          {
  QwParameterFile mapstr(map.Data());
  while (mapstr.ReadNextLine()) {
    mapstr.TrimComment();       // Remove everything after a comment character.
    mapstr.TrimWhitespace();    // Get rid of leading and trailing spaces.
    if (mapstr.LineIsEmpty())
      continue;

    string varname, varvalue;
    if (mapstr.HasVariablePair("=", varname, varvalue)) {
      if (varname == "QTOR") {
        SetActualCurrent(atof(varvalue.c_str()));
      }
    }
  }
}

Here is the call graph for this function:

Here is the caller graph for this function:

void QwMagneticField::ProcessOptions

(

QwOptions &

options

)

Process command line and config file options.

Process the options for this subsystem

Parameters

options

Options object

Definition at line 135 of file QwMagneticField.cc.

References Qw::cm, Qw::deg, fMax, fMin, fStep, fWrap, QwOptions::GetValue(), LoadBeamProperty(), SetActualCurrent(), SetFilename(), SetReferenceCurrent(), SetRotation(), and SetTranslation().

Referenced by QwMagneticField().

{
  // Field currents
  SetActualCurrent(options.GetValue<double>("QwMagneticField.current"));
  SetReferenceCurrent(options.GetValue<double>("QwMagneticField.reference"));
  // Override if necessary
  LoadBeamProperty("beam_property.map");

  // Translation and rotation
  double trans = Qw::cm  * options.GetValue<double>("QwMagneticField.trans");
  double rot   = Qw::deg * options.GetValue<double>("QwMagneticField.rot");
  SetTranslation(trans);
  SetRotation(rot);

  // Grid options
  double zmin    = Qw::cm  * options.GetValue<double>("QwMagneticField.zmin");
  double zmax    = Qw::cm  * options.GetValue<double>("QwMagneticField.zmax");
  double zstep   = Qw::cm  * options.GetValue<double>("QwMagneticField.zstep");
  double rmin    = Qw::cm  * options.GetValue<double>("QwMagneticField.rmin");
  double rmax    = Qw::cm  * options.GetValue<double>("QwMagneticField.rmax");
  double rstep   = Qw::cm  * options.GetValue<double>("QwMagneticField.rstep");
  double phimin  = Qw::deg * options.GetValue<double>("QwMagneticField.phimin");
  double phimax  = Qw::deg * options.GetValue<double>("QwMagneticField.phimax");
  double phistep = Qw::deg * options.GetValue<double>("QwMagneticField.phistep");
  int phiwrap = options.GetValue<int>("QwMagneticField.phiwrap");

  // The order is z, r, phi (no wrapping in r or z)
  fMin.push_back(zmin);   fMax.push_back(zmax);   fStep.push_back(zstep);   fWrap.push_back(0);
  fMin.push_back(rmin);   fMax.push_back(rmax);   fStep.push_back(rstep);   fWrap.push_back(0);
  fMin.push_back(phimin); fMax.push_back(phimax); fStep.push_back(phistep); fWrap.push_back(phiwrap);

  // Determine magnetic field file from environment variables
  std::string fieldmap = 
    options.GetValue<std::string>("QwMagneticField.mapfile");
  SetFilename(fieldmap);
}

Here is the call graph for this function:

Here is the caller graph for this function:

bool QwMagneticField::ReadFieldMap

(

)

Read a field map.

Read the magnetic field map

Returns

True if read successfully

Definition at line 176 of file QwMagneticField.cc.

References QwLog::endl(), fField, fFilename, fMax, fMin, fStep, fWrap, getenv_safe_string(), QwError, QwWarning, QwInterpolator< value_t, value_n >::ReadBinaryFile(), ReadFieldMapFile(), ReadFieldMapZip(), and QwInterpolator< value_t, value_n >::SetWrapCoordinate().

Referenced by main(), and QwMagneticField().

{
  // Delete existing magnetic field
  if (fField) delete fField;

  // Create new magnetic field
  fField = new QwInterpolator<field_t,value_n>(fMin,fMax,fStep);
  fField->SetWrapCoordinate(fWrap);

  // Add path to filename
  std::string filename = getenv_safe_string("QW_FIELDMAP") + "/" + fFilename;

  // Depending on form of filename, read zipped/regular/binary field map
  bool status = false;
  if (filename.find(".dat") != std::string::npos) {
    status = ReadFieldMapFile(filename);
  }
  if (filename.find(".dat.gz") != std::string::npos) {
    status = ReadFieldMapZip(filename);
  }
  if (filename.find(".bin") != std::string::npos) {
    status = fField->ReadBinaryFile(filename);
    // Try the regular map as a fallback option
    if (status == false) {
      filename.replace(filename.find("bin"),3,"dat");
      status = ReadFieldMapFile(filename);
    }
  }

  // Check whether we succeeded
  if (status == false) {
    QwError   << "Could not load magnetic field map!" << QwLog::endl;
    QwWarning << "Filename: " << filename << QwLog::endl;
  }

  return status;
}

Here is the call graph for this function:

Here is the caller graph for this function:

bool QwMagneticField::ReadFieldMapFile

(

const std::string &

filename

)

Read a field map input file.

Read the magnetic field from an ANSYS map file in text format

Parameters

filename

ANSYS map file name

Returns

True if read successfully

Definition at line 276 of file QwMagneticField.cc.

References QwLog::endl(), Qw::in, QwError, and ReadFieldMapStream().

Referenced by ReadFieldMap().

{
  // Open the field map file
  std::ifstream input;
  input.open(filename.c_str(), std::ios_base::in);
  // Check for success
  if (!input.good()) {
    QwError << "Could not open field map file!" << QwLog::endl;
    QwError << "File name: " << filename << QwLog::endl;
    return false;
  }

  // Read the input field map stream
  return ReadFieldMapStream(input);
}

Here is the call graph for this function:

Here is the caller graph for this function:

bool QwMagneticField::ReadFieldMapStream

(

std::istream &

input

)

Read the field map input stream.

Read the magnetic field from an ANSYS map text stream

Parameters

input

Input stream

Returns

True if read successfully

Definition at line 318 of file QwMagneticField.cc.

References Qw::cm, Qw::deg, QwLog::endl(), fField, QwLog::flush(), fRotation, fRotationCos, fRotationSin, fTranslation, QwInterpolator< value_t, value_n >::GetCurrentEntries(), QwInterpolator< value_t, value_n >::GetMaximumEntries(), Qw::kG, Qw::pi, QwInterpolator< value_t, value_n >::PrintCoverage(), QwError, QwMessage, QwWarning, QwInterpolator< value_t, value_n >::Set(), and value_n.

Referenced by ReadFieldMapFile(), and ReadFieldMapZip().

{
  // Check whether field map exists
  if (fField == 0) {
    QwWarning << "Trying to read field map without object to put values in."
              << QwLog::endl;
    return false;
  }

  // Declare variables
  double r, z, phi;
  field_t bx, by, bz, bx_new, by_new;

  // Check for stream
  if (!input.good()) {
    QwError << "Error: Could not open field map stream!" << QwLog::endl;
    return false;
  }

  QwMessage << "Reading magnetic field map ";

  // Loop over stream until end-of-file
  // Note: input.good() only says whether next operation *might* succeed
  while (! input.fail()) {

    // Progress bar
    if (fField->GetCurrentEntries() % (fField->GetMaximumEntries() / 10) == 0) {
      int pct = fField->GetCurrentEntries() / (fField->GetMaximumEntries() / 100);
      QwMessage << pct << "%" << QwLog::flush;
    }
    if (fField->GetCurrentEntries() % (fField->GetMaximumEntries() / 10) != 0
     && fField->GetCurrentEntries() % (fField->GetMaximumEntries() / 40) == 0) {
      QwMessage << "." << QwLog::flush;
    }

    // Read a line with three position coordinates and three field components
    input >> r >> z >> phi >> bx >> by >> bz;
    if (! input.good()) continue;

    // Fix the units
    r *= Qw::cm; z *= Qw::cm; phi *= Qw::deg;
    bx *= Qw::kG; by *= Qw::kG; bz *= Qw::kG;

    // Correct for translation along z
    z -= fTranslation;

    // Correct for rotation around z
    phi -= fRotation;
    if (phi < 0.0*Qw::pi) phi += 2.0*Qw::pi;
    if (phi > 2.0*Qw::pi) phi -= 2.0*Qw::pi;
    bx_new =  bx * fRotationCos + by * fRotationSin;
    by_new = -bx * fRotationSin + by * fRotationCos;
    bx = bx_new; by = by_new;

    // Construct the coordinate
    double coord[3] = {z, r, phi};

    // Construct the field vector
    field_t field[value_n];
    field[0] = bx;
    field[1] = by;
    field[2] = bz;

    if (value_n == 5) {
      // Calculate the radial and azimuthal field components
      double br =    bx * cos(phi) + by * sin(phi);
      double bphi = -bx * sin(phi) + by * cos(phi);

      // Construct the field vector
      field[3] = br;
      field[4] = bphi;
    }

    bool status = fField->Set(coord, field);
    if (! status) {
      QwError << "Problem assigning field to coordinate!" << QwLog::endl;
      QwError << coord[0] << "," << coord[1] << "," << coord[2] << QwLog::endl;
    }
  }
  QwMessage << QwLog::endl;

  if (abs(fField->GetCurrentEntries() / fField->GetMaximumEntries() - 1) > 0.00001) {
    QwWarning << "Expected " << fField->GetMaximumEntries() << " entries, "
              << "but only read " << fField->GetCurrentEntries() << "." << QwLog::endl;
    QwMessage << "Coverage of the z bins:" << QwLog::endl;
    fField->PrintCoverage(0);
    QwMessage << "Coverage of the r bins:" << QwLog::endl;
    fField->PrintCoverage(1);
    QwMessage << "Coverage of the phi bins:" << QwLog::endl;
    fField->PrintCoverage(2);
  }

  return true;
}

Here is the call graph for this function:

Here is the caller graph for this function:

bool QwMagneticField::ReadFieldMapZip

(

const std::string &

filename

)

Read a field map input gzip file.

Read the magnetic field from an ANSYS map file in gzipped text format

Parameters

filename

ANSYS map file name

Returns

True if read successfully

Definition at line 297 of file QwMagneticField.cc.

References QwLog::endl(), QwWarning, and ReadFieldMapStream().

Referenced by ReadFieldMap().

{
#ifdef __USE_BOOST_IOSTREAMS
  // Create a gzip filter for the field map file
  boost::iostreams::filtering_istream input;
  input.push(boost::iostreams::gzip_decompressor());
  input.push(boost::iostreams::file_source(filename));

  // Read the input field map stream
  return ReadFieldMapStream(input);
#else
  QwWarning << "Compressed input files not supported!" << QwLog::endl;
  return false;
#endif
}

Here is the call graph for this function:

Here is the caller graph for this function:

void QwMagneticField::SetActualCurrent ( const double  current )

inline

Set the actual current.

Definition at line 84 of file QwMagneticField.h.

References fActualCurrent, fReferenceCurrent, and fScaleFactor.

Referenced by LoadBeamProperty(), ProcessOptions(), QwMagneticField(), and QwRayTracer::SetMagneticFieldCurrent().

                                                {
      fActualCurrent = current;
      if (fReferenceCurrent > 0.0)
        fScaleFactor = fActualCurrent/fReferenceCurrent;
    }

Here is the caller graph for this function:

void QwMagneticField::SetFilename ( const std::string &  filename )

inline

Set the filename.

Definition at line 77 of file QwMagneticField.h.

References fFilename.

Referenced by main(), and ProcessOptions().

      { fFilename = filename; };

Here is the caller graph for this function:

void QwMagneticField::SetInterpolationMethod ( const EQwInterpolationMethod  method )

inline

Set interpolation method.

Definition at line 188 of file QwMagneticField.h.

References fField, and QwInterpolator< value_t, value_n >::SetInterpolationMethod().

Referenced by main().

                                                                     {
      if (fField) fField->SetInterpolationMethod(method);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

void QwMagneticField::SetReferenceCurrent ( const double  current )

inline

Set the reference current.

Definition at line 94 of file QwMagneticField.h.

References fActualCurrent, fReferenceCurrent, and fScaleFactor.

Referenced by ProcessOptions(), and QwMagneticField().

                                                   {
      fReferenceCurrent = current;
      if (fReferenceCurrent > 0.0)
        fScaleFactor = fActualCurrent/fReferenceCurrent;
    }

Here is the caller graph for this function:

void QwMagneticField::SetRotation ( const double  rotation )

inline

Set the field rotation around z (with QwUnits)

Definition at line 104 of file QwMagneticField.h.

References Qw::deg, fRotation, fRotationCos, fRotationDeg, fRotationRad, fRotationSin, and Qw::rad.

Referenced by ProcessOptions(), and QwMagneticField().

                                            {
      fRotation = rotation;
      fRotationCos = cos(rotation);
      fRotationSin = sin(rotation);
       // Unit conversions
      fRotationDeg = rotation / Qw::deg;
      fRotationRad = rotation / Qw::rad;
    };

Here is the caller graph for this function:

void QwMagneticField::SetTranslation ( const double  translation )

inline

Set the field translation along z.

Definition at line 117 of file QwMagneticField.h.

References fTranslation.

Referenced by ProcessOptions(), and QwMagneticField().

      { fTranslation = translation; };

Here is the caller graph for this function:

bool QwMagneticField::TestFieldMap

(

)

Test the field map.

Test the field map value at a specific point to make sure nothing went wrong

Returns

True if read successfully

Definition at line 218 of file QwMagneticField.cc.

References Qw::cm, QwLog::endl(), GetFieldValue(), Qw::kG, QwError, QwMessage, and QwWarning.

Referenced by QwRayTracer::LoadMagneticFieldMap().

{
  bool status = true;

  // Test field value at exact grid point
  // (r = 100*cm, z = 100*cm, phi = 22.5*degree)
  double point[3] = {100.0 * Qw::cm, 0.0 * Qw::cm, 100.0 * Qw::cm};
  double exact[3] = {-0.0499845 * Qw::kG, 3.28516 * Qw::kG, -0.0112704 * Qw::kG};

  // Calculate field value
  QwMessage << "Calculating test field value at cartesian position "
    << "(" << point[0]/Qw::cm << "," << point[1]/Qw::cm << "," << point[2]/Qw::cm << ") cm "
    << QwLog::endl;
  double value[3] = {0.0, 0.0, 0.0};
  GetFieldValue(point,value);

  // Calculate difference
  double diff[3] = {0.0, 0.0, 0.0};
  double norm = 0.0;
  for (size_t i = 0; i < 3; i++) {
    diff[i] = value[i] - exact[i];
    norm += diff[i] * diff[i];
  }
  norm = sqrt(norm);

  // Output
  QwMessage << "  Value = "
    << "(" << value[0]/Qw::kG << ", " << value[1]/Qw::kG << ", " << value[2]/Qw::kG << ") kG."
    << QwLog::endl;
  QwMessage << "  Exact = "
    << "(" << exact[0]/Qw::kG << ", " << exact[1]/Qw::kG << ", " << exact[2]/Qw::kG << ") kG."
    << QwLog::endl;
  QwMessage << "  Diff  = "
    << "(" << diff[0]/Qw::kG << ", " << diff[1]/Qw::kG << ", " << diff[2]/Qw::kG << ") kG."
    << QwLog::endl;

  // Test difference (0.1 kG is of the order of 2%)
  if (norm > 0.1 * Qw::kG) {
    QwWarning << "Magnetic field is different from expected value by " << norm/Qw::kG << " kG."
              << QwLog::endl;
    status = false;
  }

  // Check validity
  if (status == false) {
    QwError   << "Fieldmap did not satisfy consistency checks!" << QwLog::endl;
  }

  // Nothing is tested, just return true
  return status;
}

Here is the call graph for this function:

Here is the caller graph for this function:

bool QwMagneticField::WriteBinaryFile ( const std::string &  fieldmap ) const

inline

Write a binary field map.

Definition at line 176 of file QwMagneticField.h.

References fField, getenv_safe_string(), and QwInterpolator< value_t, value_n >::WriteBinaryFile().

Referenced by main().

                                                          {
      std::string filename = getenv_safe_string("QW_FIELDMAP") + "/" + fieldmap;
      if (fField) return fField->WriteBinaryFile(filename);
      else return false;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

bool QwMagneticField::WriteTextFile ( const std::string &  fieldmap ) const

inline

Write a text field map.

Definition at line 182 of file QwMagneticField.h.

References fField, getenv_safe_string(), and QwInterpolator< value_t, value_n >::WriteTextFile().

                                                        {
      std::string filename = getenv_safe_string("QW_FIELDMAP") + "/" + fieldmap;
      if (fField) return fField->WriteTextFile(filename);
      else return false;
    }

Here is the call graph for this function:

Field Documentation

double QwMagneticField::fActualCurrent

private

Definition at line 212 of file QwMagneticField.h.

Referenced by GetActualCurrent(), SetActualCurrent(), and SetReferenceCurrent().

QwInterpolator<field_t,value_n>* QwMagneticField::fField

private

Field map.

Definition at line 204 of file QwMagneticField.h.

Referenced by GetFieldValue(), GetInterpolationMethod(), QwMagneticField(), ReadFieldMap(), ReadFieldMapStream(), SetInterpolationMethod(), WriteBinaryFile(), WriteTextFile(), and ~QwMagneticField().

std::string QwMagneticField::fFilename

private

File name.

Definition at line 201 of file QwMagneticField.h.

Referenced by GetFilename(), ReadFieldMap(), and SetFilename().

std::vector<double> QwMagneticField::fMax

private

Definition at line 207 of file QwMagneticField.h.

Referenced by ProcessOptions(), and ReadFieldMap().

std::vector<double> QwMagneticField::fMin

private

Field map grid min, max, step, wrap.

Definition at line 207 of file QwMagneticField.h.

Referenced by ProcessOptions(), and ReadFieldMap().

double QwMagneticField::fReferenceCurrent

private

Field scale factor.

Definition at line 211 of file QwMagneticField.h.

Referenced by GetReferenceCurrent(), SetActualCurrent(), and SetReferenceCurrent().

double QwMagneticField::fRotation

private

Field rotation and translation with respect to the z axis.

Definition at line 225 of file QwMagneticField.h.

Referenced by ReadFieldMapStream(), and SetRotation().

double QwMagneticField::fRotationCos

private

Definition at line 225 of file QwMagneticField.h.

Referenced by ReadFieldMapStream(), and SetRotation().

double QwMagneticField::fRotationDeg

private

Definition at line 225 of file QwMagneticField.h.

Referenced by SetRotation().

double QwMagneticField::fRotationRad

private

Definition at line 225 of file QwMagneticField.h.

Referenced by GetRotation(), and SetRotation().

double QwMagneticField::fRotationSin

private

Definition at line 225 of file QwMagneticField.h.

Referenced by ReadFieldMapStream(), and SetRotation().

double QwMagneticField::fScaleFactor

private

Definition at line 213 of file QwMagneticField.h.

Referenced by GetFieldValue(), SetActualCurrent(), and SetReferenceCurrent().

std::vector<double> QwMagneticField::fStep

private

Definition at line 207 of file QwMagneticField.h.

Referenced by ProcessOptions(), and ReadFieldMap().

double QwMagneticField::fTranslation

private

Definition at line 226 of file QwMagneticField.h.

Referenced by GetTranslation(), ReadFieldMapStream(), and SetTranslation().

std::vector<size_t> QwMagneticField::fWrap

private

Definition at line 208 of file QwMagneticField.h.

Referenced by ProcessOptions(), and ReadFieldMap().

const unsigned int QwMagneticField::value_n = 3

staticprivate

Definition at line 55 of file QwMagneticField.h.

Referenced by GetCartesianFieldValue(), GetCylindricalFieldValue(), GetFieldValue(), QwMagneticField(), and ReadFieldMapStream().

---

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

• QwMagneticField.h
• QwMagneticField.cc