Trk::GXFTrackState Class Reference

#include <GXFTrackState.h>

Collaboration diagram for Trk::GXFTrackState:

Public Member Functions
	GXFTrackState ()=delete
	GXFTrackState (const GXFTrackState &)
	GXFTrackState (GXFTrackState &&)=default
GXFTrackState &	operator= (const GXFTrackState &)=delete
GXFTrackState &	operator= (GXFTrackState &&)=default
	~GXFTrackState ()=default
	GXFTrackState (std::unique_ptr< const MeasurementBase >, std::unique_ptr< const TrackParameters >)
	GXFTrackState (std::unique_ptr< const TrackParameters >, TrackStateOnSurface::TrackStateOnSurfaceType)
	GXFTrackState (std::unique_ptr< GXFMaterialEffects >, std::unique_ptr< const TrackParameters >)
GXFTrackState &	operator= (GXFTrackState &)=delete
bool	isSane () const
void	setMeasurement (std::unique_ptr< const MeasurementBase >)
const MeasurementBase *	measurement (void)
void	setTrackParameters (std::unique_ptr< const TrackParameters >)
const TrackParameters *	trackParameters (void) const
GXFMaterialEffects *	materialEffects ()
const Surface &	associatedSurface () const
void	setJacobian (TransportJacobian &)
Eigen::Matrix< double, 5, 5 > &	jacobian ()
Amg::MatrixX &	derivatives ()
void	setDerivatives (Amg::MatrixX &)
void	setTrackCovariance (AmgSymMatrix(5) *)
void	resetTrackCovariance ()
	reset covariance to nullptr
	AmgSymMatrix (5) &trackCovariance(void)
bool	hasTrackCovariance (void) const
void	zeroTrackCovariance (void)
void	setFitQuality (FitQualityOnSurface)
const FitQualityOnSurface	fitQuality (void)
TrackState::MeasurementType	measurementType ()
void	setMeasurementType (TrackState::MeasurementType)
double	sinStereo () const
void	setSinStereo (double)
double *	measurementErrors ()
void	setMeasurementErrors (const double *)
int	numberOfMeasuredParameters ()
bool	isRecalibrated ()
void	setRecalibrated (bool)
Amg::Vector3D	position ()
void	setPosition (Amg::Vector3D &)
bool	measuresPhi () const
void	setMeasuresPhi (bool)
void	resetStateType (TrackStateOnSurface::TrackStateOnSurfaceType type, bool value=true)
	Set a specific type, wiping all others.
void	setStateType (TrackStateOnSurface::TrackStateOnSurfaceType type, bool value=true)
	Set a specific type bit.
bool	getStateType (TrackStateOnSurface::TrackStateOnSurfaceType type) const
	Retrieve the value of a specific type bit.
std::optional< std::vector< std::unique_ptr< TrackParameters > > > &	getHoles (void)
void	setHoles (std::vector< std::unique_ptr< TrackParameters > > &&)
std::unique_ptr< const TrackStateOnSurface >	trackStateOnSurface () const

Private Member Functions
	AmgSymMatrix (5) m_covariancematrix
	Covariance matrix of track parameters at this surface.

Private Attributes
std::unique_ptr< const MeasurementBase >	m_measurement
	The measurement defining the track state.
std::bitset< TrackStateOnSurface::NumberOfTrackStateOnSurfaceTypes >	m_tsType
	type of track state, eg Fittable, Outlier, Scatterer, Brem, Hole
std::unique_ptr< const TrackParameters >	m_trackpar
	track parameters
std::unique_ptr< GXFMaterialEffects >	m_materialEffects
	Material effects on track (ie scatterer, brem)
Eigen::Matrix< double, 5, 5 >	m_jacobian
	Transport jacobian wrt previous state.
Amg::MatrixX	m_derivs
	Derivatives of local parameters wrt fit parameters.
bool	m_covariance_set
FitQualityOnSurface	m_fitqual
double	m_measerror [5] {}
	Measurement errors (corrected for stereo angle)
double	m_sinstereo
	stereo angle
TrackState::MeasurementType	m_mType
	Measurement type, eg pixel, SCT, ...
bool	m_recalib
	Has this measurement already been recalibrated?
