genfit::FieldManager Class Reference

Singleton which provides access to magnetic field maps. More...

#include <FieldManager.h>

Public Member Functions
AbsBField *	getField ()
TVector3	getFieldVal (const TVector3 &position)
	This does NOT use the cache! More...
void	getFieldVal (const double &posX, const double &posY, const double &posZ, double &Bx, double &By, double &Bz)
void	init (AbsBField *b)
	set the magnetic field here. Magnetic field classes must be derived from AbsBField. More...
bool	isInitialized ()
void	checkInitialized ()
void	useCache (bool opt=true, unsigned int nBuckets=8)
	Cache last lookup positions, and use stored field values if a lookup at (almost) the same position is done. More...

Static Public Member Functions
static void	checkInstanciated ()
static FieldManager *	getInstance ()
	Get singleton instance. More...

Detailed Description

Singleton which provides access to magnetic field maps.

Author

Christian Höppner (Technische Universität München, original author)

Sebastian Neubert (Technische Universität München, original author)

Definition at line 55 of file FieldManager.h.

Member Function Documentation

checkInitialized()

void genfit::FieldManager::checkInitialized ( )

inline

Definition at line 86 of file FieldManager.h.

  {
    if (!isInitialized()) {
      std::cerr << "FieldManager hasn't been initialized with a correct AbsBField pointer!" << std::endl;
      std::string msg("FieldManager hasn't been initialized with a correct AbsBField pointer!");
      std::runtime_error err(msg);
      throw err;
    }
  }

checkInstanciated()

static void genfit::FieldManager::checkInstanciated ( )

inlinestatic

Definition at line 96 of file FieldManager.h.

  {
    if (instance_ == nullptr) {
      std::cerr << "FieldManager hasn't been instantiated yet, call getInstance() and init() before getFieldVal()!" << std::endl;
      std::string msg("FieldManager hasn't been instantiated yet, call getInstance() and init() before getFieldVal()!");
      std::runtime_error err(msg);
      throw err;
    }
  }

getField()

AbsBField* genfit::FieldManager::getField ( )

inline

Definition at line 58 of file FieldManager.h.

  {
    checkInitialized();
    return field_;
  }

getFieldVal() [1/2]

TVector3 genfit::FieldManager::getFieldVal ( const TVector3 &  position )

inline

This does NOT use the cache!

Definition at line 65 of file FieldManager.h.

References genfit::fieldCache::Bx, genfit::fieldCache::By, genfit::fieldCache::Bz, genfit::fieldCache::posX, genfit::fieldCache::posY, and genfit::fieldCache::posZ.

  {
    checkInitialized();
    return field_->get(position);
  }

getFieldVal() [2/2]

void genfit::FieldManager::getFieldVal	(	const double &	posX,
		const double &	posY,
		const double &	posZ,
		double &	Bx,
		double &	By,
		double &	Bz
	)

getInstance()

static FieldManager* genfit::FieldManager::getInstance ( )

inlinestatic

Get singleton instance.

Definition at line 117 of file FieldManager.h.

  {
    if (instance_ == nullptr) {
      instance_ = new FieldManager();
    }
    return instance_;
  }

init()

void genfit::FieldManager::init ( AbsBField *  b )

inline

set the magnetic field here. Magnetic field classes must be derived from AbsBField.

Definition at line 82 of file FieldManager.h.

{ field_ = b; }

isInitialized()

bool genfit::FieldManager::isInitialized ( )

inline

Definition at line 84 of file FieldManager.h.

{ return field_ != nullptr; }

useCache()

void genfit::FieldManager::useCache	(	bool	opt = true,
		unsigned int	nBuckets = 8
	)

Cache last lookup positions, and use stored field values if a lookup at (almost) the same position is done.

---

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

• FieldManager.h