Level 1 algorithm: Filters a 3d image in Fourier domain by selecting a frequency range. More...

#include <FrequencyFiltering3dImgLvl1.h>

Inheritance diagram for ipsdk::imaproc::filter::FrequencyFiltering3dImgLvl1:

Public Member Functions
	~FrequencyFiltering3dImgLvl1 ()
	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::InImg3d &	get () const
	Getter for attribute InImg3d.

template<>
void	set (const typename ipsdk::imaproc::attr::InImg3d::StorageType &value)
	Setter for attribute InImg3d.

template<>
const ipsdk::imaproc::attr::InFrequencyBandPassFilterType &	get () const
	Getter for attribute InFrequencyBandPassFilterType.

template<>
void	set (const typename ipsdk::imaproc::attr::InFrequencyBandPassFilterType::StorageType &value)
	Setter for attribute InFrequencyBandPassFilterType.

template<>
const ipsdk::imaproc::attr::InCutoffFrequency &	get () const
	Getter for attribute InCutoffFrequency.

template<>
void	set (const typename ipsdk::imaproc::attr::InCutoffFrequency::StorageType &value)
	Setter for attribute InCutoffFrequency.

template<>
const ipsdk::imaproc::attr::InStdDev &	get () const
	Getter for attribute InStdDev.

template<>
void	set (const typename ipsdk::imaproc::attr::InStdDev::StorageType &value)
	Setter for attribute InStdDev.

template<>
const ipsdk::imaproc::attr::InOptTheta &	get () const
	Getter for attribute InOptTheta.

template<>
void	set (const typename ipsdk::imaproc::attr::InOptTheta::StorageType &value)
	Setter for attribute InOptTheta.

template<>
const ipsdk::imaproc::attr::InOptRangeTheta &	get () const
	Getter for attribute InOptRangeTheta.

template<>
void	set (const typename ipsdk::imaproc::attr::InOptRangeTheta::StorageType &value)
	Setter for attribute InOptRangeTheta.

template<>
const ipsdk::imaproc::attr::InOptPhi &	get () const
	Getter for attribute InOptPhi.

template<>
void	set (const typename ipsdk::imaproc::attr::InOptPhi::StorageType &value)
	Setter for attribute InOptPhi.

template<>
const ipsdk::imaproc::attr::InOptRangePhi &	get () const
	Getter for attribute InOptRangePhi.

template<>
void	set (const typename ipsdk::imaproc::attr::InOptRangePhi::StorageType &value)
	Setter for attribute InOptRangePhi.

template<>
const ipsdk::imaproc::attr::OutWk1RealImg &	get () const
	Getter for attribute OutWk1RealImg.

template<>
void	set (const typename ipsdk::imaproc::attr::OutWk1RealImg::StorageType &value)
	Setter for attribute OutWk1RealImg.

template<>
const ipsdk::imaproc::attr::OutWk2RealImg &	get () const
	Getter for attribute OutWk2RealImg.

template<>
void	set (const typename ipsdk::imaproc::attr::OutWk2RealImg::StorageType &value)
	Setter for attribute OutWk2RealImg.

template<>
const ipsdk::imaproc::attr::OutWk3RealImg &	get () const
	Getter for attribute OutWk3RealImg.

template<>
void	set (const typename ipsdk::imaproc::attr::OutWk3RealImg::StorageType &value)
	Setter for attribute OutWk3RealImg.

template<>
const ipsdk::imaproc::attr::OutWk4RealImg &	get () const
	Getter for attribute OutWk4RealImg.

template<>
void	set (const typename ipsdk::imaproc::attr::OutWk4RealImg::StorageType &value)
	Setter for attribute OutWk4RealImg.

template<>
const ipsdk::imaproc::attr::OutImg &	get () const
	Getter for attribute OutImg.

template<>
void	set (const typename ipsdk::imaproc::attr::OutImg::StorageType &value)
	Setter for attribute OutImg.

Public Member Functions inherited from ipsdk::processor::BaseProcessor< ipsdk::core::BaseRepeatedAsync1Action >
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< FrequencyFiltering3dImgLvl1 >	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
	FrequencyFiltering3dImgLvl1 ()
	constructor

ipsdk::processor::RetrievalResult	retrieveProvider (const ipsdk::core::BasePriority &priority, ipsdk::ipUInt32 curNbIter, ipsdk::core::ActionProviderPtr &pProvider)
	method allowing to retrieve provider associated to asynchronous processing in derived class More...

processor::RetrievalResult	provideProcessor (const boost::shared_ptr< core::BaseAction > &pProcessor, const core::BasePriority &priority, core::ActionProviderPtr &pProvider)

processor::RetrievalResult	dft (const core::BasePriority &priority, core::ActionProviderPtr &pProvider)

processor::RetrievalResult	lvl2 (const core::BasePriority &priority, core::ActionProviderPtr &pProvider)

processor::RetrievalResult	idft (const core::BasePriority &priority, core::ActionProviderPtr &pProvider)

processor::RetrievalResult	convert (const core::BasePriority &priority, core::ActionProviderPtr &pProvider)

Protected Member Functions inherited from ipsdk::processor::BaseProcessor< ipsdk::core::BaseRepeatedAsync1Action >
virtual BoolResult	initDerived (AttributeColl &attributeColl, OutputInitializerColl &outputInitializerColl, ProcessorDispatchPolicy &dispatchPolicy, RulePtr &pGlobalRule, const eProcessorRulePolicy &rulePolicy)=0

Protected Attributes
attr::DFTConfigPtr	_pDFTConfig
	Configuration for direct and inverse DFT.

Attribute members
boost::shared_ptr< ipsdk::imaproc::attr::InImg3d >	_pInImg3d

