Level 1 algorithm: algorithm allowing to extract 2d features associated to a grey signature from an image. More...

#include <ExtractGreySignedFeatures2dLvl1.h>

Inheritance diagram for ipsdk::imaproc::registration::ExtractGreySignedFeatures2dLvl1:

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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< ExtractGreySignedFeatures2dLvl1 >	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
	ExtractGreySignedFeatures2dLvl1 ()
	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::InImg >	_pInImg

boost::shared_ptr< ipsdk::imaproc::attr::InOptSignatureScaleFactor >	_pInOptSignatureScaleFactor

boost::shared_ptr< ipsdk::imaproc::attr::InOptGradStdDev >	_pInOptGradStdDev

boost::shared_ptr< ipsdk::imaproc::attr::InOptGradientGaussianCoverage >	_pInOptGradientGaussianCoverage

boost::shared_ptr< ipsdk::imaproc::attr::InOptCornerDetectionParams2d >	_pInOptCornerDetectionParams2d

boost::shared_ptr< ipsdk::imaproc::attr::InNbFeatures >	_pInNbFeatures

boost::shared_ptr< ipsdk::imaproc::attr::InOptFeaturesDistX >	_pInOptFeaturesDistX

boost::shared_ptr< ipsdk::imaproc::attr::InOptFeaturesDistY >	_pInOptFeaturesDistY

boost::shared_ptr< ipsdk::imaproc::attr::InOptInterpolationPolicy >	_pInOptInterpolationPolicy

boost::shared_ptr< ipsdk::imaproc::attr::InOptSamplingBallInfo2d >	_pInOptSamplingBallInfo2d

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

boost::shared_ptr< ipsdk::imaproc::attr::OutWk2Img >	_pOutWk2Img

boost::shared_ptr< ipsdk::imaproc::attr::OutWk3Img >	_pOutWk3Img

boost::shared_ptr< ipsdk::imaproc::attr::OutWk4Img >	_pOutWk4Img

boost::shared_ptr< ipsdk::imaproc::attr::OutPIGreySignatures2d >	_pOutPIGreySignatures2d

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 extract 2d features associated to a grey signature from an image.

See Extract grey signed features 2d for a complete algorithm description.

Author: E.Noirfalise

Date: 2016/10/25

Copyright: 2016 Reactiv'IP, all right reserved.

Algorithm associated library :

IPSDKIPLRegistration

Attribute description for algorithm :

Name	ToolTip	Default Initializer
ipsdk::imaproc::attr::InImg	[Input] image for processing operation	X
ipsdk::imaproc::attr::InOptSignatureScaleFactor	[Input Optional] image scale factor used during signature computation	X
ipsdk::imaproc::attr::InOptGradStdDev	[Input Optional] standard deviation used for gradient computation	X
ipsdk::imaproc::attr::InOptGradientGaussianCoverage	[Input Optional] Parameter allowing to specify a gaussian distribution coverage for processing	X
ipsdk::imaproc::attr::InOptCornerDetectionParams2d	[Input Optional] parameters used during corner detection process	X
ipsdk::imaproc::attr::InNbFeatures	[Input] target number of features to be detected by algorithm	X
ipsdk::imaproc::attr::InOptFeaturesDistX	[Input Optional] distance between detected features along x axis (tchebychev distance)	X
ipsdk::imaproc::attr::InOptFeaturesDistY	[Input Optional] distance between detected features along y axis (tchebychev distance)	X
ipsdk::imaproc::attr::InOptInterpolationPolicy	[Input Optional] interpolation policy used to extract local data from image	X
ipsdk::imaproc::attr::InOptSamplingBallInfo2d	[Input Optional] Parameters for used sampling ball around image points	X
ipsdk::imaproc::attr::OutWk1Img	[Output] Temporary working image for algorithm	promoteUnary (_pOutWk1Img, _pInImg, ipsdk::imaproc::ePromoteUnaryType::ePUT_UpperSigned)
ipsdk::imaproc::attr::OutWk2Img	[Output] Temporary working image for algorithm	promoteUnary (_pOutWk2Img, _pInImg, ipsdk::imaproc::ePromoteUnaryType::ePUT_UpperSigned)
ipsdk::imaproc::attr::OutWk3Img	[Output] Temporary working image for algorithm	promoteUnary (_pOutWk3Img, _pInImg, ipsdk::imaproc::ePromoteUnaryType::ePUT_UpperSigned)
ipsdk::imaproc::attr::OutWk4Img	[Output] Temporary working image for algorithm	promoteUnary (_pOutWk4Img, _pInImg, ipsdk::imaproc::ePromoteUnaryType::ePUT_UpperSigned)
ipsdk::imaproc::attr::OutPIGreySignatures2d	[Output] collection of features 2d grey signature used during processing	fromImage (_pOutPIGreySignatures2d, _pInImg)

Global attributes rule :

Global rule on attributes is given by
ipsdk::imaproc::matchSize (_pOutWk1Img,_pInImg) &&
ipsdk::imaproc::matchSizeAndType (_pOutWk1Img,_pOutWk2Img,_pOutWk3Img) &&
ipsdk::imaproc::matchImagePlans (_pOutPIGreySignatures2d,_pInImg)

Member Function Documentation

◆ getStorage()

template<typename TAttribute >

TAttribute::StorageType ipsdk::imaproc::registration::ExtractGreySignedFeatures2dLvl1::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::registration::ExtractGreySignedFeatures2dLvl1::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/IPSDKIPLRegistration/Processor/ExtractGreySignedFeatures2d/ExtractGreySignedFeatures2dLvl1.h

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes