ipsdk::imaproc::itrans::ForwardDiscreteFourierTransform2dImgLvl1 Class Reference

Level 1 algorithm: forward Discrete Fourier Transform for an input 2d image. More...

#include <ForwardDiscreteFourierTransform2dImgLvl1.h>

Inheritance diagram for ipsdk::imaproc::itrans::ForwardDiscreteFourierTransform2dImgLvl1:

Public Member Functions
	~ForwardDiscreteFourierTransform2dImgLvl1 ()
	destructor
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 processor
const std::string	getLibraryName () const
	retrieve library name associated processor
template<typename TAttribute >
TAttribute::StorageType	getStorage ()
	retrieve storage associated to a given attribute More...
Attribute accessors
Setters and Getters for attributes
template<>
const ipsdk::imaproc::attr::InImg &	get () const
	Getter for attribute InImg.
template<>
void	set (const typename ipsdk::imaproc::attr::InImg::StorageType &value)
	Setter for attribute InImg.
template<>
const ipsdk::imaproc::attr::InOptDFTConfig &	get () const
	Getter for attribute InOptDFTConfig.
template<>
void	set (const typename ipsdk::imaproc::attr::InOptDFTConfig::StorageType &value)
	Setter for attribute InOptDFTConfig.
template<>
const ipsdk::imaproc::attr::OutOptWk1RealGpuImg &	get () const
	Getter for attribute OutOptWk1RealGpuImg.
template<>
void	set (const typename ipsdk::imaproc::attr::OutOptWk1RealGpuImg::StorageType &value)
	Setter for attribute OutOptWk1RealGpuImg.
template<>
const ipsdk::imaproc::attr::OutDFTImg1 &	get () const
	Getter for attribute OutDFTImg1.
template<>
void	set (const typename ipsdk::imaproc::attr::OutDFTImg1::StorageType &value)
	Setter for attribute OutDFTImg1.
template<>
const ipsdk::imaproc::attr::OutDFTImg2 &	get () const
	Getter for attribute OutDFTImg2.
template<>
void	set (const typename ipsdk::imaproc::attr::OutDFTImg2::StorageType &value)
	Setter for attribute OutDFTImg2.
Public Member Functions inherited from ipsdk::processor::BaseProcessor< ipsdk::core::BaseAsync2Action >
virtual eProcessorType	getProcessorType () const =0
BoolResult	init (const eProcessorRulePolicy rulePolicy=eProcessorRulePolicy::ePRP_DisableSubRules)
const eProcessorRulePolicy &	getProcessorRulePolicy () const
std::string	getFullInfoStr () const
const BaseRule &	getGlobalRule () const
const ProcessorDispatchPolicy &	getDispatchPolicy () const
void	restrictDispatchPolicy (const ProcessorDispatchPolicy &policy)
bool	isProgressAvailable () const
ipsdk::processor::eProcessorProgressAvailability	getProgressAvailability () const
ipsdk::ipUInt64	getTotalNbIterations () const
bool	existsHeaderKey (const std::string &key) const
bool	existsHeaderKey (const std::string &key) const
ItemNames	getHeaderKeys () const
ItemNames	getHeaderKeys () const
const BaseDataItem &	getHeaderItem (const std::string &key) const
BaseDataItem &	getHeaderItem (const std::string &key)
const BaseDataItem &	getHeaderItem (const std::string &key) const
BaseDataItem &	getHeaderItem (const std::string &key)
void	addHeaderItem (const std::string &key, const DataItemPtr &pItem)
void	addHeaderItem (const std::string &key, const DataItemPtr &pItem)
void	removeHeaderItem (const std::string &key)
void	removeHeaderItem (const std::string &key)
void	clearHeader ()
void	clearHeader ()
ipUInt32	getNbAttributes () const
ipUInt32	getNbAttributes () const
const BaseAttribute &	getAttribute (ipUInt32 index) const
BaseAttribute &	getAttribute (ipUInt32 index)
const BaseAttribute &	getAttribute (const std::string &attributeName) const
BaseAttribute &	getAttribute (const std::string &attributeName)
const BaseAttribute &	getAttribute (ipUInt32 index) const
BaseAttribute &	getAttribute (ipUInt32 index)
const BaseAttribute &	getAttribute (const std::string &attributeName) const
BaseAttribute &	getAttribute (const std::string &attributeName)
bool	existsAttribute (const std::string &attributeName) const
bool	existsAttribute (const std::string &attributeName) const
StringVector	getAttributeNameColl () const
StringVector	getAttributeNameColl () const
bool	hasOutputInitializer (const std::string &attributeName) const
bool	hasOutputInitializer (const std::string &attributeName) const
const BaseOutputInitializer &	getOutputInitializer (const std::string &attributeName) const
const BaseOutputInitializer &	getOutputInitializer (const std::string &attributeName) const