bool	m_measphi
Amg::Vector3D	m_globpos
std::optional< std::vector< std::unique_ptr< TrackParameters > > >	m_holes

Detailed Description

Definition at line 30 of file GXFTrackState.h.

Constructor & Destructor Documentation

GXFTrackState() [1/6]

Trk::GXFTrackState::GXFTrackState ( )

delete

GXFTrackState() [2/6]

Trk::GXFTrackState::GXFTrackState

(

const GXFTrackState &

rhs

)

Definition at line 22 of file GXFTrackState.cxx.

                                                       :
    m_measurement(rhs.m_measurement != nullptr ? std::unique_ptr<const MeasurementBase>(rhs.m_measurement->clone()) : nullptr), 
    m_tsType(rhs.m_tsType), 
    m_trackpar(std::unique_ptr<const TrackParameters>(rhs.m_trackpar != nullptr ? rhs.m_trackpar->clone() : nullptr)),
    m_materialEffects(rhs.m_materialEffects != nullptr ? std::make_unique<GXFMaterialEffects>(*rhs. m_materialEffects) : nullptr),
    m_derivs(rhs.m_derivs),
    m_covariancematrix(rhs.m_covariancematrix),
    m_covariance_set(rhs.m_covariance_set),
    m_fitqual(rhs.m_fitqual), 
    m_sinstereo(rhs.m_sinstereo),
    m_mType(rhs.m_mType), 
    m_recalib(rhs.m_recalib),
    m_measphi(rhs.m_measphi) 
  {
    for (int i = 0; i < 5; i++) {
      m_measerror[i] = rhs.m_measerror[i];
      for (int j = 0; j < 5; j++) {
        m_jacobian(i, j) = rhs.m_jacobian(i, j);
      }
    }
  }

GXFTrackState() [3/6]

Trk::GXFTrackState::GXFTrackState ( GXFTrackState && )

default

~GXFTrackState()

Trk::GXFTrackState::~GXFTrackState ( )

default

GXFTrackState() [4/6]

Trk::GXFTrackState::GXFTrackState	(	std::unique_ptr< const MeasurementBase >	measurement,
		std::unique_ptr< const TrackParameters >	trackpar )

Definition at line 44 of file GXFTrackState.cxx.

   :
    m_measurement(std::move(measurement)),
    m_trackpar(std::move(trackpar)),
    m_materialEffects(nullptr), 
    m_jacobian {}, 
    m_derivs(), 
    m_covariancematrix(),
    m_covariance_set(false),
    m_fitqual(),
    m_sinstereo(0), 
    m_mType(TrackState::unidentified), 
    m_recalib(false),
    m_measphi(false) {
    setStateType(TrackStateOnSurface::Measurement);
    m_measerror[0] = m_measerror[1] = m_measerror[2] = m_measerror[3] = m_measerror[4] = -1;
  }

GXFTrackState() [5/6]

Trk::GXFTrackState::GXFTrackState	(	std::unique_ptr< const TrackParameters >	trackpar,
		TrackStateOnSurface::TrackStateOnSurfaceType	tsType )

Definition at line 64 of file GXFTrackState.cxx.

   :
    m_measurement(nullptr),
    m_trackpar(std::move(trackpar)),
    m_materialEffects(nullptr), 
    m_jacobian {}, 
    m_derivs(), 
    m_covariancematrix(), 
    m_covariance_set(false),
    m_fitqual(),
    m_sinstereo(0), 
    m_mType(TrackState::unidentified), 
    m_recalib(false),
    m_measphi(false) 
  {
    setStateType(tsType);
    m_measerror[0] = m_measerror[1] = m_measerror[2] = m_measerror[3] = m_measerror[4] = -1;
  }

GXFTrackState() [6/6]

Trk::GXFTrackState::GXFTrackState	(	std::unique_ptr< GXFMaterialEffects >	mef,
		std::unique_ptr< const TrackParameters >	trackpar )

