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

#include <FieldManager.h>

Collaboration diagram for genfit::FieldManager:

[legend]

Public Member Functions
AbsBField *	getField ()

TVector3	getFieldVal (const TVector3 &position)
	This does NOT use the cache!

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.

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.

AbsBField *	getField ()

TVector3	getFieldVal (const TVector3 &position)
	This does NOT use the cache!

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.

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.

Static Public Member Functions
static void	checkInstanciated ()

static FieldManager *	getInstance ()
	Get singleton instance.

static void	checkInstanciated ()

static FieldManager *	getInstance ()
	Get singleton instance.

Private Member Functions
	FieldManager ()

	~FieldManager ()

	FieldManager ()

	~FieldManager ()

Static Private Attributes
static FieldManager *	instance_ = NULL

static AbsBField *	field_ = NULL

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

◆ FieldManager() [1/2]

genfit::FieldManager::FieldManager ( )

inlineprivate

Definition at line 122 of file FieldManager.h.

122{}

◆ ~FieldManager() [1/2]

genfit::FieldManager::~FieldManager ( )

inlineprivate

Definition at line 124 of file FieldManager.h.

124{ delete cache_; }

genfit::FieldManager::cache_

static fieldCache * cache_

Definition FieldManager.h:134

◆ FieldManager() [2/2]

genfit::FieldManager::FieldManager ( )

inlineprivate

Definition at line 122 of file FieldManager.h.

122{}

◆ ~FieldManager() [2/2]

genfit::FieldManager::~FieldManager ( )

inlineprivate

Definition at line 124 of file FieldManager.h.

124{ delete cache_; }

Member Function Documentation

◆ checkInitialized() [1/2]

void genfit::FieldManager::checkInitialized ( )

inline

Definition at line 84 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;
    }
  }

◆ checkInitialized() [2/2]

void genfit::FieldManager::checkInitialized ( )

inline

Definition at line 84 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() [1/2]

static void genfit::FieldManager::checkInstanciated ( )

inlinestatic

Definition at line 93 of file FieldManager.h.

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

◆ checkInstanciated() [2/2]

static void genfit::FieldManager::checkInstanciated ( )

inlinestatic

Definition at line 93 of file FieldManager.h.

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

◆ getField() [1/2]

AbsBField * genfit::FieldManager::getField ( )

inline

Definition at line 57 of file FieldManager.h.

                       {
    checkInitialized();
    return field_;
  }

◆ getField() [2/2]

AbsBField * genfit::FieldManager::getField ( )

inline

Definition at line 57 of file FieldManager.h.

                       {
    checkInitialized();
    return field_;
  }

◆ getFieldVal() [1/4]

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

◆ getFieldVal() [2/4]

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

◆ getFieldVal() [3/4]

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

inline

This does NOT use the cache!

Definition at line 63 of file FieldManager.h.

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

◆ getFieldVal() [4/4]

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

inline

This does NOT use the cache!

Definition at line 63 of file FieldManager.h.

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

◆ getInstance() [1/2]

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

inlinestatic

Get singleton instance.

Definition at line 112 of file FieldManager.h.

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

◆ getInstance() [2/2]

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

inlinestatic

Get singleton instance.

Definition at line 112 of file FieldManager.h.

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

◆ init() [1/2]

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.

                          {
    field_=b;
  }

◆ init() [2/2]

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.

                          {
    field_=b;
  }

◆ isInitialized() [1/2]

bool genfit::FieldManager::isInitialized ( )

inline

Definition at line 82 of file FieldManager.h.

82{ return field_ != NULL; }

◆ isInitialized() [2/2]

bool genfit::FieldManager::isInitialized ( )

inline

Definition at line 82 of file FieldManager.h.

82{ return field_ != NULL; }

◆ useCache() [1/2]

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.

◆ useCache() [2/2]

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

◆ cache_

static fieldCache * genfit::FieldManager::cache_

staticprivate

Definition at line 134 of file FieldManager.h.

◆ field_

static AbsBField * genfit::FieldManager::field_ = NULL

staticprivate

Definition at line 129 of file FieldManager.h.

◆ instance_

static FieldManager * genfit::FieldManager::instance_ = NULL

staticprivate

Definition at line 128 of file FieldManager.h.

◆ n_buckets_

static unsigned int genfit::FieldManager::n_buckets_

staticprivate

Definition at line 133 of file FieldManager.h.

◆ useCache_

static bool genfit::FieldManager::useCache_

staticprivate

Definition at line 132 of file FieldManager.h.

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

genfit/core/include/FieldManager.h
genfit/include/genfit/FieldManager.h
genfit/core/src/FieldManager.cc

Public Member Functions

Static Public Member Functions

Private Member Functions

Static Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ FieldManager() [1/2]

◆ ~FieldManager() [1/2]

◆ FieldManager() [2/2]

◆ ~FieldManager() [2/2]

Member Function Documentation

◆ checkInitialized() [1/2]

◆ checkInitialized() [2/2]

◆ checkInstanciated() [1/2]

◆ checkInstanciated() [2/2]

◆ getField() [1/2]

◆ getField() [2/2]

◆ getFieldVal() [1/4]

◆ getFieldVal() [2/4]

◆ getFieldVal() [3/4]

◆ getFieldVal() [4/4]

◆ getInstance() [1/2]

◆ getInstance() [2/2]

◆ init() [1/2]

◆ init() [2/2]

◆ isInitialized() [1/2]

◆ isInitialized() [2/2]

◆ useCache() [1/2]

◆ useCache() [2/2]

Member Data Documentation

◆ cache_

◆ field_

◆ instance_

◆ n_buckets_

◆ useCache_