Openholo  v1.0
Open Source Digital Holographic Library
ophGen Class Referenceabstract

#include <ophGen.h>

Inheritance diagram for ophGen:
Collaboration diagram for ophGen:

Public Types

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

 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 ~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...
 

Protected Attributes

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

Author

Definition at line 68 of file ophGen.h.

Member Enumeration Documentation

◆ ENCODE_FLAG

Enumerator
ENCODE_PHASE 
ENCODE_AMPLITUDE 
ENCODE_REAL 
ENCODE_SIMPLENI 
ENCODE_BURCKHARDT 
ENCODE_TWOPHASE 
ENCODE_SSB 
ENCODE_OFFSSB 
ENCODE_SYMMETRIZATION 

Definition at line 72 of file ophGen.h.

◆ SSB_PASSBAND

Enumerator
SSB_LEFT 
SSB_RIGHT 
SSB_TOP 
SSB_BOTTOM 

Definition at line 227 of file ophGen.h.

Constructor & Destructor Documentation

◆ ophGen()

ophGen::ophGen ( void  )
explicit

Constructor.

Definition at line 56 of file ophGen.cpp.

◆ ~ophGen()

ophGen::~ophGen ( void  )
protectedpure virtual

Destructor.

Definition at line 65 of file ophGen.cpp.

Member Function Documentation

◆ burckhardt()

void ophGen::burckhardt ( Complex< Real > *  holo,
Real encoded,
const int  size 
)
protected

Definition at line 646 of file ophGen.cpp.

◆ encodeSideBand()

void ophGen::encodeSideBand ( bool  bCPU,
ivec2  sig_location 
)
protected

Encode the CGH according to a signal location parameter.

Parameters
[in]bCPUSelect whether to operate with CPU or GPU
[in]sig_locationSignal location
sig_location[0]: upper or lower half, sig_location[1]:left or right half.
See also
encodeSideBand_CPU, encodeSideBand_GPU

Definition at line 976 of file ophGen.cpp.

◆ encodeSideBand_CPU()

void ophGen::encodeSideBand_CPU ( int  cropx1,
int  cropx2,
int  cropy1,
int  cropy2,
ivec2  sig_location 
)
protected

Encode the CGH according to a signal location parameter on the CPU.

The CPU variable, (*complex_H) on CPU has the final result.

Parameters
[in]cropx1the start x-coordinate to crop
[in]cropx2the end x-coordinate to crop
[in]cropy1the start y-coordinate to crop
[in]cropy2the end y-coordinate to crop
[in]sig_locationSignal location
sig_location[0]: upper or lower half, sig_location[1]:left or right half.
See also
fftwShift

Definition at line 1018 of file ophGen.cpp.

◆ encodeSideBand_GPU()

void ophGen::encodeSideBand_GPU ( int  cropx1,
int  cropx2,
int  cropy1,
int  cropy2,
ivec2  sig_location 
)
protected

Encode the CGH according to a signal location parameter on the GPU.

The GPU variable, (*complex_H) on GPU has the final result.

Parameters
[in]cropx1the start x-coordinate to crop
[in]cropx2the end x-coordinate to crop
[in]cropy1the start y-coordinate to crop
[in]cropy2the end y-coordinate to crop
[in]sig_locationSignal location
sig_location[0]: upper or lower half, sig_location[1]:left or right half.
See also
cudaCropFringe, cudaFFT, cudaGetFringe

Definition at line 1180 of file ophGen.cpp.

◆ encodeSymmetrization()

void ophGen::encodeSymmetrization ( Complex< Real > *  holo,
Real encoded,
const ivec2  sig_loc 
)
protected

Encoding method.

Parameters
[in]holoSource data.
[out]encodedDestination data.
[in]sig_locSignal location.
sig_loc[0]: upper or lower half, sig_loc[1]:left or right half.

Definition at line 1112 of file ophGen.cpp.

◆ encoding() [1/3]

void ophGen::encoding ( unsigned int  ENCODE_FLAG,
Complex< Real > *  holo = nullptr,
bool  bShift = false 
)
virtual

Encoding Functions.

ENCODE_PHASE : Phase
ENCODE_AMPLITUDE : Amplitude
ENCODE_REAL : Real Part
ENCODE_SIMPLENI : Simple numerical interference
ENCODE_BURCKHARDT : Burckhardt encoding
ENCODE_TWOPHASE : Two Phase Encoding

Parameters
[in]ENCODE_FLAGencoding method.
[in]holobuffer to encode.
[in]bShiftshift or not. 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 383 of file ophGen.cpp.

◆ encoding() [2/3]

