Openholo  v1.0
Open Source Digital Holographic Library
ophWRP Class Reference

#include <ophWRP.h>

Inheritance diagram for ophWRP:
Collaboration diagram for ophWRP:

Public Member Functions

 ophWRP (void)
 Constructor. More...
 
const vec3 & getScale ()
 
const RealgetLocation ()
 
const RealgetDistance ()
 
const int & getNumOfWRP ()
 
const RealgetFieldLens ()
 
void setScale (vec3 scale)
 
void setLocation (Real location)
 
void setDistance (Real distance)
 
void autoScaling ()
 
int getNumOfPoints ()
 
virtual int loadPointCloud (const char *pc_file)
 load to point cloud data. More...
 
virtual bool readConfig (const char *fname)
 load to configuration file. More...
 
void setMode (bool is_CPU)
 Set the value of a variable is_CPU(true or false) More...
 
double calculateWRPCPU (void)
 
double calculateWRPGPU (void)
 
void generateHologram (void)
 Generate a hologram, main funtion. More...
 
Complex< Real > ** calculateMWRP (void)
 Generate multiple wavefront recording planes, main funtion. More...
 
Complex< Real > * getWRPBuff (void)
 
void setViewingWindow (bool is_ViewingWindow)
 Set the value of a variable is_ViewingWindow(true or false) More...
 
- Public Member Functions inherited from ophGen
 ophGen (void)
 Constructor. More...
 
Real ** getEncodedBuffer (void)
 Function for getting the encoded complex field buffer. More...
 
uchar ** getNormalizedBuffer (void)
 Function for getting the normalized(0~255) complex field buffer. More...
 
void initialize (void)
 Initialize variables for Hologram complex field, encoded data, normalized data. More...
 
int loadPointCloud (const char *pc_file, OphPointCloudData *pc_data_)
 load to point cloud data. More...
 
bool readConfig (const char *fname)
 load to configuration file. More...
 
void propagationAngularSpectrum (int ch, Complex< Real > *input_u, Real propagation_dist, Real k, Real lambda)
 Angular spectrum propagation method. More...
 
void normalize (void)
 Normalization function to save as image file after hologram creation. More...
 
bool save (const char *fname, uint8_t bitsperpixel=8, uchar *src=nullptr, uint px=0, uint py=0)
 Function for saving image files. More...
 
void * load (const char *fname)
 Function for loading image files. More...
 
virtual bool loadAsOhc (const char *fname)
 Function to read OHC file. More...
 
virtual void encoding (unsigned int ENCODE_FLAG, Complex< Real > *holo=nullptr, bool bShift=false)
 Encoding Functions. More...
 
virtual void encoding (unsigned int ENCODE_FLAG, unsigned int SSB_PASSBAND, Complex< Real > *holo=nullptr)
 
void encoding ()
 
void waveCarry (Real carryingAngleX, Real carryingAngleY, Real distance)
 Wave carry. More...
 
ivec2 & getEncodeSize (void)
 Function for getting encode size. More...
 
void setResolution (ivec2 resolution)
 Function for setting buffer size. More...
 
Real getElapsedTime ()
 Function for getting elapsed time.
More...
 
void fresnelPropagation (OphConfig context, Complex< Real > *in, Complex< Real > *out, Real distance)
 Fresnel propagation. More...
 
void fresnelPropagation (Complex< Real > *in, Complex< Real > *out, Real distance, uint channel)
 Fresnel propagation. More...
 
- 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...
 
virtual bool saveAsOhc (const char *fname)
 Function to write OHC file
More...
 
Complex< Real > ** getComplexField (void)
 Function for getting the complex field. More...
 
OphConfiggetContext (void)
 Function for getting the current context. More...
 
void setPixelNumber (ivec2 n)
 Function for setting the output resolution. More...
 
void setPixelPitch (vec2 p)
 Function for setting the output pixel pitch. More...
 
void setWaveLength (Real w, const uint idx)
 Function for setting the wave length. 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...
 

Protected Member Functions

virtual ~ophWRP (void)
 Destructor. More...
 
void prepareInputdataGPU ()
 
- Protected Member Functions inherited from ophGen
virtual ~ophGen (void)=0
 Destructor. More...
 
bool save (const char *fname, uint8_t bitsperpixel, uint px, uint py, uint fnum, uchar *args ...)
 Called when saving multiple hologram data at a time. More...
 
void resetBuffer ()
 reset buffer More...
 
void numericalInterference (Complex< Real > *holo, Real *encoded, const int size)
 Encoding method. More...
 
void twoPhaseEncoding (Complex< Real > *holo, Real *encoded, const int size)
 
void burckhardt (Complex< Real > *holo, Real *encoded, const int size)
 
void singleSideBand (Complex< Real > *holo, Real *encoded, const ivec2 holosize, int passband)
 Encoding method. More...
 
void encodeSymmetrization (Complex< Real > *holo, Real *encoded, const ivec2 sig_loc)
 Encoding method. More...
 
void freqShift (Complex< Real > *src, Complex< Real > *dst, const ivec2 holosize, int shift_x, int shift_y)
 Frequency shift. More...
 
void encodeSideBand (bool bCPU, ivec2 sig_location)
 Encode the CGH according to a signal location parameter. More...
 
void encodeSideBand_CPU (int cropx1, int cropx2, int cropy1, int cropy2, ivec2 sig_location)
 Encode the CGH according to a signal location parameter on the CPU. More...
 
void encodeSideBand_GPU (int cropx1, int cropx2, int cropy1, int cropy2, ivec2 sig_location)
 Encode the CGH according to a signal location parameter on the GPU. More...
 
void getShiftPhaseValue (Complex< Real > &shift_phase_val, int idx, ivec2 sig_location)
 Calculate the shift phase value. More...
 
void getRandPhaseValue (Complex< Real > &rand_phase_val, bool rand_phase)
 Assign random phase value if RANDOM_PHASE == 1. More...
 
- 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 imgScaleBilnear (uchar *src, uchar *dst, int w, int h, int neww, int newh)
 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)
 Execution functions to be called after fft1, fft2, and fft3. More...
 
void fftFree (void)
 