Static Public Member Functions
static boost::shared_ptr< ForwardDiscreteFourierTransform2dImgLvl1 >	createProcessor ()
	processor creation function
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 processor
static const std::string	getLibraryNameStr ()
	retrieve library name associated processor

Protected Member Functions
	ForwardDiscreteFourierTransform2dImgLvl1 ()
	constructor
ipsdk::processor::RetrievalResult	retrieveFirstProvider (const ipsdk::core::BasePriority &priority, ipsdk::core::ActionProviderPtr &pProvider)
	method allowing to retrieve first provider associated to asynchronous processing in derived class More...
ipsdk::processor::RetrievalResult	retrieveSecondProvider (const ipsdk::core::BasePriority &priority, ipsdk::core::ActionProviderPtr &pProvider)
	method allowing to retrieve second provider associated to asynchronous processing in derived class More...
eturn provider retrieval result ote On success provider pointer must not be null nor uninitialized ipsdk::processor::RetrievalResult	retrieveThirdProvider (const ipsdk::core::BasePriority &priority, ipsdk::core::ActionProviderPtr &pProvider)
eturn provider retrieval result ote On success provider pointer must not be null nor uninitialized ipsdk::processor::RetrievalResult	retrieveFourthProvider (const ipsdk::core::BasePriority &priority, ipsdk::core::ActionProviderPtr &pProvider)
processor::RetrievalResult	provideProcessor (const boost::shared_ptr< core::BaseAction > &pProcessor, const core::BasePriority &priority, core::ActionProviderPtr &pProvider)
processor::RetrievalResult	convert (const core::BasePriority &priority, core::ActionProviderPtr &pProvider)
processor::RetrievalResult	erase (const core::BasePriority &priority, core::ActionProviderPtr &pProvider)
processor::RetrievalResult	fft (const core::BasePriority &priority, core::ActionProviderPtr &pProvider)
processor::RetrievalResult	cartesianToPolar (const core::BasePriority &priority, core::ActionProviderPtr &pProvider)
Protected Member Functions inherited from ipsdk::processor::BaseProcessor< ipsdk::core::BaseAsync2Action >
virtual BoolResult	initDerived (AttributeColl &attributeColl, OutputInitializerColl &outputInitializerColl, ProcessorDispatchPolicy &dispatchPolicy, RulePtr &pGlobalRule, const eProcessorRulePolicy &rulePolicy)=0

Protected Attributes
bool	_bProcessedOnGpu
Attribute members
boost::shared_ptr< ipsdk::imaproc::attr::InImg >	_pInImg
boost::shared_ptr< ipsdk::imaproc::attr::InOptDFTConfig >	_pInOptDFTConfig
boost::shared_ptr< ipsdk::imaproc::attr::OutOptWk1RealGpuImg >	_pOutOptWk1RealGpuImg
boost::shared_ptr< ipsdk::imaproc::attr::OutDFTImg1 >	_pOutDFTImg1
boost::shared_ptr< ipsdk::imaproc::attr::OutDFTImg2 >	_pOutDFTImg2
Protected Attributes inherited from ipsdk::processor::BaseProcessor< ipsdk::core::BaseAsync2Action >
eProcessorProgressAvailability	_processorProgressAvailability
ipUInt32	_nbIter

Additional Inherited Members
Protected Types inherited from ipsdk::processor::BaseProcessor< ipsdk::core::BaseAsync2Action >
typedef std::vector< AttributePtr >	AttributeColl
typedef std::map< std::string, OutputInitializerPtr >	OutputInitializerColl

Detailed Description

Level 1 algorithm: forward Discrete Fourier Transform for an input 2d image.

See Forward Discrete Fourier Transform 2d for a complete algorithm description.

Author

E.Noirfalise

Date

2017/02/23

Copyright

2017 Reactiv'IP, all right reserved.

