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

#include <ophLUT.h>

Inheritance diagram for ophLUT:
Collaboration diagram for ophLUT:

Public Member Functions

 ophLUT ()
int init (const char *_filename, CGHEnvironmentData *_CGHE)
bool loadConfig (const char *filename, CGHEnvironmentData *_CGHE)
bool loadPoint (const char *_filename, VoxelStruct *h_vox)
bool load_Num_Point (const char *_filename, long *num_point)
void DataInit (CGHEnvironmentData *_CGHE)
int LUTCalcuation (long voxnum, unsigned char *cghfringe, VoxelStruct *h_vox, CGHEnvironmentData *_CGHE)
void APAS (long voxelnum, VoxelStruct *_h_vox, CGHEnvironmentData *_CGHE)
int saveAsImg (const char *fname, uint8_t bitsperpixel, void *src, int pic_width, int pic_height)
char * trim (char *s)
char * ltrim (char *s)
char * rtrim (char *s)
- 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.
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
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...

Public Attributes

double * m_pHologram
float m_COStbl [NUMTBL]
float m_SINtbl [NUMTBL]

Protected Member Functions

virtual ~ophLUT ()
- 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...
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 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
- Protected Attributes inherited from ophGen
ivec2 encode_size
 Encoded hologram size, varied from encoding type. More...
 Encoding method flag. More...
 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
 OHC file format Variables for read and write. More...
- Protected Attributes inherited from Base
unsigned long refCnt

Detailed Description

Definition at line 25 of file ophLUT.h.

Constructor & Destructor Documentation

◆ ophLUT()

ophLUT::ophLUT ( )

Definition at line 16 of file ophLUT.cpp.

◆ ~ophLUT()

ophLUT::~ophLUT ( )

Definition at line 20 of file ophLUT.cpp.

Member Function Documentation

◆ APAS()

void ophLUT::APAS ( long  voxelnum,
VoxelStruct _h_vox,
CGHEnvironmentData _CGHE 

Definition at line 239 of file ophLUT.cpp.

◆ DataInit()

void ophLUT::DataInit ( CGHEnvironmentData _CGHE)

Definition at line 193 of file ophLUT.cpp.

◆ init()

int ophLUT::init ( const char *  _filename,
CGHEnvironmentData _CGHE 

Definition at line 25 of file ophLUT.cpp.

◆ load_Num_Point()

bool ophLUT::load_Num_Point ( const char *  _filename,
long *  num_point 

Definition at line 173 of file ophLUT.cpp.

◆ loadConfig()

bool ophLUT::loadConfig ( const char *  filename,
CGHEnvironmentData _CGHE 

Definition at line 34 of file ophLUT.cpp.

◆ loadPoint()

bool ophLUT::loadPoint ( const char *  _filename,
VoxelStruct h_vox 

Definition at line 118 of file ophLUT.cpp.

◆ ltrim()

char * ophLUT::ltrim ( char *  s)

Definition at line 488 of file ophLUT.cpp.

◆ LUTCalcuation()

int ophLUT::LUTCalcuation ( long  voxnum,
unsigned char *  cghfringe,
VoxelStruct h_vox,
CGHEnvironmentData _CGHE 

Definition at line 206 of file ophLUT.cpp.

◆ rtrim()

char * ophLUT::rtrim ( char *  s)

Definition at line 469 of file ophLUT.cpp.

◆ saveAsImg()

int ophLUT::saveAsImg ( const char *  fname,
uint8_t  bitsperpixel,
void *  src,
int  pic_width,
int  pic_height 

Definition at line 415 of file ophLUT.cpp.

◆ trim()

char * ophLUT::trim ( char *  s)

Definition at line 507 of file ophLUT.cpp.

Member Data Documentation

◆ m_COStbl

float ophLUT::m_COStbl[NUMTBL]

Definition at line 52 of file ophLUT.h.

◆ m_pHologram

double* ophLUT::m_pHologram

Definition at line 50 of file ophLUT.h.

◆ m_Segment

Segment* ophLUT::m_Segment

Definition at line 51 of file ophLUT.h.

◆ m_SINtbl

float ophLUT::m_SINtbl[NUMTBL]

Definition at line 53 of file ophLUT.h.

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