Arroyo::plane_optic Class Reference

#include <optic.h>

Inheritance diagram for Arroyo::plane_optic:

List of all members.

Public Member Functions
	plane_optic ()
	plane_optic (const plane_optic &plane_op)
virtual	~plane_optic ()
plane_optic &	operator= (const plane_optic &plane_op)
virtual void	read (const iofits &iof)
virtual void	write (iofits &iof) const
virtual void	print (ostream &os, const char *prefix="") const
virtual three_point	get_point_of_intersection (const three_point &tp, const three_vector &tv) const
Static Public Member Functions
plane_optic *	plane_optic_factory (const char *filename)
plane_optic *	plane_optic_factory (const iofits &iof)
Protected Member Functions
template<class T>
void	get_projected_wavefront_pixel_spacing (const diffractive_wavefront< T > &wf, three_vector &origin_offset, three_vector &dx, three_vector &dy) const

---

Detailed Description

A virtual base class for a plane_optic.

---

Constructor & Destructor Documentation

Arroyo::plane_optic::plane_optic (   )  [inline]

Null constructor

Arroyo::plane_optic::plane_optic (  const plane_optic &  plane_op  )

Copy constructor

virtual Arroyo::plane_optic::~plane_optic (   )  [inline, virtual]

Virtual destructor

---

Member Function Documentation

virtual three_point Arroyo::plane_optic::get_point_of_intersection (  const three_point &  tp, const three_vector &  tv )  const [virtual]

Get the point of intersection of a line extending from three_point tp in the direction of the three_vector tv and this optic. If there is no intersection point, this function throws an error Implements Arroyo::optic.

template<class T> void Arroyo::plane_optic::get_projected_wavefront_pixel_spacing (  const diffractive_wavefront< T > &  wf, three_vector &  origin_offset, three_vector &  dx, three_vector &  dy )  const [protected]

A simple function to find the projected wavefront pixel spacing in the plane containing the plane_optic

plane_optic& Arroyo::plane_optic::operator= (  const plane_optic &  plane_op  )

Operator =

plane_optic* Arroyo::plane_optic::plane_optic_factory (  const iofits &  iof  )  [static]

Factory to construct optics from file

plane_optic* Arroyo::plane_optic::plane_optic_factory (  const char *  filename  )  [static]

Factory to construct optics from file

virtual void Arroyo::plane_optic::print (  ostream &  os, const char *  prefix = "" )  const [virtual]

Print Reimplemented from Arroyo::optic. 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::square_lenslet_array, Arroyo::refractive_atmospheric_layer< T >, Arroyo::tip_tilt_mirror_base, and Arroyo::ideal_tip_tilt_mirror< aperture_type >.

virtual void Arroyo::plane_optic::read (  const iofits &  iof  )  [virtual]

Read from an iofits object Reimplemented from Arroyo::optic. 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::square_lenslet_array, Arroyo::refractive_atmospheric_layer< T >, Arroyo::tip_tilt_mirror_base, and Arroyo::ideal_tip_tilt_mirror< aperture_type >.

virtual void Arroyo::plane_optic::write (  iofits &  iof  )  const [virtual]

Write to an iofits object Reimplemented from Arroyo::optic. 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::lenslet_array_base, Arroyo::square_lenslet_array, Arroyo::refractive_atmospheric_layer< T >, Arroyo::tip_tilt_mirror_base, and Arroyo::ideal_tip_tilt_mirror< aperture_type >.

---

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

• optic.h

---