Arroyo::propagation_plan Class Reference

#include <propagation_plan.h>

Inheritance diagram for Arroyo::propagation_plan:

List of all members.

Public Member Functions
	propagation_plan ()
virtual	~propagation_plan ()
virtual diffractive_wavefront_header< float >	pad (const diffractive_wavefront_header< float > &dwf, double dist) const =0
virtual diffractive_wavefront_header< double >	pad (const diffractive_wavefront_header< double > &dwf, double dist) const =0

---

Detailed Description

A virtual base class for different types of propagation plans

---

Constructor & Destructor Documentation

Arroyo::propagation_plan::propagation_plan (   )  [inline]

Null constructor

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

Virtual destructor

---

Member Function Documentation

virtual diffractive_wavefront_header<double> Arroyo::propagation_plan::pad (  const diffractive_wavefront_header< double > &  dwf, double  dist )  const [pure virtual]

Virtual member function to return a diffractive wavefront header that has been padded enough that subsequent propagation through a distance dist will not corrupt the data within a subarray equal to the original axes of the diffractive wavefront header dwf This member function is defined explicitly for the template argument to diffractive_wavefront_header because virtual template member functions are not supported in C++ Implemented in Arroyo::geometric_propagation_plan, and Arroyo::near_field_fresnel_propagation_plan.

virtual diffractive_wavefront_header<float> Arroyo::propagation_plan::pad (  const diffractive_wavefront_header< float > &  dwf, double  dist )  const [pure virtual]

Virtual member function to return a diffractive wavefront header that has been padded enough that subsequent propagation through a distance dist will not corrupt the data within a subarray equal to the original axes of the diffractive wavefront header dwf This member function is defined explicitly for the template argument to diffractive_wavefront_header because virtual template member functions are not supported in C++ Implemented in Arroyo::geometric_propagation_plan, and Arroyo::near_field_fresnel_propagation_plan.

---

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

• propagation_plan.h

---