Algorithm associated library :

IPSDKIPLIntensityTransform

Attribute description for algorithm :

Name	ToolTip	Default Initializer
ipsdk::imaproc::attr::InImg	[Input] image for processing operation	X
ipsdk::imaproc::attr::InOptDFTConfig	[Input Optional] configuration for Discrete Fourier Transform algorithm	X
ipsdk::imaproc::attr::OutOptWk1RealGpuImg	[Output Optional] Temporary working image for GPU processes (data contained in image buffer are reals)	X
ipsdk::imaproc::attr::OutDFTImg1	[Output] first element for Discrete Fourier Transform (can be real cartesian part or rho polar part [default] of signal depending on algorithm configuration)	duplicateInOut (_pOutDFTImg1, _pInImg, ipsdk::image::eImageBufferType::eIBT_Real32)
ipsdk::imaproc::attr::OutDFTImg2	[Output] second element for Discrete Fourier Transform (can be imaginary cartesian part or theta polar part [default] of signal depending on algorithm configuration)	duplicateInOut (_pOutDFTImg2, _pInImg, ipsdk::image::eImageBufferType::eIBT_Real32)

Global attributes rule :

Global rule on attributes is given by
ipsdk::processor::none () && 
//ipsdk::imaproc::matchSize (_pInImg,_pOutDFTImg1,_pOutDFTImg2) && 
//ipsdk::processor::If (
 ipsdk::processor::isSet (_pOutOptWk1RealGpuImg), //
 CustomRuleTODO (_pInImg,_pOutOptWk1RealGpuImg), //
 ipsdk::processor::none ()),
ipsdk::imaproc::noInSitu (_pInImg,_pOutDFTImg1)

Member Function Documentation

getStorage()

template<typename TAttribute >

TAttribute::StorageType ipsdk::imaproc::itrans::ForwardDiscreteFourierTransform2dImgLvl1::getStorage

(

)

retrieve storage associated to a given attribute

Note

This method is only available for Output and In/Out attributes

Exceptions

ipsdk::processor::IPSDKBaseProcessingException

if isInit() == false

retrieveFirstProvider()

ipsdk::processor::RetrievalResult ipsdk::imaproc::itrans::ForwardDiscreteFourierTransform2dImgLvl1::retrieveFirstProvider ( const ipsdk::core::BasePriority &  priority, ipsdk::core::ActionProviderPtr &  pProvider  )

protected

method allowing to retrieve first provider associated to asynchronous processing in derived class

Returns

provider retrieval result.

Note

On success provider pointer must not be null nor uninitialized

retrieveSecondProvider()

ipsdk::processor::RetrievalResult ipsdk::imaproc::itrans::ForwardDiscreteFourierTransform2dImgLvl1::retrieveSecondProvider ( const ipsdk::core::BasePriority &  priority, ipsdk::core::ActionProviderPtr &  pProvider  )

protected

method allowing to retrieve second provider associated to asynchronous processing in derived class

Returns

provider retrieval result.

Note

On success provider pointer must not be null nor uninitialized

retrieveThirdProvider()

eturn provider retrieval result ote On success provider pointer must not be null nor uninitialized ipsdk::processor::RetrievalResult ipsdk::imaproc::itrans::ForwardDiscreteFourierTransform2dImgLvl1::retrieveThirdProvider ( const ipsdk::core::BasePriority &  priority, ipsdk::core::ActionProviderPtr &  pProvider  )

protected

rief method allowing to retrieve third provider associated to asynchronous processing in derived class

retrieveFourthProvider()

eturn provider retrieval result ote On success provider pointer must not be null nor uninitialized ipsdk::processor::RetrievalResult ipsdk::imaproc::itrans::ForwardDiscreteFourierTransform2dImgLvl1::retrieveFourthProvider ( const ipsdk::core::BasePriority &  priority, ipsdk::core::ActionProviderPtr &  pProvider  )

protected

rief method allowing to retrieve fourth provider associated to asynchronous processing in derived class

---

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

• /media/reactivipdev/Nightly/IPSDK_Patch/IPSDK_4_1/IPSDK_Nightly/include/public/IPSDKIPL/IPSDKIPLIntensityTransform/Processor/ForwardDiscreteFourierTransform2dImg/ForwardDiscreteFourierTransform2dImgLvl1.h