Level 1 algorithm: algorithm allowing to generate a 3d image using a formula string. More...

#include <Formula3dImgLvl1.h>

Inheritance diagram for ipsdk::imaproc::arithm::Formula3dImgLvl1:

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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< Formula3dImgLvl1 >	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
	Formula3dImgLvl1 ()
	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::InImageFormula3d >	_pInImageFormula3d

boost::shared_ptr< ipsdk::imaproc::attr::InOptImg3d1 >	_pInOptImg3d1

boost::shared_ptr< ipsdk::imaproc::attr::InOptImg3d2 >	_pInOptImg3d2

boost::shared_ptr< ipsdk::imaproc::attr::InOptImg3d3 >	_pInOptImg3d3

boost::shared_ptr< ipsdk::imaproc::attr::InOptBinImg3d1 >	_pInOptBinImg3d1

boost::shared_ptr< ipsdk::imaproc::attr::InOptBinImg3d2 >	_pInOptBinImg3d2

boost::shared_ptr< ipsdk::imaproc::attr::InOptBinImg3d3 >	_pInOptBinImg3d3

boost::shared_ptr< ipsdk::imaproc::attr::InOptLabImg3d1 >	_pInOptLabImg3d1

boost::shared_ptr< ipsdk::imaproc::attr::InOptLabImg3d2 >	_pInOptLabImg3d2

boost::shared_ptr< ipsdk::imaproc::attr::InOptLabImg3d3 >	_pInOptLabImg3d3

boost::shared_ptr< ipsdk::imaproc::attr::InOptConvolBorder3d >	_pInOptConvolBorder3d

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: algorithm allowing to generate a 3d image using a formula string.

See Formula 3d image algorithm for a complete algorithm description.

Author: E.Noirfalise

Date: 2017/03/16

Copyright: 2017 Reactiv'IP, all right reserved.

Algorithm associated library :

IPSDKIPLArithmetic

Attribute description for algorithm :

Name	ToolTip	Default Initializer
ipsdk::imaproc::attr::InImageFormula3d	[Input] Image formula 3d used for image generation	X
ipsdk::imaproc::attr::InOptImg3d1	[Input Optional] first input image 3d for operation	X
ipsdk::imaproc::attr::InOptImg3d2	[Input Optional] second input image 3d for operation	X
ipsdk::imaproc::attr::InOptImg3d3	[Input Optional] third input image 3d for operation	X
ipsdk::imaproc::attr::InOptBinImg3d1	[Input Optional] first binary image 3d for operation	X
ipsdk::imaproc::attr::InOptBinImg3d2	[Input Optional] second binary image 3d for operation	X
ipsdk::imaproc::attr::InOptBinImg3d3	[Input Optional] third binary image 3d for operation	X
ipsdk::imaproc::attr::InOptLabImg3d1	[Input Optional] first label image 3d for operation	X
ipsdk::imaproc::attr::InOptLabImg3d2	[Input Optional] second label image 3d for operation	X
ipsdk::imaproc::attr::InOptLabImg3d3	[Input Optional] third label image 3d for operation	X
ipsdk::imaproc::attr::InOptConvolBorder3d	[Input Optional] Border preparation policy for 3d convolution algorithm	X
ipsdk::imaproc::attr::OutImg	[Output] image for processing operation	customOutput (_pOutImg, outputFormula(_pInImageFormula3d,_pInOptImg3d1,_pInOptImg3d2,_pInOptImg3d3,_pInOptBinImg3d1,_pInOptBinImg3d2,_pInOptBinImg3d3,_pInOptLabImg3d1,_pInOptLabImg3d2,_pInOptLabImg3d3))

Global attributes rule :

Global rule on attributes is given by
validateFormulaAndImages (_pInImageFormula3d,_pInOptImg3d1,_pInOptImg3d2,_pInOptImg3d3,_pInOptBinImg3d1,_pInOptBinImg3d2,_pInOptBinImg3d3,_pInOptLabImg3d1,_pInOptLabImg3d2,_pInOptLabImg3d3,_pOutImg)

Member Function Documentation

◆ getStorage()

template<typename TAttribute >

TAttribute::StorageType ipsdk::imaproc::arithm::Formula3dImgLvl1::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::arithm::Formula3dImgLvl1::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/IPSDKIPLArithmetic/Processor/Formula3dImg/Formula3dImgLvl1.h

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes