Arroyo::three_point Class Reference

#include <three_point.h>

Inheritance diagram for Arroyo::three_point:

List of all members.

Public Member Functions
	three_point ()
	three_point (const three_point &tp)
	three_point (double x, double y, double z, const three_frame &tf)
	~three_point ()
three_point &	operator= (const three_point &tp)
void	read (const iofits &iof)
void	write (iofits &iof) const
void	print (ostream &os, const char *prefix="", long precision=6) const
void	print (ostream &os, const three_frame &tf, const char *prefix="", long precision=6) const
double	x (const three_frame &tf) const
double	y (const three_frame &tf) const
double	z (const three_frame &tf) const
three_point &	operator+= (const three_vector &tv)
three_point &	operator-= (const three_vector &tv)
Static Public Attributes
int	verbose_level
	A verbose_level for printing messages.
Protected Member Functions
	three_point (double x, double y, double z)
Protected Attributes
double	x_
	X coordinate defined relative to global coordinate system.
double	y_
	Y coordinate defined relative to global coordinate system.
double	z_
	Z coordinate defined relative to global coordinate system.
Friends
three_vector	operator- (const three_point &tp1, const three_point &tp2)
void	three_transformation::transform (three_point &tp) const
bool	operator== (const three_point &tp1, const three_point &tp2)

---

Detailed Description

Aclass to represent a point in three dimensional space.

---

Constructor & Destructor Documentation

Arroyo::three_point::three_point (  double  x, double  y, double  z )  [protected]

Construct from coordinates wrt underlying frame

Arroyo::three_point::three_point (   )  [inline]

Null constructor

Arroyo::three_point::three_point (  const three_point &  tp  )

Copy constructor

Arroyo::three_point::three_point (  double  x, double  y, double  z, const three_frame &  tf )

Construct from coordinates wrt frame f

Arroyo::three_point::~three_point (   )  [inline]

Destructor

---

Member Function Documentation

three_point& Arroyo::three_point::operator+= (  const three_vector &  tv  )

Add a vector to a point to get another point

three_point& Arroyo::three_point::operator-= (  const three_vector &  tv  )

Subtract a vector from a point to get another point

three_point& Arroyo::three_point::operator= (  const three_point &  tp  )

Operator =

void Arroyo::three_point::print (  ostream &  os, const three_frame &  tf, const char *  prefix = "", long  precision = 6 )  const

Print coordinates wrt frame tf Reimplemented in Arroyo::three_frame.

void Arroyo::three_point::print (  ostream &  os, const char *  prefix = "", long  precision = 6 )  const

Print coordinates wrt default frame Reimplemented in Arroyo::three_frame.

void Arroyo::three_point::read (  const iofits &  iof  )

Read from iofits object Reimplemented in Arroyo::aperture, Arroyo::circular_aperture, Arroyo::annular_aperture, Arroyo::rectangular_aperture, Arroyo::spidered_annular_aperture, Arroyo::hexagonal_aperture, Arroyo::tiled_hexagonal_aperture, Arroyo::deformable_mirror_base, Arroyo::ideal_deformable_mirror< aperture_type >, Arroyo::diffractive_wavefront< T >, Arroyo::square_lenslet_array, Arroyo::plane_optic, Arroyo::refractive_atmospheric_layer< T >, Arroyo::three_frame, Arroyo::tip_tilt_mirror_base, Arroyo::ideal_tip_tilt_mirror< aperture_type >, and Arroyo::diffractive_wavefront_header< T >.

void Arroyo::three_point::write (  iofits &  iof  )  const

Write to iofits object Reimplemented in Arroyo::aperture, Arroyo::circular_aperture, Arroyo::annular_aperture, Arroyo::rectangular_aperture, Arroyo::spidered_annular_aperture, Arroyo::hexagonal_aperture, Arroyo::tiled_hexagonal_aperture, Arroyo::deformable_mirror_base, Arroyo::ideal_deformable_mirror< aperture_type >, Arroyo::diffractive_wavefront< T >, Arroyo::lenslet_array_base, Arroyo::square_lenslet_array, Arroyo::plane_optic, Arroyo::refractive_atmospheric_layer< T >, Arroyo::three_frame, Arroyo::tip_tilt_mirror_base, Arroyo::ideal_tip_tilt_mirror< aperture_type >, and Arroyo::diffractive_wavefront_header< T >.

double Arroyo::three_point::x (  const three_frame &  tf  )  const

Get x coordinate wrt frame f

double Arroyo::three_point::y (  const three_frame &  tf  )  const

Get y coordinate wrt frame f

double Arroyo::three_point::z (  const three_frame &  tf  )  const

Get z coordinate wrt frame f

---

Friends And Related Function Documentation

three_vector operator- (  const three_point &  tp1, const three_point &  tp2 )  [friend]

Subtract two points to get a vector

bool operator== (  const three_point &  tp1, const three_point &  tp2 )  [friend]

Operator==

void three_transformation::transform (  three_point &  tp  )  const [friend]

Friend member function of three_transformation that will effect that transformation on a three_point

---

Member Data Documentation

int Arroyo::three_point::verbose_level [static]

A verbose_level for printing messages. Reimplemented in Arroyo::three_frame.

double Arroyo::three_point::x_ [protected]

X coordinate defined relative to global coordinate system.

double Arroyo::three_point::y_ [protected]

Y coordinate defined relative to global coordinate system.

double Arroyo::three_point::z_ [protected]

Z coordinate defined relative to global coordinate system.

---

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

• three_point.h

---