Placeholder for what will later be the muon segment EDM representation. More...

#include <Segment.h>

Collaboration diagram for MuonR4::Segment:

Public Types
using	MeasType = std::unique_ptr< CalibratedSpacePoint >

using	MeasVec = std::vector< MeasType >

Public Member Functions
	Segment (Amg::Vector3D &&globPos, Amg::Vector3D &&globDir, const SegmentSeed *parent, MeasVec &&constMeas, double chi2, unsigned int nDoF)
	Segment constructor. More...

const MuonGMR4::SpectrometerSector *	msSector () const
	Returns the associated MS sector. More...

const Amg::Vector3D &	position () const
	Returns the global segment position. More...

const Amg::Vector3D &	direction () const
	Returns the global segment direction. More...

double	chi2 () const
	Returns the chi2 of the segment fit. More...

unsigned int	nDoF () const
	Returns the number of degrees of freedom. More...

const MeasVec &	measurements () const
	Returns the associated measurements. More...

const SegmentSeed *	parent () const
	Returns the seed out of which the segment was built. More...

const SegmentFit::Covariance &	covariance () const
	Returns the uncertainties of the defining parameters. More...

unsigned int	nFitIterations () const
	Returns how many iterations the fitter needed to make the segment converge. More...

bool	hasTimeFit () const
	has the time been fitted More...

double	segementT0 () const
	Returns the fitted segment time, if there's any. More...

void	setSegmentT0 (double t0)
	Sets the fitted segment time. More...

void	setCallsToConverge (unsigned int nCalls)
	Set how many iteration the fitter needed to reach convergence. More...

void	setParUncertainties (SegmentFit::Covariance &&cov)
	Set the uncertainties from the fit. More...

Private Attributes
Amg::Vector3D	m_globPos {Amg::Vector3D::Zero()}
	Global position of the segment at the chamber centre. More...

Amg::Vector3D	m_globDir {Amg::Vector3D::Zero()}
	Global direction of the segment. More...

const SegmentSeed *	m_parent {nullptr}
	Seed from which the segment is stemming. More...

MeasVec	m_measurements {}
	List of associated measurements. More...

double	m_chi2 {0.}

unsigned int	m_nDoF {0}
	Number of degrees of freedom in the fit. More...

std::optional< double >	m_t0 {std::nullopt}
	Fitted time of arrival at the chamber centre. More...

unsigned int	m_nCalls {0}
	Number of calls to reach the minimum. More...

SegmentFit::Covariance	m_cov {SegmentFit::Covariance::Identity()}
	Covariance matrix of the fit More...

Detailed Description

Placeholder for what will later be the muon segment EDM representation.

For now, just a plain storage for the dummy fit result, to test the implementation of residuals

Definition at line 19 of file MuonSpectrometer/MuonPhaseII/Event/MuonPatternEvent/MuonPatternEvent/Segment.h.

Member Typedef Documentation

◆ MeasType

using MuonR4::Segment::MeasType = std::unique_ptr<CalibratedSpacePoint>

Definition at line 22 of file MuonSpectrometer/MuonPhaseII/Event/MuonPatternEvent/MuonPatternEvent/Segment.h.

◆ MeasVec

using MuonR4::Segment::MeasVec = std::vector<MeasType>

Definition at line 23 of file MuonSpectrometer/MuonPhaseII/Event/MuonPatternEvent/MuonPatternEvent/Segment.h.

Constructor & Destructor Documentation

◆ Segment()

MuonR4::Segment::Segment	(	Amg::Vector3D &&	globPos,
		Amg::Vector3D &&	globDir,
		const SegmentSeed *	parent,
		MeasVec &&	constMeas,
		double	chi2,
		unsigned int	nDoF
	)

inline

Segment constructor.

Parameters

globPos	Global position of the segment expressed at the associated chamber centre
globDir	Global direction of the segment
parent	Seed out of which the segment has been built
constMeas	Measurements building up the segment
chi2	Chi2 of the segment fit
nDoF	Degrees of freedom

