Openholo  v4.2
Open Source Digital Holographic Library
ophCascadedPropagation Class Reference

Cascaded propagation module. More...

#include <ophCascadedPropagation.h>

Inheritance diagram for ophCascadedPropagation:
Collaboration diagram for ophCascadedPropagation:

Public Member Functions

 ophCascadedPropagation (const wchar_t *configfilepath)
 Constructor. More...
 
 ~ophCascadedPropagation ()
 Destructor. More...
 
bool propagate ()
 Do cascaded propagation. More...
 
bool save (const wchar_t *pathname, uint8_t bitsperpixel)
 Save wavefield at retina plane as Windows Bitmap file. More...
 
virtual bool saveAsOhc (const char *fname)
 Function to write OHC file. More...
 
virtual bool loadAsOhc (const char *fname)
 Function to read OHC file. More...
 
bool isReadyToPropagate ()
 Returns if all data are prepared. More...
 
oph::uint getNumColors ()
 Returns number of colors. More...
 
oph::vec3 getWavelengths ()
 Returns wavelengths in meter. More...
 
Real getPixelPitchX ()
 Returns horizontal pixel pitch in meter. More...
 
Real getPixelPitchY ()
 Returns vertical pixel pitch in meter. More...
 
oph::uint getResX ()
 Returns horizontal resolution. More...
 
oph::uint getResY ()
 Returns vertical resolution. More...
 
Real getFieldLensFocalLength ()
 Returns focal length of field lens in meter. More...
 
Real getDistObjectToPupil ()
 Returns distance from reconstruction plane to pupil plane in meter. More...
 
Real getDistPupilToRetina ()
 Returns distance from pupil plane to retina plane in meter. More...
 
Real getPupilDiameter ()
 Returns diameter of pupil in meter. More...
 
Real getNor ()
 Returns Nor, which affects the range of output intensity. More...
 
oph::Complex< Real > * getSlmWavefield (oph::uint id)
 Return monochromatic wavefield at SLM plane. More...
 
oph::Complex< Real > * getPupilWavefield (oph::uint id)
 Return monochromatic wavefield at pupil plane. More...
 
oph::Complex< Real > * getRetinaWavefield (oph::uint id)
 Return monochromatic wavefield at retina plane. More...
 
vector< oph::Complex< Real > * > getRetinaWavefieldAll ()
 Return all wavefields at retina plane. More...
 
bool propagateSlmToPupil ()
 Calculates 1st propagation (from SLM plane to pupil plane) More...
 
bool propagatePupilToRetina ()
 Calculates 2nd propagation (from pupil plane to retina plane) More...
 
 ophCascadedPropagation (const wchar_t *configfilepath)
 Constructor. More...
 
 ~ophCascadedPropagation ()
 Destructor. More...
 
bool propagate ()
 Do cascaded propagation. More...
 
bool save (const wchar_t *pathname, uint8_t bitsperpixel)
 Save wavefield at retina plane as Windows Bitmap file. More...
 
virtual bool saveAsOhc (const char *fname)
 Function to write OHC file. More...
 
virtual bool loadAsOhc (const char *fname)
 Function to read OHC file. More...
 
bool isReadyToPropagate ()
 Returns if all data are prepared. More...
 
oph::uint getNumColors ()
 Returns number of colors. More...
 
oph::vec3 getWavelengths ()
 Returns wavelengths in meter. More...
 
Real getPixelPitchX ()
 Returns horizontal pixel pitch in meter. More...
 
Real getPixelPitchY ()
 Returns vertical pixel pitch in meter. More...
 
oph::uint getResX ()
 Returns horizontal resolution. More...
 
oph::uint getResY ()
 Returns vertical resolution. More...
 
Real getFieldLensFocalLength ()
 Returns focal length of field lens in meter. More...
 
Real getDistObjectToPupil ()
 Returns distance from reconstruction plane to pupil plane in meter. More...
 
Real getDistPupilToRetina ()
 Returns distance from pupil plane to retina plane in meter. More...
 
Real getPupilDiameter ()
 Returns diameter of pupil in meter. More...
 
Real getNor ()
 Returns Nor, which affects the range of output intensity. More...
 
oph::Complex< Real > * getSlmWavefield (oph::uint id)
 Return monochromatic wavefield at SLM plane. More...
 
oph::Complex< Real > * getPupilWavefield (oph::uint id)
 Return monochromatic wavefield at pupil plane. More...
 
oph::Complex< Real > * getRetinaWavefield (oph::uint id)
 Return monochromatic wavefield at retina plane. More...
 
vector< oph::Complex< Real > * > getRetinaWavefieldAll ()
 Return all wavefields at retina plane. More...
 
bool propagateSlmToPupil ()
 Calculates 1st propagation (from SLM plane to pupil plane) More...
 
bool propagatePupilToRetina ()
 Calculates 2nd propagation (from pupil plane to retina plane) More...
 
 ophCascadedPropagation (const wchar_t *configfilepath)
 Constructor. More...
 
 ~ophCascadedPropagation ()
 Destructor. More...
 
bool propagate ()
 Do cascaded propagation. More...
 
bool save (const wchar_t *pathname, uint8_t bitsperpixel)
 Save wavefield at retina plane as Windows Bitmap file. More...
 
virtual bool saveAsOhc (const char *fname)
 Function to write OHC file. More...
 
virtual bool loadAsOhc (const char *fname)
 Function to read OHC file. More...
 
bool isReadyToPropagate ()
 Returns if all data are prepared. More...
 
oph::uint getNumColors ()
 Returns number of colors. More...
 
oph::vec3 getWavelengths ()
 Returns wavelengths in meter. More...
 
Real getPixelPitchX ()
 Returns horizontal pixel pitch in meter. More...
 
Real getPixelPitchY ()
 Returns vertical pixel pitch in meter. More...
 
oph::uint getResX ()
 Returns horizontal resolution. More...
 
oph::uint getResY ()
 Returns vertical resolution. More...
 
Real getFieldLensFocalLength ()
 Returns focal length of field lens in meter. More...
 
Real getDistObjectToPupil ()
 Returns distance from reconstruction plane to pupil plane in meter. More...
 
Real getDistPupilToRetina ()
 Returns distance from pupil plane to retina plane in meter. More...
 
Real getPupilDiameter ()
 Returns diameter of pupil in meter. More...
 
Real getNor ()
 Returns Nor, which affects the range of output intensity. More...
 
oph::Complex< Real > * getSlmWavefield (oph::uint id)
 Return monochromatic wavefield at SLM plane. More...
 
oph::Complex< Real > * getPupilWavefield (oph::uint id)
 Return monochromatic wavefield at pupil plane. More...
 
oph::Complex< Real > * getRetinaWavefield (oph::uint id)
 Return monochromatic wavefield at retina plane. More...
 
vector< oph::Complex< Real > * > getRetinaWavefieldAll ()
 Return all wavefields at retina plane. More...
 
bool propagateSlmToPupil ()
 Calculates 1st propagation (from SLM plane to pupil plane) More...
 
bool propagatePupilToRetina ()
 Calculates 2nd propagation (from pupil plane to retina plane) More...
 
 ophCascadedPropagation (const wchar_t *configfilepath)
 Constructor. More...
 
 ~ophCascadedPropagation ()
 Destructor. More...
 
bool propagate ()
 Do cascaded propagation. More...
 
bool save (const wchar_t *pathname, uint8_t bitsperpixel)
 Save wavefield at retina plane as Windows Bitmap file. More...
 
virtual bool saveAsOhc (const char *fname)
 Function to write OHC file. More...
 
virtual bool loadAsOhc (const char *fname)
 Function to read OHC file. More...
 
bool isReadyToPropagate ()
 Returns if all data are prepared. More...
 
oph::uint getNumColors ()
 Returns number of colors. More...
 
oph::vec3 getWavelengths ()
 Returns wavelengths in meter. More...
 
Real getPixelPitchX ()
 Returns horizontal pixel pitch in meter. More...
 
Real getPixelPitchY ()
 Returns vertical pixel pitch in meter. More...
 
oph::uint getResX ()
 Returns horizontal resolution. More...
 
oph::uint getResY ()
 Returns vertical resolution. More...
 
Real getFieldLensFocalLength ()
 Returns focal length of field lens in meter. More...
 
Real getDistObjectToPupil ()
 Returns distance from reconstruction plane to pupil plane in meter. More...
 
Real getDistPupilToRetina ()
 Returns distance from pupil plane to retina plane in meter. More...
 
Real getPupilDiameter ()
 Returns diameter of pupil in meter. More...
 
Real getNor ()
 Returns Nor, which affects the range of output intensity. More...
 
oph::Complex< Real > * getSlmWavefield (oph::uint id)
 Return monochromatic wavefield at SLM plane. More...
 
oph::Complex< Real > * getPupilWavefield (oph::uint id)
 Return monochromatic wavefield at pupil plane. More...
 
oph::Complex< Real > * getRetinaWavefield (oph::uint id)
 Return monochromatic wavefield at retina plane. More...
 
vector< oph::Complex< Real > * > getRetinaWavefieldAll ()
 Return all wavefields at retina plane. More...
 
bool propagateSlmToPupil ()
 Calculates 1st propagation (from SLM plane to pupil plane) More...
 
bool propagatePupilToRetina ()
 Calculates 2nd propagation (from pupil plane to retina plane) More...
 
- Public Member Functions inherited from ophRec
 ophRec (void)
 Constructor. More...
 
void SaveImage (const char *path, const char *ext="bmp")
 
void setConfig (OphRecConfig config)
 
void SetMode (unsigned int mode)
 
OphRecConfiggetConfig ()
 
bool ReconstructImage ()
 
bool readConfig (const char *fname)
 
bool readImage (const char *path)
 
bool readImagePNA (const char *phase, const char *amplitude)
 
bool readImageRNI (const char *real, const char *imaginary)
 
void Perform_Simulation ()
 
void Initialize ()
 
bool save (const char *fname, uint8_t bitsperpixel, uchar *src, uint px, uint py)
 
template<typename T >
void normalize (T *src, uchar *dst, int x, int y)
 
template<typename T >
void normalize (T *src, uchar *dst, int x, int y, T max, T min)
 
 ophRec (void)
 Constructor. More...
 
void SaveImage (const char *path, const char *ext="bmp")
 
void setConfig (OphRecConfig config)
 
void SetMode (unsigned int mode)
 
OphRecConfiggetConfig ()
 
bool ReconstructImage ()
 
bool readConfig (const char *fname)
 
bool readImage (const char *path)
 
bool readImagePNA (const char *phase, const char *amplitude)
 
bool readImageRNI (const char *real, const char *imaginary)
 
void Perform_Simulation ()
 
void Initialize ()
 
bool save (const char *fname, uint8_t bitsperpixel, uchar *src, uint px, uint py)
 
template<typename T >
void normalize (T *src, uchar *dst, int x, int y)
 
template<typename T >
void normalize (T *src, uchar *dst, int x, int y, T max, T min)
 
vector< uchar * > & getNormalizedBuffer ()
 
 ophRec (void)
 Constructor. More...
 
void SaveImage (const char *path, const char *ext="bmp")
 
void setConfig (OphRecConfig config)
 
void SetMode (unsigned int mode)
 
OphRecConfiggetConfig ()
 
bool ReconstructImage ()
 
bool readConfig (const char *fname)
 
bool readImage (const char *path)
 
bool readImagePNA (const char *phase, const char *amplitude)
 
bool readImageRNI (const char *real, const char *imaginary)
 
void Perform_Simulation ()
 
void Initialize ()
 
bool save (const char *fname, uint8_t bitsperpixel, uchar *src, uint px, uint py)
 
template<typename T >
void normalize (T *src, uchar *dst, int x, int y)
 
template<typename T >
void normalize (T *src, uchar *dst, int x, int y, T max, T min)
 
 ophRec (void)
 Constructor. More...
 
void SaveImage (const char *path, const char *ext="bmp")
 
void setConfig (OphRecConfig config)
 
void SetMode (unsigned int mode)
 
OphRecConfiggetConfig ()
 
bool ReconstructImage ()
 
bool readConfig (const char *fname)
 
bool readImage (const char *path)
 
bool readImagePNA (const char *phase, const char *amplitude)
 
bool readImageRNI (const char *real, const char *imaginary)
 
void Perform_Simulation ()
 
void Initialize ()
 
bool save (const char *fname, uint8_t bitsperpixel, uchar *src, uint px, uint py)
 
template<typename T >
void normalize (T *src, uchar *dst, int x, int y)
 
template<typename T >
void normalize (T *src, uchar *dst, int x, int y, T max, T min)
 
vector< uchar * > & getNormalizedBuffer ()
 
- Public Member Functions inherited from Openholo
 Openholo (void)
 Constructor. More...
 
virtual bool saveAsImg (const char *fname, uint8_t bitsperpixel, uchar *src, int width, int height)
 Function for creating image files. More...
 
virtual ucharloadAsImg (const char *fname)
 Function for loading image files. More...
 
Complex< Real > ** getComplexField (void)
 Function for getting the complex field. More...
 
OphConfiggetContext (void)
 Function for getting the current context. More...
 
ImageConfiggetImageConfig ()
 Function for getting the image config. More...
 
void setPixelNumber (ivec2 n)
 Function for setting the output resolution. More...
 
void setPixelNumber (int width, int height)
 
void setPixelPitch (vec2 p)
 Function for setting the output pixel pitch. More...
 
void setPixelPitch (Real pitchX, Real pitchY)
 
void setWaveLength (Real w, const uint idx=0)
 Function for setting the wave length. More...
 
void setWaveNum (int num)
 Function for setting the wave number. More...
 
void setOffset (ivec2 offset)
 Function for setting the offset. More...
 
void setImageMerge (bool merge)
 Function for setting the image merge(true or false) More...
 
void setImageRotate (bool rotate)
 Function for setting the image rotate(true or false) More...
 
void setImageFlip (int flip)
 Function for setting the image flip. More...
 
void setMaxThreadNum (int num)
 Function for setting the max thread num. More...
 
int getMaxThreadNum ()
 Function for getting the max thread num. More...
 
bool mergeColor (int idx, int width, int height, uchar *src, uchar *dst)
 Function for generate RGB image from each grayscale image. More...
 
bool separateColor (int idx, int width, int height, uchar *src, uchar *dst)
 Function for generate each grayscale image from RGB image. More...
 
 Openholo (void)
 Constructor. More...
 
virtual bool saveAsImg (const char *fname, uint8_t bitsperpixel, uchar *src, int width, int height)
 Function for creating image files. More...
 
virtual ucharloadAsImg (const char *fname)
 Function for loading image files. More...
 
Complex< Real > ** getComplexField (void)
 Function for getting the complex field. More...
 
OphConfiggetContext (void)
 Function for getting the current context. More...
 
ImageConfiggetImageConfig ()
 Function for getting the image config. More...
 
void setPixelNumber (ivec2 n)
 Function for setting the output resolution. More...
 
void setPixelNumber (int width, int height)
 
void setPixelPitch (vec2 p)
 Function for setting the output pixel pitch. More...
 
void setPixelPitch (Real pitchX, Real pitchY)
 
void setWaveLength (Real w, const uint idx=0)
 Function for setting the wave length. More...
 
void setWaveNum (int num)
 Function for setting the wave number. More...
 
void setOffset (ivec2 offset)
 Function for setting the offset. More...
 
void setImageMerge (bool merge)
 Function for setting the image merge(true or false) More...
 
void setImageRotate (bool rotate)
 Function for setting the image rotate(true or false) More...
 
void setImageFlip (int flip)
 Function for setting the image flip. More...
 
void setMaxThreadNum (int num)
 Function for setting the max thread num. More...
 
int getMaxThreadNum ()
 Function for getting the max thread num. More...
 
bool mergeColor (int idx, int width, int height, uchar *src, uchar *dst)
 Function for generate RGB image from each grayscale image. More...
 
bool separateColor (int idx, int width, int height, uchar *src, uchar *dst)
 Function for generate each grayscale image from RGB image. More...
 
 Openholo (void)
 Constructor. More...
 
virtual bool saveAsImg (const char *fname, uint8_t bitsperpixel, uchar *src, int width, int height)
 Function for creating image files. More...
 
virtual ucharloadAsImg (const char *fname)
 Function for loading image files. More...
 
Complex< Real > ** getComplexField (void)
 Function for getting the complex field. More...
 
OphConfiggetContext (void)
 Function for getting the current context. More...
 
ImageConfiggetImageConfig ()
 Function for getting the image config. More...
 
void setPixelNumber (ivec2 n)
 Function for setting the output resolution. More...
 
void setPixelNumber (int width, int height)
 
void setPixelPitch (vec2 p)
 Function for setting the output pixel pitch. More...
 
void setPixelPitch (Real pitchX, Real pitchY)
 
void setWaveLength (Real w, const uint idx=0)
 Function for setting the wave length. More...
 
void setWaveNum (int num)
 Function for setting the wave number. More...
 
void setOffset (ivec2 offset)
 Function for setting the offset. More...
 
void setImageMerge (bool merge)
 Function for setting the image merge(true or false) More...
 
void setImageRotate (bool rotate)
 Function for setting the image rotate(true or false) More...
 
void setImageFlip (int flip)
 Function for setting the image flip. More...
 
void setMaxThreadNum (int num)
 Function for setting the max thread num. More...
 
int getMaxThreadNum ()
 Function for getting the max thread num. More...
 
bool mergeColor (int idx, int width, int height, uchar *src, uchar *dst)
 Function for generate RGB image from each grayscale image. More...
 
bool separateColor (int idx, int width, int height, uchar *src, uchar *dst)
 Function for generate each grayscale image from RGB image. More...
 
 Openholo (void)
 Constructor. More...
 
virtual bool saveAsImg (const char *fname, uint8_t bitsperpixel, uchar *src, int width, int height)
 Function for creating image files. More...
 
virtual ucharloadAsImg (const char *fname)
 Function for loading image files. More...
 
Complex< Real > ** getComplexField (void)
 Function for getting the complex field. More...
 
OphConfiggetContext (void)
 Function for getting the current context. More...
 
ImageConfiggetImageConfig ()
 Function for getting the image config. More...
 
void setPixelNumber (ivec2 n)
 Function for setting the output resolution. More...
 
void setPixelNumber (int width, int height)
 
void setPixelPitch (vec2 p)
 Function for setting the output pixel pitch. More...
 
void setPixelPitch (Real pitchX, Real pitchY)
 
void setWaveLength (Real w, const uint idx=0)
 Function for setting the wave length. More...
 
void setWaveNum (int num)
 Function for setting the wave number. More...
 
void setOffset (ivec2 offset)
 Function for setting the offset. More...
 
void setImageMerge (bool merge)
 Function for setting the image merge(true or false) More...
 
void setImageRotate (bool rotate)
 Function for setting the image rotate(true or false) More...
 
void setImageFlip (int flip)
 Function for setting the image flip. More...
 
void setMaxThreadNum (int num)
 Function for setting the max thread num. More...
 
int getMaxThreadNum ()
 Function for getting the max thread num. More...
 
bool mergeColor (int idx, int width, int height, uchar *src, uchar *dst)
 Function for generate RGB image from each grayscale image. More...
 
bool separateColor (int idx, int width, int height, uchar *src, uchar *dst)
 Function for generate each grayscale image from RGB image. More...
 
- Public Member Functions inherited from Base
 Base (void)
 Constructor. More...
 
unsigned long addRef (void)
 If referenced this(Base's child, not abstract class) instance, must call this method. More...
 
unsigned long release (void)
 Call release() when reference is finished. More...
 
 Base (void)
 Constructor. More...
 
unsigned long addRef (void)
 If referenced this(Base's child, not abstract class) instance, must call this method. More...
 
unsigned long release (void)
 Call release() when reference is finished. More...
 
 Base (void)
 Constructor. More...
 
unsigned long addRef (void)
 If referenced this(Base's child, not abstract class) instance, must call this method. More...
 
unsigned long release (void)
 Call release() when reference is finished. More...
 
 Base (void)
 Constructor. More...
 
unsigned long addRef (void)
 If referenced this(Base's child, not abstract class) instance, must call this method. More...
 
unsigned long release (void)
 Call release() when reference is finished. More...
 

Protected Member Functions

virtual void ophFree (void)
 Pure virtual function for override in child classes. More...
 
virtual void ophFree (void)
 Pure virtual function for override in child classes. More...
 
virtual void ophFree (void)
 Pure virtual function for override in child classes. More...
 
virtual void ophFree (void)
 Pure virtual function for override in child classes. More...
 
- Protected Member Functions inherited from ophRec
virtual ~ophRec (void)
 Destructor. More...
 
void Clear ()
 
void GetPupilFieldFromHologram ()
 
void GetPupilFieldFromVWHologram ()
 
void Propagation_Fresnel_FFT (int chnum)
 
void ASM_Propagation ()
 
void ASM_Propagation_GPU ()
 
void GetPupilFieldImage (Complex< Real > *src, double *dst, int pnx, int pny, double ppx, double ppy, double scaleX, double scaleY)
 
void getVarname (int vtr, vec3 &var_vals, std::string &varname2)
 
virtual ~ophRec (void)
 Destructor. More...
 
void Clear ()
 
void GetPupilFieldFromHologram ()
 
void GetPupilFieldFromVWHologram ()
 
void Propagation_Fresnel_FFT (int chnum)
 
void ASM_Propagation ()
 
void ASM_Propagation_GPU ()
 
void GetPupilFieldImage (Complex< Real > *src, double *dst, int pnx, int pny, double ppx, double ppy, double scaleX, double scaleY)
 
void getVarname (int vtr, vec3 &var_vals, std::string &varname2)
 
virtual ~ophRec (void)
 Destructor. More...
 
void Clear ()
 
void GetPupilFieldFromHologram ()
 
void GetPupilFieldFromVWHologram ()
 
void Propagation_Fresnel_FFT (int chnum)
 
void ASM_Propagation ()
 
void ASM_Propagation_GPU ()
 
void GetPupilFieldImage (Complex< Real > *src, double *dst, int pnx, int pny, double ppx, double ppy, double scaleX, double scaleY)
 
void getVarname (int vtr, vec3 &var_vals, std::string &varname2)
 
virtual ~ophRec (void)
 Destructor. More...
 
void Clear ()
 
void GetPupilFieldFromHologram ()
 
void GetPupilFieldFromVWHologram ()
 
void Propagation_Fresnel_FFT (int chnum)
 
void ASM_Propagation ()
 
void ASM_Propagation_GPU ()
 
void GetPupilFieldImage (Complex< Real > *src, double *dst, int pnx, int pny, double ppx, double ppy, double scaleX, double scaleY)
 
void getVarname (int vtr, vec3 &var_vals, std::string &varname2)
 
- Protected Member Functions inherited from Openholo
virtual ~Openholo (void)=0
 Destructor. More...
 
bool checkExtension (const char *fname, const char *ext)
 Functions for extension checking. More...
 
bool loadAsImgUpSideDown (const char *fname, uchar *dst)
 Function for loading image files | Output image data upside down. More...
 
bool getImgSize (int &w, int &h, int &bytesperpixel, const char *fname)
 Function for getting the image size. More...
 
void imgScaleBilinear (uchar *src, uchar *dst, int w, int h, int neww, int newh, int channels=1)
 Function for change image size. More...
 
void convertToFormatGray8 (uchar *src, uchar *dst, int w, int h, int bytesperpixel)
 Function for convert image format to gray8. More...
 
void fft1 (int n, Complex< Real > *in, int sign=OPH_FORWARD, uint flag=OPH_ESTIMATE)
 Functions for performing fftw 1-dimension operations inside Openholo. More...
 
void fft2 (ivec2 n, Complex< Real > *in, int sign=OPH_FORWARD, uint flag=OPH_ESTIMATE)
 Functions for performing fftw 2-dimension operations inside Openholo. More...
 
void fft3 (ivec3 n, Complex< Real > *in, int sign=OPH_FORWARD, uint flag=OPH_ESTIMATE)
 Functions for performing fftw 3-dimension operations inside Openholo. More...
 
void fftExecute (Complex< Real > *out, bool bReverse=false)
 Execution functions to be called after fft1, fft2, and fft3. More...
 
void fftFree (void)
 Resource release method. More...
 
void fftInit2D (ivec2 size, int sign, unsigned int flag)
 initialize method for 2D FFT More...
 
void fft2 (Complex< Real > *src, Complex< Real > *dst, int nx, int ny, int type, bool bNormalized=false)
 Convert data from the spatial domain to the frequency domain using 2D FFT on CPU. More...
 
void fftShift (int nx, int ny, Complex< Real > *input, Complex< Real > *output)
 Swap the top-left quadrant of data with the bottom-right , and the top-right quadrant with the bottom-left. More...
 
void setPixelNumberOHC (const ivec2 pixel_number)
 getter/setter for OHC file read and write More...
 
void setPixelPitchOHC (const vec2 pixel_pitch)
 
void setWavelengthOHC (const Real wavelength, const LenUnit wavelength_unit)
 
void setWaveLengthNumOHC (const uint wavelength_num)
 
void setColorTypeOHC (const ColorType color_type)
 
void setColorArrangeOHC (const ColorArran color_arrange)
 
void setWaveLengthUnitOHC (const LenUnit length_unit)
 
void setFieldEncodingOHC (const FldStore field_store, const FldCodeType field_code_type)
 
void setPhaseEncodingOHC (const BPhaseCode phase_code, const vec2 phase_code_range)
 
void addWaveLengthNComplexFieldDataOHC (const Real wavelength, const OphComplexField &complex_field)
 Function to add ComplexField when adding wavelength data. More...
 
void addWaveLengthOHC (const Real wavelength)
 
void addComplexFieldDataOHC (const OphComplexField &complex_field)
 
void getPixelNumberOHC (ivec2 &pixel_number)
 
void getPixelPitchOHC (vec2 &pixel_pitch)
 
void getWavelengthOHC (vector< Real > &wavelength)
 
void getWaveLengthNumOHC (uint &wavelength_num)
 
void getColorTypeOHC (ColorType &color_type)
 
void getColorArrangeOHC (ColorArran &color_arrange)
 
void getWaveLengthUnitOHC (LenUnit &length_unit)
 
void getComplexFieldDataOHC (Complex< Real > **cmplx, uint wavelen_idx)
 
void getComplexFieldDataOHC (OphComplexField &cmplx, uint wavelen_idx)
 
virtual ~Openholo (void)=0
 Destructor. More...
 
bool checkExtension (const char *fname, const char *ext)
 Functions for extension checking. More...
 
bool loadAsImgUpSideDown (const char *fname, uchar *dst)
 Function for loading image files | Output image data upside down. More...
 
bool getImgSize (int &w, int &h, int &bytesperpixel, const char *fname)
 Function for getting the image size. More...
 
void imgScaleBilinear (uchar *src, uchar *dst, int w, int h, int neww, int newh, int channels=1)
 Function for change image size. More...
 
void convertToFormatGray8 (uchar *src, uchar *dst, int w, int h, int bytesperpixel)
 Function for convert image format to gray8. More...
 
void fft1 (int n, Complex< Real > *in, int sign=OPH_FORWARD, uint flag=OPH_ESTIMATE)
 Functions for performing fftw 1-dimension operations inside Openholo. More...
 
void fft2 (ivec2 n, Complex< Real > *in, int sign=OPH_FORWARD, uint flag=OPH_ESTIMATE)
 Functions for performing fftw 2-dimension operations inside Openholo. More...
 
void fft3 (ivec3 n, Complex< Real > *in, int sign=OPH_FORWARD, uint flag=OPH_ESTIMATE)
 Functions for performing fftw 3-dimension operations inside Openholo. More...
 
void fftExecute (Complex< Real > *out, bool bReverse=false)
 Execution functions to be called after fft1, fft2, and fft3. More...
 
void fftFree (void)
 Resource release method. More...
 
void fftInit2D (ivec2 size, int sign, unsigned int flag)
 initialize method for 2D FFT More...
 
void fft2 (Complex< Real > *src, Complex< Real > *dst, int nx, int ny, int type, bool bNormalized=false)
 Convert data from the spatial domain to the frequency domain using 2D FFT on CPU. More...
 
void fftShift (int nx, int ny, Complex< Real > *input, Complex< Real > *output)
 Swap the top-left quadrant of data with the bottom-right , and the top-right quadrant with the bottom-left. More...
 
void setPixelNumberOHC (const ivec2 pixel_number)
 getter/setter for OHC file read and write More...
 
void setPixelPitchOHC (const vec2 pixel_pitch)
 
void setWavelengthOHC (const Real wavelength, const LenUnit wavelength_unit)
 
void setWaveLengthNumOHC (const uint wavelength_num)
 
void setColorTypeOHC (const ColorType color_type)
 
void setColorArrangeOHC (const ColorArran color_arrange)
 
void setWaveLengthUnitOHC (const LenUnit length_unit)
 
void setFieldEncodingOHC (const FldStore field_store, const FldCodeType field_code_type)
 
void setPhaseEncodingOHC (const BPhaseCode phase_code, const vec2 phase_code_range)
 
void addWaveLengthNComplexFieldDataOHC (const Real wavelength, const OphComplexField &complex_field)
 Function to add ComplexField when adding wavelength data. More...
 
void addWaveLengthOHC (const Real wavelength)
 
void addComplexFieldDataOHC (const OphComplexField &complex_field)
 
void getPixelNumberOHC (ivec2 &pixel_number)
 
void getPixelPitchOHC (vec2 &pixel_pitch)
 
void getWavelengthOHC (vector< Real > &wavelength)
 
void getWaveLengthNumOHC (uint &wavelength_num)
 
void getColorTypeOHC (ColorType &color_type)
 
void getColorArrangeOHC (ColorArran &color_arrange)
 
void getWaveLengthUnitOHC (LenUnit &length_unit)
 
void getComplexFieldDataOHC (Complex< Real > **cmplx, uint wavelen_idx)
 
void getComplexFieldDataOHC (OphComplexField &cmplx, uint wavelen_idx)
 
virtual ~Openholo (void)=0
 Destructor. More...
 
bool checkExtension (const char *fname, const char *ext)
 Functions for extension checking. More...
 
bool loadAsImgUpSideDown (const char *fname, uchar *dst)
 Function for loading image files | Output image data upside down. More...
 
bool getImgSize (int &w, int &h, int &bytesperpixel, const char *fname)
 Function for getting the image size. More...
 
void imgScaleBilinear (uchar *src, uchar *dst, int w, int h, int neww, int newh, int channels=1)
 Function for change image size. More...
 
void convertToFormatGray8 (uchar *src, uchar *dst, int w, int h, int bytesperpixel)
 Function for convert image format to gray8. More...
 
void fft1 (int n, Complex< Real > *in, int sign=OPH_FORWARD, uint flag=OPH_ESTIMATE)
 Functions for performing fftw 1-dimension operations inside Openholo. More...
 
void fft2 (ivec2 n, Complex< Real > *in, int sign=OPH_FORWARD, uint flag=OPH_ESTIMATE)
 Functions for performing fftw 2-dimension operations inside Openholo. More...
 
void fft3 (ivec3 n, Complex< Real > *in, int sign=OPH_FORWARD, uint flag=OPH_ESTIMATE)
 Functions for performing fftw 3-dimension operations inside Openholo. More...
 
void fftExecute (Complex< Real > *out, bool bReverse=false)
 Execution functions to be called after fft1, fft2, and fft3. More...
 
void fftFree (void)
 Resource release method. More...
 
void fftInit2D (ivec2 size, int sign, unsigned int flag)
 initialize method for 2D FFT More...
 
void fft2 (Complex< Real > *src, Complex< Real > *dst, int nx, int ny, int type, bool bNormalized=false)
 Convert data from the spatial domain to the frequency domain using 2D FFT on CPU. More...
 
void fftShift (int nx, int ny, Complex< Real > *input, Complex< Real > *output)
 Swap the top-left quadrant of data with the bottom-right , and the top-right quadrant with the bottom-left. More...
 
void setPixelNumberOHC (const ivec2 pixel_number)
 getter/setter for OHC file read and write More...
 
void setPixelPitchOHC (const vec2 pixel_pitch)
 
void setWavelengthOHC (const Real wavelength, const LenUnit wavelength_unit)
 
void setWaveLengthNumOHC (const uint wavelength_num)
 
void setColorTypeOHC (const ColorType color_type)
 
void setColorArrangeOHC (const ColorArran color_arrange)
 
void setWaveLengthUnitOHC (const LenUnit length_unit)
 
void setFieldEncodingOHC (const FldStore field_store, const FldCodeType field_code_type)
 
void setPhaseEncodingOHC (const BPhaseCode phase_code, const vec2 phase_code_range)
 
void addWaveLengthNComplexFieldDataOHC (const Real wavelength, const OphComplexField &complex_field)
 Function to add ComplexField when adding wavelength data. More...
 
void addWaveLengthOHC (const Real wavelength)
 
void addComplexFieldDataOHC (const OphComplexField &complex_field)
 
void getPixelNumberOHC (ivec2 &pixel_number)
 
void getPixelPitchOHC (vec2 &pixel_pitch)
 
void getWavelengthOHC (vector< Real > &wavelength)
 
void getWaveLengthNumOHC (uint &wavelength_num)
 
void getColorTypeOHC (ColorType &color_type)
 
void getColorArrangeOHC (ColorArran &color_arrange)
 
void getWaveLengthUnitOHC (LenUnit &length_unit)
 
void getComplexFieldDataOHC (Complex< Real > **cmplx, uint wavelen_idx)
 
void getComplexFieldDataOHC (OphComplexField &cmplx, uint wavelen_idx)
 
virtual ~Openholo (void)=0
 Destructor. More...
 
bool checkExtension (const char *fname, const char *ext)
 Functions for extension checking. More...
 
bool loadAsImgUpSideDown (const char *fname, uchar *dst)
 Function for loading image files | Output image data upside down. More...
 
bool getImgSize (int &w, int &h, int &bytesperpixel, const char *fname)
 Function for getting the image size. More...
 
void imgScaleBilinear (uchar *src, uchar *dst, int w, int h, int neww, int newh, int channels=1)
 Function for change image size. More...
 
void convertToFormatGray8 (uchar *src, uchar *dst, int w, int h, int bytesperpixel)
 Function for convert image format to gray8. More...
 
void fft1 (int n, Complex< Real > *in, int sign=OPH_FORWARD, uint flag=OPH_ESTIMATE)
 Functions for performing fftw 1-dimension operations inside Openholo. More...
 
void fft2 (ivec2 n, Complex< Real > *in, int sign=OPH_FORWARD, uint flag=OPH_ESTIMATE)
 Functions for performing fftw 2-dimension operations inside Openholo. More...
 
void fft3 (ivec3 n, Complex< Real > *in, int sign=OPH_FORWARD, uint flag=OPH_ESTIMATE)
 Functions for performing fftw 3-dimension operations inside Openholo. More...
 
void fftExecute (Complex< Real > *out, bool bReverse=false)
 Execution functions to be called after fft1, fft2, and fft3. More...
 
void fftFree (void)
 Resource release method. More...
 
void fftInit2D (ivec2 size, int sign, unsigned int flag)
 initialize method for 2D FFT More...
 
void fft2 (Complex< Real > *src, Complex< Real > *dst, int nx, int ny, int type, bool bNormalized=false)
 Convert data from the spatial domain to the frequency domain using 2D FFT on CPU. More...
 
void fftShift (int nx, int ny, Complex< Real > *input, Complex< Real > *output)
 Swap the top-left quadrant of data with the bottom-right , and the top-right quadrant with the bottom-left. More...
 
void setPixelNumberOHC (const ivec2 pixel_number)
 getter/setter for OHC file read and write More...
 
void setPixelPitchOHC (const vec2 pixel_pitch)
 
void setWavelengthOHC (const Real wavelength, const LenUnit wavelength_unit)
 
void setWaveLengthNumOHC (const uint wavelength_num)
 
void setColorTypeOHC (const ColorType color_type)
 
void setColorArrangeOHC (const ColorArran color_arrange)
 
void setWaveLengthUnitOHC (const LenUnit length_unit)
 
void setFieldEncodingOHC (const FldStore field_store, const FldCodeType field_code_type)
 
void setPhaseEncodingOHC (const BPhaseCode phase_code, const vec2 phase_code_range)
 
void addWaveLengthNComplexFieldDataOHC (const Real wavelength, const OphComplexField &complex_field)
 Function to add ComplexField when adding wavelength data. More...
 
void addWaveLengthOHC (const Real wavelength)
 
void addComplexFieldDataOHC (const OphComplexField &complex_field)
 
void getPixelNumberOHC (ivec2 &pixel_number)
 
void getPixelPitchOHC (vec2 &pixel_pitch)
 
void getWavelengthOHC (vector< Real > &wavelength)
 
void getWaveLengthNumOHC (uint &wavelength_num)
 
void getColorTypeOHC (ColorType &color_type)
 
void getColorArrangeOHC (ColorArran &color_arrange)
 
void getWaveLengthUnitOHC (LenUnit &length_unit)
 
void getComplexFieldDataOHC (Complex< Real > **cmplx, uint wavelen_idx)
 
void getComplexFieldDataOHC (OphComplexField &cmplx, uint wavelen_idx)
 
- Protected Member Functions inherited from Base
virtual ~Base (void)
 Destructor. More...
 
virtual ~Base (void)
 Destructor. More...
 
virtual ~Base (void)
 Destructor. More...
 
virtual ~Base (void)
 Destructor. More...
 

Additional Inherited Members

- Protected Attributes inherited from Openholo
OphConfig context_
 
ResolutionConfig resCfg
 
ImageConfig imgCfg
 
Complex< Real > ** complex_H
 
ImgEncoderOhcOHC_encoder
 OHC file format Variables for read and write. More...
 
ImgDecoderOhcOHC_decoder
 
- Protected Attributes inherited from Base
unsigned long refCnt
 

Detailed Description

Cascaded propagation module.

Author
Seunghyup Shin

Definition at line 159 of file ophCascadedPropagation.h.

Constructor & Destructor Documentation

◆ ophCascadedPropagation() [1/4]

ophCascadedPropagation::ophCascadedPropagation ( const wchar_t *  configfilepath)

Constructor.

Parameters
configfilepathabsolute or relative path of configuration file

Definition at line 60 of file ophCascadedPropagation.cpp.

◆ ~ophCascadedPropagation() [1/4]

ophCascadedPropagation::~ophCascadedPropagation ( )

Destructor.

Definition at line 72 of file ophCascadedPropagation.cpp.

◆ ophCascadedPropagation() [2/4]

ophCascadedPropagation::ophCascadedPropagation ( const wchar_t *  configfilepath)

Constructor.

Parameters
configfilepathabsolute or relative path of configuration file

◆ ~ophCascadedPropagation() [2/4]

ophCascadedPropagation::~ophCascadedPropagation ( )

Destructor.

◆ ophCascadedPropagation() [3/4]

ophCascadedPropagation::ophCascadedPropagation ( const wchar_t *  configfilepath)

Constructor.

Parameters
configfilepathabsolute or relative path of configuration file

◆ ~ophCascadedPropagation() [3/4]

ophCascadedPropagation::~ophCascadedPropagation ( )

Destructor.

◆ ophCascadedPropagation() [4/4]

ophCascadedPropagation::ophCascadedPropagation ( const wchar_t *  configfilepath)

Constructor.

Parameters
configfilepathabsolute or relative path of configuration file

◆ ~ophCascadedPropagation() [4/4]

ophCascadedPropagation::~ophCascadedPropagation ( )

Destructor.

Member Function Documentation

◆ getDistObjectToPupil() [1/4]

Real ophCascadedPropagation::getDistObjectToPupil ( )
inline

Returns distance from reconstruction plane to pupil plane in meter.

Definition at line 321 of file ophCascadedPropagation.h.

◆ getDistObjectToPupil() [2/4]

Real ophCascadedPropagation::getDistObjectToPupil ( )
inline

Returns distance from reconstruction plane to pupil plane in meter.

Definition at line 321 of file ophCascadedPropagation.h.

◆ getDistObjectToPupil() [3/4]

Real ophCascadedPropagation::getDistObjectToPupil ( )
inline

Returns distance from reconstruction plane to pupil plane in meter.

Definition at line 321 of file ophCascadedPropagation.h.

◆ getDistObjectToPupil() [4/4]

Real ophCascadedPropagation::getDistObjectToPupil ( )
inline

Returns distance from reconstruction plane to pupil plane in meter.

Definition at line 321 of file ophCascadedPropagation.h.

◆ getDistPupilToRetina() [1/4]

Real ophCascadedPropagation::getDistPupilToRetina ( )
inline

Returns distance from pupil plane to retina plane in meter.

Definition at line 326 of file ophCascadedPropagation.h.

◆ getDistPupilToRetina() [2/4]

Real ophCascadedPropagation::getDistPupilToRetina ( )
inline

Returns distance from pupil plane to retina plane in meter.

Definition at line 326 of file ophCascadedPropagation.h.

◆ getDistPupilToRetina() [3/4]

Real ophCascadedPropagation::getDistPupilToRetina ( )
inline

Returns distance from pupil plane to retina plane in meter.

Definition at line 326 of file ophCascadedPropagation.h.

◆ getDistPupilToRetina() [4/4]

Real ophCascadedPropagation::getDistPupilToRetina ( )
inline

Returns distance from pupil plane to retina plane in meter.

Definition at line 326 of file ophCascadedPropagation.h.

◆ getFieldLensFocalLength() [1/4]

Real ophCascadedPropagation::getFieldLensFocalLength ( )
inline

Returns focal length of field lens in meter.

Definition at line 316 of file ophCascadedPropagation.h.

◆ getFieldLensFocalLength() [2/4]

Real ophCascadedPropagation::getFieldLensFocalLength ( )
inline

Returns focal length of field lens in meter.

Definition at line 316 of file ophCascadedPropagation.h.

◆ getFieldLensFocalLength() [3/4]

Real ophCascadedPropagation::getFieldLensFocalLength ( )
inline

Returns focal length of field lens in meter.

Definition at line 316 of file ophCascadedPropagation.h.

◆ getFieldLensFocalLength() [4/4]

Real ophCascadedPropagation::getFieldLensFocalLength ( )
inline

Returns focal length of field lens in meter.

Definition at line 316 of file ophCascadedPropagation.h.

◆ getNor() [1/4]

Real ophCascadedPropagation::getNor ( )
inline

Returns Nor, which affects the range of output intensity.

Nor is NOT intuitive at all and should be changed sometime

Definition at line 337 of file ophCascadedPropagation.h.

◆ getNor() [2/4]

Real ophCascadedPropagation::getNor ( )
inline

Returns Nor, which affects the range of output intensity.

Nor is NOT intuitive at all and should be changed sometime

Definition at line 337 of file ophCascadedPropagation.h.

◆ getNor() [3/4]

Real ophCascadedPropagation::getNor ( )
inline

Returns Nor, which affects the range of output intensity.

Nor is NOT intuitive at all and should be changed sometime

Definition at line 337 of file ophCascadedPropagation.h.

◆ getNor() [4/4]

Real ophCascadedPropagation::getNor ( )
inline

Returns Nor, which affects the range of output intensity.

Nor is NOT intuitive at all and should be changed sometime

Definition at line 337 of file ophCascadedPropagation.h.

◆ getNumColors() [1/4]

oph::uint ophCascadedPropagation::getNumColors ( )
inline

Returns number of colors.

Definition at line 286 of file ophCascadedPropagation.h.

◆ getNumColors() [2/4]

oph::uint ophCascadedPropagation::getNumColors ( )
inline

Returns number of colors.

Definition at line 286 of file ophCascadedPropagation.h.

◆ getNumColors() [3/4]

oph::uint ophCascadedPropagation::getNumColors ( )
inline

Returns number of colors.

Definition at line 286 of file ophCascadedPropagation.h.

◆ getNumColors() [4/4]

oph::uint ophCascadedPropagation::getNumColors ( )
inline

Returns number of colors.

Definition at line 286 of file ophCascadedPropagation.h.

◆ getPixelPitchX() [1/4]

Real ophCascadedPropagation::getPixelPitchX ( )
inline

Returns horizontal pixel pitch in meter.

Definition at line 296 of file ophCascadedPropagation.h.

◆ getPixelPitchX() [2/4]

Real ophCascadedPropagation::getPixelPitchX ( )
inline

Returns horizontal pixel pitch in meter.

Definition at line 296 of file ophCascadedPropagation.h.

◆ getPixelPitchX() [3/4]

Real ophCascadedPropagation::getPixelPitchX ( )
inline

Returns horizontal pixel pitch in meter.

Definition at line 296 of file ophCascadedPropagation.h.

◆ getPixelPitchX() [4/4]

Real ophCascadedPropagation::getPixelPitchX ( )
inline

Returns horizontal pixel pitch in meter.

Definition at line 296 of file ophCascadedPropagation.h.

◆ getPixelPitchY() [1/4]

Real ophCascadedPropagation::getPixelPitchY ( )
inline

Returns vertical pixel pitch in meter.

Definition at line 301 of file ophCascadedPropagation.h.

◆ getPixelPitchY() [2/4]

Real ophCascadedPropagation::getPixelPitchY ( )
inline

Returns vertical pixel pitch in meter.

Definition at line 301 of file ophCascadedPropagation.h.

◆ getPixelPitchY() [3/4]

Real ophCascadedPropagation::getPixelPitchY ( )
inline

Returns vertical pixel pitch in meter.

Definition at line 301 of file ophCascadedPropagation.h.

◆ getPixelPitchY() [4/4]

Real ophCascadedPropagation::getPixelPitchY ( )
inline

Returns vertical pixel pitch in meter.

Definition at line 301 of file ophCascadedPropagation.h.

◆ getPupilDiameter() [1/4]

Real ophCascadedPropagation::getPupilDiameter ( )
inline

Returns diameter of pupil in meter.

Definition at line 331 of file ophCascadedPropagation.h.

◆ getPupilDiameter() [2/4]

Real ophCascadedPropagation::getPupilDiameter ( )
inline

Returns diameter of pupil in meter.

Definition at line 331 of file ophCascadedPropagation.h.

◆ getPupilDiameter() [3/4]

Real ophCascadedPropagation::getPupilDiameter ( )
inline

Returns diameter of pupil in meter.

Definition at line 331 of file ophCascadedPropagation.h.

◆ getPupilDiameter() [4/4]

Real ophCascadedPropagation::getPupilDiameter ( )
inline

Returns diameter of pupil in meter.

Definition at line 331 of file ophCascadedPropagation.h.

◆ getPupilWavefield() [1/4]

oph::Complex<Real>* ophCascadedPropagation::getPupilWavefield ( oph::uint  id)

Return monochromatic wavefield at pupil plane.

◆ getPupilWavefield() [2/4]

oph::Complex< Real > * ophCascadedPropagation::getPupilWavefield ( oph::uint  id)

Return monochromatic wavefield at pupil plane.

Definition at line 499 of file ophCascadedPropagation.cpp.

◆ getPupilWavefield() [3/4]

oph::Complex<Real>* ophCascadedPropagation::getPupilWavefield ( oph::uint  id)

Return monochromatic wavefield at pupil plane.

◆ getPupilWavefield() [4/4]

oph::Complex<Real>* ophCascadedPropagation::getPupilWavefield ( oph::uint  id)

Return monochromatic wavefield at pupil plane.

◆ getResX() [1/4]

oph::uint ophCascadedPropagation::getResX ( )
inline

Returns horizontal resolution.

Definition at line 306 of file ophCascadedPropagation.h.

◆ getResX() [2/4]

oph::uint ophCascadedPropagation::getResX ( )
inline

Returns horizontal resolution.

Definition at line 306 of file ophCascadedPropagation.h.

◆ getResX() [3/4]

oph::uint ophCascadedPropagation::getResX ( )
inline

Returns horizontal resolution.

Definition at line 306 of file ophCascadedPropagation.h.

◆ getResX() [4/4]

oph::uint ophCascadedPropagation::getResX ( )
inline

Returns horizontal resolution.

Definition at line 306 of file ophCascadedPropagation.h.

◆ getResY() [1/4]

oph::uint ophCascadedPropagation::getResY ( )
inline

Returns vertical resolution.

Definition at line 311 of file ophCascadedPropagation.h.

◆ getResY() [2/4]

oph::uint ophCascadedPropagation::getResY ( )
inline

Returns vertical resolution.

Definition at line 311 of file ophCascadedPropagation.h.

◆ getResY() [3/4]

oph::uint ophCascadedPropagation::getResY ( )
inline

Returns vertical resolution.

Definition at line 311 of file ophCascadedPropagation.h.

◆ getResY() [4/4]

oph::uint ophCascadedPropagation::getResY ( )
inline

Returns vertical resolution.

Definition at line 311 of file ophCascadedPropagation.h.

◆ getRetinaWavefield() [1/4]

oph::Complex<Real>* ophCascadedPropagation::getRetinaWavefield ( oph::uint  id)

Return monochromatic wavefield at retina plane.

◆ getRetinaWavefield() [2/4]

oph::Complex< Real > * ophCascadedPropagation::getRetinaWavefield ( oph::uint  id)

Return monochromatic wavefield at retina plane.

Definition at line 506 of file ophCascadedPropagation.cpp.

◆ getRetinaWavefield() [3/4]

oph::Complex<Real>* ophCascadedPropagation::getRetinaWavefield ( oph::uint  id)

Return monochromatic wavefield at retina plane.

◆ getRetinaWavefield() [4/4]

oph::Complex<Real>* ophCascadedPropagation::getRetinaWavefield ( oph::uint  id)

Return monochromatic wavefield at retina plane.

◆ getRetinaWavefieldAll() [1/4]

vector<oph::Complex<Real>*> ophCascadedPropagation::getRetinaWavefieldAll ( )

Return all wavefields at retina plane.

◆ getRetinaWavefieldAll() [2/4]

vector<oph::Complex<Real>*> ophCascadedPropagation::getRetinaWavefieldAll ( )

Return all wavefields at retina plane.

◆ getRetinaWavefieldAll() [3/4]

vector< oph::Complex< Real > * > ophCascadedPropagation::getRetinaWavefieldAll ( )

Return all wavefields at retina plane.

Definition at line 513 of file ophCascadedPropagation.cpp.

◆ getRetinaWavefieldAll() [4/4]

vector<oph::Complex<Real>*> ophCascadedPropagation::getRetinaWavefieldAll ( )

Return all wavefields at retina plane.

◆ getSlmWavefield() [1/4]

oph::Complex< Real > * ophCascadedPropagation::getSlmWavefield ( oph::uint  id)

Return monochromatic wavefield at SLM plane.

Definition at line 492 of file ophCascadedPropagation.cpp.

◆ getSlmWavefield() [2/4]

oph::Complex<Real>* ophCascadedPropagation::getSlmWavefield ( oph::uint  id)

Return monochromatic wavefield at SLM plane.

◆ getSlmWavefield() [3/4]

oph::Complex<Real>* ophCascadedPropagation::getSlmWavefield ( oph::uint  id)

Return monochromatic wavefield at SLM plane.

◆ getSlmWavefield() [4/4]

oph::Complex<Real>* ophCascadedPropagation::getSlmWavefield ( oph::uint  id)

Return monochromatic wavefield at SLM plane.

◆ getWavelengths() [1/4]

oph::vec3 ophCascadedPropagation::getWavelengths ( )
inline

Returns wavelengths in meter.

Definition at line 291 of file ophCascadedPropagation.h.

◆ getWavelengths() [2/4]

oph::vec3 ophCascadedPropagation::getWavelengths ( )
inline

Returns wavelengths in meter.

Definition at line 291 of file ophCascadedPropagation.h.

◆ getWavelengths() [3/4]

oph::vec3 ophCascadedPropagation::getWavelengths ( )
inline

Returns wavelengths in meter.

Definition at line 291 of file ophCascadedPropagation.h.

◆ getWavelengths() [4/4]

oph::vec3 ophCascadedPropagation::getWavelengths ( )
inline

Returns wavelengths in meter.

Definition at line 291 of file ophCascadedPropagation.h.

◆ isReadyToPropagate() [1/4]

bool ophCascadedPropagation::isReadyToPropagate ( )
inline

Returns if all data are prepared.

Definition at line 281 of file ophCascadedPropagation.h.

◆ isReadyToPropagate() [2/4]

bool ophCascadedPropagation::isReadyToPropagate ( )
inline

Returns if all data are prepared.

Definition at line 281 of file ophCascadedPropagation.h.

◆ isReadyToPropagate() [3/4]

bool ophCascadedPropagation::isReadyToPropagate ( )
inline

Returns if all data are prepared.

Definition at line 281 of file ophCascadedPropagation.h.

◆ isReadyToPropagate() [4/4]

bool ophCascadedPropagation::isReadyToPropagate ( )
inline

Returns if all data are prepared.

Definition at line 281 of file ophCascadedPropagation.h.

◆ loadAsOhc() [1/4]

virtual bool ophCascadedPropagation::loadAsOhc ( const char *  fname)
virtual

Function to read OHC file.

Reimplemented from Openholo.

◆ loadAsOhc() [2/4]

bool ophCascadedPropagation::loadAsOhc ( const char *  fname)
virtual

Function to read OHC file.

Reimplemented from Openholo.

Definition at line 132 of file ophCascadedPropagation.cpp.

◆ loadAsOhc() [3/4]

virtual bool ophCascadedPropagation::loadAsOhc ( const char *  fname)
virtual

Function to read OHC file.

Reimplemented from Openholo.

◆ loadAsOhc() [4/4]

virtual bool ophCascadedPropagation::loadAsOhc ( const char *  fname)
virtual

Function to read OHC file.

Reimplemented from Openholo.

◆ ophFree() [1/4]

virtual void ophCascadedPropagation::ophFree ( void  )
protectedvirtual

Pure virtual function for override in child classes.

Reimplemented from ophRec.

◆ ophFree() [2/4]

virtual void ophCascadedPropagation::ophFree ( void  )
protectedvirtual

Pure virtual function for override in child classes.

Reimplemented from ophRec.

◆ ophFree() [3/4]

void ophCascadedPropagation::ophFree ( void  )
protectedvirtual

Pure virtual function for override in child classes.

Reimplemented from ophRec.

Definition at line 76 of file ophCascadedPropagation.cpp.

◆ ophFree() [4/4]

virtual void ophCascadedPropagation::ophFree ( void  )
protectedvirtual

Pure virtual function for override in child classes.

Reimplemented from ophRec.

◆ propagate() [1/4]

bool ophCascadedPropagation::propagate ( )

Do cascaded propagation.

Returns
true if successful
false when failed

◆ propagate() [2/4]

bool ophCascadedPropagation::propagate ( )

Do cascaded propagation.

Returns
true if successful
false when failed

◆ propagate() [3/4]

bool ophCascadedPropagation::propagate ( )

Do cascaded propagation.

Returns
true if successful
false when failed

Definition at line 81 of file ophCascadedPropagation.cpp.

◆ propagate() [4/4]

bool ophCascadedPropagation::propagate ( )

Do cascaded propagation.

Returns
true if successful
false when failed

◆ propagatePupilToRetina() [1/4]

bool ophCascadedPropagation::propagatePupilToRetina ( )

Calculates 2nd propagation (from pupil plane to retina plane)

Returns
true if successful
false when failed

Definition at line 451 of file ophCascadedPropagation.cpp.

◆ propagatePupilToRetina() [2/4]

bool ophCascadedPropagation::propagatePupilToRetina ( )

Calculates 2nd propagation (from pupil plane to retina plane)

Returns
true if successful
false when failed

◆ propagatePupilToRetina() [3/4]

bool ophCascadedPropagation::propagatePupilToRetina ( )

Calculates 2nd propagation (from pupil plane to retina plane)

Returns
true if successful
false when failed

◆ propagatePupilToRetina() [4/4]

bool ophCascadedPropagation::propagatePupilToRetina ( )

Calculates 2nd propagation (from pupil plane to retina plane)

Returns
true if successful
false when failed

◆ propagateSlmToPupil() [1/4]

bool ophCascadedPropagation::propagateSlmToPupil ( )

Calculates 1st propagation (from SLM plane to pupil plane)

Returns
true if successful
false when failed

Definition at line 401 of file ophCascadedPropagation.cpp.

◆ propagateSlmToPupil() [2/4]

bool ophCascadedPropagation::propagateSlmToPupil ( )

Calculates 1st propagation (from SLM plane to pupil plane)

Returns
true if successful
false when failed

◆ propagateSlmToPupil() [3/4]

bool ophCascadedPropagation::propagateSlmToPupil ( )

Calculates 1st propagation (from SLM plane to pupil plane)

Returns
true if successful
false when failed

◆ propagateSlmToPupil() [4/4]

bool ophCascadedPropagation::propagateSlmToPupil ( )

Calculates 1st propagation (from SLM plane to pupil plane)

Returns
true if successful
false when failed

◆ save() [1/4]

bool ophCascadedPropagation::save ( const wchar_t *  pathname,
uint8_t  bitsperpixel 
)

Save wavefield at retina plane as Windows Bitmap file.

Parameters
pathnameabsolute or relative path of output file
bitsperpixelnumber of bits per pixel
Returns
true if successfully saved
false when failed

◆ save() [2/4]

bool ophCascadedPropagation::save ( const wchar_t *  pathname,
uint8_t  bitsperpixel 
)

Save wavefield at retina plane as Windows Bitmap file.

Parameters
pathnameabsolute or relative path of output file
bitsperpixelnumber of bits per pixel
Returns
true if successfully saved
false when failed

◆ save() [3/4]

bool ophCascadedPropagation::save ( const wchar_t *  pathname,
uint8_t  bitsperpixel 
)

Save wavefield at retina plane as Windows Bitmap file.

Parameters
pathnameabsolute or relative path of output file
bitsperpixelnumber of bits per pixel
Returns
true if successfully saved
false when failed

Definition at line 104 of file ophCascadedPropagation.cpp.

◆ save() [4/4]

bool ophCascadedPropagation::save ( const wchar_t *  pathname,
uint8_t  bitsperpixel 
)

Save wavefield at retina plane as Windows Bitmap file.

Parameters
pathnameabsolute or relative path of output file
bitsperpixelnumber of bits per pixel
Returns
true if successfully saved
false when failed

◆ saveAsOhc() [1/4]

virtual bool ophCascadedPropagation::saveAsOhc ( const char *  fname)
virtual

Function to write OHC file.

Reimplemented from Openholo.

◆ saveAsOhc() [2/4]

bool ophCascadedPropagation::saveAsOhc ( const char *  fname)
virtual

Function to write OHC file.

Reimplemented from Openholo.

Definition at line 113 of file ophCascadedPropagation.cpp.

◆ saveAsOhc() [3/4]

virtual bool ophCascadedPropagation::saveAsOhc ( const char *  fname)
virtual

Function to write OHC file.

Reimplemented from Openholo.

◆ saveAsOhc() [4/4]

virtual bool ophCascadedPropagation::saveAsOhc ( const char *  fname)
virtual

Function to write OHC file.

Reimplemented from Openholo.


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