Direction Class Reference

A direction in three-dimensional space. More...

Public Member Functions
	Direction ()
	Direction (double alpha, double phi)
double	alpha () const
double	phi () const
kvector_t	vector () const
	Returns Cartesian 3D vector. More...

Private Attributes
double	m_alpha
double	m_phi

Detailed Description

A direction in three-dimensional space.

Definition at line 24 of file Direction.h.

Constructor & Destructor Documentation

Direction() [1/2]

Direction::Direction ( double  alpha, double  phi  )

inline

Definition at line 26 of file Direction.h.

: m_alpha(alpha), m_phi(phi) {}

Direction() [2/2]

Direction::Direction ( )

inline

Definition at line 27 of file Direction.h.

: Direction(0, 0) {} // needed by Swig

Member Function Documentation

alpha()

double Direction::alpha ( ) const

inline

Definition at line 29 of file Direction.h.

{ return m_alpha; }

References m_alpha.

Referenced by DepthProbeSimulation::generateSimulationElements(), ISimulation2D::generateSimulationElements(), RectangularDetector::indexOfSpecular(), SphericalDetector::indexOfSpecular(), RectangularDetector::init(), Beam::setDirection(), TransformFromDomain::setGISASBeamItem(), and TransformFromDomain::setOffSpecularBeamItem().

phi()

double Direction::phi ( ) const

inline

Definition at line 30 of file Direction.h.

{ return m_phi; }

References m_phi.

Referenced by ISimulation2D::generateSimulationElements(), RectangularDetector::indexOfSpecular(), SphericalDetector::indexOfSpecular(), Beam::setDirection(), TransformFromDomain::setGISASBeamItem(), and TransformFromDomain::setOffSpecularBeamItem().

vector()

kvector_t Direction::vector

(

)

const

Returns Cartesian 3D vector.

Definition at line 24 of file Direction.cpp.

{
    return {std::cos(m_alpha) * std::cos(m_phi), -std::cos(m_alpha) * std::sin(m_phi),
            std::sin(m_alpha)};
}

References m_alpha, and m_phi.

Referenced by Beam::getCentralK(), and vecOfLambdaAlphaPhi().

Member Data Documentation

m_alpha

double Direction::m_alpha

private

Definition at line 36 of file Direction.h.

Referenced by alpha(), and vector().

m_phi

double Direction::m_phi

private

Definition at line 37 of file Direction.h.

Referenced by phi(), and vector().

---

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

• /home/www/ba/Base/Vector/Direction.h
• /home/www/ba/Base/Vector/Direction.cpp