Definition at line 31 of file MuonSpectrometer/MuonPhaseII/Event/MuonPatternEvent/MuonPatternEvent/Segment.h.

                                       :
                 m_globPos{std::move(globPos)},
                 m_globDir{std::move(globDir)},
                 m_parent{parent},
                 m_measurements{std::move(constMeas)},
                 m_chi2{chi2}, 
                 m_nDoF{nDoF}{}

Member Function Documentation

◆ chi2()

double MuonR4::Segment::chi2 ( ) const

inline

Returns the chi2 of the segment fit.

Definition at line 51 of file MuonSpectrometer/MuonPhaseII/Event/MuonPatternEvent/MuonPatternEvent/Segment.h.

51 { return m_chi2; }

◆ covariance()

const SegmentFit::Covariance& MuonR4::Segment::covariance ( ) const

inline

Returns the uncertainties of the defining parameters.

Definition at line 59 of file MuonSpectrometer/MuonPhaseII/Event/MuonPatternEvent/MuonPatternEvent/Segment.h.

59 { return m_cov; }

◆ direction()

const Amg::Vector3D& MuonR4::Segment::direction ( ) const

inline

Returns the global segment direction.

Definition at line 49 of file MuonSpectrometer/MuonPhaseII/Event/MuonPatternEvent/MuonPatternEvent/Segment.h.

49 { return m_globDir; }

◆ hasTimeFit()

bool MuonR4::Segment::hasTimeFit ( ) const

inline

has the time been fitted

Definition at line 63 of file MuonSpectrometer/MuonPhaseII/Event/MuonPatternEvent/MuonPatternEvent/Segment.h.

63 { return m_t0 != std::nullopt; }

◆ measurements()

const MeasVec& MuonR4::Segment::measurements ( ) const

inline

Returns the associated measurements.

Definition at line 55 of file MuonSpectrometer/MuonPhaseII/Event/MuonPatternEvent/MuonPatternEvent/Segment.h.

55 { return m_measurements; }

◆ msSector()

const MuonGMR4::SpectrometerSector* MuonR4::Segment::msSector ( ) const

inline

Returns the associated MS sector.

Definition at line 45 of file MuonSpectrometer/MuonPhaseII/Event/MuonPatternEvent/MuonPatternEvent/Segment.h.

45 { return m_parent->msSector(); }

◆ nDoF()

unsigned int MuonR4::Segment::nDoF ( ) const

inline

Returns the number of degrees of freedom.

Definition at line 53 of file MuonSpectrometer/MuonPhaseII/Event/MuonPatternEvent/MuonPatternEvent/Segment.h.

53 { return m_nDoF; }

◆ nFitIterations()

unsigned int MuonR4::Segment::nFitIterations ( ) const

inline

Returns how many iterations the fitter needed to make the segment converge.

Definition at line 61 of file MuonSpectrometer/MuonPhaseII/Event/MuonPatternEvent/MuonPatternEvent/Segment.h.

61 { return m_nCalls; }

◆ parent()

const SegmentSeed* MuonR4::Segment::parent ( ) const

inline

Returns the seed out of which the segment was built.

Definition at line 57 of file MuonSpectrometer/MuonPhaseII/Event/MuonPatternEvent/MuonPatternEvent/Segment.h.

57 { return m_parent; }

◆ position()

const Amg::Vector3D& MuonR4::Segment::position ( ) const

inline

Returns the global segment position.

Definition at line 47 of file MuonSpectrometer/MuonPhaseII/Event/MuonPatternEvent/MuonPatternEvent/Segment.h.

47 { return m_globPos; }

◆ segementT0()

double MuonR4::Segment::segementT0 ( ) const

inline

Returns the fitted segment time, if there's any.

Definition at line 65 of file MuonSpectrometer/MuonPhaseII/Event/MuonPatternEvent/MuonPatternEvent/Segment.h.

                                       {
                 return m_t0.value_or(0);
             }

◆ setCallsToConverge()

void MuonR4::Segment::setCallsToConverge ( unsigned int nCalls )

inline

Set how many iteration the fitter needed to reach convergence.

Definition at line 73 of file MuonSpectrometer/MuonPhaseII/Event/MuonPatternEvent/MuonPatternEvent/Segment.h.

                                                          {
                 m_nCalls = nCalls;
             }

