HerdSoftware  0.1.1
Public Member Functions | Private Attributes | List of all members
Herd::Track Class Reference

Class describing a track. More...

#include <dataobjects/Track.h>

Public Member Functions

 Track ()
 Default constructor. More...
 
 Track (Line line)
 Constructor. More...
 
 Track (const CaloAxis &caloAxis)
 Constructor. More...
 
 Track (const Track2D &proj1, RefFrame::View view1, const Track2D &proj2, RefFrame::View view2)
 Constructor. More...
 
virtual ~Track ()=default
 Virtual destructor. More...
 
const Herd::LineGetLine () const
 Returns the line associated to the track. More...
 
void AddClusters (const StkClustersColl &clusterColl)
 Add STK clusters to the current collection. More...
 
void AddClusters (const ScdClustersColl &clusterColl)
 Add SCD clusters to the current collection. More...
 
void AddClusters (const FitClustersColl &clusterColl)
 Add FIT clusters to the current collection. More...
 
void AddCaloAxis (const CaloAxis &caloAxis)
 Add calo hits to the current collection. More...
 
const StkClustersCollGetStkClusters () const
 Returns the STK clusters associated to the track. More...
 
const ScdClustersCollGetScdClusters () const
 Returns the SCD clusters associated to the track. More...
 
const FitClustersCollGetFitClusters () const
 Returns the FIT clusters associated to the track. More...
 
const CaloAxisGetCaloAxis () const
 Returns the calorimeter axis associated to the track. More...
 

Private Attributes

CaloAxis m_caloAxis
 
StkClustersColl m_stkClusterColl
 
ScdClustersColl m_scdClusterColl
 
FitClustersColl m_fitClusterColl
 
Herd::Line m_line
 

Detailed Description

Class describing a track.

A track is broadly defined as a #Line obtained by fitting a set of Points. Fitting should be done externally by some dedicated code, then the obtained Line can be used to create the Track object

Constructor & Destructor Documentation

◆ Track() [1/4]

Herd::Track::Track ( )
inline

Default constructor.

◆ Track() [2/4]

Herd::Track::Track ( Line  line)
inline

Constructor.

Constructs a track starting from a already pre-computed line.

Parameters
lineAlready computed Line object.

◆ Track() [3/4]

Herd::Track::Track ( const CaloAxis caloAxis)
inline

Constructor.

Constructs a track starting from a calorimeter axis.

Parameters
caloAxisCollection of measured clusters.

◆ Track() [4/4]

Herd::Track::Track ( const Track2D proj1,
RefFrame::View  view1,
const Track2D proj2,
RefFrame::View  view2 
)

Constructor.

Constructs a 3D track starting from two 2D projections.

Parameters
proj1The first projection.
view1The view of the first projection.
proj2The second projection.
view1The view of the second projection.
Exceptions
Exceptionif the 2D lines in the given projections are not valid.
See also
Line::Line(const Line2D &, RefFrame::View, const Line2D &, RefFrame::View).

◆ ~Track()

virtual Herd::Track::~Track ( )
virtualdefault

Virtual destructor.

Member Function Documentation

◆ AddCaloAxis()

void Herd::Track::AddCaloAxis ( const CaloAxis caloAxis)
inline

Add calo hits to the current collection.

Append new clusters to the current calo hits collection.

Parameters
clusterCollCollection of measured clusters.

◆ AddClusters() [1/3]

void Herd::Track::AddClusters ( const StkClustersColl clusterColl)

Add STK clusters to the current collection.

Append new clusters to the current STK clusters collection.

Parameters
clusterCollCollection of measured clusters.

◆ AddClusters() [2/3]

void Herd::Track::AddClusters ( const ScdClustersColl clusterColl)

Add SCD clusters to the current collection.

Append new clusters to the current SCD clusters collection.

Parameters
clusterCollCollection of measured clusters.

◆ AddClusters() [3/3]

void Herd::Track::AddClusters ( const FitClustersColl clusterColl)

Add FIT clusters to the current collection.

Append new clusters to the current FIT clusters collection.

Parameters
clusterCollCollection of measured clusters.

◆ GetCaloAxis()

const CaloAxis& Herd::Track::GetCaloAxis ( ) const
inline

Returns the calorimeter axis associated to the track.

Returns
the calorimeter axis.

◆ GetFitClusters()

const FitClustersColl& Herd::Track::GetFitClusters ( ) const
inline

Returns the FIT clusters associated to the track.

Returns
the vector of clusters.

◆ GetLine()

const Herd::Line& Herd::Track::GetLine ( ) const
inline

Returns the line associated to the track.

Returns
The line associated to the track

◆ GetScdClusters()

const ScdClustersColl& Herd::Track::GetScdClusters ( ) const
inline

Returns the SCD clusters associated to the track.

Returns
the vector of clusters.

◆ GetStkClusters()

const StkClustersColl& Herd::Track::GetStkClusters ( ) const
inline

Returns the STK clusters associated to the track.

Returns
the vector of clusters.

Member Data Documentation

◆ m_caloAxis

CaloAxis Herd::Track::m_caloAxis
private

◆ m_fitClusterColl

FitClustersColl Herd::Track::m_fitClusterColl
private

◆ m_line

Herd::Line Herd::Track::m_line
private

◆ m_scdClusterColl

ScdClustersColl Herd::Track::m_scdClusterColl
private

◆ m_stkClusterColl

StkClustersColl Herd::Track::m_stkClusterColl
private

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