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

Openholo Point Cloud based Compter-generated holography. More...

#include <ophPointCloud.h>

Inheritance diagram for ophPointCloud:
Collaboration diagram for ophPointCloud:

Public Types

enum  PC_DIFF_FLAG { PC_DIFF_RS, PC_DIFF_FRESNEL }
 
- 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 }
 

Public Member Functions

 ophPointCloud (void)
 Constructor. More...
 
 ophPointCloud (const char *, const char *cfg_file)
 
void setScale (Real sx, Real sy, Real sz)
 
void setOffsetDepth (Real offset_depth)
 
void setFilterShapeFlag (int8_t *fsf)
 
void setFilterWidth (Real wx, Real wy)
 
void setFocalLength (Real lens_in, Real lens_out, Real lens_eye_piece)
 
void setTiltAngle (Real ax, Real ay)
 
void getScale (vec3 &scale)
 
Real getOffsetDepth (void)
 
int8_t * getFilterShapeFlag (void)
 
void getFilterWidth (vec2 &filterwidth)
 
void getFocalLength (Real *lens_in, Real *lens_out, Real *lens_eye_piece)
 
void getTiltAngle (vec2 &tiltangle)
 
Real ** getVertex (void)
 
Real ** getColorPC (void)
 
Real ** getPhasePC (void)
 
void setPointCloudModel (Real *vertex, Real *color, Real *phase)
 
void getPointCloudModel (Real *vertex, Real *color, Real *phase)
 
const RealgetModelVertex (Real *vertex)
 Directly Get Basic Data. More...
 
const RealgetModelColor (Real *color)
 Directly Get Basic Data. More...
 
const RealgetModelPhase (Real *phase)
 Directly Get Basic Data. More...
 
int getNumberOfPoints ()
 Directly Get Basic Data. More...
 
Real getFieldLens (void)
 Directly Get Basic Data. More...
 
