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...

Private Member Functions
	FieldManager ()
	~FieldManager ()

Static Private Attributes
static FieldManager *	instance_
static AbsBField *	field_
static bool	useCache_
static unsigned int	n_buckets_
static fieldCache *	cache_

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 53 of file FieldManager.h.

Constructor & Destructor Documentation

genfit::FieldManager::FieldManager ( )

inlineprivate

Definition at line 122 of file FieldManager.h.

Referenced by getInstance().

{}

genfit::FieldManager::~FieldManager ( )

inlineprivate

Definition at line 124 of file FieldManager.h.

References cache_.

{ delete cache_; }

Member Function Documentation

void genfit::FieldManager::checkInitialized ( )

inline

Definition at line 84 of file FieldManager.h.

References isInitialized().

Referenced by getField(), and getFieldVal().

                          {
    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;
    }
  }

static void genfit::FieldManager::checkInstanciated ( )

inlinestatic

Definition at line 93 of file FieldManager.h.

References instance_.

                                  {
    if(instance_==NULL){
      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;
    }
  }

AbsBField* genfit::FieldManager::getField ( )

inline

Definition at line 57 of file FieldManager.h.

References checkInitialized(), and field_.

                       {
    checkInitialized();
    return field_;
  }

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

inline

This does NOT use the cache!

Definition at line 63 of file FieldManager.h.

References checkInitialized(), field_, and genfit::AbsBField::get().

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

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

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

inlinestatic

Get singleton instance.

Definition at line 112 of file FieldManager.h.

References FieldManager(), and instance_.

Referenced by PndRecoDafFit2::Init(), and PndRecoKalmanFit2::Init().

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

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

inline

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

Definition at line 78 of file FieldManager.h.

References b, and field_.

Referenced by PndRecoDafFit2::Init(), and PndRecoKalmanFit2::Init().

                          {
    field_=b;
  }

bool genfit::FieldManager::isInitialized ( )

inline

Definition at line 82 of file FieldManager.h.

References field_.

Referenced by checkInitialized().

{ return field_ != NULL; }

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.

Member Data Documentation

fieldCache* genfit::FieldManager::cache_

staticprivate

Definition at line 134 of file FieldManager.h.

Referenced by ~FieldManager().

AbsBField* genfit::FieldManager::field_

staticprivate

Definition at line 129 of file FieldManager.h.

Referenced by getField(), getFieldVal(), init(), and isInitialized().

FieldManager* genfit::FieldManager::instance_

staticprivate

Definition at line 128 of file FieldManager.h.

Referenced by checkInstanciated(), and getInstance().

unsigned int genfit::FieldManager::n_buckets_

staticprivate

Definition at line 133 of file FieldManager.h.

bool genfit::FieldManager::useCache_

staticprivate

Definition at line 132 of file FieldManager.h.

---

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

• FieldManager.h