boost::shared_ptr< ipsdk::imaproc::attr::InFrequencyBandPassFilterType >	_pInFrequencyBandPassFilterType

boost::shared_ptr< ipsdk::imaproc::attr::InCutoffFrequency >	_pInCutoffFrequency

boost::shared_ptr< ipsdk::imaproc::attr::InStdDev >	_pInStdDev

boost::shared_ptr< ipsdk::imaproc::attr::InOptTheta >	_pInOptTheta

boost::shared_ptr< ipsdk::imaproc::attr::InOptRangeTheta >	_pInOptRangeTheta

boost::shared_ptr< ipsdk::imaproc::attr::InOptPhi >	_pInOptPhi

boost::shared_ptr< ipsdk::imaproc::attr::InOptRangePhi >	_pInOptRangePhi

boost::shared_ptr< ipsdk::imaproc::attr::OutWk1RealImg >	_pOutWk1RealImg

boost::shared_ptr< ipsdk::imaproc::attr::OutWk2RealImg >	_pOutWk2RealImg

boost::shared_ptr< ipsdk::imaproc::attr::OutWk3RealImg >	_pOutWk3RealImg

boost::shared_ptr< ipsdk::imaproc::attr::OutWk4RealImg >	_pOutWk4RealImg

boost::shared_ptr< ipsdk::imaproc::attr::OutImg >	_pOutImg

Protected Attributes inherited from ipsdk::processor::BaseProcessor< ipsdk::core::BaseRepeatedAsync1Action >
eProcessorProgressAvailability	_processorProgressAvailability

ipUInt32	_nbIter

Additional Inherited Members
Protected Types inherited from ipsdk::processor::BaseProcessor< ipsdk::core::BaseRepeatedAsync1Action >
typedef std::vector< AttributePtr >	AttributeColl

typedef std::map< std::string, OutputInitializerPtr >	OutputInitializerColl

Detailed Description

Level 1 algorithm: Filters a 3d image in Fourier domain by selecting a frequency range.

See Band-pass frequency filtering 3d for a complete algorithm description.

Author: R. Abbal

Date: 2017/06/30

Copyright: 2017 Reactiv'IP, all right reserved.

Algorithm associated library :

IPSDKIPLFiltering

Attribute description for algorithm :

Name	ToolTip	Default Initializer
ipsdk::imaproc::attr::InImg3d	[Input] 3d image for operation	X
ipsdk::imaproc::attr::InFrequencyBandPassFilterType	[Input] Indicates the band-pass filter to apply on the input image	X
ipsdk::imaproc::attr::InCutoffFrequency	[Input] Cutoff normalizes frequency for band-pass filtering in Fourier space (must belong to [-0.5, 0.5[)	X
ipsdk::imaproc::attr::InStdDev	[Input] standard deviation used for operation along all axis	X
ipsdk::imaproc::attr::InOptTheta	[Input Optional] 2d orientation for processing operation	X
ipsdk::imaproc::attr::InOptRangeTheta	[Input Optional] Orientation range in degrees	X
ipsdk::imaproc::attr::InOptPhi	[Input Optional] starting azimuth angle offset value	X
ipsdk::imaproc::attr::InOptRangePhi	[Input Optional] Orientation range in degrees	X
ipsdk::imaproc::attr::OutWk1RealImg	[Output] Temporary working image for algorithm	duplicateInOut (_pOutWk1RealImg, _pInImg3d, ipsdk::image::eImageBufferType::eIBT_Real32)
ipsdk::imaproc::attr::OutWk2RealImg	[Output] Temporary working image for algorithm	duplicateInOut (_pOutWk2RealImg, _pInImg3d, ipsdk::image::eImageBufferType::eIBT_Real32)
ipsdk::imaproc::attr::OutWk3RealImg	[Output] Temporary working image for algorithm	duplicateInOut (_pOutWk3RealImg, _pInImg3d, ipsdk::image::eImageBufferType::eIBT_Real32)
ipsdk::imaproc::attr::OutWk4RealImg	[Output] Temporary working image for algorithm	duplicateInOut (_pOutWk4RealImg, _pInImg3d, ipsdk::image::eImageBufferType::eIBT_Real32)
ipsdk::imaproc::attr::OutImg	[Output] image for processing operation	duplicateInOut (_pOutImg, _pInImg3d)

Global attributes rule :

Global rule on attributes is given by
ipsdk::imaproc::matchSizeAndType (_pInImg3d,_pOutImg) &&
ipsdk::imaproc::matchSizeAndType (_pOutWk1RealImg,_pOutWk2RealImg) &&
ipsdk::imaproc::matchSizeAndType (_pOutWk2RealImg,_pOutWk3RealImg) &&
ipsdk::imaproc::matchSizeAndType (_pOutWk3RealImg,_pOutWk4RealImg) &&
ipsdk::imaproc::matchSize (_pInImg3d,_pOutWk1RealImg)

Member Function Documentation

◆ getStorage()

template<typename TAttribute >

TAttribute::StorageType ipsdk::imaproc::filter::FrequencyFiltering3dImgLvl1::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

◆ retrieveProvider()

ipsdk::processor::RetrievalResult ipsdk::imaproc::filter::FrequencyFiltering3dImgLvl1::retrieveProvider	(	const ipsdk::core::BasePriority &	priority,
		ipsdk::ipUInt32	curNbIter,
		ipsdk::core::ActionProviderPtr &	pProvider
	)

protected

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

Returns: provider retrieval result.

Note: On success provider pointer must not be null nor uninitialized

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

/media/reactivipdev/Nightly/IPSDK_Patch/IPSDK_4_1/IPSDK_Nightly/include/public/IPSDKIPL/IPSDKIPLFiltering/Processor/FrequencyFiltering3dImg/FrequencyFiltering3dImgLvl1.h

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes