Arroyo::three_frame Class Reference

#include <three_frame.h>

Inheritance diagram for Arroyo::three_frame:

List of all members.

Public Member Functions
	three_frame ()
	three_frame (const three_frame &tp)
	three_frame (const three_point &tp, const three_vector &x, const three_vector &y, const three_vector &z)
	~three_frame ()
three_frame &	operator= (const three_frame &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
three_vector	x () const
three_vector	y () const
three_vector	z () const
bool	right_handed_frame () const
friend	three_vector::three_vector (double x, double y, double z, const three_frame &tf)
Static Public Attributes
double	precision
	The precision to use in comparison calculations.
int	verbose_level
	A verbose_level for printing messages.
Protected Attributes
double	basis [9]
Friends
bool	operator== (const three_frame &tf1, const three_frame &tf2)

---

Detailed Description

A class to represent a frame in three dimensional space.

---

Constructor & Destructor Documentation

Arroyo::three_frame::three_frame (   )

Null constructor

Arroyo::three_frame::three_frame (  const three_frame &  tp  )

Copy constructor

Arroyo::three_frame::three_frame (  const three_point &  tp, const three_vector &  x, const three_vector &  y, const three_vector &  z )

Construct from a point and 3 vectors These vectors must be orthogonal, but need not be normalized

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

Destructor

---

Member Function Documentation

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

Operator =

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

Print components wrt frame tf Reimplemented from Arroyo::three_point.

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

Print components wrt default frame Reimplemented from Arroyo::three_point.

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

Read from iofits object Reimplemented from Arroyo::three_point. 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::tip_tilt_mirror_base, Arroyo::ideal_tip_tilt_mirror< aperture_type >, and Arroyo::diffractive_wavefront_header< T >.

bool Arroyo::three_frame::right_handed_frame (   )  const

Check if this frame is a right-handed frame. That is, whether X x Y = Z

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

Construct a three vector from coordinates specified relative to a frame tf

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

Write to iofits object Reimplemented from Arroyo::three_point. 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::tip_tilt_mirror_base, Arroyo::ideal_tip_tilt_mirror< aperture_type >, and Arroyo::diffractive_wavefront_header< T >.

three_vector Arroyo::three_frame::x (   )  const

Get x basis vector wrt frame f

three_vector Arroyo::three_frame::y (   )  const

Get y basis vector wrt frame f

three_vector Arroyo::three_frame::z (   )  const

Get z basis vector wrt frame f

---

Friends And Related Function Documentation

bool operator== (  const three_frame &  tf1, const three_frame &  tf2 )  [friend]

Operator==

---

Member Data Documentation

double Arroyo::three_frame::basis[9] [protected]

Nine components defined relative to a global coordinate system

double Arroyo::three_frame::precision [static]

The precision to use in comparison calculations.

int Arroyo::three_frame::verbose_level [static]

A verbose_level for printing messages. Reimplemented from Arroyo::three_point.

---

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

• three_frame.h

---