Openholo  v4.0
Open Source Digital Holographic Library
ophTri Class Reference

Openholo Triangular Mesh based CGH generation. More...

#include <ophTriMesh.h>

Inheritance diagram for ophTri:
Collaboration diagram for ophTri:

Public Types

enum  SHADING_FLAG { SHADING_FLAT, SHADING_CONTINUOUS }
 Mesh object data scaling and shifting. More...
 
- Public Types inherited from ophGen
enum  PRECISION { SINGLE, DOUBLE }
 
enum  ENCODE_FLAG {
  ENCODE_PHASE, ENCODE_AMPLITUDE, ENCODE_REAL, ENCODE_IMAGINARY,
  ENCODE_SIMPLENI, ENCODE_BURCKHARDT, ENCODE_TWOPHASE, ENCODE_SSB,
  ENCODE_OFFSSB, ENCODE_SIMPLEBINARY, ENCODE_EDBINARY
}
 
enum  SSB_PASSBAND { SSB_LEFT, SSB_RIGHT, SSB_TOP, SSB_BOTTOM }
 
enum  ED_WType { FLOYD_STEINBERG, SINGLE_RIGHT, SINGLE_DOWN, ITERATIVE_DESIGN }
 

Public Member Functions

 ophTri (void)
 Constructor. More...
 
void setObjSize (vec3 in)
 
void setObjShift (vec3 in)
 
void setCarrierWave (Real in1, Real in2, Real in3)
 
void setIllumination (vec3 in)
 
void setIllumination (Real inx, Real iny, Real inz)
 
void setShadingType (int in)
 
void setRandPhase (bool in)
 
void setOcclusion (bool in)
 
void setTextureMapping (bool in)
 
void setTextureImgDim (int dim1, int dim2)
 
void setTexturePeriod (Real in)
 
ulonglong getNumMesh ()
 
FacegetMeshData ()
 
Complex< Real > * getAngularSpectrum ()
 
FacegetScaledMeshData ()
 
const vec3getObjSize (void)
 
const vec3getObjShift (void)
 
const vec3getIllumination (void)
 
bool readConfig (const char *fname)
 Triangular mesh basc CGH configuration file load. More...
 
bool loadMeshData (const char *fileName, const char *ext)
 Mesh data load. More...
 
void loadTexturePattern (const char *fileName, const char *ext)
 
virtual void encoding (unsigned int ENCODE_FLAG)
 
Real generateHologram (uint SHADING_FLAG)
 Hologram generation. More...
 
void reconTest (const char *fname)
 
void triTimeMultiplexing (char *dirName, uint ENCODE_METHOD, Real cenFx, Real cenFy, Real rangeFx, Real rangeFy, Real stepFx, Real stepFy)
 
void setViewingWindow (bool is_ViewingWindow)
 Set the value of a variable is_ViewingWindow(true or false) More...
 
uintgetProgress ()
 
- 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 RS_Diffraction (Point src, Complex< Real > *dst, Real lambda, Real distance, Real amplitude)
 RS-diffraction method. More...
 
void Fresnel_Diffraction (Point src, Complex< Real > *dst, Real lambda, Real distance, Real amplitude)
 Fresnel-diffraction method. More...
 
void Fresnel_FFT (Complex< Real > *src, Complex< Real > *dst, Real lambda, Real waveRatio, Real distance)
 Fresnel-fft method. More...
 
void AngularSpectrumMethod (Complex< Real > *src, Complex< Real > *dst, Real lambda, Real distance)
 Angular spectrum propagation method. More...
 
void conv_fft2 (Complex< Real > *src1, Complex< Real > *src2, Complex< Real > *dst, ivec2 size)
 Convolution between Complex arrays which have same size. More...
 
void normalize (void)
 Normalization function to save as image file after hologram creation. More...
 
void normalize (uint ch)
 
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...
 
void setPrecision (uint precision)
 Function for setting precision. More...
 
uint getPrecision ()
 
void setEncodeMethod (unsigned int ENCODE_FLAG)
 
void encoding (unsigned int ENCODE_FLAG)
 Encoding Functions. More...
 
void encoding (unsigned int ENCODE_FLAG, Complex< Real > *holo, Real *encoded)
 
void encoding ()
 
virtual void encoding (unsigned int ENCODE_FLAG, unsigned int SSB_PASSBAND, Complex< Real > *holo=nullptr, Real *encoded=nullptr)
 
void encoding (unsigned int BIN_ENCODE_FLAG, unsigned int ENCODE_FLAG, Real threshold, Complex< Real > *holo=nullptr, Real *encoded=nullptr)
 Binary Encoding Functions. More...
 
bool Shift (Real x, Real y)
 
void waveCarry (Real carryingAngleX, Real carryingAngleY, Real distance)
 Wave carry. More...
 
