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

#include <FrequencyFiltering3dImgLvl2.h>

Inheritance diagram for ipsdk::imaproc::filter::FrequencyFiltering3dImgLvl2:

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

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

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

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

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::InTheta &	get () const
	Getter for attribute InTheta.

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

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

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

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

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

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

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

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

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

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

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

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

Protected Attributes
Attribute members
boost::shared_ptr< ipsdk::imaproc::attr::InOutSubDFTImg3d1 >	_pInOutSubDFTImg3d1

boost::shared_ptr< ipsdk::imaproc::attr::InOutSubDFTImg3d2 >	_pInOutSubDFTImg3d2

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::InTheta >	_pInTheta

boost::shared_ptr< ipsdk::imaproc::attr::InRangeTheta >	_pInRangeTheta

boost::shared_ptr< ipsdk::imaproc::attr::InPhi >	_pInPhi

boost::shared_ptr< ipsdk::imaproc::attr::InRangePhi >	_pInRangePhi

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

ipUInt32	_nbIter

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

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

Detailed Description

Level 2 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::InOutSubDFTImg3d1	[InOut] first 3d single sub image for Discreet Fourier Transform (can be real cartesian part or rho polar part [default] of signal depending on algorithm configuration)	X
ipsdk::imaproc::attr::InOutSubDFTImg3d2	[InOut] second 3d single sub image for Discreet Fourier Transform (can be imaginary cartesian part or theta polar part [default] of signal depending on algorithm configuration)	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::InTheta	[Input] 2d orientation for processing operation	X
ipsdk::imaproc::attr::InRangeTheta	[Input] Orientation range in degrees	X
ipsdk::imaproc::attr::InPhi	[Input] starting azimuth angle offset value	X
ipsdk::imaproc::attr::InRangePhi	[Input] Orientation range in degrees	X

Global attributes rule :

Global rule on attributes is given by
ipsdk::imaproc::matchSizeAndType (_pInOutSubDFTImg3d1,_pInOutSubDFTImg3d2)

Member Function Documentation

◆ getStorage()

template<typename TAttribute >

TAttribute::StorageType ipsdk::imaproc::filter::FrequencyFiltering3dImgLvl2::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::FrequencyFiltering3dImgLvl2::retrieveProvider	(	const ipsdk::core::BasePriority &	priority,
		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/FrequencyFiltering3dImgLvl2.h

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes