Level 1 algorithm: Anisotropic diffusion smoothing filter. More...

#include <AnisotropicDiffusion2dImgLvl1.h>

Inheritance diagram for ipsdk::imaproc::filter::AnisotropicDiffusion2dImgLvl1:

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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::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< AnisotropicDiffusion2dImgLvl1 >	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
	AnisotropicDiffusion2dImgLvl1 ()
	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...

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::InImg >	_pInImg

boost::shared_ptr< ipsdk::imaproc::attr::InNbTimeSteps >	_pInNbTimeSteps

boost::shared_ptr< ipsdk::imaproc::attr::InSharpness >	_pInSharpness

boost::shared_ptr< ipsdk::imaproc::attr::InAnisotropy >	_pInAnisotropy

boost::shared_ptr< ipsdk::imaproc::attr::InOptStdDevGrad >	_pInOptStdDevGrad

boost::shared_ptr< ipsdk::imaproc::attr::InOptStdDevMat >	_pInOptStdDevMat

boost::shared_ptr< ipsdk::imaproc::attr::InOptAnisotropicGaussianCoverage >	_pInOptAnisotropicGaussianCoverage

boost::shared_ptr< ipsdk::imaproc::attr::InOptNbAngles2d >	_pInOptNbAngles2d

boost::shared_ptr< ipsdk::imaproc::attr::InOptMaxHalfKnlSize >	_pInOptMaxHalfKnlSize

boost::shared_ptr< ipsdk::imaproc::attr::InOptDirSmoothFactor >	_pInOptDirSmoothFactor

boost::shared_ptr< ipsdk::imaproc::attr::InOptSpatialStep >	_pInOptSpatialStep

boost::shared_ptr< ipsdk::imaproc::attr::OutWk1Img >	_pOutWk1Img

boost::shared_ptr< ipsdk::imaproc::attr::OutWk2Img >	_pOutWk2Img

boost::shared_ptr< ipsdk::imaproc::attr::OutWk3Img >	_pOutWk3Img

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

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 1 algorithm: Anisotropic diffusion smoothing filter.

See Anisotropic diffusion 2d for a complete algorithm description.

Author: E. Noirfalise

Date: 2014/09/26

Copyright: 2014 Reactiv'IP, all right reserved.

Algorithm associated library :

IPSDKIPLFiltering

Attribute description for algorithm :

Name	ToolTip	Default Initializer
ipsdk::imaproc::attr::InImg	[Input] image for processing operation	X
ipsdk::imaproc::attr::InNbTimeSteps	[Input] number for time steps for anisotropic diffusion	X
ipsdk::imaproc::attr::InSharpness	[Input] Sharpness factor used by processing operation	X
ipsdk::imaproc::attr::InAnisotropy	[Input] Anisotropy factor for processing operation	X
ipsdk::imaproc::attr::InOptStdDevGrad	[Input Optional] standard deviation used for gaussian gradient computation	X
ipsdk::imaproc::attr::InOptStdDevMat	[Input Optional] standard deviation used for matrix gaussian smoothing	X
ipsdk::imaproc::attr::InOptAnisotropicGaussianCoverage	[Input Optional] Parameter allowing to specify a gaussian distribution coverage for processing	X
ipsdk::imaproc::attr::InOptNbAngles2d	[Input Optional] Number of angles for directional smoothing	X
ipsdk::imaproc::attr::InOptMaxHalfKnlSize	[Input Optional] Maximum half kernel size for processing operation	X
ipsdk::imaproc::attr::InOptDirSmoothFactor	[Input Optional] Directional smoothing amplitude factor	X
ipsdk::imaproc::attr::InOptSpatialStep	[Input Optional] Spatial step used for smoothing along processed directions	X
ipsdk::imaproc::attr::OutWk1Img	[Output] Temporary working image for algorithm	promoteUnary (_pOutWk1Img, _pInImg, ipsdk::imaproc::ePromoteUnaryType::ePUT_UpperSigned)
ipsdk::imaproc::attr::OutWk2Img	[Output] Temporary working image for algorithm	promoteUnary (_pOutWk2Img, _pInImg, ipsdk::imaproc::ePromoteUnaryType::ePUT_UpperSigned)
ipsdk::imaproc::attr::OutWk3Img	[Output] Temporary working image for algorithm	promoteUnary (_pOutWk3Img, _pInImg, ipsdk::imaproc::ePromoteUnaryType::ePUT_UpperSigned)
ipsdk::imaproc::attr::OutImg	[Output] image for processing operation	duplicateInOut (_pOutImg, _pInImg)

Global attributes rule :

Global rule on attributes is given by
matchSizeAndType (_pInImg,_pOutImg) &&
matchSize (_pInImg,_pOutWk1Img) &&
matchSizeAndType (_pOutWk1Img,_pOutWk2Img) &&
matchSizeAndType (_pOutWk1Img,_pOutWk3Img)

Member Function Documentation

◆ getStorage()

template<typename TAttribute >

TAttribute::StorageType ipsdk::imaproc::filter::AnisotropicDiffusion2dImgLvl1::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::AnisotropicDiffusion2dImgLvl1::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/AnisotropicDiffusion2dImg/AnisotropicDiffusion2dImgLvl1.h

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes