MuonCalib::CurvedLine Class Reference

#include <CurvedLine.h>

Collaboration diagram for MuonCalib::CurvedLine:

Public Types
using	MdtHitVec = MuonCalibSegment::MdtHitVec
using	MdtHitPtr = MuonCalibSegment::MdtHitPtr

Public Member Functions
	CurvedLine ()
	Default constructor: a straight line through (0,0,0) pointing in in the local x direction of the chambers is created. More...
	CurvedLine (std::vector< Amg::Vector3D > &points)
	Constructor. More...
	CurvedLine (std::vector< Amg::Vector3D > &points, std::vector< Amg::Vector3D > &x_and_y_errors)
	Constructor. More...
Amg::Vector3D	getPointOnLine (const double &loc_z) const
	get the point on the line a the local z coordinate "loc_z" More...
MTStraightLine	getTangent (const double &loc_z) const
	get the tangent to the line a the local z coordinate "loc_z" More...
void	setChi2 (double chi2)
	Cache the chi2. More...
double	chi2 () const
void	setNumberOfTrackHits (unsigned int n_hits)
	cache the number of track hits More...
unsigned int	numberOfTrackHits () const
double	chi2PerDegreesOfFreedom () const
	Return chi2 / number of TrackHits - 3. More...
void	setUsedHits (const MdtHitVec &hits)
const MdtHitVec &	trackHits () const

Private Member Functions
void	init (std::vector< Amg::Vector3D > &points, std::vector< Amg::Vector3D > &x_and_y_errors)

Private Attributes
const Legendre_polynomial *	m_Legendre = nullptr
Amg::VectorX	m_coeff_xz
Amg::VectorX	m_coeff_yz
double	m_chi2 {-1}
unsigned int	m_numTrkHits {0}
MdtHitVec	m_used_hits

Detailed Description

Definition at line 31 of file CurvedLine.h.

Member Typedef Documentation

MdtHitPtr

using MuonCalib::CurvedLine::MdtHitPtr = MuonCalibSegment::MdtHitPtr

Definition at line 34 of file CurvedLine.h.

MdtHitVec

using MuonCalib::CurvedLine::MdtHitVec = MuonCalibSegment::MdtHitVec

Definition at line 33 of file CurvedLine.h.

Constructor & Destructor Documentation

CurvedLine() [1/3]

CurvedLine::CurvedLine

(

)

Default constructor: a straight line through (0,0,0) pointing in in the local x direction of the chambers is created.

Definition at line 20 of file CurvedLine.cxx.

                       {
    // VARIABLES //
 
    std::vector<Amg::Vector3D> points(3);
    std::vector<Amg::Vector3D> errors(3);
 
    // FILL VARIABLES //
 
    points[0] = Amg::Vector3D(0.0, 0.0, 0.0);
    errors[0] = Amg::Vector3D(1.0, 1.0, 0.0);
    points[1] = Amg::Vector3D(0.0, 0.0, 1.0);
    errors[1] = Amg::Vector3D(1.0, 1.0, 0.0);
    points[2] = Amg::Vector3D(0.0, 0.0, 2.0);
    errors[2] = Amg::Vector3D(1.0, 1.0, 0.0);
 
    // INITIALIZATION //
 
    init(points, errors);
}

CurvedLine() [2/3]

CurvedLine::CurvedLine

(

std::vector< Amg::Vector3D > &

points

)

Constructor.

Parameters

points

A straight line in the xz and a parabolic line in the yz plane is fitter through the given points. All points get equal weight.

Definition at line 52 of file CurvedLine.cxx.

                                                     {
    // VARIABLES //
 
    std::vector<Amg::Vector3D> errors(points.size());
 
    // FILL VARIABLES //
 
    for (auto & error : errors) { error = Amg::Vector3D(1.0, 1.0, 0.0); }
 
    // INITIALIZATION //
 
    init(points, errors);
}

CurvedLine() [3/3]

CurvedLine::CurvedLine	(	std::vector< Amg::Vector3D > &	points,
		std::vector< Amg::Vector3D > &	x_and_y_errors
	)

Constructor.

Parameters

points	A straight line in the xz and a parabolic line in the yz plane is fitter through the given points.
x_and_y_errors	Errors of the x and y coordinates of the given points

Definition at line 78 of file CurvedLine.cxx.

{ init(points, x_and_y_errors); }

Member Function Documentation

chi2()

double CurvedLine::chi2

(

)

const

Definition at line 191 of file CurvedLine.cxx.

{ return m_chi2; }

chi2PerDegreesOfFreedom()

double CurvedLine::chi2PerDegreesOfFreedom

(

)

const

Return chi2 / number of TrackHits - 3.

Definition at line 195 of file CurvedLine.cxx.

{ return m_chi2 / (m_numTrkHits > 2 ? m_numTrkHits - 3 : 0.01); }

getPointOnLine()

Amg::Vector3D CurvedLine::getPointOnLine

(

const double &

loc_z

)

const

get the point on the line a the local z coordinate "loc_z"

