SpatialVector Class Reference

#include <SpatialVector.h>

Public Member Functions
	SpatialVector ()
	SpatialVector (float64 x, float64 y, float64 z)
	SpatialVector (float64 ra, float64 dec)
float64	dec ()
void	get (float64 &x, float64 &y, float64 &z) const
void	get (float64 &ra, float64 &dec)
float64	length () const
void	normalize ()
float64	operator* (const SpatialVector &) const
SpatialVector	operator+ (const SpatialVector &) const
SpatialVector	operator- (const SpatialVector &) const
int	operator== (const SpatialVector &) const
SpatialVector	operator^ (const SpatialVector &) const
float64	ra ()
void	set (const float64 &x, const float64 &y, const float64 &z)
void	set (const float64 &ra, const float64 &dec)
float64	x () const
float64	y () const
float64	z () const

operator *=
SpatialVector	operator* (float64, const SpatialVector &)
SpatialVector	operator* (int, const SpatialVector &)
SpatialVector	operator* (const SpatialVector &, float64)
SpatialVector	operator* (const SpatialVector &, int)
SpatialVector &	operator*= (float64)
SpatialVector &	operator*= (int)

Detailed Description

The SpatialVector is a 3D vector usually living on the surface of the sphere.

The corresponding ra, dec can be obtained if the vector has unit length. That can be ensured with the normalize() function.

Definition at line 32 of file SpatialVector.h.

Constructor & Destructor Documentation

SpatialVector::SpatialVector

(

)

constructs (1,0,0), ra=0, dec=0.

Definition at line 29 of file SpatialVector.cpp.

SpatialVector::SpatialVector	(	float64	x,
		float64	y,
		float64	z
	)

Constructor from three coordinates, not necessarily normed to 1.

Definition at line 34 of file SpatialVector.cpp.

SpatialVector::SpatialVector	(	float64	ra,
		float64	dec
	)

Constructor from ra/dec, this is always normed to 1.

Definition at line 40 of file SpatialVector.cpp.

Member Function Documentation

float64 SpatialVector::dec

(

)

return dec - this norms the vector to 1 if not already done so

Definition at line 98 of file SpatialVector.cpp.

void SpatialVector::get	(	float64 &	x,
		float64 &	y,
		float64 &	z
	)		const

Get x,y,z.

Definition at line 70 of file SpatialVector.cpp.

void SpatialVector::get	(	float64 &	ra,
		float64 &	dec
	)

Get ra,dec - normalizes x,y,z.

Definition at line 80 of file SpatialVector.cpp.

float64 SpatialVector::length

(

)

const

return length of vector

Definition at line 123 of file SpatialVector.cpp.

void SpatialVector::normalize

(

)

Normalize vector length to 1.

Definition at line 110 of file SpatialVector.cpp.

float64 SpatialVector::operator*

(

const SpatialVector &

v

)

const

dot product

Definition at line 223 of file SpatialVector.cpp.

SpatialVector & SpatialVector::operator*=

(

float64

a

)

Definition at line 161 of file SpatialVector.cpp.

SpatialVector & SpatialVector::operator*=

(

int

a

)

Definition at line 173 of file SpatialVector.cpp.

SpatialVector SpatialVector::operator+

(

const SpatialVector &

v

)

const

addition

Definition at line 231 of file SpatialVector.cpp.

SpatialVector SpatialVector::operator-

(

const SpatialVector &

v

)

const

subtraction

Definition at line 239 of file SpatialVector.cpp.

int SpatialVector::operator==

(

const SpatialVector &

v

)

const

Comparison.

Definition at line 258 of file SpatialVector.cpp.

SpatialVector SpatialVector::operator^

(

const SpatialVector &

v

)

const

cross product

Definition at line 248 of file SpatialVector.cpp.

float64 SpatialVector::ra

(

)

return ra - this norms the vector to 1 if not already done so

Definition at line 90 of file SpatialVector.cpp.

void SpatialVector::set	(	const float64 &	x,
		const float64 &	y,
		const float64 &	z
	)

Set member function: set values - always normed to 1.

Definition at line 49 of file SpatialVector.cpp.

void SpatialVector::set	(	const float64 &	ra,
		const float64 &	dec
	)

Set member function: set values - always normed to 1.

Definition at line 60 of file SpatialVector.cpp.

float64 SpatialVector::x ( ) const

inline

return x (only as rvalue)

Definition at line 68 of file SpatialVector.h.

float64 SpatialVector::y ( ) const

inline

return y

Definition at line 71 of file SpatialVector.h.

float64 SpatialVector::z ( ) const

inline

return z

Definition at line 74 of file SpatialVector.h.

Friends And Related Function Documentation

SpatialVector operator* ( float64  , const SpatialVector &    )

friend

Definition at line 186 of file SpatialVector.cpp.

SpatialVector operator* ( int  , const SpatialVector &    )

friend

Definition at line 204 of file SpatialVector.cpp.

SpatialVector operator* ( const SpatialVector &  , float64    )

friend

Definition at line 195 of file SpatialVector.cpp.

SpatialVector operator* ( const SpatialVector &  , int    )

friend

Definition at line 213 of file SpatialVector.cpp.

---

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

• SpatialVector.h
• SpatialVector.cpp