Definition at line 85 of file GXFTrackState.cxx.

   :
    m_measurement(nullptr),
    m_trackpar(std::move(trackpar)),
    m_materialEffects(std::move(mef)), 
    m_jacobian {}, 
    m_derivs(), 
    m_covariancematrix(),
    m_covariance_set(false), 
    m_fitqual(),
    m_sinstereo(0), 
    m_mType(TrackState::unidentified), 
    m_recalib(false),
    m_measphi(false) 
  {
    m_measerror[0] = m_measerror[1] = m_measerror[2] = m_measerror[3] = m_measerror[4] = -1;
 
    if (m_materialEffects->sigmaDeltaTheta() == 0) {
      setStateType(TrackStateOnSurface::BremPoint);
    } else {
      setStateType(TrackStateOnSurface::Scatterer);
    }
  }

Member Function Documentation

AmgSymMatrix() [1/2]

Trk::GXFTrackState::AmgSymMatrix

(

5

)

&

AmgSymMatrix() [2/2]

Trk::GXFTrackState::AmgSymMatrix ( 5 )

private

Covariance matrix of track parameters at this surface.

associatedSurface()

const Surface & Trk::GXFTrackState::associatedSurface

(

)

const

Definition at line 183 of file GXFTrackState.cxx.

                                         {
    if (m_measurement != nullptr) {
      return m_measurement->associatedSurface();
    } if (m_trackpar != nullptr) {
      return m_trackpar->associatedSurface();
    } if (m_materialEffects != nullptr) {
      return m_materialEffects->associatedSurface();
    } else {
     throw std::runtime_error("GXFTrackState::associatedSurface: None of measurement, track parameters or material effects are non-null pointers");
    }
    
  }

derivatives()

Amg::MatrixX & Trk::GXFTrackState::derivatives ( )

inline

Definition at line 152 of file GXFTrackState.h.

                                                 {
    return m_derivs;
  }

fitQuality()

const FitQualityOnSurface Trk::GXFTrackState::fitQuality

(

void

)

Definition at line 210 of file GXFTrackState.cxx.

                                                          {
    return m_fitqual;
  }

getHoles()

std::optional< std::vector< std::unique_ptr< TrackParameters > > > & Trk::GXFTrackState::getHoles

(

void

)

Definition at line 286 of file GXFTrackState.cxx.

                                                                                       {
    return m_holes;
  }

getStateType()

bool Trk::GXFTrackState::getStateType

(

TrackStateOnSurface::TrackStateOnSurfaceType

type

)

const

Retrieve the value of a specific type bit.

Parameters

[in]

type

The track state type bit to set.

Returns

A boolean value indicating whether or not the type bit is set.

Definition at line 282 of file GXFTrackState.cxx.

                                                                                     {
    return m_tsType.test(t);
  }

hasTrackCovariance()

bool Trk::GXFTrackState::hasTrackCovariance

(

void

)

const

Definition at line 259 of file GXFTrackState.cxx.

                                                   {
    return m_covariance_set;
  }

isRecalibrated()

bool Trk::GXFTrackState::isRecalibrated ( )

inline

Definition at line 176 of file GXFTrackState.h.

                                            {
    return m_recalib;
  }

isSane()

bool Trk::GXFTrackState::isSane

(

)

const

Definition at line 112 of file GXFTrackState.cxx.

                             {
    const GXFMaterialEffects* eff = m_materialEffects.get();
    if (not consistentSurfaces(m_measurement.get(),m_trackpar.get(), eff) ){
      std::cerr << "GXFTrackState::isSane. With :" << '\n';
      std::cerr << "Types : " << m_tsType.to_string() << '\n';
      std::cerr << "Surfaces differ! " << std::endl;
      if (m_trackpar) {
        std::cerr << "ParamSurf: [" << &(m_trackpar->associatedSurface())
                  << "] " << m_trackpar->associatedSurface() << std::endl;
      }
      if (m_measurement) {
        std::cerr << "measSurf: [" << &(m_measurement->associatedSurface())
                  << "] " << m_measurement->associatedSurface()
                  << std::endl;
      }
      if (m_materialEffects) {
        std::cerr << "matSurf: ["
                  << &(m_materialEffects->associatedSurface()) << "] "
                  << m_materialEffects->associatedSurface() << std::endl;
      }
      return false;
    }
  return true;
  }

jacobian()

Eigen::Matrix< double, 5, 5 > & Trk::GXFTrackState::jacobian ( )

inline

Definition at line 148 of file GXFTrackState.h.

                                                             {
    return m_jacobian;
  } 

materialEffects()

GXFMaterialEffects * Trk::GXFTrackState::materialEffects ( )

