Level 1 algorithm: Sobel filter used to compute gradient on a 2d image. More...

#include <SobelGradient2dImgLvl1.h>

Inheritance diagram for ipsdk::imaproc::filter::SobelGradient2dImgLvl1:

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

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

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

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

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

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

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

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

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< SobelGradient2dImgLvl1 >	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
	SobelGradient2dImgLvl1 ()
	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...

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

ipsdk::processor::RetrievalResult	retrieveXGradXDerivationProvider (const ipsdk::core::BasePriority &priority, ipsdk::core::ActionProviderPtr &pProvider)
	method allowing to process x derivation of x gradient

ipsdk::processor::RetrievalResult	retrieveXGradYSmoothingProvider (const ipsdk::core::BasePriority &priority, ipsdk::core::ActionProviderPtr &pProvider)
	method allowing to process y smoothing of x gradient

ipsdk::processor::RetrievalResult	retrieveYGradXSmoothingProvider (const ipsdk::core::BasePriority &priority, ipsdk::core::ActionProviderPtr &pProvider)
	method allowing to process x smoothing of y gradient

ipsdk::processor::RetrievalResult	retrieveYGradYDerivationProvider (const ipsdk::core::BasePriority &priority, ipsdk::core::ActionProviderPtr &pProvider)
	method allowing to process y derivation of y gradient

void	clearIntermediateData ()
	method allowing to clear intermediate data for object

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
image::Border2dPolicyPtr	_pBorder2dPolicy

Attribute members
boost::shared_ptr< ipsdk::imaproc::attr::InImg >	_pInImg

boost::shared_ptr< ipsdk::imaproc::attr::InOptSobelKernelType >	_pInOptSobelKernelType

boost::shared_ptr< ipsdk::imaproc::attr::InOptNormalizeSobelKernel >	_pInOptNormalizeSobelKernel

boost::shared_ptr< ipsdk::imaproc::attr::OutOptGradXImg >	_pOutOptGradXImg

boost::shared_ptr< ipsdk::imaproc::attr::OutOptGradYImg >	_pOutOptGradYImg


KernelXYPtr	_pXSmoothingKernel
	kernel used for processing

KernelXYPtr	_pYSmoothingKernel
	kernel used for processing

KernelXYPtr	_pXGradientKernel
	kernel used for processing

KernelXYPtr	_pYGradientKernel
	kernel used for processing

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: Sobel filter used to compute gradient on a 2d image.

See Sobel Gradient 2d for a complete algorithm description.

Author: H. Delestre

Date: 2016/10/20

Copyright: 2016 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::InOptSobelKernelType	[Input Optional] kernel type for Sobel gradient filter	X
ipsdk::imaproc::attr::InOptNormalizeSobelKernel	[Input Optional] boolean flag indicating whether kernel use for Sobel gradient filtering has to be normalized or not	X
ipsdk::imaproc::attr::OutOptGradXImg	[Output Optional] image associated to X component of gradient computation	promoteUnary (_pOutOptGradXImg, _pInImg, ipsdk::imaproc::ePromoteUnaryType::ePUT_UpperSigned)
ipsdk::imaproc::attr::OutOptGradYImg	[Output Optional] image associated to Y component of gradient computation	promoteUnary (_pOutOptGradYImg, _pInImg, ipsdk::imaproc::ePromoteUnaryType::ePUT_UpperSigned)

Global attributes rule :

Global rule on attributes is given by
((ipsdk::processor::isSet (_pOutOptGradXImg) ||
  ipsdk::processor::isSet (_pOutOptGradYImg)) &&
(ipsdk::processor::ifIsSet (_pOutOptGradXImg,
   ipsdk::imaproc::matchSize (_pInImg,_pOutOptGradXImg))) &&
(ipsdk::processor::ifIsSet (_pOutOptGradYImg,
   ipsdk::imaproc::matchSize (_pInImg,_pOutOptGradYImg))))

Member Function Documentation

◆ getStorage()

template<typename TAttribute >

TAttribute::StorageType ipsdk::imaproc::filter::SobelGradient2dImgLvl1::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::SobelGradient2dImgLvl1::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

◆ preProcess()

ipsdk::core::ExecResult ipsdk::imaproc::filter::SobelGradient2dImgLvl1::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/IPSDKIPLFiltering/Processor/SobelGradient2dImg/SobelGradient2dImgLvl1.h

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members