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

This class generates CGH based on depth map. More...

#include <ophDepthMap.h>

Inheritance diagram for ophDepthMap:
Collaboration diagram for ophDepthMap:

Public Member Functions

 ophDepthMap ()
 Constructor. More...
 
void setMode (bool is_CPU)
 Set the value of a variable is_CPU(true or false) More...
 
bool readConfig (const char *fname)
 Read parameters from a config file(config_openholo.txt). More...
 
bool readImageDepth (const char *source_folder, const char *img_prefix, const char *depth_img_prefix)
 Read image and depth map. More...
 
Real generateHologram (void)
 Generate a hologram, main funtion. When the calculation is finished, the angular spectrum is performed. More...
 
void encodeHologram (void)
 
virtual void encoding (unsigned int ENCODE_FLAG)
 
virtual void encoding (unsigned int ENCODE_FLAG, unsigned int SSB_PASSBAND)
 
void setViewingWindow (bool is_ViewingWindow)
 Set the value of a variable is_ViewingWindow(true or false) More...
 
ivec2 getRGBImgSize ()
 
ivec2 getDepthImgSize ()
 
void setConfig (OphDepthMapConfig config)
 
void setResolution (ivec2 resolution)
 
uintgetPercent ()
 
void setFieldLens (Real fieldlens)
 
void setNearDepth (Real neardepth)
 
void setFarDepth (Real fardetph)
 
void setNumOfDepth (uint numofdepth)
 
Real getFieldLens (void)
 
Real getNearDepth (void)
 
Real getFarDepth (void)
 
uint getNumOfDepth (void)
 
void getRenderDepth (std::vector< int > &renderdepth)
 
const OphDepthMapConfiggetConfig ()
 
- 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 ~ophDepthMap ()
 Destructor. More...
 
void free_gpu (void)
 
void ophFree (void)
 Pure virtual function for override in child classes. More...
 
- 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...
 

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 }
 
- 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
 

Detailed Description

This class generates CGH based on depth map.

Author

Definition at line 111 of file ophDepthMap.h.

Constructor & Destructor Documentation

◆ ophDepthMap()

ophDepthMap::ophDepthMap ( )
explicit

Constructor.

Initialize variables.

Definition at line 61 of file ophDepthMap.cpp.

◆ ~ophDepthMap()

ophDepthMap::~ophDepthMap ( )
protectedvirtual

Destructor.

Definition at line 89 of file ophDepthMap.cpp.

Member Function Documentation

◆ encodeHologram()

void ophDepthMap::encodeHologram ( void  )

Definition at line 359 of file ophDepthMap.cpp.

◆ encoding() [1/2]

void ophDepthMap::encoding ( unsigned int  ENCODE_FLAG)
virtual

Definition at line 366 of file ophDepthMap.cpp.

◆ encoding() [2/2]

void ophDepthMap::encoding ( unsigned int  ENCODE_FLAG,
unsigned int  SSB_PASSBAND 
)
virtual

Definition at line 371 of file ophDepthMap.cpp.

◆ free_gpu()

void ophDepthMap::free_gpu ( void  )
protected

Definition at line 256 of file ophDepthMap_GPU.cpp.

◆ generateHologram()

Real ophDepthMap::generateHologram ( void  )

Generate a hologram, main funtion. When the calculation is finished, the angular spectrum is performed.

Returns
implement time (sec)

Definition at line 318 of file ophDepthMap.cpp.

◆ getConfig()

const OphDepthMapConfig& ophDepthMap::getConfig ( )
inline

Definition at line 175 of file ophDepthMap.h.

◆ getDepthImgSize()

ivec2 ophDepthMap::getDepthImgSize ( )
inline

Definition at line 155 of file ophDepthMap.h.

◆ getFarDepth()

Real ophDepthMap::getFarDepth ( void  )
inline

Definition at line 171 of file ophDepthMap.h.

◆ getFieldLens()

Real ophDepthMap::getFieldLens ( void  )
inline

Definition at line 169 of file ophDepthMap.h.

◆ getNearDepth()

Real ophDepthMap::getNearDepth ( void  )
inline

Definition at line 170 of file ophDepthMap.h.

◆ getNumOfDepth()

uint ophDepthMap::getNumOfDepth ( void  )
inline

Definition at line 172 of file ophDepthMap.h.

◆ getPercent()

uint* ophDepthMap::getPercent ( )
inline

Definition at line 161 of file ophDepthMap.h.

◆ getRenderDepth()

void ophDepthMap::getRenderDepth ( std::vector< int > &  renderdepth)
inline

Definition at line 173 of file ophDepthMap.h.

◆ getRGBImgSize()

ivec2 ophDepthMap::getRGBImgSize ( )
inline

Definition at line 154 of file ophDepthMap.h.

◆ ophFree()

void ophDepthMap::ophFree ( void  )
protectedvirtual

Pure virtual function for override in child classes.

Reimplemented from ophGen.

Definition at line 695 of file ophDepthMap.cpp.

◆ readConfig()

bool ophDepthMap::readConfig ( const char *  fname)

Read parameters from a config file(config_openholo.txt).

Returns
true if config infomation are sucessfully read, flase otherwise.

Definition at line 115 of file ophDepthMap.cpp.

◆ readImageDepth()

bool ophDepthMap::readImageDepth ( const char *  source_folder,
const char *  img_prefix,
const char *  depth_img_prefix 
)

Read image and depth map.

Read input files and load image & depth map data. If the input image size is different with the dislay resolution, resize the image size.

Parameters
ftr: the frame number of the image.
Returns
true if image data are sucessfully read, flase otherwise.
See also
prepare_inputdata_CPU, prepare_inputdata_GPU

Definition at line 215 of file ophDepthMap.cpp.

◆ setConfig()

void ophDepthMap::setConfig ( OphDepthMapConfig  config)
inline

Definition at line 157 of file ophDepthMap.h.

◆ setFarDepth()

void ophDepthMap::setFarDepth ( Real  fardetph)
inline

Definition at line 166 of file ophDepthMap.h.

◆ setFieldLens()

void ophDepthMap::setFieldLens ( Real  fieldlens)
inline

Definition at line 164 of file ophDepthMap.h.

◆ setMode()

void ophDepthMap::setMode ( bool  isCPU)

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

Set the value of a variable isCPU_(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
  if isCPU_ == true
     CPU implementation
  else
     GPU implementation 
Parameters
isCPU: the value for specifying whether the hologram generation method is implemented on the CPU or GPU

Definition at line 102 of file ophDepthMap.cpp.

◆ setNearDepth()

void ophDepthMap::setNearDepth ( Real  neardepth)
inline

Definition at line 165 of file ophDepthMap.h.

◆ setNumOfDepth()

void ophDepthMap::setNumOfDepth ( uint  numofdepth)
inline

Definition at line 167 of file ophDepthMap.h.

◆ setResolution()

void ophDepthMap::setResolution ( ivec2  resolution)

Definition at line 701 of file ophDepthMap.cpp.

◆ setViewingWindow()

void ophDepthMap::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 107 of file ophDepthMap.cpp.


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