KFParticleFieldValue Class Reference

A class to store a vector with the magnetic field values {Bx, By, Bz} at the certain point. More...

#include <KFParticle/blob/master/KFParticle/KFParticleField.h>

Public Member Functions
	KFParticleFieldValue ()
void	Combine (KFParticleFieldValue &B, float_v w)

Public Attributes
float_v	x
	Bx component of the magnetic field.
float_v	y
	By component of the magnetic field.
float_v	z
	Bz component of the magnetic field.

Friends
std::ostream &	operator<< (std::ostream &out, KFParticleFieldValue &B)

Detailed Description

A class to store a vector with the magnetic field values {Bx, By, Bz} at the certain point.

Author

M.Zyzak, I.Kisel

Date

05.02.2019

Version

1.0

The class is used to represent the vector of the magnetic field at the certain position of the track. It contains three components of the magnetic field: Bx, By and Bz. It allows to combine the current field measurement with another measurement using a weight.

Definition at line 39 of file KFParticleField.h.

View newest version in sPHENIX GitHub at line 39 of file KFParticleField.h

Constructor & Destructor Documentation

KFParticleFieldValue::KFParticleFieldValue ( )

inline

Definition at line 42 of file KFParticleField.h.

View newest version in sPHENIX GitHub at line 42 of file KFParticleField.h

Member Function Documentation

void KFParticleFieldValue::Combine ( KFParticleFieldValue &  B, float_v  w  )

inline

Function allows to combine the current magntic field measurement with another measurement weighted by "w"

Parameters

[in]	B	- another field measurement to be combined with the current value
[in]	w	- weight of the measurement being added

Definition at line 48 of file KFParticleField.h.

View newest version in sPHENIX GitHub at line 48 of file KFParticleField.h

References x, y, and z.

Friends And Related Function Documentation

std::ostream& operator<< ( std::ostream &  out, KFParticleFieldValue &  B  )

friend

Operator to print components of the magnetic field in order Bx, By, Bz.

Parameters

[in]	out	- output stream where the values will be printed
[in]	B	- field vecrot to be printed

Definition at line 64 of file KFParticleField.h.

View newest version in sPHENIX GitHub at line 64 of file KFParticleField.h

Member Data Documentation

float_v KFParticleFieldValue::x

Bx component of the magnetic field.

Definition at line 42 of file KFParticleField.h.

View newest version in sPHENIX GitHub at line 42 of file KFParticleField.h

Referenced by Combine(), KFParticleFieldRegion::Get(), and KFParticleFieldRegion::Set().

float_v KFParticleFieldValue::y

By component of the magnetic field.

Definition at line 45 of file KFParticleField.h.

View newest version in sPHENIX GitHub at line 45 of file KFParticleField.h

Referenced by Combine(), KFParticleFieldRegion::Get(), and KFParticleFieldRegion::Set().

float_v KFParticleFieldValue::z

Bz component of the magnetic field.

Definition at line 46 of file KFParticleField.h.

View newest version in sPHENIX GitHub at line 46 of file KFParticleField.h

Referenced by Combine(), KFParticleFieldRegion::Get(), and KFParticleFieldRegion::Set().

---

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

• KFParticle/blob/master/KFParticle/KFParticleField.h