Level 1 algorithm: algorithm allowing registration of 3d images using features associated to grey signature. More...

#include <GreySignedFeaturesImg3dRegistrationLvl1.h>

Inheritance diagram for ipsdk::imaproc::registration::GreySignedFeaturesImg3dRegistrationLvl1:

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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< GreySignedFeaturesImg3dRegistrationLvl1 >	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 Types
typedef std::vector< attr::Features3dRegistrationResultPtr >	RegistrationResultColl
	collection of registration results

Protected Types inherited from ipsdk::processor::BaseProcessor< ipsdk::core::BaseRepeatedAsync1Action >
typedef std::vector< AttributePtr >	AttributeColl

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

Protected Member Functions
	GreySignedFeaturesImg3dRegistrationLvl1 ()
	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::core::ExecResult	postProcess ()
	method called after processing More...

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
ipUInt32	_curStepIdx
	current processing step

ipUInt32	_curSubStepIdx
	current processing sub step

ipUInt32	_nbTotSteps
	total number of processing steps for algorithm

attr::Features3dGreySignaturePtr	_pOriginSignatures
	current feature signatures for origin image

attr::Features3dGreySignaturePtr	_pTargetSignatures
	current feature signatures for target image

RegistrationResultColl	_registrationResultColl
	collection of computed registration results

Attribute members
boost::shared_ptr< ipsdk::imaproc::attr::InOriginImg3d >	_pInOriginImg3d

boost::shared_ptr< ipsdk::imaproc::attr::InTargetImg3d >	_pInTargetImg3d

boost::shared_ptr< ipsdk::imaproc::attr::InOptScaleCandidates >	_pInOptScaleCandidates

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

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

boost::shared_ptr< ipsdk::imaproc::attr::InOptCornerDetectionParams3d >	_pInOptCornerDetectionParams3d

boost::shared_ptr< ipsdk::imaproc::attr::InOptNbFeatures >	_pInOptNbFeatures

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

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

boost::shared_ptr< ipsdk::imaproc::attr::InOptFeaturesDistZ >	_pInOptFeaturesDistZ

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

boost::shared_ptr< ipsdk::imaproc::attr::InOptSamplingBallInfo3d >	_pInOptSamplingBallInfo3d

boost::shared_ptr< ipsdk::imaproc::attr::InOptRegMotionModel3d >	_pInOptRegMotionModel3d

boost::shared_ptr< ipsdk::imaproc::attr::InOptCorrelationThreshold3d >	_pInOptCorrelationThreshold3d

boost::shared_ptr< ipsdk::imaproc::attr::InOptRegistrationEstimationConfig >	_pInOptRegistrationEstimationConfig

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::OutWk5Img >	_pOutWk5Img

boost::shared_ptr< ipsdk::imaproc::attr::OutWk6Img >	_pOutWk6Img

boost::shared_ptr< ipsdk::imaproc::attr::OutWk7Img >	_pOutWk7Img

boost::shared_ptr< ipsdk::imaproc::attr::OutFeatures3dRegistrationResults >	_pOutFeatures3dRegistrationResults

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

ipUInt32	_nbIter

Detailed Description

Level 1 algorithm: algorithm allowing registration of 3d images using features associated to grey signature.

See Image 3d registration using grey signed features for a complete algorithm description.

Author: E.Noirfalise

Date: 2016/11/03

Copyright: 2016 Reactiv'IP, all right reserved.

Algorithm associated library :

IPSDKIPLRegistration

Attribute description for algorithm :

Name	ToolTip	Default Initializer
ipsdk::imaproc::attr::InOriginImg3d	[Input] Origin 3d image provided to registration algorithm	X
ipsdk::imaproc::attr::InTargetImg3d	[Input] Target 3d image provided to registration algorithm	X
ipsdk::imaproc::attr::InOptScaleCandidates	[Input Optional] scale candidates for processing	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::InOptCornerDetectionParams3d	[Input Optional] parameters used during corner detection process	X
ipsdk::imaproc::attr::InOptNbFeatures	[Input Optional] 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::InOptFeaturesDistZ	[Input Optional] distance between detected features along z axis (tchebychev distance)	X
ipsdk::imaproc::attr::InOptInterpolationPolicy	[Input Optional] interpolation policy used to extract local data from image	X
ipsdk::imaproc::attr::InOptSamplingBallInfo3d	[Input Optional] Parameters for used sampling ball around image points	X
ipsdk::imaproc::attr::InOptRegMotionModel3d	[Input Optional] 3d motion model which should be used for computation	X
ipsdk::imaproc::attr::InOptCorrelationThreshold3d	[Input Optional] threshold on 3d correlation scores used during pairs matching	X
ipsdk::imaproc::attr::InOptRegistrationEstimationConfig	[Input Optional] configuration for robust estimation part of features registration	X
ipsdk::imaproc::attr::OutWk1Img	[Output] Temporary working image for algorithm	promoteReInterpretable (_pOutWk1Img, _pInOriginImg3d, _pInTargetImg3d, ipsdk::imaproc::ePromoteBinaryType::ePBT_UpperSigned)
ipsdk::imaproc::attr::OutWk2Img	[Output] Temporary working image for algorithm	promoteReInterpretable (_pOutWk2Img, _pInOriginImg3d, _pInTargetImg3d, ipsdk::imaproc::ePromoteBinaryType::ePBT_UpperSigned)
ipsdk::imaproc::attr::OutWk3Img	[Output] Temporary working image for algorithm	promoteReInterpretable (_pOutWk3Img, _pInOriginImg3d, _pInTargetImg3d, ipsdk::imaproc::ePromoteBinaryType::ePBT_UpperSigned)
ipsdk::imaproc::attr::OutWk4Img	[Output] Temporary working image for algorithm	promoteReInterpretable (_pOutWk4Img, _pInOriginImg3d, _pInTargetImg3d, ipsdk::imaproc::ePromoteBinaryType::ePBT_UpperSigned)
ipsdk::imaproc::attr::OutWk5Img	[Output] Temporary working image for algorithm	promoteReInterpretable (_pOutWk5Img, _pInOriginImg3d, _pInTargetImg3d, ipsdk::imaproc::ePromoteBinaryType::ePBT_UpperSigned)
ipsdk::imaproc::attr::OutWk6Img	[Output] Temporary working image for algorithm	promoteReInterpretable (_pOutWk6Img, _pInOriginImg3d, _pInTargetImg3d, ipsdk::imaproc::ePromoteBinaryType::ePBT_UpperSigned)
ipsdk::imaproc::attr::OutWk7Img	[Output] Temporary working image for algorithm	promoteReInterpretable (_pOutWk7Img, _pInOriginImg3d, _pInTargetImg3d, ipsdk::imaproc::ePromoteBinaryType::ePBT_UpperSigned)
ipsdk::imaproc::attr::OutFeatures3dRegistrationResults	[Output] collection of results for features 3d registration algorithm	allocate (_pOutFeatures3dRegistrationResults)

Global attributes rule :

Global rule on attributes is given by
((ipsdk::imaproc::matchBufferType (_pInOriginImg3d,_pInTargetImg3d)) &&
(ipsdk::imaproc::isReInterpretable (_pOutWk1Img,_pInOriginImg3d)) &&
(ipsdk::imaproc::isReInterpretable (_pOutWk1Img,_pInTargetImg3d)) &&
(ipsdk::imaproc::matchSizeAndType (_pOutWk1Img,_pOutWk2Img,_pOutWk3Img,_pOutWk4Img,_pOutWk5Img,_pOutWk6Img)) &&
(ipsdk::imaproc::matchSizeAndType (_pOutWk1Img,_pOutWk7Img)))

Member Function Documentation

◆ getStorage()

template<typename TAttribute >

TAttribute::StorageType ipsdk::imaproc::registration::GreySignedFeaturesImg3dRegistrationLvl1::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::GreySignedFeaturesImg3dRegistrationLvl1::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::registration::GreySignedFeaturesImg3dRegistrationLvl1::preProcess ( )

protected

method called before processing

Returns: execution result

◆ postProcess()

ipsdk::core::ExecResult ipsdk::imaproc::registration::GreySignedFeaturesImg3dRegistrationLvl1::postProcess ( )

protected

method called after 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/IPSDKIPLRegistration/Processor/GreySignedFeaturesImg3dRegistration/GreySignedFeaturesImg3dRegistrationLvl1.h

Public Member Functions

Static Public Member Functions

Protected Types

Protected Member Functions

Protected Attributes

Detailed Description

Algorithm associated library :

Attribute description for algorithm :

Global attributes rule :

Member Function Documentation

◆ getStorage()

◆ retrieveProvider()

◆ preProcess()

◆ postProcess()