#include <ophGen.h>

Inheritance diagram for ophGen:

[legend]

Collaboration diagram for ophGen:

[legend]

Public Types
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
	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 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...

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 ()

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

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 (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 uchar *	loadAsImg (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...

OphConfig &	getContext (void)
	Function for getting the current context. More...

ImageConfig &	getImageConfig ()
	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	~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 scaleFactor=2)

void	encodeSideBand (unsigned int passband)
	Encode the CGH according to a passband 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, bool bShift=true)
	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	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

Real *	weight

Complex< Real > *	weightC

Complex< Real > *	freqW

Real *	realEnc

Real *	binary

Real *	maskSSB

Real *	maskHP

bool	m_bRandomPhase

Protected Attributes inherited from Openholo
OphConfig	context_

ResolutionConfig	resCfg

ImageConfig	imgCfg

Complex< Real > **	complex_H

ImgEncoderOhc *	OHC_encoder
	OHC file format Variables for read and write. More...

ImgDecoderOhc *	OHC_decoder

Protected Attributes inherited from Base
unsigned long	refCnt

Detailed Description

Author

Definition at line 76 of file ophGen.h.

Member Enumeration Documentation

◆ ED_WType

enum ophGen::ED_WType

Enumerator
FLOYD_STEINBERG
SINGLE_RIGHT
SINGLE_DOWN
ITERATIVE_DESIGN

Definition at line 421 of file ophGen.h.

◆ ENCODE_FLAG

enum ophGen::ENCODE_FLAG

Enumerator
ENCODE_PHASE
ENCODE_AMPLITUDE
ENCODE_REAL
ENCODE_IMAGINARY
ENCODE_SIMPLENI
ENCODE_BURCKHARDT
ENCODE_TWOPHASE
ENCODE_SSB
ENCODE_OFFSSB
ENCODE_SIMPLEBINARY
ENCODE_EDBINARY

Definition at line 84 of file ophGen.h.

◆ PRECISION

enum ophGen::PRECISION

Enumerator
SINGLE
DOUBLE

Definition at line 79 of file ophGen.h.

◆ SSB_PASSBAND

enum ophGen::SSB_PASSBAND

Enumerator
SSB_LEFT
SSB_RIGHT
SSB_TOP
SSB_BOTTOM

Definition at line 295 of file ophGen.h.

Constructor & Destructor Documentation

◆ ophGen()

ophGen::ophGen ( void )

explicit

Constructor.

Definition at line 112 of file ophGen.cpp.

◆ ~ophGen()

ophGen::~ophGen ( void )

protectedpure virtual

Destructor.

Definition at line 141 of file ophGen.cpp.

Member Function Documentation

◆ Amplitude()

template<typename T >

void ophGen::Amplitude	(	Complex< T > *	holo,
		T *	encoded,
		const int	size
	)

protected

Definition at line 1855 of file ophGen.cpp.

◆ AngularSpectrumMethod()

void ophGen::AngularSpectrumMethod	(	Complex< Real > *	src,
		Complex< Real > *	dst,
		Real	lambda,
		Real	distance
	)

Angular spectrum propagation method.

Parameters

[in]	src	Each depth plane data.
[out]	dst	complex data.
[in]	lambda	wave length.
[in]	distance	the distance from the object to the hologram plane.

See also: calcHoloCPU, fft2

Definition at line 583 of file ophGen.cpp.

◆ binarization()

void ophGen::binarization	(	Complex< Real > *	src,
		Real *	dst,
		const int	size,
		int	ENCODE_FLAG,
		Real	threshold
	)

protected

Definition at line 1400 of file ophGen.cpp.

◆ binaryErrorDiffusion()

bool ophGen::binaryErrorDiffusion	(	Complex< Real > *	holo,
		Real *	encoded,
		const ivec2	holosize,
		const int	type,
		Real	threshold
	)

protected

Definition at line 1231 of file ophGen.cpp.

◆ Burckhardt()

template<typename T >

void ophGen::Burckhardt	(	Complex< T > *	holo,
		T *	encoded,
		const int	size
	)

protected

Definition at line 1901 of file ophGen.cpp.

◆ conv_fft2()

void ophGen::conv_fft2	(	Complex< Real > *	src1,
		Complex< Real > *	src2,
		Complex< Real > *	dst,
		ivec2	size
	)

Convolution between Complex arrays which have same size.

Parameters

[in]	src1	convolution matrix 1
[in]	src2	convolution matrix 2
[in]	dst	convolution destination matrix
[in]	size	matrix size

