CbmRoot
Public Member Functions | Private Attributes | Friends | List of all members
lit::parallel::LitStationGroupMuon< T > Class Template Reference

#include <LitStationGroupMuon.h>

Collaboration diagram for lit::parallel::LitStationGroupMuon< T >:
[legend]

Public Member Functions

 LitStationGroupMuon ()
 Constructor. More...
 
virtual ~LitStationGroupMuon ()
 Destructor. More...
 
const LitFieldGrid & GetFieldGridFront () const
 Return magnetic field grid in front of the absorber. More...
 
void SetFieldGridFront (const LitFieldGrid &fieldGrid)
 Set field grid in front of the absorber. More...
 
const LitFieldGrid & GetFieldGridMiddle () const
 Return magnetic field grid in the middle of the absorber. More...
 
void SetFieldGridMiddle (const LitFieldGrid &fieldGrid)
 Set field grid in the middle of the absorber. More...
 
const LitFieldGrid & GetFieldGridBack () const
 Return magnetic field grid in the back of the absorber. More...
 
void SetFieldGridBack (const LitFieldGrid &fieldGrid)
 Set magnetic field grid in the back of the absorber. More...
 
void AddStation (const LitStationMuon< T > &station)
 Add station to the station group. More...
 
const LitStationMuon< T > & GetStation (unsigned short index) const
 Return station by index. More...
 
unsigned char GetNofStations () const
 Return number of stations in this station group. More...
 
const LitAbsorber< T > & GetAbsorber () const
 Return absorber. More...
 
void SetAbsorber (const LitAbsorber< T > &absorber)
 Set absorber. More...
 
void GetFieldRegion (T x, T y, LitFieldRegion< T > &field) const
 Calculate field region for the group of stations. More...
 
std::string ToString () const
 Return std::string representation for the class. More...
 

Private Attributes

LitFieldGrid fFieldGridFront
 
LitFieldGrid fFieldGridMiddle
 
LitFieldGrid fFieldGridBack
 
std::vector< LitStationMuon< T > > fStations
 
LitAbsorber< T > fAbsorber
 

Friends

std::ostream & operator<< (std::ostream &strm, const LitStationGroupMuon &stationGroup)
 Operator << for convenient output to std::ostream. More...
 

Detailed Description

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

Definition at line 26 of file LitStationGroupMuon.h.

Constructor & Destructor Documentation

◆ LitStationGroupMuon()

template<class T >
lit::parallel::LitStationGroupMuon< T >::LitStationGroupMuon ( )
inline

Constructor.

Definition at line 31 of file LitStationGroupMuon.h.

◆ ~LitStationGroupMuon()

template<class T >
virtual lit::parallel::LitStationGroupMuon< T >::~LitStationGroupMuon ( )
inlinevirtual

Destructor.

Definition at line 41 of file LitStationGroupMuon.h.

Member Function Documentation

◆ AddStation()

template<class T >
void lit::parallel::LitStationGroupMuon< T >::AddStation ( const LitStationMuon< T > &  station)
inline

Add station to the station group.

Parameters
[in]stationStation to be added.

Definition at line 91 of file LitStationGroupMuon.h.

References lit::parallel::LitStationGroupMuon< T >::fStations.

◆ GetAbsorber()

template<class T >
const LitAbsorber<T>& lit::parallel::LitStationGroupMuon< T >::GetAbsorber ( ) const
inline

Return absorber.

Returns
Absorber.

Definition at line 114 of file LitStationGroupMuon.h.

References lit::parallel::LitStationGroupMuon< T >::fAbsorber.

Referenced by lit::parallel::LitTrackFinderNNVecMuon::FollowTracks(), and lit::parallel::LitStationGroupMuon< T >::ToString().

◆ GetFieldGridBack()

template<class T >
const LitFieldGrid& lit::parallel::LitStationGroupMuon< T >::GetFieldGridBack ( ) const
inline

Return magnetic field grid in the back of the absorber.

Returns
Magnetic field grid in the back of the absorber.

Definition at line 77 of file LitStationGroupMuon.h.

References lit::parallel::LitStationGroupMuon< T >::fFieldGridBack.

◆ GetFieldGridFront()

template<class T >
const LitFieldGrid& lit::parallel::LitStationGroupMuon< T >::GetFieldGridFront ( ) const
inline

Return magnetic field grid in front of the absorber.

Returns
Magnetic field grid in front of the absorber.

Definition at line 47 of file LitStationGroupMuon.h.

References lit::parallel::LitStationGroupMuon< T >::fFieldGridFront.

◆ GetFieldGridMiddle()

template<class T >
const LitFieldGrid& lit::parallel::LitStationGroupMuon< T >::GetFieldGridMiddle ( ) const
inline

Return magnetic field grid in the middle of the absorber.

Returns
Magnetic field grid in the middle of the absorber.

Definition at line 61 of file LitStationGroupMuon.h.

References lit::parallel::LitStationGroupMuon< T >::fFieldGridMiddle.

◆ GetFieldRegion()

template<class T >
void lit::parallel::LitStationGroupMuon< T >::GetFieldRegion ( T  x,
T  y,
LitFieldRegion< T > &  field 
) const
inline

Calculate field region for the group of stations.

Parameters
[in]xX position.
[in]yY position.
[out]fieldOutput field region.

Definition at line 128 of file LitStationGroupMuon.h.

References lit::parallel::LitStationGroupMuon< T >::fFieldGridBack, lit::parallel::LitStationGroupMuon< T >::fFieldGridFront, lit::parallel::LitStationGroupMuon< T >::fFieldGridMiddle, lit::parallel::LitFieldGrid::GetFieldValue(), lit::parallel::LitFieldGrid::GetZ(), lit::parallel::LitFieldRegion< T >::Set(), x, and y.

Referenced by lit::parallel::LitTrackFinderNNVecMuon::ProcessStation().

◆ GetNofStations()

template<class T >
unsigned char lit::parallel::LitStationGroupMuon< T >::GetNofStations ( ) const
inline

Return number of stations in this station group.

Returns
Number of stations in this station group.

Definition at line 108 of file LitStationGroupMuon.h.

References lit::parallel::LitStationGroupMuon< T >::fStations.

Referenced by lit::parallel::LitTrackFinderNNVecMuon::FollowTracks(), lit::parallel::LitTrackFitterMuon(), and lit::parallel::LitStationGroupMuon< T >::ToString().

◆ GetStation()

template<class T >
const LitStationMuon<T>& lit::parallel::LitStationGroupMuon< T >::GetStation ( unsigned short  index) const
inline

Return station by index.

Parameters
[in]indexIndex of the station.
Returns
Station by index.

Definition at line 100 of file LitStationGroupMuon.h.

References lit::parallel::LitStationGroupMuon< T >::fStations.

Referenced by lit::parallel::LitTrackFinderNNVecMuon::ProcessStation(), and lit::parallel::LitStationGroupMuon< T >::ToString().

◆ SetAbsorber()

template<class T >
void lit::parallel::LitStationGroupMuon< T >::SetAbsorber ( const LitAbsorber< T > &  absorber)
inline

Set absorber.

Parameters
[in]absorberAbsorber value.

Definition at line 120 of file LitStationGroupMuon.h.

References lit::parallel::LitStationGroupMuon< T >::fAbsorber.

◆ SetFieldGridBack()

template<class T >
void lit::parallel::LitStationGroupMuon< T >::SetFieldGridBack ( const LitFieldGrid &  fieldGrid)
inline

Set magnetic field grid in the back of the absorber.

Parameters
[in]fieldGridField grid value.

Definition at line 83 of file LitStationGroupMuon.h.

References lit::parallel::LitStationGroupMuon< T >::fFieldGridBack.