inline

Definition at line 164 of file GXFTrackState.h.

                                                            {
    return m_materialEffects.get();
  }

measurement()

const MeasurementBase * Trk::GXFTrackState::measurement

(

void

)

Definition at line 142 of file GXFTrackState.cxx.

                                                        {
    return m_measurement.get();
  }  

measurementErrors()

double * Trk::GXFTrackState::measurementErrors

(

)

Definition at line 159 of file GXFTrackState.cxx.

                                           {
    return m_measerror;
  }

measurementType()

TrackState::MeasurementType Trk::GXFTrackState::measurementType ( )

inline

Definition at line 168 of file GXFTrackState.h.

                                                                  {
    return m_mType;
  }

measuresPhi()

bool Trk::GXFTrackState::measuresPhi

(

)

const

Definition at line 245 of file GXFTrackState.cxx.

                                     {
    return m_measphi;
  }

numberOfMeasuredParameters()

int Trk::GXFTrackState::numberOfMeasuredParameters

(

)

Definition at line 215 of file GXFTrackState.cxx.

                                              {
    int nmeas = 0;
 
    if (getStateType(TrackStateOnSurface::Measurement) || getStateType(TrackStateOnSurface::Outlier)) {
      for (double i : m_measerror) {
        if (i > 0) {
          nmeas++;
        }
      }
    }
 
    return nmeas;
  }

operator=() [1/3]

GXFTrackState & Trk::GXFTrackState::operator= ( const GXFTrackState & )

delete

operator=() [2/3]

GXFTrackState & Trk::GXFTrackState::operator= ( GXFTrackState && )

default

operator=() [3/3]

GXFTrackState & Trk::GXFTrackState::operator= ( GXFTrackState & )

delete

position()

Amg::Vector3D Trk::GXFTrackState::position

(

)

Definition at line 229 of file GXFTrackState.cxx.

                                      {
    if (m_trackpar != nullptr) {
      return m_trackpar->position();
    } if (m_measurement != nullptr) {
      return m_measurement->globalPosition();
    }
    // return surface()->center();  // Better than nothing...
    return m_globpos;
  }

resetStateType()

void Trk::GXFTrackState::resetStateType	(	TrackStateOnSurface::TrackStateOnSurfaceType	type,
		bool	value = true )

Set a specific type, wiping all others.

When called, this method will set the bit for a specific type to true or false. It will also set all other type bits to false.

Parameters

[in]	type	The track state type bit to set.
[in]	value	The boolean value for the given bit (default true).

Definition at line 273 of file GXFTrackState.cxx.

                                                                                         {
    m_tsType.reset();
    setStateType(t, v);
  }

resetTrackCovariance()

void Trk::GXFTrackState::resetTrackCovariance

(

)

reset covariance to nullptr

Definition at line 267 of file GXFTrackState.cxx.

                                          {
    if (m_covariance_set) {
      setTrackCovariance(nullptr);
    }
  }

setDerivatives()

void Trk::GXFTrackState::setDerivatives

(

Amg::MatrixX &

deriv

)

Definition at line 155 of file GXFTrackState.cxx.

                                                    {
    m_derivs = deriv;
  }

setFitQuality()

void Trk::GXFTrackState::setFitQuality

(

FitQualityOnSurface

fitqual

)

Definition at line 206 of file GXFTrackState.cxx.

                                                               {
    m_fitqual = fitqual;
  }

setHoles()

void Trk::GXFTrackState::setHoles

(

std::vector< std::unique_ptr< TrackParameters > > &&

v

)

Definition at line 290 of file GXFTrackState.cxx.

                                                                             {
    m_holes = std::move(v);
  }

setJacobian()

void Trk::GXFTrackState::setJacobian

(

TransportJacobian &

jac

)

Definition at line 150 of file GXFTrackState.cxx.

                                                         {
    m_jacobian = jac;
  }

setMeasurement()

void Trk::GXFTrackState::setMeasurement

(

std::unique_ptr< const MeasurementBase >

meas

)

Definition at line 137 of file GXFTrackState.cxx.

                                                                              {
    m_measurement = std::move(meas);
    m_recalib = true;
  }

setMeasurementErrors()

void Trk::GXFTrackState::setMeasurementErrors