Definition at line 632 of file ophGen.cpp.

◆ CorrectionChromaticAberration()

void ophGen::CorrectionChromaticAberration	(	uchar *	src,
		uchar *	dst,
		int	width,
		int	height,
		int	scaleFactor = `2`
	)

protected

Definition at line 2026 of file ophGen.cpp.

◆ encodeSideBand()

void ophGen::encodeSideBand ( unsigned int passband )

protected

Encode the CGH according to a passband parameter.

Parameters

[in] passband direction of passband.

See also: encodeSideBand_CPU, encodeSideBand_GPU

Definition at line 1607 of file ophGen.cpp.

◆ encodeSideBand_CPU()

void ophGen::encodeSideBand_CPU	(	int	cropx1,
		int	cropx2,
		int	cropy1,
		int	cropy2,
		oph::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]	cropx1	the start x-coordinate to crop
[in]	cropx2	the end x-coordinate to crop
[in]	cropy1	the start y-coordinate to crop
[in]	cropy2	the end y-coordinate to crop
[in]	sig_location	Signal location sig_location[0]: upper or lower half, sig_location[1]:left or right half.

See also: fft2

Definition at line 1655 of file ophGen.cpp.

◆ encodeSideBand_GPU()

void ophGen::encodeSideBand_GPU	(	int	cropx1,
		int	cropx2,
		int	cropy1,
		int	cropy2,
		oph::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]	cropx1	the start x-coordinate to crop
[in]	cropx2	the end x-coordinate to crop
[in]	cropy1	the start y-coordinate to crop
[in]	cropy2	the end y-coordinate to crop
[in]	sig_location	Signal location sig_location[0]: upper or lower half, sig_location[1]:left or right half.

See also: cudaCropFringe, cudaFFT, cudaGetFringe

Definition at line 1697 of file ophGen.cpp.

◆ encoding() [1/5]

void ophGen::encoding ( unsigned int ENCODE_FLAG )

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_FLAG	encoding method.
[in]	holo	buffer to encode. 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 816 of file ophGen.cpp.

◆ encoding() [2/5]

void ophGen::encoding	(	unsigned int	ENCODE_FLAG,
		Complex< Real > *	holo,
		Real *	encoded
	)

Definition at line 853 of file ophGen.cpp.

◆ encoding() [3/5]

void ophGen::encoding ( )

Definition at line 962 of file ophGen.cpp.

◆ encoding() [4/5]

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

virtual

Definition at line 882 of file ophGen.cpp.

◆ encoding() [5/5]

void ophGen::encoding	(	unsigned int	BIN_ENCODE_FLAG,
		unsigned int	ENCODE_FLAG,
		Real	threshold,
		Complex< Real > *	holo = `nullptr`,
		Real *	encoded = `nullptr`
	)

Binary 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
ENCODE_SIMPLEBINARY : Simple binary encoding
ENCODE_EDBINARY : Error diffusion binary encoding

Parameters

[in]	BIN_ENCODE_FLAG	binarization method.
[in]	ENCODE_FLAG	encoding method for binarization.
[in]	threshold	threshold for binarization.
[in]	holo	buffer to encode. 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 925 of file ophGen.cpp.

◆ freqShift()

void ophGen::freqShift	(	Complex< Real > *	holo,
		Complex< Real > *	encoded,
		const ivec2	holosize,
		int	shift_x,
		int	shift_y
	)

protected

Frequency shift.

Parameters

[in]	holo	Source data.
[out]	encoded	Destination data.
[in]	holosize
[in]	shift_x	X pixel value to shift
[in]	shift_y	Y pixel value to shift

Definition at line 1079 of file ophGen.cpp.

◆ Fresnel_Diffraction()

void ophGen::Fresnel_Diffraction	(	Point	src,
		Complex< Real > *	dst,
		Real	lambda,
		Real	distance,
		Real	amplitude
	)

Fresnel-diffraction method.

Parameters

[in]	src	point coordinate data.
[out]	dst	complex data.
[in]	lambda	wave length.
[in]	distance	the distance from the object to the hologram plane.
[in]	amplitude	point color data.

Definition at line 447 of file ophGen.cpp.

◆ Fresnel_FFT()

void ophGen::Fresnel_FFT	(	Complex< Real > *	src,
		Complex< Real > *	dst,
		Real	lambda,
		Real	distance
	)

Fresnel-fft method.

Parameters

[in]	src	plane color data.
[out]	dst	complex data.
[in]	lambda	wave length.
[in]	distance	the distance from the object to the hologram plane.

See also: fft2

Definition at line 516 of file ophGen.cpp.

◆ fresnelPropagation()

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

Fresnel propagation.

Parameters

[in]	in	Input complex field
[out]	out	Output complex field
[in]	distance	Propagation distance
[in]	channel	index of channel

Definition at line 1416 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 376 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 117 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 363 of file ophGen.h.

◆ getFieldLength()

Real ophGen::getFieldLength ( )

inline

Definition at line 356 of file ophGen.h.

◆ GetMaxMin()

void ophGen::GetMaxMin	(	Real *	src,
		int	len,
		Real &	max,
		Real &	min
	)

protected

Definition at line 2010 of file ophGen.cpp.

◆ GetMode()

unsigned int ophGen::GetMode ( )

inline

Definition at line 530 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 124 of file ophGen.h.

◆ getPrecision()

uint ophGen::getPrecision ( )

inline

Definition at line 260 of file ophGen.h.

◆ GetRandomPhase()

bool ophGen::GetRandomPhase ( )

inline

Function for getting the random phase.

Returns: Type: bool
If the succeeds to use random phase, the return value is true.
If the fails to not use random phase, the return value is false.

Definition at line 528 of file ophGen.h.

◆ GetRandomPhaseValue()

void ophGen::GetRandomPhaseValue	(	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_val	Input & Ouput value.
[in]	rand_phase	random or not.

Definition at line 1783 of file ophGen.cpp.

◆ getShiftPhaseValue()

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

protected

Calculate the shift phase value.

Parameters

[in]	shift_phase_val	output variable.
[in]	idx	the current pixel position.
[in]	sig_location	signal location.

See also: encodingSideBand_CPU

Definition at line 1741 of file ophGen.cpp.

◆ getStream()

int ophGen::getStream ( )

inline

Definition at line 355 of file ophGen.h.

◆ getWeightED()

bool ophGen::getWeightED	(	const ivec2	holosize,
		const int	type,
		ivec2 *	pNw
	)

protected

Definition at line 1337 of file ophGen.cpp.

◆ ImaginaryPart()

template<typename T >

void ophGen::ImaginaryPart	(	Complex< T > *	holo,
		T *	encoded,
		const int	size
	)

protected

Definition at line 1832 of file ophGen.cpp.

◆ initialize()

void ophGen::initialize ( void )

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

Definition at line 146 of file ophGen.cpp.

◆ load()

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

Function for loading image files.

Parameters

[in] fname File name.

Definition at line 771 of file ophGen.cpp.

◆ loadAsOhc()

bool ophGen::loadAsOhc ( const char * fname )

virtual

Function to read OHC file.

Parameters

[in] fname File 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 783 of file ophGen.cpp.

◆ loadPointCloud()

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

load to point cloud data.

Parameters

[in]	pc_file	Point 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 207 of file ophGen.cpp.

◆ normalize()

void ophGen::normalize ( void )

Normalization function to save as image file after hologram creation.

Definition at line 654 of file ophGen.cpp.

◆ ophFree()

void ophGen::ophFree ( void )

protectedvirtual

Pure virtual function for override in child classes.

Reimplemented from Openholo.

Reimplemented in ophDepthMap, and ophLF.

Definition at line 2072 of file ophGen.cpp.

◆ Phase()

template<typename T >

void ophGen::Phase	(	Complex< T > *	holo,
		T *	encoded,
		const int	size
	)

protected

Definition at line 1843 of file ophGen.cpp.

◆ readConfig()

bool ophGen::readConfig ( const char * fname )

load to configuration file.

Parameters

[in] fname config 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 221 of file ophGen.cpp.

◆ RealPart()

template<typename T >

void ophGen::RealPart	(	Complex< T > *	holo,
		T *	encoded,
		const int	size
	)

protected

Encoding method.

Parameters

[in]	holo	Source data.
[out]	encoded	Destination data.
[in]	size	size of encode.

Definition at line 1821 of file ophGen.cpp.

◆ resetBuffer()

void ophGen::resetBuffer ( )

protected

reset buffer

buffer memory set '0'

Definition at line 801 of file ophGen.cpp.

◆ RS_Diffraction()

void ophGen::RS_Diffraction	(	Point	src,
		Complex< Real > *	dst,
		Real	lambda,
		Real	distance,
		Real	amplitude
	)

RS-diffraction method.

Parameters

[in]	src	point coordinate data.
[out]	dst	complex data.
[in]	lambda	wave length.
[in]	distance	the distance from the object to the hologram plane.
[in]	amplitude	point color data.

Definition at line 361 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]	fname	Input file name.
[in]	bitsperpixel	bits per pixel.
[in]	src	Source data.
[in]	px	image width.
[in]	py	image 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 689 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]	fname	Input file name.
[in]	bitsperpixel	bits per pixel.
[in]	px	image width.
[in]	py	image height.