◆ SetFieldGridFront()

template<class T >
void lit::parallel::LitStationGroupMuon< T >::SetFieldGridFront ( const LitFieldGrid &  fieldGrid)
inline

Set field grid in front of the absorber.

Parameters
[in]fieldGridField grid value.

Definition at line 53 of file LitStationGroupMuon.h.

References lit::parallel::LitStationGroupMuon< T >::fFieldGridFront.

◆ SetFieldGridMiddle()

template<class T >
void lit::parallel::LitStationGroupMuon< T >::SetFieldGridMiddle ( const LitFieldGrid &  fieldGrid)
inline

Set field grid in the middle of the absorber.

Parameters
[in]fieldGridField grid value.

Definition at line 69 of file LitStationGroupMuon.h.

References lit::parallel::LitStationGroupMuon< T >::fFieldGridMiddle.

◆ ToString()

template<class T >
std::string lit::parallel::LitStationGroupMuon< T >::ToString ( ) const
inline

Return std::string representation for the class.

Returns
std::string representation for the class.

Definition at line 145 of file LitStationGroupMuon.h.

References lit::parallel::LitStationGroupMuon< T >::GetAbsorber(), lit::parallel::LitStationGroupMuon< T >::GetNofStations(), lit::parallel::LitStationGroupMuon< T >::GetStation(), and i.

Friends And Related Function Documentation

◆ operator<<

template<class T >
std::ostream& operator<< ( std::ostream &  strm,
const LitStationGroupMuon< T > &  stationGroup 
)
friend

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

Returns
std::ostream for continuous output.

Definition at line 161 of file LitStationGroupMuon.h.

Member Data Documentation

◆ fAbsorber

template<class T >
LitAbsorber<T> lit::parallel::LitStationGroupMuon< T >::fAbsorber
private

Definition at line 178 of file LitStationGroupMuon.h.

Referenced by lit::parallel::LitStationGroupMuon< T >::GetAbsorber(), and lit::parallel::LitStationGroupMuon< T >::SetAbsorber().

◆ fFieldGridBack

template<class T >
LitFieldGrid lit::parallel::LitStationGroupMuon< T >::fFieldGridBack
private

Definition at line 175 of file LitStationGroupMuon.h.

Referenced by lit::parallel::LitStationGroupMuon< T >::GetFieldGridBack(), lit::parallel::LitStationGroupMuon< T >::GetFieldRegion(), and lit::parallel::LitStationGroupMuon< T >::SetFieldGridBack().

◆ fFieldGridFront

template<class T >
LitFieldGrid lit::parallel::LitStationGroupMuon< T >::fFieldGridFront
private

Definition at line 172 of file LitStationGroupMuon.h.

Referenced by lit::parallel::LitStationGroupMuon< T >::GetFieldGridFront(), lit::parallel::LitStationGroupMuon< T >::GetFieldRegion(), and lit::parallel::LitStationGroupMuon< T >::SetFieldGridFront().

◆ fFieldGridMiddle

template<class T >
LitFieldGrid lit::parallel::LitStationGroupMuon< T >::fFieldGridMiddle
private

Definition at line 174 of file LitStationGroupMuon.h.

Referenced by lit::parallel::LitStationGroupMuon< T >::GetFieldGridMiddle(), lit::parallel::LitStationGroupMuon< T >::GetFieldRegion(), and lit::parallel::LitStationGroupMuon< T >::SetFieldGridMiddle().

◆ fStations

template<class T >
std::vector<LitStationMuon<T> > lit::parallel::LitStationGroupMuon< T >::fStations
private

Definition at line 177 of file LitStationGroupMuon.h.

Referenced by lit::parallel::LitStationGroupMuon< T >::AddStation(), lit::parallel::LitStationGroupMuon< T >::GetNofStations(), and lit::parallel::LitStationGroupMuon< T >::GetStation().

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