(

const double *

measerror

)

Definition at line 164 of file GXFTrackState.cxx.

                                                               {
    m_measerror[0] = measerror[0];
    m_measerror[1] = measerror[1];
    m_measerror[2] = measerror[2];
    m_measerror[3] = measerror[3];
    m_measerror[4] = measerror[4];
  }

setMeasurementType()

void Trk::GXFTrackState::setMeasurementType ( TrackState::MeasurementType mt )

inline

Definition at line 172 of file GXFTrackState.h.

                                                                            {
    m_mType = mt;
  }

setMeasuresPhi()

void Trk::GXFTrackState::setMeasuresPhi

(

bool

measphi

)

Definition at line 250 of file GXFTrackState.cxx.

                                              {
    m_measphi = measphi;
  }

setPosition()

void Trk::GXFTrackState::setPosition

(

Amg::Vector3D &

pos

)

Definition at line 240 of file GXFTrackState.cxx.

                                                {
    m_globpos = pos;
  }

setRecalibrated()

void Trk::GXFTrackState::setRecalibrated

(

bool

isrecal

)

Definition at line 255 of file GXFTrackState.cxx.

                                               {
    m_recalib = isrecal;
  }

setSinStereo()

void Trk::GXFTrackState::setSinStereo

(

double

sinstereo

)

Definition at line 178 of file GXFTrackState.cxx.

                                                {
    m_sinstereo = sinstereo;
  }

setStateType()

void Trk::GXFTrackState::setStateType	(	TrackStateOnSurface::TrackStateOnSurfaceType	type,
		bool	value = true )

Set a specific type bit.

This method sets a specific bit in the type bitfield to the specified value, and does not touch any of the other bits.

Parameters

[in]	type	The track state type bit to set.
[in]	value	The boolean value for the given bit (default true).

Definition at line 278 of file GXFTrackState.cxx.

                                                                                       {
    m_tsType[t] = v;
  }

setTrackCovariance()

void Trk::GXFTrackState::setTrackCovariance

(

AmgSymMatrix(5) *

covmat

)

Definition at line 197 of file GXFTrackState.cxx.

                                                              {
    if (covmat == nullptr) {
      m_covariance_set = false;
    } else {
      m_covariance_set = true;
      m_covariancematrix = *covmat;
    }
  }

setTrackParameters()

void Trk::GXFTrackState::setTrackParameters

(

std::unique_ptr< const TrackParameters >

par

)

Definition at line 146 of file GXFTrackState.cxx.

                                                                                 {
    m_trackpar = std::move(par);
  }

sinStereo()

double Trk::GXFTrackState::sinStereo

(

)

const

Definition at line 173 of file GXFTrackState.cxx.

                                   {
    return m_sinstereo;
  }

trackParameters()

const TrackParameters * Trk::GXFTrackState::trackParameters ( void ) const

inline

Definition at line 160 of file GXFTrackState.h.

                                                                         {
    return m_trackpar.get();
  }

trackStateOnSurface()

std::unique_ptr< const TrackStateOnSurface > Trk::GXFTrackState::trackStateOnSurface

(

)

const