Returns: Type: bool
If the function succeeds, the return value is true.
If the function fails, the return value is false.

◆ saveRefImages()

bool ophGen::saveRefImages	(	char *	fnameW,
		char *	fnameWC,
		char *	fnameAS,
		char *	fnameSSB,
		char *	fnameHP,
		char *	fnameFreq,
		char *	fnameReal,
		char *	fnameBin,
		char *	fnameReconBin,
		char *	fnameReconErr,
		char *	fnameReconNo
	)

Definition at line 1100 of file ophGen.cpp.

◆ ScaleChange()

void ophGen::ScaleChange	(	Real *	src,
		Real *	dst,
		int	nSize,
		Real	scaleX,
		Real	scaleY,
		Real	scaleZ
	)

protected

Definition at line 1994 of file ophGen.cpp.

◆ setEncodeMethod()

void ophGen::setEncodeMethod ( unsigned int ENCODE_FLAG )

inline

Definition at line 262 of file ophGen.h.

◆ SetMode()

void ophGen::SetMode ( unsigned int mode )

inline

Definition at line 529 of file ophGen.h.

◆ setPrecision()

void ophGen::setPrecision ( uint precision )

inline

Function for setting precision.

Parameters

[in] precision level.

Definition at line 259 of file ophGen.h.

◆ SetRandomPhase()

void ophGen::SetRandomPhase ( bool bRandomPhase )

inline

Function for setting the random phase.

Definition at line 520 of file ophGen.h.

◆ setResolution()

void ophGen::setResolution ( ivec2 resolution )

Function for setting buffer size.

Parameters

[in] resolution buffer size.

Definition at line 1806 of file ophGen.cpp.

◆ Shift()

bool ophGen::Shift	(	Real	x,
		Real	y
	)

Definition at line 1482 of file ophGen.cpp.

◆ shiftW()

bool ophGen::shiftW ( ivec2 holosize )

protected

Definition at line 1374 of file ophGen.cpp.

◆ SimpleNI()

template<typename T >

void ophGen::SimpleNI	(	Complex< T > *	holo,
		T *	encoded,
		const int	size
	)

protected

Definition at line 1953 of file ophGen.cpp.

◆ singleSideBand()

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

protected

Encoding method.

Parameters

[in]	holo	Source data.
[out]	encoded	Destination data.
[in]	holosize	size of encode.
[in]	passband	direction of passband.

Definition at line 1023 of file ophGen.cpp.

◆ transVW() [1/2]

void ophGen::transVW	(	int	nVertex,
		Vertex *	dst,
		Vertex *	src
	)

Definition at line 1975 of file ophGen.cpp.

◆ transVW() [2/2]

void ophGen::transVW	(	int	nVertex,
		Real *	dst,
		Real *	src
	)

Definition at line 1986 of file ophGen.cpp.

◆ TwoPhase()

template<typename T >

void ophGen::TwoPhase	(	Complex< T > *	holo,
		T *	encoded,
		const int	size
	)

protected

Definition at line 1866 of file ophGen.cpp.

◆ waveCarry() [1/2]

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

Wave carry.

Parameters

[in]	carryingAngleX	Wave carrying angle in horizontal direction
[in]	carryingAngleY	Wave carrying angle in vertical direction
[in]	distance	Distance between the display and the object

Definition at line 1537 of file ophGen.cpp.

◆ waveCarry() [2/2]

void ophGen::waveCarry	(	Complex< Real > *	src,
		Complex< Real > *	dst,
		Real	wavelength,
		int	carryIdxX,
		int	carryIdxY
	)

Definition at line 1574 of file ophGen.cpp.

Member Data Documentation

◆ AS

Complex<Real>* ophGen::AS

protected

Binary Encoding - Error diffusion.

Definition at line 426 of file ophGen.h.

◆ binary

Real* ophGen::binary

protected

Definition at line 433 of file ophGen.h.

◆ ENCODE_METHOD

int ophGen::ENCODE_METHOD

protected

Encoding method flag.

Definition at line 332 of file ophGen.h.

◆ fftTemp

Complex<Real>* ophGen::fftTemp

protected

Definition at line 428 of file ophGen.h.

◆ freqW

Complex<Real>* ophGen::freqW

protected

Definition at line 431 of file ophGen.h.

◆ m_bRandomPhase

bool ophGen::m_bRandomPhase

protected

Definition at line 436 of file ophGen.h.

◆ m_dFieldLength

Real ophGen::m_dFieldLength

protected

Definition at line 348 of file ophGen.h.

◆ m_elapsedTime

Real ophGen::m_elapsedTime

protected

Elapsed time of generate hologram.

Definition at line 336 of file ophGen.h.

◆ m_lpEncoded

Real** ophGen::m_lpEncoded

protected

buffer to encoded.

Definition at line 338 of file ophGen.h.

◆ m_lpNormalized

uchar** ophGen::m_lpNormalized

protected

buffer to normalized.

Definition at line 340 of file ophGen.h.

◆ m_mode

unsigned int ophGen::m_mode

protected

Definition at line 350 of file ophGen.h.

◆ m_nStream

int ophGen::m_nStream

protected

Definition at line 349 of file ophGen.h.

◆ m_vecEncodeSize

ivec2 ophGen::m_vecEncodeSize

protected

Encoded hologram size, varied from encoding type.

Definition at line 330 of file ophGen.h.

◆ maskHP

Real* ophGen::maskHP

protected

Definition at line 435 of file ophGen.h.

◆ maskSSB

Real* ophGen::maskSSB

protected

Definition at line 434 of file ophGen.h.

◆ normalized

Complex<Real>* ophGen::normalized

protected

Definition at line 427 of file ophGen.h.

◆ realEnc

Real* ophGen::realEnc

protected

Definition at line 432 of file ophGen.h.

◆ SSB_PASSBAND

int ophGen::SSB_PASSBAND

protected

Passband in Single-side band encoding.

Definition at line 334 of file ophGen.h.

◆ weight

Real* ophGen::weight

protected

Definition at line 429 of file ophGen.h.

◆ weightC

Complex<Real>* ophGen::weightC

protected

Definition at line 430 of file ophGen.h.

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

C:/Users/KETI_VRAR2/source/repos/Openholo/ophgen/src/ophGen.h
C:/Users/KETI_VRAR2/source/repos/Openholo/ophgen/src/ophGen.cpp

Public Types

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Member Enumeration Documentation

◆ ED_WType

◆ ENCODE_FLAG

◆ PRECISION

◆ SSB_PASSBAND

Constructor & Destructor Documentation

◆ ophGen()

◆ ~ophGen()

Member Function Documentation

◆ Amplitude()

◆ AngularSpectrumMethod()

◆ binarization()

◆ binaryErrorDiffusion()

◆ Burckhardt()

◆ conv_fft2()

◆ CorrectionChromaticAberration()

◆ encodeSideBand()

◆ encodeSideBand_CPU()

◆ encodeSideBand_GPU()

◆ encoding() [1/5]

◆ encoding() [2/5]

◆ encoding() [3/5]

◆ encoding() [4/5]

◆ encoding() [5/5]

◆ freqShift()

◆ Fresnel_Diffraction()

◆ Fresnel_FFT()

◆ fresnelPropagation()

◆ getElapsedTime()

◆ getEncodedBuffer()

◆ getEncodeSize()

◆ getFieldLength()

◆ GetMaxMin()

◆ GetMode()

◆ getNormalizedBuffer()

◆ getPrecision()

◆ GetRandomPhase()

◆ GetRandomPhaseValue()

◆ getShiftPhaseValue()

◆ getStream()

◆ getWeightED()

◆ ImaginaryPart()

◆ initialize()

◆ load()

◆ loadAsOhc()

◆ loadPointCloud()

◆ normalize()

◆ ophFree()

◆ Phase()

◆ readConfig()

◆ RealPart()

◆ resetBuffer()

◆ RS_Diffraction()

◆ save() [1/2]

◆ save() [2/2]

◆ saveRefImages()

◆ ScaleChange()

◆ setEncodeMethod()

◆ SetMode()

◆ setPrecision()

◆ SetRandomPhase()

◆ setResolution()

◆ Shift()

◆ shiftW()

◆ SimpleNI()

◆ singleSideBand()

◆ transVW() [1/2]

◆ transVW() [2/2]

◆ TwoPhase()

◆ waveCarry() [1/2]

◆ waveCarry() [2/2]

Member Data Documentation

◆ AS

◆ binary

◆ ENCODE_METHOD