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

#include <ophSig.h>

Inheritance diagram for ophSig:
Collaboration diagram for ophSig:

Public Member Functions

 ophSig (void)
 Constructor. More...
 
bool load (const char *real, const char *imag)
 Load bmp or bin file. More...
 
bool save (const char *real, const char *imag)
 Save data as bmp or bin file. More...
 
bool save (const char *real)
 
bool loadAsOhc (const char *fname)
 Load data as ohc file. More...
 
bool saveAsOhc (const char *fname)
 Save data as ohc file. More...
 
template<typename T >
void linInterp (vector< T > &X, matrix< Complex< T >> &src, vector< T > &Xq, matrix< Complex< T >> &dst)
 Linear interpolation. More...
 
template<typename T >
vector< T > linspace (T first, T last, int len)
 Generate linearly spaced vector. More...
 
template<typename T >
void absMat (matrix< Complex< T >> &src, matrix< T > &dst)
 Function for extracts Complex absolute value. More...
 
template<typename T >
void absMat (matrix< T > &src, matrix< T > &dst)
 Function for extracts real absolute value. More...
 
template<typename T >
void angleMat (matrix< Complex< T >> &src, matrix< T > &dst)
 Function for extracts Complex phase value. More...
 
template<typename T >
void conjMat (matrix< Complex< T >> &src, matrix< Complex< T >> &dst)
 Function for extracts Complex conjugate value. More...
 
template<typename T >
void expMat (matrix< Complex< T >> &src, matrix< Complex< T >> &dst)
 Function for extracts exponent e(x), where x is complex number. More...
 
template<typename T >
void expMat (matrix< T > &src, matrix< T > &dst)
 Function for extracts exponent e(x), where x is real number. More...
 
template<typename T >
void meanOfMat (matrix< T > &src, T &dst)
 Function for extracts mean of matrix. More...
 
Real maxOfMat (matrix< Real > &src)
 Function for extracts maximum of matrix , where matrix is real number. More...
 
Complex< RealmaxOfMat (matrix< Complex< Real >> &src)
 Function for extracts maximum of matrix , where matrix is complex number. More...
 
Real minOfMat (matrix< Real > &src)
 Function for extracts minimum of matrix , where matrix is real number. More...
 
Complex< RealminOfMat (matrix< Complex< Real >> &src)
 Function for extracts minimum of matrix , where matrix is complex number. More...
 
void fftShift (matrix< Complex< Real >> &src, matrix< Complex< Real >> &dst)
 Shift zero-frequency component to center of spectrum. More...
 
template<typename T >
void fft1 (matrix< Complex< T >> &src, matrix< Complex< T >> &dst, int sign=OPH_FORWARD, uint flag=OPH_ESTIMATE)
 Function for Fast Fourier transform 1D. More...
 
template<typename T >
void fft2 (matrix< Complex< T >> &src, matrix< Complex< T >> &dst, int sign=OPH_FORWARD, uint flag=OPH_ESTIMATE)
 Function for Fast Fourier transform 2D. More...
 
bool readConfig (const char *fname)
 Function for Read parameter. More...
 
void Parameter_Set (int nx, int ny, double width, double height, double NA)
 
void wavelength_Set (double wavelength)
 
void focal_length_Set (double red, double green, double blue, double rad)
 
void Data_output (uchar *data, int pos, int bitpixel)
 
void Wavenumber_output (int &wavenumber)
 
bool sigConvertOffaxis (Real angleX, Real angleY)
 Function for Convert complex hologram to off-axis hologram. More...
 
bool cvtOffaxis_CPU (Real angleX, Real angleY)
 
void cvtOffaxis_GPU (Real angleX, Real angleY)
 
bool sigConvertHPO (Real depth, Real_t redRate)
 Function for convert complex hologram to horizontal parallax only hologram. More...
 
bool sigConvertCAC (double red, double green, double blue)
 Function for Chromatic aberration compensation filter. More...
 
bool propagationHolo (float depth)
 Function for propagation hologram (class data) More...
 
OphComplexField propagationHolo (OphComplexField complexH, float depth)
 Function for propagation hologram. More...
 
double sigGetParamAT ()
 Extraction of distance parameter using axis transfomation. More...
 
double sigGetParamSF (float zMax, float zMin, int sampN, float th)
 Extraction of distance parameter using sharpness functions. More...
 
void setMode (bool is_CPU)
 Function for select device. More...
 
void cField2Buffer (matrix< Complex< Real >> &src, Complex< Real > **dst, int nx, int ny)
 Function for move data from matrix<Complex<Real>> to Complex<Real> More...
 
void ColorField2Buffer (matrix< Complex< Real >> &src, Complex< Real > **dst, int nx, int ny)
 Function for move Color data from matrix<Complex<Real>> to Complex<Real> More...
 
bool getComplexHFromPSDH (const char *fname0, const char *fname90, const char *fname180, const char *fname270)
 Extraction of complex field from 4 phase shifted interference patterns. More...
 
bool getComplexHFrom3ArbStepPSDH (const char *f0, const char *f1, const char *f2, const char *fOI, const char *fRI, int nIter)
 Extraction of complex field from 3 phase shifted interference patterns with arbitrary unknown shifts. 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...
 
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 ~ophSig (void)=default
 
virtual void ophFree (void)
 Pure virtual function for override in child classes. More...
 
bool sigConvertOffaxis_CPU (Real angleX, Real angleY)
 Function for Convert complex hologram to off-axis hologram by using CPU. More...
 
bool sigConvertOffaxis_GPU (Real angleX, Real angleY)
 Function for Convert complex hologram to off-axis hologram by using GPU. More...
 
bool sigConvertHPO_CPU (Real depth, Real_t redRate)
 Function for convert complex hologram to horizontal parallax only hologram by using CPU. More...
 
bool sigConvertHPO_GPU (Real depth, Real_t redRate)
 Function for convert complex hologram to horizontal parallax only hologram by using GPU. More...
 
bool sigConvertCAC_CPU (double red, double green, double blue)
 Function for Chromatic aberration compensation filter by using CPU . More...
 
bool sigConvertCAC_GPU (double red, double green, double blue)
 Function for Chromatic aberration compensation filter by using GPU. More...
 
double sigGetParamAT_CPU ()
 Extraction of distance parameter using axis transfomation by using CPU. More...
 
double sigGetParamAT_GPU ()
 Extraction of distance parameter using axis transfomation by using GPU. More...
 
double sigGetParamSF_CPU (float zMax, float zMin, int sampN, float th)
 Extraction of distance parameter using sharpness functions by using CPU. More...
 
double sigGetParamSF_GPU (float zMax, float zMin, int sampN, float th)
 Extraction of distance parameter using sharpness functions by using GPU. More...
 
bool propagationHolo_CPU (float depth)
 Function for propagation hologram by using CPU. More...
 
bool propagationHolo_GPU (float depth)
 Function for propagation hologram by using GPU. More...
 
bool Color_propagationHolo_GPU (float depth)
 
- 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...
 

Protected Attributes

bool is_CPU
 
ophSigConfig _cfgSig
 
OphComplexFieldComplexH
 
fftw_plan bwd_plan
 
fftw_plan fwd_plan
 
int _wavelength_num
 
Real_t _radius
 
Real_t _foc [3]
 
- 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

Author

Definition at line 478 of file ophSig.h.

Constructor & Destructor Documentation

◆ ~ophSig()

virtual ophSig::~ophSig ( void  )
protectedvirtualdefault

◆ ophSig()

ophSig::ophSig ( void  )
explicit

Constructor.

Definition at line 50 of file ophSig.cpp.

Member Function Documentation

◆ absMat() [1/2]

template<typename T >
void ophSig::absMat ( matrix< Complex< T >> &  src,
matrix< T > &  dst 
)
inline

Function for extracts Complex absolute value.

Parameters
srcInput data
dstOutput data

Definition at line 657 of file ophSig.h.

◆ absMat() [2/2]

template<typename T >
void ophSig::absMat ( matrix< T > &  src,
matrix< T > &  dst 
)
inline

Function for extracts real absolute value.

Parameters
srcInput data
dstOutput data

Definition at line 675 of file ophSig.h.

◆ angleMat()

template<typename T >
void ophSig::angleMat ( matrix< Complex< T >> &  src,
matrix< T > &  dst 
)
inline

Function for extracts Complex phase value.

Parameters
srcInput data
dstOutput data

Definition at line 693 of file ophSig.h.

◆ cField2Buffer()

void ophSig::cField2Buffer ( matrix< Complex< Real >> &  src,
Complex< Real > **  dst,
int  nx,
int  ny 
)

Function for move data from matrix<Complex<Real>> to Complex<Real>

Parameters
srcInput martix data
dstOutput data
nxX_axis size
nyY_axis size

Definition at line 56 of file ophSig.cpp.

◆ Color_propagationHolo_GPU()

bool ophSig::Color_propagationHolo_GPU ( float  depth)
protected

Definition at line 311 of file ophSig_GPU.cpp.

◆ ColorField2Buffer()

void ophSig::ColorField2Buffer ( matrix< Complex< Real >> &  src,
Complex< Real > **  dst,
int  nx,
int  ny 
)

Function for move Color data from matrix<Complex<Real>> to Complex<Real>

Parameters
srcInput martix data
dstOutput data
nxX_axis size
nyY_axis size

Definition at line 71 of file ophSig.cpp.

◆ conjMat()

template<typename T >
void ophSig::conjMat ( matrix< Complex< T >> &  src,
matrix< Complex< T >> &  dst 
)
inline

