Level 1 algorithm: gradient computation on a 3d image using morphological operations. More...

#include <MorphoGradient3dImgLvl1.h>

Inheritance diagram for ipsdk::imaproc::morpho::MorphoGradient3dImgLvl1:

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

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

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.

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::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::BaseAsync2Action >
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< MorphoGradient3dImgLvl1 >	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
	MorphoGradient3dImgLvl1 ()
	constructor

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

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

eturn provider retrieval result ote On success provider pointer must not be null nor uninitialized ipsdk::processor::RetrievalResult	retrieveThirdProvider (const ipsdk::core::BasePriority &priority, ipsdk::core::ActionProviderPtr &pProvider)

ipsdk::core::ExecResult	preProcess ()
	method called before processing More...

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

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

Protected Attributes
boost::shared_ptr< Dilate3dImgLvl1 >	_pDilate3dImg
	Process attributes.

boost::shared_ptr< Erode3dImgLvl1 >	_pErode3dImg

ipsdk::image::ImagePtr	_pWkImg
	Temporary image.

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

boost::shared_ptr< ipsdk::imaproc::attr::InSEXYZ >	_pInSEXYZ

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

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

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

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

ipUInt32	_nbIter

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

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

Detailed Description

Level 1 algorithm: gradient computation on a 3d image using morphological operations.

See Morphological Gradient 3d for a complete algorithm description.

Author: E.Noirfalise

Date: 2014/12/01

Copyright: 2014 Reactiv'IP, all right reserved.

Algorithm associated library :

IPSDKIPLBasicMorphology

Attribute description for algorithm :

Name	ToolTip	Default Initializer
ipsdk::imaproc::attr::InImg3d	[Input] 3d image for operation	X
ipsdk::imaproc::attr::InSEXYZ	[Input] structuring element xyz for processing operation	X
ipsdk::imaproc::attr::OutOptWk1Img	[Output Optional] Temporary working image for algorithm	X
ipsdk::imaproc::attr::OutWk1Img	[Output] Temporary working image for algorithm	ipsdk::imaproc::duplicateInOut (_pOutWk1Img, _pInImg3d)
ipsdk::imaproc::attr::OutImg	[Output] image for processing operation	ipsdk::imaproc::duplicateInOut (_pOutImg, _pInImg3d)

Global attributes rule :

Global rule on attributes is given by
((ipsdk::imaproc::matchSizeAndType (_pInImg3d,_pOutImg)) &&
(ipsdk::imaproc::matchSizeAndType (_pInImg3d,_pOutWk1Img)) &&
(ipsdk::imaproc::noInSitu (_pInImg3d,_pOutImg)) &&
(ipsdk::imaproc::noInSitu (_pInImg3d,_pOutWk1Img)) &&
(ipsdk::processor::ifIsSet (
   _pOutOptWk1Img, (
    ipsdk::imaproc::matchSizeAndType (_pInImg3d,_pOutOptWk1Img)) &&
   (ipsdk::imaproc::noInSitu (_pInImg3d,_pOutOptWk1Img)))))

Member Function Documentation

◆ getStorage()

template<typename TAttribute >

TAttribute::StorageType ipsdk::imaproc::morpho::MorphoGradient3dImgLvl1::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

◆ retrieveFirstProvider()

ipsdk::processor::RetrievalResult ipsdk::imaproc::morpho::MorphoGradient3dImgLvl1::retrieveFirstProvider	(	const ipsdk::core::BasePriority &	priority,
		ipsdk::core::ActionProviderPtr &	pProvider
	)

protected

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

Returns: provider retrieval result.

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

◆ retrieveSecondProvider()

ipsdk::processor::RetrievalResult ipsdk::imaproc::morpho::MorphoGradient3dImgLvl1::retrieveSecondProvider	(	const ipsdk::core::BasePriority &	priority,
		ipsdk::core::ActionProviderPtr &	pProvider
	)

protected

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

Returns: provider retrieval result.

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

◆ retrieveThirdProvider()

eturn provider retrieval result ote On success provider pointer must not be null nor uninitialized ipsdk::processor::RetrievalResult ipsdk::imaproc::morpho::MorphoGradient3dImgLvl1::retrieveThirdProvider	(	const ipsdk::core::BasePriority &	priority,
		ipsdk::core::ActionProviderPtr &	pProvider
	)

protected

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

◆ preProcess()

ipsdk::core::ExecResult ipsdk::imaproc::morpho::MorphoGradient3dImgLvl1::preProcess ( )

protected

method called before processing

Returns: execution result

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

/media/reactivipdev/Nightly/IPSDK_Patch/IPSDK_4_1/IPSDK_Nightly/include/public/IPSDKIPL/IPSDKIPLBasicMorphology/Processor/MorphoGradient3dImg/MorphoGradient3dImgLvl1.h

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Algorithm associated library :

Attribute description for algorithm :

Global attributes rule :

Member Function Documentation

◆ getStorage()

◆ retrieveFirstProvider()

◆ retrieveSecondProvider()

◆ retrieveThirdProvider()

◆ preProcess()