void setMode (bool is_CPU)
 Set the value of a variable is_CPU(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 ~ophPointCloud (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...
 
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...
 
int loadPointCloud (const char *pc_file)
 override More...
 
bool readConfig (const char *cfg_file)
 Import Specification Config File(*.config) file. More...
 
Real generateHologram (uint diff_flag=PC_DIFF_RS)
 Generate a hologram, main funtion. More...
 
void encodeHologram (vec2 band_limit=vec2(0.8, 0.5), vec2 spectrum_shift=vec2(0.0, 0.5))
 encode Single-side band More...
 
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...
 
uintgetPercent ()
 Get the value of a CGH progress status. More...
 

Additional Inherited Members

- 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

Openholo Point Cloud based Compter-generated holography.

Author

Definition at line 548 of file ophPointCloud.h.

Member Enumeration Documentation

◆ PC_DIFF_FLAG

Enumerator
PC_DIFF_RS 
PC_DIFF_FRESNEL 

Definition at line 551 of file ophPointCloud.h.

Constructor & Destructor Documentation

◆ ophPointCloud() [1/2]

ophPointCloud::ophPointCloud ( void  )
explicit

Constructor.

Initialize variables.

Definition at line 53 of file ophPointCloud.cpp.

◆ ophPointCloud() [2/2]

ophPointCloud::ophPointCloud ( const char *  pc_file,
const char *  cfg_file 
)
explicit

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Definition at line 62 of file ophPointCloud.cpp.

◆ ~ophPointCloud()

ophPointCloud::~ophPointCloud ( void  )
protectedvirtual

Destructor.

Definition at line 75 of file ophPointCloud.cpp.

Member Function Documentation

◆ encodeHologram()

void ophPointCloud::encodeHologram ( vec2  band_limit = vec2(0.8, 0.5),
vec2  spectrum_shift = vec2(0.0, 0.5) 
)

encode Single-side band

Parameters
Vectorband limit
Vectorspecturm shift

Definition at line 183 of file ophPointCloud.cpp.

◆ encoding() [1/2]

void ophPointCloud::encoding ( unsigned int  ENCODE_FLAG)
virtual

Definition at line 266 of file ophPointCloud.cpp.

◆ encoding() [2/2]

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

Definition at line 271 of file ophPointCloud.cpp.

◆ generateHologram()

Real ophPointCloud::generateHologram ( uint  diff_flag = PC_DIFF_RS)

Generate a hologram, main funtion.

Parameters
Selectdiffraction flag
PC_DIFF_RS: Diffraction using R-S integral
PC_DIFF_FRESNEL: Diffraction using Fresnel integral
Returns
implement time (sec)

Definition at line 153 of file ophPointCloud.cpp.

◆ getColorPC()

Real** ophPointCloud::getColorPC ( void  )
inline

Definition at line 589 of file ophPointCloud.h.

◆ getFieldLens()

Real ophPointCloud::getFieldLens ( void  )
inline

Directly Get Basic Data.

Returns
Real

Definition at line 626 of file ophPointCloud.h.

◆ getFilterShapeFlag()

int8_t* ophPointCloud::getFilterShapeFlag ( void  )
inline

Definition at line 580 of file ophPointCloud.h.

◆ getFilterWidth()

void ophPointCloud::getFilterWidth ( vec2 &  filterwidth)
inline

Definition at line 581 of file ophPointCloud.h.

◆ getFocalLength()

void ophPointCloud::getFocalLength ( Real lens_in,
Real lens_out,
Real lens_eye_piece 
)
inline

Definition at line 582 of file ophPointCloud.h.

◆ getModelColor()

const Real* ophPointCloud::getModelColor ( Real color)
inline

Directly Get Basic Data.

Parameters
Color3D Point Cloud Color Data

Definition at line 611 of file ophPointCloud.h.

◆ getModelPhase()

const Real* ophPointCloud::getModelPhase ( Real phase)
inline

Directly Get Basic Data.

Parameters
Phase3D Point Cloud Model Phase Data of Point-Based Light Wave

Definition at line 616 of file ophPointCloud.h.

◆ getModelVertex()

const Real* ophPointCloud::getModelVertex ( Real vertex)
inline

Directly Get Basic Data.

Parameters
Vertex3D Point Cloud Geometry Data

Definition at line 606 of file ophPointCloud.h.

◆ getNumberOfPoints()

int ophPointCloud::getNumberOfPoints ( )
inline

Directly Get Basic Data.

Returns
int 3D Point Cloud count

Definition at line 621 of file ophPointCloud.h.

◆ getOffsetDepth()

Real ophPointCloud::getOffsetDepth ( void  )
inline

Definition at line 579 of file ophPointCloud.h.

◆ getPercent()

uint* ophPointCloud::getPercent ( )
inline

Get the value of a CGH progress status.

Returns
pointer of percent

Definition at line 697 of file ophPointCloud.h.

◆ getPhasePC()

Real** ophPointCloud::getPhasePC ( void  )
inline

Definition at line 590 of file ophPointCloud.h.

◆ getPointCloudModel()

void ophPointCloud::getPointCloudModel ( Real vertex,
Real color,
Real phase 
)
inline

Definition at line 596 of file ophPointCloud.h.

◆ getScale()

void ophPointCloud::getScale ( vec3 &  scale)
inline

Definition at line 578 of file ophPointCloud.h.

◆ getTiltAngle()

void ophPointCloud::getTiltAngle ( vec2 &  tiltangle)
inline

Definition at line 587 of file ophPointCloud.h.

◆ getVertex()

Real** ophPointCloud::getVertex ( void  )
inline

Definition at line 588 of file ophPointCloud.h.

◆ loadPointCloud()

int ophPointCloud::loadPointCloud ( const char *  pc_file)

override

Import Point Cloud Data Base File : *.dat file. This Function is included memory location of Input Point Clouds. override

Parameters
[in]InputModelFilePointCloud(*.dat) input file path
Returns
number of Pointcloud (if it failed loading, it returned -1)

Definition at line 89 of file ophPointCloud.cpp.

◆ readConfig()

bool ophPointCloud::readConfig ( const char *  cfg_file)

Import Specification Config File(*.config) file.

Parameters
InputConfigFileSpecification Config(*.config) file path

Definition at line 96 of file ophPointCloud.cpp.

◆ setFilterShapeFlag()

void ophPointCloud::setFilterShapeFlag ( int8_t *  fsf)
inline

Definition at line 573 of file ophPointCloud.h.

◆ setFilterWidth()

void ophPointCloud::setFilterWidth ( Real  wx,
Real  wy 
)
inline

Definition at line 574 of file ophPointCloud.h.

◆ setFocalLength()

void ophPointCloud::setFocalLength ( Real  lens_in,
Real  lens_out,
Real  lens_eye_piece 
)
inline

Definition at line 575 of file ophPointCloud.h.

◆ setMode()

void ophPointCloud::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 79 of file ophPointCloud.cpp.

◆ setOffsetDepth()

void ophPointCloud::setOffsetDepth ( Real  offset_depth)
inline

Definition at line 572 of file ophPointCloud.h.

◆ setPointCloudModel()

void ophPointCloud::setPointCloudModel ( Real vertex,
Real color,
Real phase 
)
inline

Definition at line 591 of file ophPointCloud.h.

◆ setScale()

void ophPointCloud::setScale ( Real  sx,
Real  sy,
Real  sz 
)
inline

Definition at line 571 of file ophPointCloud.h.

◆ setTiltAngle()

void ophPointCloud::setTiltAngle ( Real  ax,
Real  ay 
)
inline

Definition at line 576 of file ophPointCloud.h.

◆ setViewingWindow()

void ophPointCloud::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 84 of file ophPointCloud.cpp.


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