configuration structure for Discrete Fourier Transform algorithm More...

Classes
class	ipsdk::imaproc::attr::DFTConfig
	configuration structure for Discrete Fourier Transform algorithm More...

Typedefs
typedef boost::shared_ptr< ipsdk::imaproc::attr::DFTConfig >	ipsdk::imaproc::attr::DFTConfigPtr
	shared pointer to ipsdk::imaproc::attr::DFTConfig

typedef boost::shared_ptr< const ipsdk::imaproc::attr::DFTConfig >	ipsdk::imaproc::attr::DFTConfigConstPtr
	shared pointer to const ipsdk::imaproc::attr::DFTConfig

Enumerations
enum	ipsdk::imaproc::attr::eDFTQuadrantsPolicy { ipsdk::imaproc::attr::eDFTQP_Centered, ipsdk::imaproc::attr::eDFTQP_Native }
	Enumerate describing quadrants policy used to store Discrete Fourier Transform data. More...

enum	ipsdk::imaproc::attr::eDFTCoordinates { ipsdk::imaproc::attr::eDFTC_Polar, ipsdk::imaproc::attr::eDFTC_Cartesian }
	Enumerate describing coordinates system used to store Discrete Fourier Transform data. More...

enum	ipsdk::imaproc::attr::eDFTScalePolicy { ipsdk::imaproc::attr::eDFTSP_Default, ipsdk::imaproc::attr::eDFTSP_Unitary, ipsdk::imaproc::attr::eDFTSP_Custom }
	Enumerate describing policy used to scale data of Discrete Fourier Transform. More...

enum	ipsdk::imaproc::attr::eDFTDirection { ipsdk::imaproc::attr::eDFTD_Forward, ipsdk::imaproc::attr::eDFTD_Backward }
	Enumerate describing Discrete Fourier Transform computation direction. More...

Functions
IPSDKIPLATTRIBUTES_API DFTConfigPtr	ipsdk::imaproc::attr::createDefaultDFTConfig ()
	function allowing to create a default Discrete Fourier Transform configuration

IPSDKIPLATTRIBUTES_API DFTConfigPtr	ipsdk::imaproc::attr::createDFTConfig (const ipsdk::imaproc::attr::eDFTQuadrantsPolicy &quadrantsPolicy, const ipsdk::imaproc::attr::eDFTCoordinates &coordsType, const ipsdk::imaproc::attr::eDFTScalePolicy &scalePolicy, const ipReal32 customXScale=1.0f, const ipReal32 customYScale=1.0f, const ipReal32 customZScale=1.0f)
	function allowing to create a custom Discrete Fourier Transform configuration More...

Detailed Description

configuration structure for Discrete Fourier Transform algorithm

SubNodes description

Name	ToolTip	Associated Class	Default Value
QuadrantsPolicy	quadrants policy used to store Discrete Fourier Transform data	ipsdk::DataItemEnumLeaf<ipsdk::imaproc::attr::eDFTQuadrantsPolicy>	eDFTQuadrantsPolicy::eDFTQP_Centered
CoordsType	coordinates system used to store Discrete Fourier Transform data	ipsdk::DataItemEnumLeaf<ipsdk::imaproc::attr::eDFTCoordinates>	eDFTCoordinates::eDFTC_Polar
ScalePolicy	policy used to scale data of Discrete Fourier Transform	ipsdk::DataItemEnumLeaf<ipsdk::imaproc::attr::eDFTScalePolicy>	eDFTScalePolicy::eDFTSP_Default
CustomXScale	custom scale value used along X axis when ScalePolicy is set to eDFTSP_Custom	ipsdk::DataItemLeaf<ipsdk::ipReal32>
CustomYScale	custom scale value used along Y axis when ScalePolicy is set to eDFTSP_Custom	ipsdk::DataItemLeaf<ipsdk::ipReal32>
CustomZScale	custom scale value used along Z axis when ScalePolicy is set to eDFTSP_Custom	ipsdk::DataItemLeaf<ipsdk::ipReal32>

Enumeration Type Documentation

◆ eDFTQuadrantsPolicy

enum ipsdk::imaproc::attr::eDFTQuadrantsPolicy

Enumerate describing quadrants policy used to store Discrete Fourier Transform data.

Note: This object is associated to a strong enumerate definition

See also: IPSDK_Enum

Enumerator
eDFTQP_Centered	User friendly data storage with the lowest frequencies at the center.
eDFTQP_Native	Native data storage with the lowest frequencies at the corners.

◆ eDFTCoordinates

enum ipsdk::imaproc::attr::eDFTCoordinates

Enumerate describing coordinates system used to store Discrete Fourier Transform data.

Note: This object is associated to a strong enumerate definition

See also: IPSDK_Enum

Enumerator
eDFTC_Polar	frequencies are represented using polar coordinates $(\rho, \theta)$
eDFTC_Cartesian	frequencies are represented using cartesian coordinates $(x_{re}, y_{im})$

◆ eDFTScalePolicy

enum ipsdk::imaproc::attr::eDFTScalePolicy

Enumerate describing policy used to scale data of Discrete Fourier Transform.

Note: This object is associated to a strong enumerate definition

See also: IPSDK_Enum

Enumerator
eDFTSP_Default	direct transforms are left unscaled whereas inverse transforms are scaled by $\frac{1}{n}$
eDFTSP_Unitary	both direct and inverse transforms are scaled by $\frac{1}{\sqrt{n}}$
eDFTSP_Custom	transforms are scaled by predefined user value

◆ eDFTDirection

enum ipsdk::imaproc::attr::eDFTDirection

Enumerate describing Discrete Fourier Transform computation direction.

Note: This object is associated to a strong enumerate definition

See also: IPSDK_Enum

Enumerator
eDFTD_Forward	forward Discrete Fourier Transform computation direction
eDFTD_Backward	backward Discrete Fourier Transform computation direction

Function Documentation

◆ createDFTConfig()

IPSDKIPLATTRIBUTES_API DFTConfigPtr ipsdk::imaproc::attr::createDFTConfig	(	const ipsdk::imaproc::attr::eDFTQuadrantsPolicy &	quadrantsPolicy,
		const ipsdk::imaproc::attr::eDFTCoordinates &	coordsType,
		const ipsdk::imaproc::attr::eDFTScalePolicy &	scalePolicy,
		const ipReal32	customXScale = `1.0f`,
		const ipReal32	customYScale = `1.0f`,
		const ipReal32	customZScale = `1.0f`
	)

function allowing to create a custom Discrete Fourier Transform configuration

Exceptions

ipsdk::imaproc::attr::IPSDKIPLAttributesException if byAxisCustomScale <= 0

Classes

Typedefs

Enumerations

Functions