Arroyo::circular_aperture Class Reference

#include <aperture.h>

Inheritance diagram for Arroyo::circular_aperture:

List of all members.

Public Member Functions
	circular_aperture ()
	circular_aperture (const circular_aperture &circ_ap)
	circular_aperture (const char *filename)
	circular_aperture (const iofits &iof)
	circular_aperture (double in_diameter)
	~circular_aperture ()
circular_aperture &	operator= (const circular_aperture &circ_ap)
circular_aperture *	clone () const
virtual void	read (const char *filename)
virtual void	read (const iofits &iof)
virtual void	write (const char *filename) const
virtual void	write (iofits &iof) const
void	print (ostream &os, const char *prefix="") const
double	get_diameter () const
rectangular_region	get_covering_region (const three_frame &tf) const
void	transform (diffractive_wavefront< float > &wf) const
void	transform (diffractive_wavefront< double > &wf) const
double	convex_polygon_overlap (const vector< three_point > &polygon_vertices) const

---

Detailed Description

A class to represent a circular aperture.

---

Constructor & Destructor Documentation

Arroyo::circular_aperture::circular_aperture (   )

Null constructor

Arroyo::circular_aperture::circular_aperture (  const circular_aperture &  circ_ap  )

Copy constructor

Arroyo::circular_aperture::circular_aperture (  const char *  filename  )

Construct from file

Arroyo::circular_aperture::circular_aperture (  const iofits &  iof  )

Construct from iofits object

Arroyo::circular_aperture::circular_aperture (  double  in_diameter  )

r Construct from the bits The diameter should be specified in meters

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

Destructor

---

Member Function Documentation

circular_aperture* Arroyo::circular_aperture::clone (   )  const [inline, virtual]

Clone method Calling routine is responsible for deleting memory Implements Arroyo::aperture.

double Arroyo::circular_aperture::convex_polygon_overlap (  const vector< three_point > &  polygon_vertices  )  const [virtual]

Return the overlapping area between a convex polygon and the circular aperture. The vertices of the polygon must lie in the plane of the aperture, or this function throws an error Implements Arroyo::aperture.

rectangular_region Arroyo::circular_aperture::get_covering_region (  const three_frame &  tf  )  const [virtual]

Get a rectangular region guaranteed to cover the aperture. The resulting region will have its edges aligned with the x and y axes of the three_frame tf. If foreshortening is on, the projected region is guaranteed to cover the optic If the z axis of the three_frame is orthogonal to the z axis of the aperture, this function throws an error Implements Arroyo::optic.

double Arroyo::circular_aperture::get_diameter (   )  const [inline]

Return the diameter of the aperture Diameter returned in meters

circular_aperture& Arroyo::circular_aperture::operator= (  const circular_aperture &  circ_ap  )

Operator =

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

Print Reimplemented from Arroyo::aperture.

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

Read from an iofits object Implements Arroyo::aperture.

virtual void Arroyo::circular_aperture::read (  const char *  filename  )  [virtual]

Read from file Implements Arroyo::aperture.

void Arroyo::circular_aperture::transform (  diffractive_wavefront< double > &  wf  )  const [virtual]

Apply the aperture to the wavefront Implements Arroyo::one_to_one_optic.

void Arroyo::circular_aperture::transform (  diffractive_wavefront< float > &  wf  )  const [virtual]

Apply the aperture to the wavefront Implements Arroyo::one_to_one_optic.

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

Write to an iofits object Implements Arroyo::aperture.

virtual void Arroyo::circular_aperture::write (  const char *  filename  )  const [virtual]

Write to file Implements Arroyo::aperture.

---

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

• aperture.h

---