◆ setParUncertainties()

void MuonR4::Segment::setParUncertainties ( SegmentFit::Covariance && cov )

inline

Set the uncertainties from the fit.

Definition at line 77 of file MuonSpectrometer/MuonPhaseII/Event/MuonPatternEvent/MuonPatternEvent/Segment.h.

                                                                 {
                 m_cov = std::move(cov);
             }

◆ setSegmentT0()

void MuonR4::Segment::setSegmentT0 ( double t0 )

inline

Sets the fitted segment time.

Definition at line 69 of file MuonSpectrometer/MuonPhaseII/Event/MuonPatternEvent/MuonPatternEvent/Segment.h.

                                          {
                 m_t0 = std::make_optional<double>(t0);             
             }

Member Data Documentation

◆ m_chi2

double MuonR4::Segment::m_chi2 {0.}

private

Definition at line 92 of file MuonSpectrometer/MuonPhaseII/Event/MuonPatternEvent/MuonPatternEvent/Segment.h.

◆ m_cov

SegmentFit::Covariance MuonR4::Segment::m_cov {SegmentFit::Covariance::Identity()}

private

Covariance matrix of the fit

Definition at line 100 of file MuonSpectrometer/MuonPhaseII/Event/MuonPatternEvent/MuonPatternEvent/Segment.h.

◆ m_globDir

Amg::Vector3D MuonR4::Segment::m_globDir {Amg::Vector3D::Zero()}

private

Global direction of the segment.

Definition at line 86 of file MuonSpectrometer/MuonPhaseII/Event/MuonPatternEvent/MuonPatternEvent/Segment.h.

◆ m_globPos

Amg::Vector3D MuonR4::Segment::m_globPos {Amg::Vector3D::Zero()}

private

Global position of the segment at the chamber centre.

Definition at line 84 of file MuonSpectrometer/MuonPhaseII/Event/MuonPatternEvent/MuonPatternEvent/Segment.h.

◆ m_measurements

MeasVec MuonR4::Segment::m_measurements {}

private

List of associated measurements.

Definition at line 90 of file MuonSpectrometer/MuonPhaseII/Event/MuonPatternEvent/MuonPatternEvent/Segment.h.

◆ m_nCalls

unsigned int MuonR4::Segment::m_nCalls {0}

private

Number of calls to reach the minimum.

Definition at line 98 of file MuonSpectrometer/MuonPhaseII/Event/MuonPatternEvent/MuonPatternEvent/Segment.h.

◆ m_nDoF

unsigned int MuonR4::Segment::m_nDoF {0}

private

Number of degrees of freedom in the fit.

Definition at line 94 of file MuonSpectrometer/MuonPhaseII/Event/MuonPatternEvent/MuonPatternEvent/Segment.h.

◆ m_parent

const SegmentSeed* MuonR4::Segment::m_parent {nullptr}

private

Seed from which the segment is stemming.

Definition at line 88 of file MuonSpectrometer/MuonPhaseII/Event/MuonPatternEvent/MuonPatternEvent/Segment.h.

◆ m_t0

std::optional<double> MuonR4::Segment::m_t0 {std::nullopt}

private

Fitted time of arrival at the chamber centre.

Definition at line 96 of file MuonSpectrometer/MuonPhaseII/Event/MuonPatternEvent/MuonPatternEvent/Segment.h.

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

MuonSpectrometer/MuonPhaseII/Event/MuonPatternEvent/MuonPatternEvent/Segment.h

Public Types

Public Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ MeasType

◆ MeasVec

Constructor & Destructor Documentation

◆ Segment()

Member Function Documentation

◆ chi2()

◆ covariance()

◆ direction()

◆ hasTimeFit()

◆ measurements()

◆ msSector()

◆ nDoF()

◆ nFitIterations()

◆ parent()

◆ position()

◆ segementT0()

◆ setCallsToConverge()

◆ setParUncertainties()

◆ setSegmentT0()

Member Data Documentation

◆ m_chi2

◆ m_cov

◆ m_globDir

◆ m_globPos

◆ m_measurements

◆ m_nCalls

◆ m_nDoF

◆ m_parent

◆ m_t0