RaveSetup Class Reference

The RaveSetup class is part of the RaveInterface together with RaveVertexFitter It holds all global options for the RaveVertexFitter and also takes care that stuff like the magnetic field is correctly set up in way Rave can access it. More...

#include <RaveSetup.h>

Collaboration diagram for RaveSetup:

Public Member Functions
void	setBeamSpot (const B2Vector3D &beamSpot, const TMatrixDSym &beamSpotCov)
	The beam spot position and covariance is known you can set it here so that and a vertex in the beam spot should be fitted you can set it here.
void	unsetBeamSpot ()
	unset beam spot constraint
void	reset ()
	frees memory allocated by initialize().

Static Public Member Functions
static RaveSetup *	getInstance ()
	get the pointer to the instance to get/set any of options stored in RaveSetup
static void	initialize (int verbosity=1, double MagneticField=1.5)
	Set everything up so everything needed for vertex fitting is there.
static void	Print ()
	Print() writes all RaveSetup member variables to the terminal

Protected Member Functions
	RaveSetup ()
	default constructor
	~RaveSetup ()
	default destructor

Static Protected Member Functions
static RaveSetup *	getRawInstance ()
	Same as getInstance(), but no check if the instance is initialised.

Protected Attributes
bool	m_useBeamSpot
	flag determines if beam spot information should be used for vertex fit.
B2Vector3D	m_beamSpot
	beam spot position.
TMatrixDSym	m_beamSpotCov
	beam spot position covariance matrix.
rave::VertexFactory *	m_raveVertexFactory
	The RAVE vertex factory is the principal interface offered by the RAVE vertex fitting library.
rave::KinematicTreeFactory *	m_raveKinematicTreeFactory
	< The RAVE Kinematic Tree factory is the principal interface offered by the RAVE for kinematic vertex fitting.
bool	m_initialized
	Has initialize() been called? unusable otherwise.

Friends
class	RaveVertexFitter
class	RaveKinematicVertexFitter

Detailed Description

The RaveSetup class is part of the RaveInterface together with RaveVertexFitter It holds all global options for the RaveVertexFitter and also takes care that stuff like the magnetic field is correctly set up in way Rave can access it.

Definition at line 37 of file RaveSetup.h.

Constructor & Destructor Documentation

RaveSetup()

RaveSetup ( )

protected

default constructor

Definition at line 48 of file RaveSetup.cc.

                    : m_useBeamSpot(false), m_raveVertexFactory(nullptr)/*, m_GFRaveVertexFactory(NULL)*/,
  m_raveKinematicTreeFactory(nullptr), m_initialized(false)
{
}

~RaveSetup()

~RaveSetup ( )

protected

default destructor

Definition at line 53 of file RaveSetup.cc.

{
  reset();
}

Member Function Documentation

getInstance()

static RaveSetup * getInstance ( )

inlinestatic

get the pointer to the instance to get/set any of options stored in RaveSetup

Definition at line 43 of file RaveSetup.h.

      {
        RaveSetup* instance = getRawInstance();
        if (!instance->m_initialized) {
          B2FATAL("RaveSetup::initialize was not called. It has to be called before RaveSetup or RaveVertexFitter are used");
        }
        return instance;
      }

getRawInstance()

RaveSetup * getRawInstance ( )

staticprotected

Same as getInstance(), but no check if the instance is initialised.

Definition at line 27 of file RaveSetup.cc.

{
  static RaveSetup instance;
  return &instance;
}

initialize()

void initialize ( int  verbosity = 1, double  MagneticField = 1.5  )

static

Set everything up so everything needed for vertex fitting is there.

Must be called before RaveVertexFitter can be used

Definition at line 33 of file RaveSetup.cc.

