lit::parallel::LitFieldSlice< T > Class Template Reference

Approximated magnetic field slice in XY plane perpendicular to Z. More...

#include <LitFieldSlice.h>

Public Member Functions
	LitFieldSlice ()
	Constructor.
void	GetFieldValue (const T &x, const T &y, LitFieldValue< T > &B) const
	Returns field value at a certain (X, Y) position.
void	SetCoefficients (const std::vector< T > &x, const std::vector< T > &y, const std::vector< T > &z)
	Sets polynom coefficients.
const T &	GetZ () const
	Returns Z position of the slice.
void	SetZ (const T &Z)
	Sets Z position of the slice.
std::string	ToString () const
	Returns std::string representation of the class.

Static Public Attributes
static const unsigned int	N = 36

Private Attributes
T	cx [N]
T	cy [N]
T	cz [N]
T	fZ

Friends
std::ostream &	operator<< (std::ostream &strm, const LitFieldSlice &slice)
	Operator << for convenient output to std::ostream.

Detailed Description

template<class T>
class lit::parallel::LitFieldSlice< T >

Approximated magnetic field slice in XY plane perpendicular to Z.

Author

Andrey Lebedev andre.nosp@m.y.le.nosp@m.bedev.nosp@m.@gsi.nosp@m..de

Date

2009

It stores coefficients of the polynomial function for each field component Bx, By and Bz. Order of the polynom is defined by LIT_POLYNOM_DEGREE.

Definition at line 41 of file LitFieldSlice.h.

Constructor & Destructor Documentation

LitFieldSlice()

template<class T >

lit::parallel::LitFieldSlice< T >::LitFieldSlice ( )

inline

Constructor.

Definition at line 63 of file LitFieldSlice.h.

References lit::parallel::LitFieldSlice< T >::cx, lit::parallel::LitFieldSlice< T >::cy, lit::parallel::LitFieldSlice< T >::cz, and lit::parallel::LitFieldSlice< T >::N.

Member Function Documentation

GetFieldValue()

template<class T >

void lit::parallel::LitFieldSlice< T >::GetFieldValue ( const T & x, const T & y, LitFieldValue< T > & B ) const

inline

Returns field value at a certain (X, Y) position.

LIT_POLYNOM_DEGREE defines a polynom order which is used for output field value calculation.

Parameters

[in]	x	X position.
[in]	y	Y position.
[out]	B	Field value.

Definition at line 80 of file LitFieldSlice.h.

References lit::parallel::LitFieldValue< T >::Bx, lit::parallel::LitFieldValue< T >::By, lit::parallel::LitFieldValue< T >::Bz, lit::parallel::LitFieldSlice< T >::cx, lit::parallel::LitFieldSlice< T >::cy, lit::parallel::LitFieldSlice< T >::cz, x, and y.

GetZ()

template<class T >

const T & lit::parallel::LitFieldSlice< T >::GetZ ( ) const

inline

Returns Z position of the slice.

Returns

Z position of the slice.

Definition at line 312 of file LitFieldSlice.h.

References lit::parallel::LitFieldSlice< T >::fZ.

SetCoefficients()

template<class T >

void lit::parallel::LitFieldSlice< T >::SetCoefficients ( const std::vector< T > & x, const std::vector< T > & y, const std::vector< T > & z )

inline

Sets polynom coefficients.

Parameters

[in]	x	Coefficients for Bx.
[in]	y	Coefficients for By
[in]	z	Coefficients for Bz

Definition at line 299 of file LitFieldSlice.h.

References lit::parallel::LitFieldSlice< T >::cx, lit::parallel::LitFieldSlice< T >::cy, lit::parallel::LitFieldSlice< T >::cz, lit::parallel::LitFieldSlice< T >::N, x, and y.

Referenced by CbmLitFieldFitter::FitSlice().

SetZ()

template<class T >

void lit::parallel::LitFieldSlice< T >::SetZ ( const T & Z )

inline

Sets Z position of the slice.

Parameters

[in]

Z

Value of Z coordinate.

Definition at line 318 of file LitFieldSlice.h.

References lit::parallel::LitFieldSlice< T >::fZ.

Referenced by CbmLitFieldFitter::FitSlice().

ToString()

template<class T >

std::string lit::parallel::LitFieldSlice< T >::ToString ( ) const

inline

Returns std::string representation of the class.

Returns

Class representation as std::string.

Definition at line 324 of file LitFieldSlice.h.

References lit::parallel::LitFieldSlice< T >::cx, lit::parallel::LitFieldSlice< T >::cy, lit::parallel::LitFieldSlice< T >::cz, lit::parallel::LitFieldSlice< T >::fZ, lit::parallel::LitFieldSlice< T >::N, and lit::parallel::ToString().

Friends And Related Symbol Documentation

operator<<

template<class T >

std::ostream & operator<< ( std::ostream & strm, const LitFieldSlice< T > & slice )

friend

Operator << for convenient output to std::ostream.

Returns

Insertion stream in order to be able to call a succession of insertion operations.

Definition at line 349 of file LitFieldSlice.h.

Member Data Documentation

cx

template<class T >

T lit::parallel::LitFieldSlice< T >::cx[N]

private

Definition at line 356 of file LitFieldSlice.h.

Referenced by lit::parallel::LitFieldSlice< T >::GetFieldValue(), lit::parallel::LitFieldSlice< T >::LitFieldSlice(), lit::parallel::LitFieldSlice< T >::SetCoefficients(), and lit::parallel::LitFieldSlice< T >::ToString().

cy

template<class T >

T lit::parallel::LitFieldSlice< T >::cy[N]

private

Definition at line 356 of file LitFieldSlice.h.

Referenced by lit::parallel::LitFieldSlice< T >::GetFieldValue(), lit::parallel::LitFieldSlice< T >::LitFieldSlice(), lit::parallel::LitFieldSlice< T >::SetCoefficients(), and lit::parallel::LitFieldSlice< T >::ToString().

cz

template<class T >

T lit::parallel::LitFieldSlice< T >::cz[N]

private

Definition at line 356 of file LitFieldSlice.h.

Referenced by lit::parallel::LitFieldSlice< T >::GetFieldValue(), lit::parallel::LitFieldSlice< T >::LitFieldSlice(), lit::parallel::LitFieldSlice< T >::SetCoefficients(), and lit::parallel::LitFieldSlice< T >::ToString().

fZ

template<class T >

T lit::parallel::LitFieldSlice< T >::fZ

private

Definition at line 357 of file LitFieldSlice.h.

Referenced by lit::parallel::LitFieldSlice< T >::GetZ(), lit::parallel::LitFieldSlice< T >::SetZ(), and lit::parallel::LitFieldSlice< T >::ToString().

N

template<class T >

const unsigned int lit::parallel::LitFieldSlice< T >::N = 36

static

Definition at line 50 of file LitFieldSlice.h.

Referenced by lit::parallel::LitFieldSlice< T >::LitFieldSlice(), lit::parallel::LitFieldSlice< T >::SetCoefficients(), and lit::parallel::LitFieldSlice< T >::ToString().

---

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

• LitFieldSlice.h