SpatialVector.h

Go to the documentation of this file.

#ifndef _SpatialVector_h
#define _SpatialVector_h

//#     Filename:       SpatialVector.h
//#
//#     Standard 3-d vector class
//#
//#     Author:         Peter Z. Kunszt, based on A. Szalay's code
//#     
//#     Date:           October 15, 1998
//#
//#     Copyright (C) 2000  Peter Z. Kunszt, Alex S. Szalay, Aniruddha R. Thakar
//#                     The Johns Hopkins University
//#
//#     Modification History:
//#
//#     Oct 18, 2001 : Dennis C. Dinge -- Replaced ValVec with std::vector
//#

#include <cmath>
#include <SpatialGeneral.h>

//########################################################################
class LINKAGE SpatialVector {
public:
  SpatialVector();

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

  SpatialVector(float64 ra,
        float64 dec);

  void set(const float64 &x,
       const float64 &y,
       const float64 &z);

  void set(const float64 &ra,
       const float64 &dec);

  void get( float64 &x,
        float64 &y,
        float64 &z) const;

  void get( float64 &ra,
        float64 &dec);

  float64 length() const;

  float64 x() const { return x_; }

  float64 y() const { return y_; }

  float64 z() const { return z_; }

  float64 ra();

  float64 dec();

  void normalize();

  int operator ==(const SpatialVector & ) const;

  float64 operator *(const SpatialVector & ) const;

  SpatialVector operator ^(const SpatialVector & ) const;

  SpatialVector operator +(const SpatialVector & ) const;

  SpatialVector operator -(const SpatialVector & ) const;

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

private:
  float64 x_;
  float64 y_;
  float64 z_;
  float64 ra_;
  float64 dec_;
  bool okRaDec_;

  void updateXYZ();
  void updateRaDec();

  friend class SpatialIndex;
};

// Friend operators
SpatialVector operator *(float64, const SpatialVector&);
SpatialVector operator *(int, const SpatialVector&);
SpatialVector operator *(const SpatialVector&, float64);
SpatialVector operator *(const SpatialVector&, int);

#endif