Definition at line 295 of file GXFTrackState.cxx.

                                          {
    std::unique_ptr<TrackParameters> trackpar = unique_clone(m_trackpar.get());
    std::unique_ptr<MeasurementBase> measurement = unique_clone(m_measurement.get());
 
    FitQualityOnSurface fitQual =m_fitqual;
 
    std::unique_ptr<MaterialEffectsBase> mateff = nullptr;
    std::bitset<TrackStateOnSurface::NumberOfTrackStateOnSurfaceTypes> typePattern;
    if ((m_materialEffects != nullptr) && (m_tsType.test(TrackStateOnSurface::Scatterer) or m_tsType.test(TrackStateOnSurface::BremPoint))) {
      if (m_tsType.test(TrackStateOnSurface::Scatterer)) {
        typePattern.set(TrackStateOnSurface::Scatterer);
      }
      
      if (m_materialEffects->sigmaDeltaE() > 0) {
        if (m_materialEffects->sigmaDeltaTheta() == 0) {
          typePattern.set(TrackStateOnSurface::CaloDeposit);
        } else {
          typePattern.set(TrackStateOnSurface::BremPoint);
        }
      }
      
      if (mateff == nullptr) {
        mateff = m_materialEffects->makeMEOT();
      }
    } else {
      if (m_tsType.test(TrackStateOnSurface::Measurement)) {
        typePattern.set(TrackStateOnSurface::Measurement);        
        if ((fitQual) && (fitQual.chiSquared() > 1.e5 || fitQual.chiSquared() < 0)) {
          double newchi2 = 0;
          int ndf = fitQual.numberDoF();
          
          if (fitQual.chiSquared() < 0) {
            newchi2 = 0;
          } else if (fitQual.chiSquared() > 1.e5) {
            newchi2 = 1.e5;
          }
          
          fitQual = FitQualityOnSurface(newchi2, ndf);
        }
      } else if (m_tsType.test(TrackStateOnSurface::Outlier)) {
        typePattern.set(TrackStateOnSurface::Outlier);
      } else if (m_tsType.test(TrackStateOnSurface::Perigee)) {
        typePattern.set(TrackStateOnSurface::Perigee);
      }
    }
    return std::make_unique<const TrackStateOnSurface>(
      fitQual,
      std::move(measurement),
      std::move(trackpar),
      std::move(mateff),
      typePattern);
  }

zeroTrackCovariance()

void Trk::GXFTrackState::zeroTrackCovariance

(

void

)

Definition at line 263 of file GXFTrackState.cxx.

                                              {
    m_covariance_set = true;
    m_covariancematrix.setZero();
  }

Member Data Documentation

m_covariance_set

bool Trk::GXFTrackState::m_covariance_set

private

Definition at line 133 of file GXFTrackState.h.

m_derivs

Amg::MatrixX Trk::GXFTrackState::m_derivs

private

Derivatives of local parameters wrt fit parameters.

Definition at line 130 of file GXFTrackState.h.

m_fitqual

FitQualityOnSurface Trk::GXFTrackState::m_fitqual

private

Definition at line 135 of file GXFTrackState.h.

m_globpos

Amg::Vector3D Trk::GXFTrackState::m_globpos

private

Definition at line 141 of file GXFTrackState.h.

m_holes

std::optional<std::vector<std::unique_ptr<TrackParameters> > > Trk::GXFTrackState::m_holes

private

Definition at line 142 of file GXFTrackState.h.

m_jacobian

Eigen::Matrix<double, 5, 5> Trk::GXFTrackState::m_jacobian

private

Transport jacobian wrt previous state.

Definition at line 129 of file GXFTrackState.h.

m_materialEffects

std::unique_ptr<GXFMaterialEffects> Trk::GXFTrackState::m_materialEffects

private

Material effects on track (ie scatterer, brem)

Definition at line 128 of file GXFTrackState.h.

m_measerror

double Trk::GXFTrackState::m_measerror[5] {}

private

Measurement errors (corrected for stereo angle)

Definition at line 136 of file GXFTrackState.h.

{};      

m_measphi

bool Trk::GXFTrackState::m_measphi

private

Definition at line 140 of file GXFTrackState.h.

m_measurement

std::unique_ptr<const MeasurementBase> Trk::GXFTrackState::m_measurement

private

The measurement defining the track state.

Definition at line 125 of file GXFTrackState.h.

m_mType

TrackState::MeasurementType Trk::GXFTrackState::m_mType

private

Measurement type, eg pixel, SCT, ...

Definition at line 138 of file GXFTrackState.h.

m_recalib

bool Trk::GXFTrackState::m_recalib

private

Has this measurement already been recalibrated?

Definition at line 139 of file GXFTrackState.h.

m_sinstereo

double Trk::GXFTrackState::m_sinstereo

private

stereo angle

Definition at line 137 of file GXFTrackState.h.

m_trackpar

std::unique_ptr<const TrackParameters> Trk::GXFTrackState::m_trackpar

private

track parameters

Definition at line 127 of file GXFTrackState.h.

m_tsType

std::bitset<TrackStateOnSurface::NumberOfTrackStateOnSurfaceTypes> Trk::GXFTrackState::m_tsType

private

type of track state, eg Fittable, Outlier, Scatterer, Brem, Hole

Definition at line 126 of file GXFTrackState.h.

---

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

• GXFTrackState.h
• GXFTrackState.cxx