void waveCarry (Complex< Real > *src, Complex< Real > *dst, Real wavelength, int carryIdxX, int carryIdxY)
 
void transVW (int nVertex, Vertex *dst, Vertex *src)
 
void transVW (int nVertex, Real *dst, Real *src)
 
int getStream ()
 
Real getFieldLength ()
 
ivec2getEncodeSize (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...
 
bool saveRefImages (char *fnameW, char *fnameWC, char *fnameAS, char *fnameSSB, char *fnameHP, char *fnameFreq, char *fnameReal, char *fnameBin, char *fnameReconBin, char *fnameReconErr, char *fnameReconNo)
 
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...
 
void SetRandomPhase (bool bRandomPhase)
 Function for setting the random phase. More...
 
bool GetRandomPhase ()
 Function for getting the random phase. More...
 
void SetMode (unsigned int mode)
 
unsigned int GetMode ()
 
- 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...
 
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...
 

Protected Member Functions

virtual ~ophTri (void)
 Destructor. 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...
 
template<typename T >
void RealPart (Complex< T > *holo, T *encoded, const int size)
 Encoding method. More...
 
template<typename T >
void ImaginaryPart (Complex< T > *holo, T *encoded, const int size)
 
template<typename T >
void Phase (Complex< T > *holo, T *encoded, const int size)
 
template<typename T >
void Amplitude (Complex< T > *holo, T *encoded, const int size)
 
template<typename T >
void TwoPhase (Complex< T > *holo, T *encoded, const int size)
 
template<typename T >
void Burckhardt (Complex< T > *holo, T *encoded, const int size)
 
template<typename T >
void SimpleNI (Complex< T > *holo, T *encoded, const int size)
 
void singleSideBand (Complex< Real > *holo, Real *encoded, const ivec2 holosize, int passband)
 Encoding method. More...
 
void freqShift (Complex< Real > *holo, Complex< Real > *encoded, const ivec2 holosize, int shift_x, int shift_y)
 Frequency shift. More...
 
bool binaryErrorDiffusion (Complex< Real > *holo, Real *encoded, const ivec2 holosize, const int type, Real threshold)
 
bool getWeightED (const ivec2 holosize, const int type, ivec2 *pNw)
 
bool shiftW (ivec2 holosize)
 
void binarization (Complex< Real > *src, Real *dst, const int size, int ENCODE_FLAG, Real threshold)
 
void CorrectionChromaticAberration (uchar *src, uchar *dst, int width, int height, int ch)
 
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 GetRandomPhaseValue (Complex< Real > &rand_phase_val, bool rand_phase)
 Assign random phase value if random_phase == 1. More...
 
void ScaleChange (Real *src, Real *dst, int nSize, Real scaleX, Real scaleY, Real scaleZ)
 
void GetMaxMin (Real *src, int len, Real &max, Real &min)
 
virtual void ophFree (void)
 Pure virtual function for override in child classes. 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 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...
 

Additional Inherited Members

- Protected Attributes inherited from ophGen
ivec2 m_vecEncodeSize
 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 m_elapsedTime
 Elapsed time of generate hologram. More...
 
Real ** m_lpEncoded
 buffer to encoded. More...
 
uchar ** m_lpNormalized
 buffer to normalized. More...
 
Real m_dFieldLength
 
int m_nStream
 
unsigned int m_mode
 
Complex< Real > * AS
 Binary Encoding - Error diffusion. More...
 
Complex< Real > * normalized
 
Complex< Real > * fftTemp
 
Realweight
 
Complex< Real > * weightC
 
Complex< Real > * freqW
 
RealrealEnc
 
Realbinary
 
RealmaskSSB
 
RealmaskHP
 
bool m_bRandomPhase
 
- Protected Attributes inherited from Openholo
OphConfig context_
 
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

Openholo Triangular Mesh based CGH generation.

Author
Yeon-Gyeong Ju, Jae-Hyeung Park

Definition at line 113 of file ophTriMesh.h.

Member Enumeration Documentation

◆ SHADING_FLAG

Mesh object data scaling and shifting.

Parameters
objSize_Object maximum of width and height / unit : [m]
objShift_Object shift value / Data structure : [shiftX, shiftY, shiftZ] / unit : [m]
Returns
scaledMeshData This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
Enumerator
SHADING_FLAT 
SHADING_CONTINUOUS 

Definition at line 186 of file ophTriMesh.h.

Constructor & Destructor Documentation

◆ ophTri()

ophTri::ophTri ( void  )
explicit

Constructor.

Initialize variables.

Definition at line 61 of file ophTriMesh.cpp.

◆ ~ophTri()

virtual ophTri::~ophTri ( void  )
inlineprotectedvirtual

Destructor.

Definition at line 126 of file ophTriMesh.h.

Member Function Documentation

◆ encoding()

void ophTri::encoding ( unsigned int  ENCODE_FLAG)
virtual

Definition at line 1326 of file ophTriMesh.cpp.

◆ generateHologram()

Real ophTri::generateHologram ( uint  SHADING_FLAG)

Hologram generation.

Parameters
SHADING_FLAG: SHADING_FLAT, SHADING_CONTINUOUS
Returns
implement time (sec)

Definition at line 465 of file ophTriMesh.cpp.

◆ getAngularSpectrum()

Complex<Real>* ophTri::getAngularSpectrum ( )
inline

Definition at line 147 of file ophTriMesh.h.

◆ getIllumination()

const vec3& ophTri::getIllumination ( void  )
inline

Definition at line 153 of file ophTriMesh.h.

◆ getMeshData()

Face* ophTri::getMeshData ( )
inline

Definition at line 146 of file ophTriMesh.h.

◆ getNumMesh()

ulonglong ophTri::getNumMesh ( )
inline

Definition at line 142 of file ophTriMesh.h.

◆ getObjShift()

const vec3& ophTri::getObjShift ( void  )
inline

Definition at line 152 of file ophTriMesh.h.

◆ getObjSize()

const vec3& ophTri::getObjSize ( void  )
inline

Definition at line 151 of file ophTriMesh.h.

◆ getProgress()

uint* ophTri::getProgress ( )
inline

Definition at line 217 of file ophTriMesh.h.

◆ getScaledMeshData()

Face* ophTri::getScaledMeshData ( )
inline

Definition at line 149 of file ophTriMesh.h.

◆ loadMeshData()

bool ophTri::loadMeshData ( const char *  fileName,
const char *  ext 
)

Mesh data load.

Text file data structure : N*9 / Each row = [x1 y1 z1 x2 y2 z2 x3 y3 z3]

File extension : txt, ply

Parameters
extFile extension
Returns
bool return false : Failed to load mesh data return true : Success to load mesh data

Definition at line 88 of file ophTriMesh.cpp.

◆ loadTexturePattern()

void ophTri::loadTexturePattern ( const char *  fileName,
const char *  ext 
)

Definition at line 246 of file ophTriMesh.cpp.

◆ readConfig()

bool ophTri::readConfig ( const char *  fname)

Triangular mesh basc CGH configuration file load.

xml configuration file load

Returns
bool return false : Failed to load configure file return true : Success to load configure file

Definition at line 120 of file ophTriMesh.cpp.

◆ reconTest()

void ophTri::reconTest ( const char *  fname)

Definition at line 1233 of file ophTriMesh.cpp.

◆ setCarrierWave()

void ophTri::setCarrierWave ( Real  in1,
Real  in2,
Real  in3 
)
inline

Definition at line 131 of file ophTriMesh.h.

◆ setIllumination() [1/2]

void ophTri::setIllumination ( vec3  in)
inline

Definition at line 132 of file ophTriMesh.h.

◆ setIllumination() [2/2]

void ophTri::setIllumination ( Real  inx,
Real  iny,
Real  inz 
)
inline

Definition at line 133 of file ophTriMesh.h.

◆ setObjShift()

void ophTri::setObjShift ( vec3  in)
inline

Definition at line 130 of file ophTriMesh.h.

◆ setObjSize()

void ophTri::setObjSize ( vec3  in)
inline

Definition at line 129 of file ophTriMesh.h.

◆ setOcclusion()

void ophTri::setOcclusion ( bool  in)
inline

Definition at line 137 of file ophTriMesh.h.

◆ setRandPhase()

void ophTri::setRandPhase ( bool  in)
inline

Definition at line 136 of file ophTriMesh.h.

◆ setShadingType()

void ophTri::setShadingType ( int  in)
inline

Definition at line 134 of file ophTriMesh.h.

◆ setTextureImgDim()

void ophTri::setTextureImgDim ( int  dim1,
int  dim2 
)
inline

Definition at line 139 of file ophTriMesh.h.

◆ setTextureMapping()

void ophTri::setTextureMapping ( bool  in)
inline

Definition at line 138 of file ophTriMesh.h.

◆ setTexturePeriod()

void ophTri::setTexturePeriod ( Real  in)
inline

Definition at line 140 of file ophTriMesh.h.

◆ setViewingWindow()

void ophTri::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 83 of file ophTriMesh.cpp.

◆ triTimeMultiplexing()

void ophTri::triTimeMultiplexing ( char *  dirName,
uint  ENCODE_METHOD,
Real  cenFx,
Real  cenFy,
Real  rangeFx,
Real  rangeFy,
Real  stepFx,
Real  stepFy 
)

Definition at line 425 of file ophTriMesh.cpp.


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