Level 1 algorithm: 3d image deblur algorithm using Laplacian kernels based on the Richardson-Lucy algorithm. More...

#include <RichardsonLucyDeblur3dImgLvl1.h>

Inheritance diagram for ipsdk::imaproc::filter::RichardsonLucyDeblur3dImgLvl1:

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

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

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

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

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

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

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

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

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

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

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.

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

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

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< RichardsonLucyDeblur3dImgLvl1 >	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
	RichardsonLucyDeblur3dImgLvl1 ()
	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	statsMsr (const core::BasePriority &priority, core::ActionProviderPtr &pProvider)

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

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

processor::RetrievalResult	gaussSmooth (const core::BasePriority &priority, core::ActionProviderPtr &pProvider, const ipsdk::image::ImageConstPtr &pInImg)

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

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

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

processor::RetrievalResult	histoMatch (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
ipUInt32	_nbIter
	Algorithm parameters.

ipReal32	_inStdDevX

ipReal32	_inStdDevY

ipReal32	_inStdDevZ

attr::GaussianCoverageConstPtr	_pInOptGaussianCoverage

ipReal64	_minValue

attr::StatsResultPtr	_pStatsPtr
	Intermediate results.

ipsdk::image::ImageConstPtr	_pCurInImg

ipsdk::image::ImagePtr	_pCurOutImg

ipsdk::image::ImagePtr	_pCurWkImg

ipUInt32	_iterOffset
	Iteration offset due to conditions during the process.

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

boost::shared_ptr< ipsdk::imaproc::attr::InNbIter >	_pInNbIter

boost::shared_ptr< ipsdk::imaproc::attr::InStdDevX >	_pInStdDevX

boost::shared_ptr< ipsdk::imaproc::attr::InStdDevY >	_pInStdDevY

boost::shared_ptr< ipsdk::imaproc::attr::InStdDevZ >	_pInStdDevZ

boost::shared_ptr< ipsdk::imaproc::attr::InOptSmoothingGaussianCoverage >	_pInOptSmoothingGaussianCoverage

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

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

boost::shared_ptr< ipsdk::imaproc::attr::OutOptWk1Img >	_pOutOptWk1Img

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: 3d image deblur algorithm using Laplacian kernels based on the Richardson-Lucy algorithm.

See Richardson-Lucy deblur 3d for a complete algorithm description.

Author: R. Abbal

Date: 2015/05/06

Copyright: 2015 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::InNbIter	[Input] Number of iterations for an iterative algorithm	X
ipsdk::imaproc::attr::InStdDevX	[Input] standard deviation used for operation along X axis	X
ipsdk::imaproc::attr::InStdDevY	[Input] standard deviation used for operation along Z axis	X
ipsdk::imaproc::attr::InStdDevZ	[Input] standard deviation used for operation along Z axis	X
ipsdk::imaproc::attr::InOptSmoothingGaussianCoverage	[Input Optional] Parameter allowing to specify a gaussian distribution coverage for processing	X
ipsdk::imaproc::attr::OutImg	[Output] image for processing operation	ipsdk::imaproc::duplicateInOut (_pOutImg, _pInImg3d)
ipsdk::imaproc::attr::OutWk1RealImg	[Output] Temporary working image for algorithm	ipsdk::imaproc::duplicateInOut (_pOutWk1RealImg, _pInImg3d, ipsdk::image::eImageBufferType::eIBT_Real32)
ipsdk::imaproc::attr::OutOptWk1Img	[Output Optional] Temporary working image for algorithm	X

Global attributes rule :

Global rule on attributes is given by
ipsdk::imaproc::matchSize (_pInImg3d,_pOutWk1RealImg) &&
ipsdk::imaproc::matchSizeAndType (_pInImg3d,_pOutImg) &&
ipsdk::imaproc::noInSitu (_pInImg3d,_pOutWk1RealImg) &&
ipsdk::imaproc::noInSitu (_pOutImg,_pOutWk1RealImg) &&
ipsdk::processor::If (
ipsdk::processor::isSet (_pOutOptWk1Img),
ipsdk::imaproc::matchSizeAndType (_pInImg3d,_pOutOptWk1Img),
ipsdk::processor::none ())

Member Function Documentation

◆ getStorage()

template<typename TAttribute >

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

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes