PhiAngle Class Reference

#include <Angle.h>

Inheritance diagram for PhiAngle:

Public Member Functions
	PhiAngle (double angle, double error)
	Constructor using radian units.
bool	contains (const PhiAngle &angle) const
	Check if two angles are compatible.
bool	containsIn (const PhiAngle &angle, double sigma) const
	Check if two angles are compatible.
double	getAngle () const
	Getter for the angle.
double	getError () const
	Getter for the error of the angle.
double	getAngleInDeg () const
	Getter for angle in degrees.
double	getErrorInDeg () const
	Getter for the error of the angle in degrees.

Protected Attributes
double	m_angle
	Angle in rad.
double	m_error
	Error in rad.

Detailed Description

See also

BaseAngle Phi specific.

Definition at line 106 of file Angle.h.

Constructor & Destructor Documentation

PhiAngle()

PhiAngle ( double  angle, double  error  )

inline

Constructor using radian units.

Phi in [0, 2 * pi).

Parameters

angle	phi angle
error	error on the phi angle

Definition at line 114 of file Angle.h.

                                         : BaseAngle(angle, error)
    {
      /* Angle in the range (-2 * pi, 2 * pi). */
      m_angle = std::fmod(m_angle, TMath::TwoPi());
      if (m_angle < 0)
        m_angle = m_angle + TMath::TwoPi();
    }

Member Function Documentation

contains()

bool contains ( const PhiAngle &  angle ) const

inline

Check if two angles are compatible.

Parameters

angle

second angle to compare

Returns

true if within one standard deviation

Definition at line 126 of file Angle.h.

    {
      return containsIn(angle, 1);
    }

containsIn()

bool containsIn ( const PhiAngle &  angle, double  sigma  ) const

inline

Check if two angles are compatible.

Parameters

angle	second angle to compare to
sigma	width of the error band in standard deviations

Returns

true if within sigma standard deviations

Definition at line 136 of file Angle.h.

    {
      double angularDistance, shortestAngularDistance, sigmaError;
      /* Distance in the range [0, 2 * pi). */
      angularDistance = std::abs(m_angle - angle.getAngle());
      /* Distance in the range [0, pi]. */
      if (angularDistance > TMath::Pi())
        shortestAngularDistance = TMath::TwoPi() - angularDistance;
      else
        shortestAngularDistance = angularDistance;
      sigmaError = sigma * (m_error + angle.getError());
      return shortestAngularDistance < sigmaError;
    }

getAngle()

double getAngle ( ) const

inlineinherited

Getter for the angle.

Definition at line 37 of file Angle.h.

{ return m_angle; }

getAngleInDeg()

double getAngleInDeg ( ) const

inlineinherited

Getter for angle in degrees.

Definition at line 45 of file Angle.h.

{ return m_angle * TMath::RadToDeg(); }

getError()

double getError ( ) const

inlineinherited

Getter for the error of the angle.

Definition at line 41 of file Angle.h.

{ return m_error; }

getErrorInDeg()

double getErrorInDeg ( ) const

inlineinherited

Getter for the error of the angle in degrees.

Definition at line 49 of file Angle.h.

{ return m_error * TMath::RadToDeg(); }

Member Data Documentation

m_angle

double m_angle

protectedinherited

Angle in rad.

Definition at line 53 of file Angle.h.

m_error

double m_error

protectedinherited

Error in rad.

Definition at line 54 of file Angle.h.

---

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

• framework/utilities/include/Angle.h