Definition at line 86 of file CurvedLine.cxx.

                                                                {
    // VARIABLES //
 
    double loc_x(0.0), loc_y(0.0);
 
    // CALCULATE THE COORDINATES //
 
    for (int k = 0; k < m_coeff_xz.rows(); k++) { loc_x = loc_x + m_coeff_xz[k] * m_Legendre->value(k, loc_z); }
 
    for (int k = 0; k < m_coeff_yz.rows(); k++) { loc_y = loc_y + m_coeff_yz[k] * m_Legendre->value(k, loc_z); }
 
    // RETURN THE REQUESTED POINT //
 
    return Amg::Vector3D(loc_x, loc_y, loc_z);
}

getTangent()

MTStraightLine CurvedLine::getTangent

(

const double &

loc_z

)

const

get the tangent to the line a the local z coordinate "loc_z"

Definition at line 114 of file CurvedLine.cxx.

                                                               {
    // VARIABLES //
 
    Amg::Vector3D null_vec(0.0, 0.0, 0.0);               // auxiliary 0 vector
    Amg::Vector3D point_1(getPointOnLine(loc_z));        // first point on the curved
                                                         // line
    Amg::Vector3D point_2(getPointOnLine(loc_z + 1.0));  // second point on the
                                                         // curved line
 
    // RETURN THE TANGENT //
 
    return MTStraightLine(point_1, point_2 - point_1, null_vec, null_vec);
}

init()

void CurvedLine::init ( std::vector< Amg::Vector3D > &  points, std::vector< Amg::Vector3D > &  x_and_y_errors  )

private

Definition at line 138 of file CurvedLine.cxx.

                                                                                            {
    // CHECK THE NUMBER OF POINTS //
 
    if (points.size() < 3) {
        MsgStream log(Athena::getMessageSvc(), "CurvedLine");
        log << MSG::ERROR << "Class CurvedLine, method init: Not enough points given, must be at least 3 points!" << endmsg;
    }
 
    // VARIABLES //
 
    BaseFunctionFitter fitter;
    LegendrePolynomial legendre;                            // Legendre polynomial needed by the base
                                                            // function fitter
    std::vector<SamplePoint> sample_points(points.size());  // sample points needed
                                                            // by the base function
                                                            // fitter
                                                            // FILL THE VARIABLES AND PERFORM THE FITS //
 
    // xz plane //
    for (unsigned int k = 0; k < points.size(); k++) {
        sample_points[k].set_x1(points[k].z());
        sample_points[k].set_x2(points[k].x());
        sample_points[k].set_error(x_and_y_errors[k].x());
    }
    fitter.set_number_of_coefficients(2);
    fitter.fit_parameters(sample_points, 1, sample_points.size(), &legendre);
    m_coeff_xz = fitter.coefficients();
 
    // yz plane //
    for (unsigned int k = 0; k < points.size(); k++) {
        sample_points[k].set_x1(points[k].z());
        sample_points[k].set_x2(points[k].y());
        sample_points[k].set_error(x_and_y_errors[k].y());
    }
    fitter.set_number_of_coefficients(3);
    fitter.fit_parameters(sample_points, 1, sample_points.size(), &legendre);
    m_coeff_yz = fitter.coefficients();
 
    // GET A POINTER TO THE LEGENDRE POLYNOMIAL //
 
    m_Legendre = Legendre_polynomial::get_Legendre_polynomial();
 
    return;
}

numberOfTrackHits()

unsigned int CurvedLine::numberOfTrackHits

(

)

const

Definition at line 193 of file CurvedLine.cxx.

{ return m_numTrkHits; }

setChi2()

void CurvedLine::setChi2

(

double

chi2

)

Cache the chi2.

Definition at line 190 of file CurvedLine.cxx.

{ m_chi2 = std::isnan(chi2) ? -1 : chi2; }

setNumberOfTrackHits()

void CurvedLine::setNumberOfTrackHits

(

unsigned int

n_hits

)

cache the number of track hits

Definition at line 192 of file CurvedLine.cxx.

{ m_numTrkHits = n_hits; }

setUsedHits()

void CurvedLine::setUsedHits

(

const MdtHitVec &

hits

)

Definition at line 197 of file CurvedLine.cxx.

{ m_used_hits = hits; }

trackHits()

const CurvedLine::MdtHitVec & CurvedLine::trackHits

(

)

const

Definition at line 198 of file CurvedLine.cxx.

{ return m_used_hits; }

Member Data Documentation

m_chi2

double MuonCalib::CurvedLine::m_chi2 {-1}

private

Definition at line 86 of file CurvedLine.h.

m_coeff_xz

Amg::VectorX MuonCalib::CurvedLine::m_coeff_xz

private

Definition at line 81 of file CurvedLine.h.

m_coeff_yz

Amg::VectorX MuonCalib::CurvedLine::m_coeff_yz

private

Definition at line 83 of file CurvedLine.h.

m_Legendre

const Legendre_polynomial* MuonCalib::CurvedLine::m_Legendre = nullptr

private

Definition at line 79 of file CurvedLine.h.

m_numTrkHits

unsigned int MuonCalib::CurvedLine::m_numTrkHits {0}

private

Definition at line 87 of file CurvedLine.h.

m_used_hits

MdtHitVec MuonCalib::CurvedLine::m_used_hits

private

Definition at line 88 of file CurvedLine.h.

---

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

• CurvedLine.h
• CurvedLine.cxx