configuration structure for Discrete Fourier Transform algorithm More...

#include <DFTConfig.h>

Inheritance diagram for ipsdk::imaproc::attr::DFTConfig:

Public Member Functions
const std::string &	getObjectName () const
	method allowing to retrieve object name

const std::string &	getToolTip () const
	method allowing to retrieve object tooltip

const boost::filesystem::path	getHeaderPath () const
	retrieve relative header path associated to data item node

const std::string	getLibraryName () const
	retrieve library name associated data item node

const ipsdk::ItemNames &	getItemIds () const
	retrieve item associated to a given id More...

	~DFTConfig ()
	public destructor

Methods associated to sub node QuadrantsPolicy
template<>
const ipsdk::DataItemLeaf< ipsdk::imaproc::attr::eDFTQuadrantsPolicy > &	getNode () const
	access to sub node QuadrantsPolicy

template<>
ipsdk::DataItemLeaf< ipsdk::imaproc::attr::eDFTQuadrantsPolicy > &	get ()
	access to sub node QuadrantsPolicy

template<>
const ipsdk::imaproc::attr::eDFTQuadrantsPolicy &	getValue () const
	access to value for sub node QuadrantsPolicy

template<>
void	setValue (const ipsdk::imaproc::attr::eDFTQuadrantsPolicy &value)
	access to value for sub node QuadrantsPolicy

Methods associated to sub node CoordsType
template<>
const ipsdk::DataItemLeaf< ipsdk::imaproc::attr::eDFTCoordinates > &	getNode () const
	access to sub node CoordsType

template<>
ipsdk::DataItemLeaf< ipsdk::imaproc::attr::eDFTCoordinates > &	get ()
	access to sub node CoordsType

template<>
const ipsdk::imaproc::attr::eDFTCoordinates &	getValue () const
	access to value for sub node CoordsType

template<>
void	setValue (const ipsdk::imaproc::attr::eDFTCoordinates &value)
	access to value for sub node CoordsType

Methods associated to sub node ScalePolicy
template<>
const ipsdk::DataItemLeaf< ipsdk::imaproc::attr::eDFTScalePolicy > &	getNode () const
	access to sub node ScalePolicy

template<>
ipsdk::DataItemLeaf< ipsdk::imaproc::attr::eDFTScalePolicy > &	get ()
	access to sub node ScalePolicy

template<>
const ipsdk::imaproc::attr::eDFTScalePolicy &	getValue () const
	access to value for sub node ScalePolicy

template<>
void	setValue (const ipsdk::imaproc::attr::eDFTScalePolicy &value)
	access to value for sub node ScalePolicy

Methods associated to sub node CustomXScale
template<>
const ipsdk::DataItemLeaf< ipsdk::ipReal32 > &	getNode () const
	access to sub node CustomXScale

template<>
ipsdk::DataItemLeaf< ipsdk::ipReal32 > &	get ()
	access to sub node CustomXScale

template<>
const ipsdk::ipReal32 &	getValue () const
	access to value for sub node CustomXScale

template<>
void	setValue (const ipsdk::ipReal32 &value)
	access to value for sub node CustomXScale

Methods associated to sub node CustomYScale
template<>
const ipsdk::DataItemLeaf< ipsdk::ipReal32 > &	getNode () const
	access to sub node CustomYScale

template<>
ipsdk::DataItemLeaf< ipsdk::ipReal32 > &	get ()
	access to sub node CustomYScale

template<>
const ipsdk::ipReal32 &	getValue () const
	access to value for sub node CustomYScale

template<>
void	setValue (const ipsdk::ipReal32 &value)
	access to value for sub node CustomYScale

Methods associated to sub node CustomZScale
template<>
const ipsdk::DataItemLeaf< ipsdk::ipReal32 > &	getNode () const
	access to sub node CustomZScale

template<>
ipsdk::DataItemLeaf< ipsdk::ipReal32 > &	get ()
	access to sub node CustomZScale

template<>
const ipsdk::ipReal32 &	getValue () const
	access to value for sub node CustomZScale

template<>
void	setValue (const ipsdk::ipReal32 &value)
	access to value for sub node CustomZScale


ipReal32	getForwardXScale (const ipUInt64 sizeX) const
	method allowing to retrieve used forward scale factor given an input number of data

ipReal32	getForwardYScale (const ipUInt64 sizeY) const
	method allowing to retrieve used forward scale factor given an input number of data

ipReal32	getForwardZScale (const ipUInt64 sizeZ) const
	method allowing to retrieve used forward scale factor given an input number of data


ipReal32	getBackwardXScale (const ipUInt64 sizeX) const
	method allowing to retrieve used backward scale factor given an input number of data

ipReal32	getBackwardYScale (const ipUInt64 sizeY) const
	method allowing to retrieve used backward scale factor given an input number of data

ipReal32	getBackwardZScale (const ipUInt64 sizeZ) const
	method allowing to retrieve used backward scale factor given an input number of data

Public Member Functions inherited from ipsdk::BaseDataItemNode
eDataItemType	getDataItemType () const

bool	existsItem (const std::string &itemId) const

const BaseDataItem &	getItem (const std::string &itemId) const

const std::string &	getItemName (const std::string &itemId) const

const std::string &	getItemToolTip (const std::string &itemId) const

Public Member Functions inherited from ipsdk::BaseDynamicObject
virtual const std::string &	getClassName () const

virtual BaseDynamicObject *	createNew () const=0

virtual DynamicObjectPtr	createShared () const=0

virtual bool	hasCopySupport () const=0

virtual BaseDynamicObject *	duplicate () const=0

virtual DynamicObjectPtr	duplicateShared () const=0

Static Public Member Functions
static const std::string &	getObjectNameStr ()
	method allowing to retrieve object name

static const std::string &	getToolTipStr ()
	method allowing to retrieve object tooltip

static const boost::filesystem::path	getHeaderPathStr ()
	retrieve relative header path associated to data item node

static const std::string	getLibraryNameStr ()
	retrieve library name associated data item node

static boost::shared_ptr< DFTConfig >	createNode ()
	node creation function

Static Public Member Functions inherited from ipsdk::BaseSerializationObject
static ipUInt32	getVersion ()

Static Public Member Functions inherited from ipsdk::BaseDynamicObject
static const std::string &	getTypeName ()

Static Public Attributes
static const ipsdk::ipUInt32	g_nbChildNodes
	number of child nodes associated to object

Static Public Attributes inherited from ipsdk::BaseDataItemNode
static const bool	g_bIsColl

static const bool	g_bNode

static const bool	g_bLeaf

static const eDataItemType::domain	g_itemType

Protected Member Functions
	DFTConfig ()
	protected constructor

Protected Member Functions inherited from ipsdk::BaseDataItemNode
virtual ItemInfoPtr	getItemInfo (const std::string &itemId) const=0

Protected Member Functions inherited from ipsdk::BaseSerializationObject
virtual BoolResult	write (BaseOArchive &ar) const

virtual BoolResult	read (BaseIArchive &ar)

Protected Member Functions inherited from ipsdk::BaseDynamicObject
virtual void	initCtorCopy (const BaseDynamicObject &object)

virtual void	copy (const BaseDynamicObject &object)

Additional Inherited Members
Protected Types inherited from ipsdk::BaseDataItemNode
typedef boost::shared_ptr< ItemInfo >	ItemInfoPtr

Detailed Description

configuration structure for Discrete Fourier Transform algorithm

Author: E.Noirfalise

Date: 2017/02/23

Copyright: 2017 Reactiv'IP, all right reserved.

Node associated library :

IPSDKIPLAttributes

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>

Member Function Documentation

◆ getItemIds()

const ipsdk::ItemNames& ipsdk::imaproc::attr::DFTConfig::getItemIds ( ) const

virtual

retrieve item associated to a given id

Exceptions

ipsdk::IPSDKBaseDataException if existsItem(itemName) == false

Implements ipsdk::BaseDataItemNode.

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

/media/reactivipdev/Nightly/IPSDK_Patch/IPSDK_4_1/IPSDK_Nightly/include/public/IPSDKIPL/IPSDKIPLAttributes/DataItem/DFTConfig.h

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Member Functions

Additional Inherited Members

Detailed Description

Node associated library :

SubNodes description

Member Function Documentation

◆ getItemIds()