{
  if (getRawInstance()->m_initialized)
    getRawInstance()->reset();
  //now setup everything for the use of GFRave
//  getRawInstance()->m_GFRaveVertexFactory = new GFRaveVertexFactory(verbosity, true);
 
 
  getRawInstance()->m_raveVertexFactory = new rave::VertexFactory(rave::ConstantMagneticField(0, 0, magneticField),
      rave::VacuumPropagator(), "kalman", verbosity);
  getRawInstance()->m_raveKinematicTreeFactory = new rave::KinematicTreeFactory(rave::ConstantMagneticField(0, 0, magneticField),
      rave::VacuumPropagator(), verbosity);
  getRawInstance()->m_initialized = true;
}

Print()

void Print ( )

static

Print() writes all RaveSetup member variables to the terminal

Definition at line 87 of file RaveSetup.cc.

{
  if (getRawInstance() not_eq nullptr) {
    if (getRawInstance()->m_useBeamSpot == false) {
      B2INFO("use beam spot is false");
    } else {
      B2INFO("use beam spot is true and beam spot position and covariance matrix are:");
      getRawInstance()->m_beamSpot.PrintString();
      getRawInstance()->m_beamSpotCov.Print();
    }
    B2INFO("the pointer to rave::VertexFactory is " << getRawInstance()->m_raveVertexFactory);
  } else {
    B2INFO("RaveSetup::initialize was not called. There is nothing to Print.");
  }
}

reset()

void reset

(

)

frees memory allocated by initialize().

Beam spot is not modified.

Definition at line 58 of file RaveSetup.cc.

{
  //delete everything that could have potentially created with new in this class
 
  delete m_raveVertexFactory; // workaround to avoid crashes with V0 finder
  m_raveVertexFactory = nullptr;
  delete m_raveKinematicTreeFactory;
  m_raveKinematicTreeFactory = nullptr;
  //    delete m_GFRaveVertexFactory;
 
  m_initialized = false;
}

setBeamSpot()

void setBeamSpot	(	const B2Vector3D &	beamSpot,
		const TMatrixDSym &	beamSpotCov
	)

The beam spot position and covariance is known you can set it here so that and a vertex in the beam spot should be fitted you can set it here.

Definition at line 72 of file RaveSetup.cc.

{
  m_beamSpot = beamSpot;
  m_beamSpotCov.ResizeTo(beamSpotCov);
  m_beamSpotCov = beamSpotCov;
  m_useBeamSpot = true;
}

unsetBeamSpot()

void unsetBeamSpot

(

)

unset beam spot constraint

Definition at line 80 of file RaveSetup.cc.

{
  m_useBeamSpot = false;
}

Friends And Related Function Documentation

RaveKinematicVertexFitter

friend class RaveKinematicVertexFitter

friend

Definition at line 41 of file RaveSetup.h.

RaveVertexFitter

friend class RaveVertexFitter

friend

Definition at line 40 of file RaveSetup.h.

Member Data Documentation

m_beamSpot

B2Vector3D m_beamSpot

protected

beam spot position.

Can be used as additional information by RaveVertexFitter

Definition at line 73 of file RaveSetup.h.

m_beamSpotCov

TMatrixDSym m_beamSpotCov

protected

beam spot position covariance matrix.

Can be used as additional information by RaveVertexFitter

Definition at line 74 of file RaveSetup.h.

m_initialized

bool m_initialized

protected

Has initialize() been called? unusable otherwise.

Definition at line 83 of file RaveSetup.h.

m_raveKinematicTreeFactory

rave::KinematicTreeFactory* m_raveKinematicTreeFactory

protected

< The RAVE Kinematic Tree factory is the principal interface offered by the RAVE for kinematic vertex fitting.

Definition at line 81 of file RaveSetup.h.

m_raveVertexFactory

rave::VertexFactory* m_raveVertexFactory

protected

The RAVE vertex factory is the principal interface offered by the RAVE vertex fitting library.

Definition at line 77 of file RaveSetup.h.

m_useBeamSpot

bool m_useBeamSpot

protected

flag determines if beam spot information should be used for vertex fit.

Can be overruled by individual fits in RaveVertexFitter

Definition at line 72 of file RaveSetup.h.

---

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

• analysis/VertexFitting/RaveInterface/include/RaveSetup.h
• analysis/VertexFitting/RaveInterface/src/RaveSetup.cc