Parameters

Functions
void	CWO::SetCtx (const cwoCtx &c)
	Set context which manages the parameters of the wavelength, pixel pitch, etc.
cwoCtx &	CWO::GetCtx ()
	Get context which manages the parameters of the wavelength, pixel pitch, etc.
void	CWO::SetCalcType (int type)
	Set diffraction type. Do not use it.
void	CWO::SetPitch (float px, float py)
	Set the sampling rate on source and destination planes.
void	CWO::SetPitch (float p)
void	CWO::SetPitch (const cwoFloat2 &p)
void	CWO::SetPitch (const cwoVect2< float > &p)
void	CWO::SetSrcPitch (float px, float py)
	Set the sampling rate on source plane only.
void	CWO::SetSrcPitch (float p)
void	CWO::SetSrcPitch (const cwoFloat2 &p)
void	CWO::SetSrcPitch (const cwoVect2< float > &p)
void	CWO::SetDstPitch (float px, float py)
	Set the sampling rate on destination plane only.
void	CWO::SetDstPitch (float p)
void	CWO::SetDstPitch (const cwoFloat2 &p)
void	CWO::SetDstPitch (const cwoVect2< float > &p)
void	CWO::SetWaveLength (float w)
	Set the wavelength of light.
void	CWO::SetOffset (float x, float y)
	Set the offset of source plane away from the origin.
void	CWO::SetOffset (const cwoFloat2 &p)
void	CWO::SetOffset (const cwoVect2< float > &p)
void	CWO::SetSrcOffset (float x, float y)
	Set the offset of source plane away from the origin.
void	CWO::SetSrcOffset (const cwoFloat2 &p)
void	CWO::SetSrcOffset (const cwoVect2< float > &p)
void	CWO::SetDstOffset (float x, float y)
	Set the offset of destination plane away from the origin.
void	CWO::SetDstOffset (const cwoFloat2 &p)
void	CWO::SetDstOffset (const cwoVect2< float > &p)
void	CWO::SetThreads (int Nx, int Ny=1)
	set the number of threads
int	CWO::GetThreads ()
	get the number of threads
size_t	CWO::GetNx ()
	get horizontal pixel number
size_t	CWO::GetNy ()
	get vertical pixel number
cwoVect2< size_t >	CWO::GetShape ()
	get horizontal and vertical pixel number
float	CWO::GetWaveLength ()
	get wavelength
float	CWO::GetWaveNum ()
	get wave number
float	CWO::GetDistance ()
	get propagation distance
float	CWO::GetPx ()
	get sampling rate along to x-axis on source plane
float	CWO::GetPy ()
	get sampling rate along to y-axis on source plane
cwoVect2< float >	CWO::GetPitch ()
float	CWO::GetSrcPx ()
	get sampling rate along to x-axis on source plane
float	CWO::GetSrcPy ()
	get sampling rate along to y-axis on source plane
cwoVect2< float >	CWO::GetSrcPitch ()
float	CWO::GetDstPx ()
	get sampling rate along to x-axis on destination plane
float	CWO::GetDstPy ()
	get sampling rate along to y-axis on destination plane
cwoVect2< float >	CWO::GettDstPitch ()
float	CWO::GetOx ()
	get offset along to x-axis on source plane
float	CWO::GetOy ()
	get offset along to y-axis on source plane
cwoVect2< float >	CWO::GetOffset ()
float	CWO::GetSrcOx ()
	get offset along to x-axis on source plane
float	CWO::GetSrcOy ()
	get offset along to y-axis on source plane
cwoVect2< float >	CWO::GetSrcOffset ()
float	CWO::GetDstOx ()
	get offset along to x-axis on destination plane
float	CWO::GetDstOy ()
	get offset along to y-axis on destination plane
cwoVect2< float >	CWO::GetDstOffset ()
float	CWO::GetLx ()
	get physical length of source along to x-axis
float	CWO::GetLy ()
	get physical length of source along to y-axis
cwoVect2< float >	CWO::GetLength ()
float	CWO::GetSrcLx ()
	get physical length of source along to x-axis
float	CWO::GetSrcLy ()
	get physical length of source along to y-axis
cwoVect2< float >	CWO::GetSrcLength ()
float	CWO::GetDstLx ()
	get physical length of destication along to x-axis
float	CWO::GetDstLy ()
	get physical length of destication along to y-axis
cwoVect2< float >	CWO::GetDstLength ()
cwoVect2< int >	CWO::GetCenterPix ()
int	CWO::GetAliasingFreeApproxSphWave (float z, float p, float wl)
	get aliasing-free radius of approximated spherical wave
void	CWO::ShowParam ()
	Show parameters of cwoCtx.

---

Detailed Description

---

Function Documentation

void CWO::SetCtx ( const cwoCtx &  c )

inline

Set context which manages the parameters of the wavelength, pixel pitch, etc.

Set context which manages the parameters of the wavelength, pixel pitch, etc.

Parameters:

c

Context

cwoCtx& CWO::GetCtx ( )

inline

Get context which manages the parameters of the wavelength, pixel pitch, etc.

Get context which manages the parameters of the wavelength, pixel pitch, etc.

Returns:

Current context

void CWO::SetCalcType ( int  type )

inline

Set diffraction type. Do not use it.

Parameters:

type	diffraction type (e.g. CWO_ANGULAR)

void CWO::SetPitch ( float  px, float  py  )

inline

Set the sampling rate on source and destination planes.

Parameters:

px	horizon sampling rate (in meter)
py	vertical sampling rate (in meter)

void CWO::SetSrcPitch ( float  px, float  py  )

inline

Set the sampling rate on source plane only.

Parameters:

px	horizon sampling rate (in meter)
py	vertical sampling rate (in meter)

< Set sampling rate on source plane

Examples:

Shifted-Fresnel diffraction, and Using CPU threads.

void CWO::SetDstPitch ( float  px, float  py  )

inline

Set the sampling rate on destination plane only.

Parameters:

px	horizon sampling rate (in meter)
py	vertical sampling rate (in meter)

< Set sampling rate on destination plane

Examples:

Shifted-Fresnel diffraction, and Using CPU threads.

void CWO::SetWaveLength ( float  w )

inline

Set the wavelength of light.

Parameters:

w	Wavelength of light (in meter)

< Set wavelength

void CWO::SetOffset ( float  x, float  y  )

inline

Set the offset of source plane away from the origin.

Parameters:

x	Horizonal offset (in meter)
y	Vertical offset (in meter)

void CWO::SetSrcOffset ( float  x, float  y  )

inline

Set the offset of source plane away from the origin.

The offset affects off-axis diffraction calculations (e.g. Shifted Fresnel diffraction).

Parameters:

x	Horizonal offset (in meter)
y	Vertical offset (in meter)

void CWO::SetDstOffset ( float  x, float  y  )

inline

Set the offset of destination plane away from the origin.

The offset affects off-axis diffraction calculations (e.g. Shifted Fresnel diffraction).

Parameters:

x	Horizonal offset (in meter)
y	Vertical offset (in meter)

void CWO::SetThreads	(	int	Nx,
		int	Ny = 1
	)

set the number of threads

Parameters:

N	: number of threads

Reimplemented in GWO.

Examples:

Using CPU threads.

int CWO::GetThreads

(

)

get the number of threads

Returns:

number of threads

size_t CWO::GetNx ( )

inline

get horizontal pixel number

Returns:

horizontal pixel number (unitless)

size_t CWO::GetNy ( )

inline

get vertical pixel number

Returns:

vertical pixel number (unitless)

cwoVect2<size_t> CWO::GetShape ( )

inline

get horizontal and vertical pixel number

Returns:

horizontal and vertical pixel number as cwoVect2 (unitless)

float CWO::GetWaveLength ( )

inline

get wavelength

Returns:

wavelength (in meter unit)

float CWO::GetWaveNum ( )

inline

get wave number

Returns:

wave number (in meter unit)

float CWO::GetDistance ( )

inline

get propagation distance

Returns:

propagation distance (in meter unit)

float CWO::GetPx ( )

inline

get sampling rate along to x-axis on source plane

Returns:

sampling rate along to x-axis on source plane (in meter unit)

float CWO::GetPy ( )

inline

get sampling rate along to y-axis on source plane

Returns:

sampling rate along to y-axis on source plane (in meter unit)

float CWO::GetSrcPx ( )

inline

get sampling rate along to x-axis on source plane

Returns:

sampling rate along to x-axis on source plane (in meter unit)

float CWO::GetSrcPy ( )

inline

get sampling rate along to y-axis on source plane

Returns:

sampling rate along to y-axis on source plane (in meter unit)

float CWO::GetDstPx ( )

inline

get sampling rate along to x-axis on destination plane

Returns:

sampling rate along to x-axis on destination plane (in meter unit)

float CWO::GetDstPy ( )

inline

get sampling rate along to y-axis on destination plane

Returns:

sampling rate along to y-axis on destination plane (in meter unit)

float CWO::GetOx ( )

inline

get offset along to x-axis on source plane

Returns:

offset along to x-axis on source plane (in meter unit)

float CWO::GetOy ( )

inline

get offset along to y-axis on source plane

Returns:

offset along to y-axis on source plane (in meter unit)

float CWO::GetSrcOx ( )

inline

get offset along to x-axis on source plane

Returns:

offset along to x-axis on source plane (in meter unit)

float CWO::GetSrcOy ( )

inline

get offset along to y-axis on source plane

Returns:

offset along to y-axis on source plane (in meter unit)

float CWO::GetDstOx ( )

inline

get offset along to x-axis on destination plane

Returns:

offset along to x-axis on destination plane (in meter unit)

float CWO::GetDstOy ( )

inline

get offset along to y-axis on destination plane

Returns:

offset along to y-axis on destination plane (in meter unit)

float CWO::GetLx ( )

inline

get physical length of source along to x-axis

Returns:

length of source along to x-axis (in meter unit)

float CWO::GetLy ( )

inline

get physical length of source along to y-axis

Returns:

length of source along to y-axis (in meter unit)

float CWO::GetSrcLx ( )

inline

get physical length of source along to x-axis

Returns:

length of source along to x-axis (in meter unit)

float CWO::GetSrcLy ( )

inline

get physical length of source along to y-axis

Returns:

length of source along to y-axis (in meter unit)

float CWO::GetDstLx ( )

inline

get physical length of destication along to x-axis

Returns:

length of destication along to x-axis (in meter unit)

float CWO::GetDstLy ( )

inline

get physical length of destication along to y-axis

Returns:

length of destication along to y-axis (in meter unit)

int CWO::GetAliasingFreeApproxSphWave ( float  z, float  p, float  wl  )

inline

get aliasing-free radius of approximated spherical wave

Returns:

aliasing-free radius

void CWO::ShowParam

(

)

Show parameters of cwoCtx.

Returns:

Current field-type. (e.g. CWO_FLD_COMPLEX)

Current field-type as string. (e.g. string "CWO_FLD_COMPLEX")