void ophGen::encoding ( unsigned int  ENCODE_FLAG,
unsigned int  SSB_PASSBAND,
Complex< Real > *  holo = nullptr 
)
virtual

Definition at line 484 of file ophGen.cpp.

◆ encoding() [3/3]

void ophGen::encoding ( )

Definition at line 525 of file ophGen.cpp.

◆ freqShift()

void ophGen::freqShift ( Complex< Real > *  src,
Complex< Real > *  dst,
const ivec2  holosize,
int  shift_x,
int  shift_y 
)
protected

Frequency shift.

Parameters
[in]srcSource data.
[out]dstDestination data.
[in]holosize
[in]shift_xX pixel value to shift
[in]shift_yY pixel value to shift

Definition at line 750 of file ophGen.cpp.

◆ fresnelPropagation() [1/2]

void ophGen::fresnelPropagation ( OphConfig  context,
Complex< Real > *  in,
Complex< Real > *  out,
Real  distance 
)

Fresnel propagation.

Parameters
[in]contextOphContext structure
[in]inInput complex field
[out]outOutput complex field
[in]distancePropagation distance

Definition at line 768 of file ophGen.cpp.

◆ fresnelPropagation() [2/2]

void ophGen::fresnelPropagation ( Complex< Real > *  in,
Complex< Real > *  out,
Real  distance,
uint  channel 
)

Fresnel propagation.

Parameters
[in]inInput complex field
[out]outOutput complex field
[in]distancePropagation distance
[in]channelindex of channel

Definition at line 842 of file ophGen.cpp.

◆ getElapsedTime()

Real ophGen::getElapsedTime ( )
inline

Function for getting elapsed time.

Returns
Type: Real
If the function succeeds, the return value is elapsed time.

Definition at line 276 of file ophGen.h.

◆ getEncodedBuffer()

Real** ophGen::getEncodedBuffer ( void  )
inline

Function for getting the encoded complex field buffer.

Returns
Type: Real**
If the function succeeds, the return value is encoded complex field data's pointer.
If the function fails, the return value is nullptr.

Definition at line 103 of file ophGen.h.

◆ getEncodeSize()

ivec2& ophGen::getEncodeSize ( void  )
inline

Function for getting encode size.

Returns
Type: ivec2&
If the function succeeds, the return value is encode size.
If the function fails, the return value is nullptr.

Definition at line 263 of file ophGen.h.

◆ getNormalizedBuffer()

uchar** ophGen::getNormalizedBuffer ( void  )
inline

Function for getting the normalized(0~255) complex field buffer.

Returns
Type: uchar**
If the function succeeds, the return value is normalized complex field data's pointer.
If the function fails, the return value is nullptr.

Definition at line 110 of file ophGen.h.

◆ getRandPhaseValue()

void ophGen::getRandPhaseValue ( Complex< Real > &  rand_phase_val,
bool  rand_phase 
)
protected

Assign random phase value if RANDOM_PHASE == 1.

If RANDOM_PHASE == 1, calculate a random phase value using random generator
otherwise, random phase value is 1.

Parameters
[out]rand_phase_valInput & Ouput value.
[in]rand_phaserandom or not.

Definition at line 1266 of file ophGen.cpp.

◆ getShiftPhaseValue()

void ophGen::getShiftPhaseValue ( Complex< Real > &  shift_phase_val,
int  idx,
ivec2  sig_location 
)
protected

Calculate the shift phase value.

Parameters
[in]shift_phase_valoutput variable.
[in]idxthe current pixel position.
[in]sig_locationsignal location.
See also
encodingSideBand_CPU, encodeSymmetrization

Definition at line 1224 of file ophGen.cpp.

◆ initialize()

void ophGen::initialize ( void  )

Initialize variables for Hologram complex field, encoded data, normalized data.

Definition at line 69 of file ophGen.cpp.

◆ load()

void * ophGen::load ( const char *  fname)

Function for loading image files.

Parameters
[in]fnameFile name.

Definition at line 333 of file ophGen.cpp.

◆ loadAsOhc()

bool ophGen::loadAsOhc ( const char *  fname)
virtual

Function to read OHC file.

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

Reimplemented from Openholo.

Definition at line 345 of file ophGen.cpp.

◆ loadPointCloud()

int ophGen::loadPointCloud ( const char *  pc_file,
OphPointCloudData pc_data_ 
)

load to point cloud data.

Parameters
[in]pc_filePoint cloud data file name
[out]pc_data_Point cloud data - number of points, number of color, geometry of point cloud, color data, phase data
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 133 of file ophGen.cpp.

◆ normalize()

void ophGen::normalize ( void  )

