Level 1 algorithm: Non-local means filter used to denoise a 3d image. More...

#include <PatchBasedBilateral3dImgLvl1.h>

Inheritance diagram for ipsdk::imaproc::filter::PatchBasedBilateral3dImgLvl1:

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

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

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

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

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

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

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

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

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

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

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< PatchBasedBilateral3dImgLvl1 >	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
	PatchBasedBilateral3dImgLvl1 ()
	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::InImg3d >	_pInImg3d

boost::shared_ptr< ipsdk::imaproc::attr::InOptPIPatchBasedBilateralParams >	_pInOptPIPatchBasedBilateralParams

boost::shared_ptr< ipsdk::imaproc::attr::OutPIPatchBasedBilateralParams >	_pOutPIPatchBasedBilateralParams

boost::shared_ptr< ipsdk::imaproc::attr::OutOptWk1RealImg >	_pOutOptWk1RealImg

boost::shared_ptr< ipsdk::imaproc::attr::OutOptWk2RealImg >	_pOutOptWk2RealImg

boost::shared_ptr< ipsdk::imaproc::attr::OutRealImg >	_pOutRealImg

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: Non-local means filter used to denoise a 3d image.

See Patch-based bilateral filter 3d for a complete algorithm description.

Author: H. Delestre

Date: 2016/08/10

Copyright: 2016 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::InOptPIPatchBasedBilateralParams	[In Optional] Plan indexed collection of parameters for patch-based bilateral filter	X
ipsdk::imaproc::attr::OutPIPatchBasedBilateralParams	[Output] Plan indexed collection of parameters for patch-based bilateral filter	ipsdk::imaproc::fromImageButVolume (_pOutPIPatchBasedBilateralParams, _pInImg3d)
ipsdk::imaproc::attr::OutOptWk1RealImg	[Output Optional] Temporary working image for algorithm (data contained in image buffer are reals)	X
ipsdk::imaproc::attr::OutOptWk2RealImg	[Output Optional] Temporary working image for algorithm (data contained in image buffer are reals)	X
ipsdk::imaproc::attr::OutRealImg	[Output] image for processing operation (data contained in image buffer are reals)	ipsdk::imaproc::duplicateInOut (_pOutRealImg, _pInImg3d, ipsdk::image::eImageBufferType::eIBT_Real32)

Global attributes rule :

Global rule on attributes is given by
ipsdk::imaproc::matchSize (_pInImg3d,_pOutRealImg) &&
ipsdk::imaproc::matchImagePlans (_pOutPIPatchBasedBilateralParams,_pInImg3d,eImagePlansMatchPolicy::eIPMP_CT) &&
ipsdk::processor::ifIsSet (_pInOptPIPatchBasedBilateralParams,
ipsdk::imaproc::matchImagePlans (_pInOptPIPatchBasedBilateralParams,_pInImg3d,eImagePlansMatchPolicy::eIPMP_CT)) &&
(ipsdk::processor::ifIsSet (
  _pOutOptWk1RealImg, (
   ipsdk::imaproc::matchSize (_pInImg3d,_pOutOptWk1RealImg)) &&
  (ipsdk::imaproc::noInSitu (_pInImg3d,_pOutOptWk1RealImg)) &&
  (ipsdk::imaproc::noInSitu (_pOutRealImg,_pOutOptWk1RealImg)))) &&
(ipsdk::processor::ifIsSet (
  _pOutOptWk2RealImg, (
   ipsdk::imaproc::matchSize (_pInImg3d,_pOutOptWk2RealImg)) &&
  (ipsdk::imaproc::noInSitu (_pInImg3d,_pOutOptWk2RealImg)) &&
  (ipsdk::imaproc::noInSitu (_pOutRealImg,_pOutOptWk2RealImg))))

Member Function Documentation

◆ getStorage()

template<typename TAttribute >

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

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes