ATLAS Offline Software
Loading...
Searching...
No Matches
MuonCalib::SamplePoint Class Reference

This class provides a sample point for the BaseFunctionFitter. More...

#include <SamplePoint.h>

Collaboration diagram for MuonCalib::SamplePoint:

Public Member Functions

 SamplePoint ()=default
 SamplePoint (const std::array< double, 3 > &triplet)
 constructor, triplet[0] = x1 coordinate of the sample point, triplet[1] = x2 coordinate of the sample point, triplet[2] = error of the x2 coordinate of the sample point
 SamplePoint (const double mx1, const double mx2, const double msigma)
 constructor, mx1 = x1 coordinate of the sample point, mx2 = x2 coordinate of the sample point, msigma = error of the x2 coordinate of the sample point
double x1 () const
 < get the x1 coordinate of the sample point
double x2 () const
 get the error on the x2 coordinate of the sample point
double error () const
void set_triplet (const std::array< double, 3 > &values)
 set the sample point, x[0] = x1 coordinate of the sample point, x[1] = x2 coordinate of the sample point, x[2] = error of the x2 coordinate of the sample point
void set_x1 (const double mx1)
 set the x2 coordinate of the sample point to mx2
void set_x2 (const double mx2)
 set the error of the x2 coordinate sample point to merror
void set_error (const double merror)

Private Attributes

double m_x1 {0.}
 x1 coordinate of the sample point
double m_x2 {0.}
 x2 coordinate of the sample point
double m_sigma {0.}
 error of the x2 coordinate of the sample point

Detailed Description

This class provides a sample point for the BaseFunctionFitter.

Definition at line 15 of file SamplePoint.h.

Constructor & Destructor Documentation

◆ SamplePoint() [1/3]

MuonCalib::SamplePoint::SamplePoint ( )
default

◆ SamplePoint() [2/3]

MuonCalib::SamplePoint::SamplePoint ( const std::array< double, 3 > & triplet)
inline

constructor, triplet[0] = x1 coordinate of the sample point, triplet[1] = x2 coordinate of the sample point, triplet[2] = error of the x2 coordinate of the sample point

Definition at line 28 of file SamplePoint.h.

28 :
29 m_x1{triplet[0]}, m_x2{triplet[1]}, m_sigma{triplet[2]}{}
double m_sigma
error of the x2 coordinate of the sample point
Definition SamplePoint.h:20
double m_x2
x2 coordinate of the sample point
Definition SamplePoint.h:19
double m_x1
x1 coordinate of the sample point
Definition SamplePoint.h:18

◆ SamplePoint() [3/3]

MuonCalib::SamplePoint::SamplePoint ( const double mx1,
const double mx2,
const double msigma )
inline

constructor, mx1 = x1 coordinate of the sample point, mx2 = x2 coordinate of the sample point, msigma = error of the x2 coordinate of the sample point

Definition at line 35 of file SamplePoint.h.

37 :
38 m_x1{mx1}, m_x2{mx2}, m_sigma{msigma} {}

Member Function Documentation

◆ error()

double MuonCalib::SamplePoint::error ( ) const
inline

Definition at line 46 of file SamplePoint.h.

46{ return m_sigma; }

◆ set_error()

void MuonCalib::SamplePoint::set_error ( const double merror)
inline

Definition at line 62 of file SamplePoint.h.

62{ m_sigma = merror; }

◆ set_triplet()

void MuonCalib::SamplePoint::set_triplet ( const std::array< double, 3 > & values)
inline

set the sample point, x[0] = x1 coordinate of the sample point, x[1] = x2 coordinate of the sample point, x[2] = error of the x2 coordinate of the sample point

set the x1 coordinate of the sample point to mx1

Definition at line 52 of file SamplePoint.h.

◆ set_x1()

void MuonCalib::SamplePoint::set_x1 ( const double mx1)
inline

set the x2 coordinate of the sample point to mx2

Definition at line 58 of file SamplePoint.h.

◆ set_x2()

void MuonCalib::SamplePoint::set_x2 ( const double mx2)
inline

set the error of the x2 coordinate sample point to merror

Definition at line 60 of file SamplePoint.h.

◆ x1()

double MuonCalib::SamplePoint::x1 ( ) const
inline

< get the x1 coordinate of the sample point

get the x2 coordinate of the sample point

Definition at line 42 of file SamplePoint.h.

◆ x2()

double MuonCalib::SamplePoint::x2 ( ) const
inline

get the error on the x2 coordinate of the sample point

Definition at line 44 of file SamplePoint.h.

Member Data Documentation

◆ m_sigma

double MuonCalib::SamplePoint::m_sigma {0.}
private

error of the x2 coordinate of the sample point

Definition at line 20 of file SamplePoint.h.

20{0.};

◆ m_x1

double MuonCalib::SamplePoint::m_x1 {0.}
private

x1 coordinate of the sample point

Definition at line 18 of file SamplePoint.h.

18{0.};

◆ m_x2

double MuonCalib::SamplePoint::m_x2 {0.}
private

x2 coordinate of the sample point

Definition at line 19 of file SamplePoint.h.

19{0.};

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