Normalization function to save as image file after hologram creation.

Definition at line 252 of file ophGen.cpp.

◆ numericalInterference()

void ophGen::numericalInterference ( Complex< Real > *  holo,
Real encoded,
const int  size 
)
protected

Encoding method.

Parameters
[in]holoSource data.
[out]encodedDestination data.
[in]sizesize of encode.

Definition at line 593 of file ophGen.cpp.

◆ ophFree()

void ophGen::ophFree ( void  )
protectedvirtual

Pure virtual function for override in child classes.

Reimplemented from Openholo.

Reimplemented in ophDepthMap.

Definition at line 1299 of file ophGen.cpp.

◆ propagationAngularSpectrum()

void ophGen::propagationAngularSpectrum ( int  ch,
Complex< Real > *  input_u,
Real  propagation_dist,
Real  k,
Real  lambda 
)

Angular spectrum propagation method.

Parameters
[in]chindex of channel.
[in]input_uEach depth plane data.
[in]propagation_distthe distance from the object to the hologram plane.
[in]kconst value.
[in]lambdawave length.
See also
calcHoloCPU, fftwShift

Definition at line 218 of file ophGen.cpp.

◆ readConfig()

bool ophGen::readConfig ( const char *  fname)

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 150 of file ophGen.cpp.

◆ resetBuffer()

void ophGen::resetBuffer ( )
protected

reset buffer

buffer memory set '0'

Definition at line 363 of file ophGen.cpp.

◆ save() [1/2]

bool ophGen::save ( const char *  fname,
uint8_t  bitsperpixel = 8,
uchar src = nullptr,
uint  px = 0,
uint  py = 0 
)

Function for saving image files.

Parameters
[in]fnameInput file name.
[in]bitsperpixelbits per pixel.
[in]srcSource data.
[in]pximage width.
[in]pyimage height.
Returns
Type: bool
If the function succeeds, the return value is true.
If the function fails, the return value is false.

Definition at line 258 of file ophGen.cpp.

◆ save() [2/2]

bool ophGen::save ( const char *  fname,
uint8_t  bitsperpixel,
uint  px,
uint  py,
uint  fnum,
uchar args ... 
)
protected

Called when saving multiple hologram data at a time.

Parameters
[in]fnameInput file name.
[in]bitsperpixelbits per pixel.
[in]pximage width.
[in]pyimage height.
Returns
Type: bool
If the function succeeds, the return value is true.
If the function fails, the return value is false.

Definition at line 303 of file ophGen.cpp.

◆ setResolution()

void ophGen::setResolution ( ivec2  resolution)

Function for setting buffer size.

Parameters
[in]resolutionbuffer size.

Definition at line 1289 of file ophGen.cpp.

◆ singleSideBand()

void ophGen::singleSideBand ( Complex< Real > *  holo,
Real encoded,
const ivec2  holosize,
int  passband 
)
protected

Encoding method.

Parameters
[in]holoSource data.
[out]encodedDestination data.
[in]holosizesize of encode.
[in]passbanddirection of passband.

Definition at line 690 of file ophGen.cpp.

◆ twoPhaseEncoding()

void ophGen::twoPhaseEncoding ( Complex< Real > *  holo,
Real encoded,
const int  size 
)
protected

Definition at line 619 of file ophGen.cpp.

◆ waveCarry()

void ophGen::waveCarry ( Real  carryingAngleX,
Real  carryingAngleY,
Real  distance 
)

Wave carry.

Parameters
[in]carryingAngleXWave carrying angle in horizontal direction
[in]carryingAngleYWave carrying angle in vertical direction
[in]distanceDistance between the display and the object

Definition at line 936 of file ophGen.cpp.

Member Data Documentation

◆ elapsedTime

Real ophGen::elapsedTime
protected

Elapsed time of generate hologram.

Definition at line 246 of file ophGen.h.

◆ ENCODE_METHOD

int ophGen::ENCODE_METHOD
protected

Encoding method flag.

Definition at line 242 of file ophGen.h.

◆ encode_size

ivec2 ophGen::encode_size
protected

Encoded hologram size, varied from encoding type.

Definition at line 240 of file ophGen.h.

◆ holo_encoded

Real** ophGen::holo_encoded
protected

buffer to encoded.

Definition at line 248 of file ophGen.h.

◆ holo_normalized

uchar** ophGen::holo_normalized
protected

buffer to normalized.

Definition at line 250 of file ophGen.h.

◆ SSB_PASSBAND

int ophGen::SSB_PASSBAND
protected

Passband in Single-side band encoding.

Definition at line 244 of file ophGen.h.


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