Function for extracts Complex conjugate value.

Parameters
srcInput data
dstOutput data

Definition at line 711 of file ophSig.h.

◆ cvtOffaxis_CPU()

bool ophSig::cvtOffaxis_CPU ( Real  angleX,
Real  angleY 
)

Definition at line 1101 of file ophSig.cpp.

◆ cvtOffaxis_GPU()

void ophSig::cvtOffaxis_GPU ( Real  angleX,
Real  angleY 
)

Definition at line 64 of file ophSig_GPU.cpp.

◆ Data_output()

void ophSig::Data_output ( uchar data,
int  pos,
int  bitpixel 
)

Definition at line 744 of file ophSig.cpp.

◆ expMat() [1/2]

template<typename T >
void ophSig::expMat ( matrix< Complex< T >> &  src,
matrix< Complex< T >> &  dst 
)
inline

Function for extracts exponent e(x), where x is complex number.

Parameters
srcInput data
dstOutput data

Definition at line 730 of file ophSig.h.

◆ expMat() [2/2]

template<typename T >
void ophSig::expMat ( matrix< T > &  src,
matrix< T > &  dst 
)
inline

Function for extracts exponent e(x), where x is real number.

Parameters
srcInput data
dstOutput data

Definition at line 749 of file ophSig.h.

◆ fft1()

template<typename T >
void ophSig::fft1 ( matrix< Complex< T >> &  src,
matrix< Complex< T >> &  dst,
int  sign = OPH_FORWARD,
uint  flag = OPH_ESTIMATE 
)

Function for Fast Fourier transform 1D.

Parameters
srcInput data
dstOutput data
signsign = OPH_FORWARD is fft and sign= OPH_BACKWARD is inverse fft
flagflag = OPH_ESTIMATE is fine best way to compute the transform but it is need some time, flag = OPH_ESTIMATE is probably sub-optimal

Definition at line 113 of file ophSig.cpp.

◆ fft2()

template<typename T >
void ophSig::fft2 ( matrix< Complex< T >> &  src,
matrix< Complex< T >> &  dst,
int  sign = OPH_FORWARD,
uint  flag = OPH_ESTIMATE 
)

Function for Fast Fourier transform 2D.

Parameters
srcInput data
dstOutput data
signsign = OPH_FORWARD is fft and sign= OPH_BACKWARD is inverse fft
flagflag = OPH_ESTIMATE is fine best way to compute the transform but it is need some time, flag = OPH_ESTIMATE is probably sub-optimal

Definition at line 149 of file ophSig.cpp.

◆ fftShift()

void ophSig::fftShift ( matrix< Complex< Real >> &  src,
matrix< Complex< Real >> &  dst 
)
inline

Shift zero-frequency component to center of spectrum.

Parameters
srcInput data
dstOutput data

Definition at line 849 of file ophSig.h.

◆ focal_length_Set()

void ophSig::focal_length_Set ( double  red,
double  green,
double  blue,
double  rad 
)

Definition at line 1252 of file ophSig.cpp.

◆ linInterp()

template<typename T >
void ophSig::linInterp ( vector< T > &  X,
matrix< Complex< T >> &  src,
vector< T > &  Xq,
matrix< Complex< T >> &  dst 
)

Linear interpolation.

Parameters
XSample point
srcSample values
XqQuery points
XqQuery values

Definition at line 90 of file ophSig.cpp.

◆ linspace()

template<typename T >
vector<T> ophSig::linspace ( first,
last,
int  len 
)
inline

Generate linearly spaced vector.

Parameters
firstFirst number of vector
lastLast number of vector
lenVector with specified number of values
Returns
Result vector

Definition at line 645 of file ophSig.h.

◆ load()

bool ophSig::load ( const char *  real,
const char *  imag 
)

Load bmp or bin file.

Parameters
realReal data file name
imagImag data file name
Returns
If works well return 0 or error occurs return -1

Definition at line 257 of file ophSig.cpp.

◆ loadAsOhc()

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

Load data as ohc file.

Parameters
fnameFile name
Returns
If works well return 0 or error occurs return -1

Reimplemented from Openholo.

Definition at line 198 of file ophSig.cpp.

◆ maxOfMat() [1/2]

Real ophSig::maxOfMat ( matrix< Real > &  src)
inline

Function for extracts maximum of matrix , where matrix is real number.

Parameters
srcInput data
Returns
Output data

Definition at line 783 of file ophSig.h.

◆ maxOfMat() [2/2]

Complex<Real> ophSig::maxOfMat ( matrix< Complex< Real >> &  src)
inline

Function for extracts maximum of matrix , where matrix is complex number.

Parameters
srcInput data
Returns
Output data

Definition at line 799 of file ophSig.h.

◆ meanOfMat()

template<typename T >
void ophSig::meanOfMat ( matrix< T > &  src,
T &  dst 
)
inline

Function for extracts mean of matrix.

Parameters
srcInput data
dstOutput data

Definition at line 767 of file ophSig.h.

◆ minOfMat() [1/2]

Real ophSig::minOfMat ( matrix< Real > &  src)
inline

Function for extracts minimum of matrix , where matrix is real number.

Parameters
srcInput signal

Definition at line 817 of file ophSig.h.

◆ minOfMat() [2/2]

Complex<Real> ophSig::minOfMat ( matrix< Complex< Real >> &  src)
inline

Function for extracts minimum of matrix , where matrix is complex number.

Parameters
srcInput data

Definition at line 832 of file ophSig.h.

◆ ophFree()

void ophSig::ophFree ( void  )
protectedvirtual

Pure virtual function for override in child classes.

Reimplemented from Openholo.

Definition at line 2042 of file ophSig.cpp.

◆ Parameter_Set()

void ophSig::Parameter_Set ( int  nx,
int  ny,
double  width,
double  height,
double  NA 
)

Definition at line 1238 of file ophSig.cpp.

◆ propagationHolo() [1/2]

bool ophSig::propagationHolo ( float  depth)

Function for propagation hologram (class data)

Parameters
depthPosition from hologram plane to propagation hologram plane
Returns
If works well return 0 or error occurs return -1

Definition at line 1054 of file ophSig.cpp.

◆ propagationHolo() [2/2]

OphComplexField ophSig::propagationHolo ( OphComplexField  complexH,
float  depth 
)

Function for propagation hologram.

Parameters
complexHInput data
depthposition from hologram plane to propagation hologram plane
Returns
Output data

Definition at line 1349 of file ophSig.cpp.

◆ propagationHolo_CPU()

bool ophSig::propagationHolo_CPU ( float  depth)
protected

Function for propagation hologram by using CPU.

Parameters
depthPosition from hologram plane to propagation hologram plane
Returns
If works well return 0 or error occurs return -1

Definition at line 1308 of file ophSig.cpp.

◆ propagationHolo_GPU()

bool ophSig::propagationHolo_GPU ( float  depth)
protected

Function for propagation hologram by using GPU.

Parameters
depthPosition from hologram plane to propagation hologram plane
Returns
If works well return 0 or error occurs return -1

Definition at line 255 of file ophSig_GPU.cpp.

◆ readConfig()

bool ophSig::readConfig ( const char *  fname)

Function for Read parameter.

Parameters
fnamefile name
Returns
if works well return 0 or error occurs return -1

Definition at line 1265 of file ophSig.cpp.

◆ save() [1/2]

bool ophSig::save ( const char *  real,
const char *  imag 
)

Save data as bmp or bin file.

Parameters
realReal data file name
imagImag data file name
Returns
If works well return 0 or error occurs return -1

Definition at line 391 of file ophSig.cpp.

◆ save() [2/2]

bool ophSig::save ( const char *  real)

Definition at line 649 of file ophSig.cpp.

◆ saveAsOhc()

bool ophSig::saveAsOhc ( const char *  fname)
virtual

Save data as ohc file.

Parameters
fnameFile name
Returns
If works well return 0 or error occurs return -1

Reimplemented from Openholo.

Definition at line 227 of file ophSig.cpp.

◆ setMode()

void ophSig::setMode ( bool  is_CPU)

Function for select device.

Parameters
is_CPUIf is_CPU = true using CPU , is_CPU = false using GPU

Definition at line 84 of file ophSig.cpp.

◆ wavelength_Set()

void ophSig::wavelength_Set ( double  wavelength)

Definition at line 1247 of file ophSig.cpp.

◆ Wavenumber_output()

void ophSig::Wavenumber_output ( int &  wavenumber)

Definition at line 1260 of file ophSig.cpp.

Member Data Documentation

◆ _cfgSig

ophSigConfig ophSig::_cfgSig
protected

Definition at line 486 of file ophSig.h.

◆ _foc

Real_t ophSig::_foc[3]
protected

Definition at line 492 of file ophSig.h.

◆ _radius

Real_t ophSig::_radius
protected

Definition at line 491 of file ophSig.h.

◆ _wavelength_num

int ophSig::_wavelength_num
protected

Definition at line 490 of file ophSig.h.

◆ bwd_plan

fftw_plan ophSig::bwd_plan
protected

Definition at line 488 of file ophSig.h.

◆ ComplexH

OphComplexField* ophSig::ComplexH
protected

Definition at line 487 of file ophSig.h.

◆ fwd_plan

fftw_plan ophSig::fwd_plan
protected

Definition at line 488 of file ophSig.h.

◆ is_CPU

bool ophSig::is_CPU
protected

Definition at line 485 of file ophSig.h.


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