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

Class describing a track. More...

#include <dataobjects/Track2D.h>

Public Member Functions

 Track2D ()
 Default constructor. More...
 
 Track2D (Line2D line)
 Constructor. More...
 
 Track2D (const StkClustersColl &clusterColl)
 Constructor. More...
 
 Track2D (const ScdClustersColl &clusterColl)
 Constructor. More...
 
 Track2D (const FitClustersColl &clusterColl)
 Constructor. More...
 
virtual ~Track2D ()=default
 Virtual destructor. 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...
 
unsigned int NClusters () const
 Returns the total number of clusters associated to the track. More...
 
const Herd::Line2DGetLine () const
 Returns the line associated to the track. 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...
 
float ClusterResidual (const Cluster &cluster, const TrackingDetectorGeoParams &geoParams) const
 Returns the residual of the track w.r.t. a given Cluster. More...
 
SidesArray< std::vector< std::vector< float > > > GetStkResiduals (const StkGeoParamsColl &stkGeoParamsColl) const
 Returns the residual of the track w.r.t. all STK Clusters. More...
 
SidesArray< std::vector< std::vector< float > > > GetScdResiduals (const ScdGeoParamsColl &scdGeoParamsColl) const
 Returns the residual of the track w.r.t. all SCD Clusters. More...
 
SidesArray< std::vector< std::vector< float > > > GetFitResiduals (const FitGeoParamsColl &fitGeoParamsColl) const
 Returns the residual of the track w.r.t. all FIT Clusters. More...
 

Private Attributes

Herd::Line2D m_line
 
StkClustersColl m_stkClusterColl
 
ScdClustersColl m_scdClusterColl
 
FitClustersColl m_fitClusterColl
 

Detailed Description

Class describing a track.

A track is broadly defined as a Line2D obtained by fitting a set of Clusters.

Constructor & Destructor Documentation

◆ Track2D() [1/5]

Herd::Track2D::Track2D ( )
inline

Default constructor.

◆ Track2D() [2/5]

Herd::Track2D::Track2D ( Line2D  line)
inline

Constructor.

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

Parameters
lineAlready computed Line2D object.

◆ Track2D() [3/5]

Herd::Track2D::Track2D ( const StkClustersColl clusterColl)
inline

Constructor.

Constructs a track starting from a set of measured STK clusters.

Parameters
clusterCollCollection of measured clusters.

◆ Track2D() [4/5]

Herd::Track2D::Track2D ( const ScdClustersColl clusterColl)
inline

Constructor.

Constructs a track starting from a set of measured SCD clusters.

Parameters
clusterCollCollection of measured clusters.

◆ Track2D() [5/5]

Herd::Track2D::Track2D ( const FitClustersColl clusterColl)
inline

Constructor.

Constructs a track starting from a set of measured FIT clusters.

Parameters
clusterCollCollection of measured clusters.

◆ ~Track2D()

virtual Herd::Track2D::~Track2D ( )
virtualdefault

Virtual destructor.

Member Function Documentation

◆ AddClusters() [1/3]

void Herd::Track2D::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::Track2D::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::Track2D::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.

◆ ClusterResidual()

float Herd::Track2D::ClusterResidual ( const Cluster cluster,
const TrackingDetectorGeoParams geoParams 
) const

Returns the residual of the track w.r.t. a given Cluster.

Returns
The residual w.r.t. the cluster.

◆ GetFitClusters()

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

Returns the FIT clusters associated to the track.

Returns
the vector of clusters.

◆ GetFitResiduals()

SidesArray< std::vector< std::vector< float > > > Herd::Track2D::GetFitResiduals ( const FitGeoParamsColl fitGeoParamsColl) const

Returns the residual of the track w.r.t. all FIT Clusters.

Returns
The residual collection.

◆ GetLine()

const Herd::Line2D& Herd::Track2D::GetLine ( ) const
inline

Returns the line associated to the track.

Returns
The line associated to the track

◆ GetScdClusters()

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

Returns the SCD clusters associated to the track.

Returns
the vector of clusters.

◆ GetScdResiduals()

SidesArray< std::vector< std::vector< float > > > Herd::Track2D::GetScdResiduals ( const ScdGeoParamsColl scdGeoParamsColl) const

Returns the residual of the track w.r.t. all SCD Clusters.

Returns
The residual collection.

◆ GetStkClusters()

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

Returns the STK clusters associated to the track.

Returns
the vector of clusters.

◆ GetStkResiduals()

SidesArray< std::vector< std::vector< float > > > Herd::Track2D::GetStkResiduals ( const StkGeoParamsColl stkGeoParamsColl) const

Returns the residual of the track w.r.t. all STK Clusters.

Returns
The residual collection.

◆ NClusters()

unsigned int Herd::Track2D::NClusters ( ) const

Returns the total number of clusters associated to the track.

Returns
The the total number of clusters associated to the track

Member Data Documentation

◆ m_fitClusterColl

FitClustersColl Herd::Track2D::m_fitClusterColl
private

◆ m_line

Herd::Line2D Herd::Track2D::m_line
private

◆ m_scdClusterColl

ScdClustersColl Herd::Track2D::m_scdClusterColl
private

◆ m_stkClusterColl

StkClustersColl Herd::Track2D::m_stkClusterColl
private

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