void fftwShift (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...
 

Protected Attributes

int n_points
 numbers of points More...
 
Complex< Real > * p_wrp_
 wrp buffer - complex type More...
 
OphPointCloudData obj_
 Input Pointcloud Data. More...
 
RealscaledVertex
 
OphWRPConfig wrp_config_
 structure variable for WRP hologram configuration More...
 
- Protected Attributes inherited from ophGen
ivec2 encode_size
 Encoded hologram size, varied from encoding type. More...
 
int ENCODE_METHOD
 Encoding method flag. More...
 
int SSB_PASSBAND
 Passband in Single-side band encoding. More...
 
Real elapsedTime
 Elapsed time of generate hologram. More...
 
Real ** holo_encoded
 buffer to encoded. More...
 
uchar ** holo_normalized
 buffer to normalized. More...
 
- Protected Attributes inherited from Openholo
OphConfig context_
 
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
 

Additional Inherited Members

- Public Types inherited from ophGen
enum  ENCODE_FLAG {
  ENCODE_PHASE, ENCODE_AMPLITUDE, ENCODE_REAL, ENCODE_SIMPLENI,
  ENCODE_BURCKHARDT, ENCODE_TWOPHASE, ENCODE_SSB, ENCODE_OFFSSB,
  ENCODE_SYMMETRIZATION
}
 
enum  SSB_PASSBAND { SSB_LEFT, SSB_RIGHT, SSB_TOP, SSB_BOTTOM }
 

Detailed Description

Author

Definition at line 122 of file ophWRP.h.

Constructor & Destructor Documentation

◆ ophWRP()

ophWRP::ophWRP ( void  )
explicit

Constructor.

Initialize variables.

Definition at line 50 of file ophWRP.cpp.

◆ ~ophWRP()

ophWRP::~ophWRP ( void  )
protectedvirtual

Destructor.

Definition at line 60 of file ophWRP.cpp.

Member Function Documentation

◆ autoScaling()

void ophWRP::autoScaling ( )

Definition at line 69 of file ophWRP.cpp.

◆ calculateMWRP()

Complex< Real > ** ophWRP::calculateMWRP ( void  )

Generate multiple wavefront recording planes, main funtion.

Returns
multiple WRP (sec)

Definition at line 472 of file ophWRP.cpp.

◆ calculateWRPCPU()

double ophWRP::calculateWRPCPU ( void  )

Definition at line 327 of file ophWRP.cpp.

◆ calculateWRPGPU()

double ophWRP::calculateWRPGPU ( void  )

Definition at line 47 of file ophWRP_GPU.cpp.

◆ generateHologram()

void ophWRP::generateHologram ( void  )

Generate a hologram, main funtion.

Returns
implement time (sec)

Definition at line 446 of file ophWRP.cpp.

◆ getDistance()

const Real& ophWRP::getDistance ( )
inline

Definition at line 141 of file ophWRP.h.

◆ getFieldLens()

const Real& ophWRP::getFieldLens ( void  )
inline

Definition at line 143 of file ophWRP.h.

◆ getLocation()

const Real& ophWRP::getLocation ( )
inline

Definition at line 140 of file ophWRP.h.

◆ getNumOfPoints()

int ophWRP::getNumOfPoints ( )
inline

Definition at line 148 of file ophWRP.h.

◆ getNumOfWRP()

const int& ophWRP::getNumOfWRP ( )
inline

Definition at line 142 of file ophWRP.h.

◆ getScale()

const vec3& ophWRP::getScale ( )
inline

Definition at line 139 of file ophWRP.h.

◆ getWRPBuff()

Complex<Real>* ophWRP::getWRPBuff ( void  )
inline

Definition at line 195 of file ophWRP.h.

◆ loadPointCloud()

int ophWRP::loadPointCloud ( const char *  pc_file)
virtual

load to point cloud data.

Parameters
[in]pc_filePoint cloud data file name
Returns
Type: int
If the function succeeds, the return value is Positive integer.
If the function fails, the return value is Negative interger.

Definition at line 156 of file ophWRP.cpp.

◆ prepareInputdataGPU()

void ophWRP::prepareInputdataGPU ( )
protected

Definition at line 65 of file ophWRP_GPU.cpp.

◆ readConfig()

bool ophWRP::readConfig ( const char *  fname)
virtual

load to configuration file.

Parameters
[in]fnameconfig file name
Returns
Type: bool
If the function succeeds, the return value is true.
If the function fails, the return value is false.

Definition at line 164 of file ophWRP.cpp.

◆ setDistance()

void ophWRP::setDistance ( Real  distance)
inline

Definition at line 146 of file ophWRP.h.

◆ setLocation()

void ophWRP::setLocation ( Real  location)
inline

Definition at line 145 of file ophWRP.h.

◆ setMode()

void ophWRP::setMode ( bool  is_CPU)

Set the value of a variable is_CPU(true or false)

if is_CPU == true
CPU implementation
else
GPU implementation 
Parameters
[in]is_CPUthe value for specifying whether the hologram generation method is implemented on the CPU or GPU

Definition at line 322 of file ophWRP.cpp.

◆ setScale()

void ophWRP::setScale ( vec3  scale)
inline

Definition at line 144 of file ophWRP.h.

◆ setViewingWindow()

void ophWRP::setViewingWindow ( bool  is_ViewingWindow)

Set the value of a variable is_ViewingWindow(true or false)

if is_ViewingWindow == true
Transform viewing window
else
Hologram 
Parameters
is_ViewingWindow: the value for specifying whether the hologram generation method is implemented on the viewing window

Definition at line 64 of file ophWRP.cpp.

Member Data Documentation

◆ n_points

int ophWRP::n_points
protected

numbers of points

Definition at line 228 of file ophWRP.h.

◆ obj_

OphPointCloudData ophWRP::obj_
protected

Input Pointcloud Data.

Definition at line 232 of file ophWRP.h.

◆ p_wrp_

Complex<Real>* ophWRP::p_wrp_
protected

wrp buffer - complex type

Definition at line 230 of file ophWRP.h.

◆ scaledVertex

Real* ophWRP::scaledVertex
protected

Definition at line 233 of file ophWRP.h.

◆ wrp_config_

OphWRPConfig ophWRP::wrp_config_
protected

structure variable for WRP hologram configuration

Definition at line 234 of file ophWRP.h.


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