Level 1 algorithm: Registration of the slices in a 3D stack using grey signed features and taking into account a cumulative angular bias. More...

#include <StackRegistrationImgLvl1.h>

Inheritance diagram for ipsdk::imaproc::registration::StackRegistrationImgLvl1:

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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< StackRegistrationImgLvl1 >	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
	StackRegistrationImgLvl1 ()
	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::InImg3d >	_pInImg3d

boost::shared_ptr< ipsdk::imaproc::attr::InOptTheta >	_pInOptTheta

boost::shared_ptr< ipsdk::imaproc::attr::InOptMaxTranslation >	_pInOptMaxTranslation

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

boost::shared_ptr< ipsdk::imaproc::attr::InOptCorrelationThreshold2d >	_pInOptCorrelationThreshold2d

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

boost::shared_ptr< ipsdk::imaproc::attr::InOptPIWarpMotionTransform2dColl >	_pInOptPIWarpMotionTransform2dColl

boost::shared_ptr< ipsdk::imaproc::attr::OutPIWarpMotionTransform2dColl >	_pOutPIWarpMotionTransform2dColl

boost::shared_ptr< ipsdk::imaproc::attr::OutWk1RealImg >	_pOutWk1RealImg

boost::shared_ptr< ipsdk::imaproc::attr::OutWk2RealImg >	_pOutWk2RealImg

boost::shared_ptr< ipsdk::imaproc::attr::OutWk3RealImg >	_pOutWk3RealImg

boost::shared_ptr< ipsdk::imaproc::attr::OutWk4RealImg >	_pOutWk4RealImg

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: Registration of the slices in a 3D stack using grey signed features and taking into account a cumulative angular bias.

See Stack registration for a complete algorithm description.

Author: R. Abbal

Date: 2024/11/04

Copyright: 2024 Reactiv'IP, all right reserved.

Support GPU

Algorithm associated library :

IPSDKIPLRegistration

Attribute description for algorithm :

Name	ToolTip	Default Initializer
ipsdk::imaproc::attr::InImg3d	[Input] 3d image for operation	X
ipsdk::imaproc::attr::InOptTheta	[Input Optional] 2d orientation for processing operation	X
ipsdk::imaproc::attr::InOptMaxTranslation	[Input Optional] Maximum translation allowed in a geometric transform (in absolute value)	X
ipsdk::imaproc::attr::InOptInterpolationPolicy	[Input Optional] interpolation policy used to extract local data from image	X
ipsdk::imaproc::attr::InOptCorrelationThreshold2d	[Input Optional] threshold on 2d 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::InOptPIWarpMotionTransform2dColl	[Input Optional] plan indexed collection of 2d geometric transform	X
ipsdk::imaproc::attr::OutPIWarpMotionTransform2dColl	[Output] plan indexed collection of 2d geometric transform	ipsdk::imaproc::fromImageButVolume (_pOutPIWarpMotionTransform2dColl, _pInImg3d)
ipsdk::imaproc::attr::OutWk1RealImg	[Output] Temporary working image for algorithm	duplicateInOut (_pOutWk1RealImg, _pInImg3d, ipsdk::image::eImageBufferType::eIBT_Real32)
ipsdk::imaproc::attr::OutWk2RealImg	[Output] Temporary working image for algorithm	duplicateInOut (_pOutWk2RealImg, _pInImg3d, ipsdk::image::eImageBufferType::eIBT_Real32)
ipsdk::imaproc::attr::OutWk3RealImg	[Output] Temporary working image for algorithm	duplicateInOut (_pOutWk3RealImg, _pInImg3d, ipsdk::image::eImageBufferType::eIBT_Real32)
ipsdk::imaproc::attr::OutWk4RealImg	[Output] Temporary working image for algorithm	duplicateInOut (_pOutWk4RealImg, _pInImg3d, ipsdk::image::eImageBufferType::eIBT_Real32)
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::matchSize (_pInImg3d,_pOutImg)

Member Function Documentation

◆ getStorage()

template<typename TAttribute >

TAttribute::StorageType ipsdk::imaproc::registration::StackRegistrationImgLvl1::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::StackRegistrationImgLvl1::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/StackRegistrationImg/StackRegistrationImgLvl1.h

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes