Level 1 algorithm: 3D Cross correlation calculated in the Fourier domain. More...

#include <FastCrossCorrelation3dImgLvl1.h>

Inheritance diagram for ipsdk::imaproc::filter::FastCrossCorrelation3dImgLvl1:

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

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

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

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

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

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

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

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

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

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

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

ipsdk::core::ExecResult	preProcess ()
	method called before processing 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
ipBool	_bPaddTemplateImg

Attribute members
boost::shared_ptr< ipsdk::imaproc::attr::InImg3d1 >	_pInImg3d1

boost::shared_ptr< ipsdk::imaproc::attr::InImg3d2 >	_pInImg3d2

boost::shared_ptr< ipsdk::imaproc::attr::OutOptWk1RealImg >	_pOutOptWk1RealImg

boost::shared_ptr< ipsdk::imaproc::attr::OutOptWk2RealImg >	_pOutOptWk2RealImg

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::OutRealImg >	_pOutRealImg

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: 3D Cross correlation calculated in the Fourier domain.

See Fast Cross-Correlation 3d for a complete algorithm description.

Author: R. Abbal

Date: 2023/01/11

Copyright: 2023 ReactivIP, all right reserved.

Algorithm associated library :

IPSDKIPLFiltering

Attribute description for algorithm :

Name	ToolTip	Default Initializer
ipsdk::imaproc::attr::InImg3d1	[Input] First 3d image for operation	X
ipsdk::imaproc::attr::InImg3d2	[Input] Second 3d image for operation	X
ipsdk::imaproc::attr::OutOptWk1RealImg	[Output Optional] Temporary working image for algorithm (data contained in image buffer are reals)	X
ipsdk::imaproc::attr::OutOptWk2RealImg	[Output Optional] Temporary working image for algorithm (data contained in image buffer are reals)	X
ipsdk::imaproc::attr::OutWk1RealImg	[Output] Temporary working image for algorithm	ipsdk::imaproc::duplicateInOut (_pOutWk1RealImg, _pInImg3d1, ipsdk::image::eImageBufferType::eIBT_Real32)
ipsdk::imaproc::attr::OutWk2RealImg	[Output] Temporary working image for algorithm	ipsdk::imaproc::duplicateInOut (_pOutWk2RealImg, _pInImg3d1, ipsdk::image::eImageBufferType::eIBT_Real32)
ipsdk::imaproc::attr::OutWk3RealImg	[Output] Temporary working image for algorithm	ipsdk::imaproc::duplicateInOut (_pOutWk3RealImg, _pInImg3d1, ipsdk::image::eImageBufferType::eIBT_Real32)
ipsdk::imaproc::attr::OutWk4RealImg	[Output] Temporary working image for algorithm	ipsdk::imaproc::duplicateInOut (_pOutWk4RealImg, _pInImg3d1, ipsdk::image::eImageBufferType::eIBT_Real32)
ipsdk::imaproc::attr::OutRealImg	[Output] image for processing operation (data contained in image buffer are reals)	ipsdk::imaproc::duplicateInOut (_pOutRealImg, _pInImg3d1, ipsdk::image::eImageBufferType::eIBT_Real32)

Global attributes rule :

Global rule on attributes is given by
ipsdk::imaproc::customImageProperty (_pInImg3d2,
fastCCRule3d (_pInImg3d1,_pInImg3d2)) &&
ipsdk::imaproc::matchSize (_pInImg3d1,_pOutWk1RealImg) &&
ipsdk::imaproc::matchSize (_pInImg3d1,_pOutWk2RealImg) &&
ipsdk::imaproc::matchSize (_pInImg3d1,_pOutWk3RealImg) &&
ipsdk::imaproc::matchSize (_pInImg3d1,_pOutWk4RealImg) &&
ipsdk::imaproc::matchSize (_pInImg3d1,_pOutRealImg) &&
(ipsdk::processor::ifIsSet (
  _pOutOptWk1RealImg, (
   ipsdk::imaproc::matchSize (_pInImg3d2,_pOutOptWk1RealImg)) &&
  (ipsdk::imaproc::noInSitu (_pInImg3d2,_pOutOptWk1RealImg)) &&
  (ipsdk::imaproc::noInSitu (_pOutWk1RealImg,_pOutOptWk1RealImg)) &&
  (ipsdk::imaproc::noInSitu (_pOutWk2RealImg,_pOutOptWk1RealImg)) &&
  (ipsdk::imaproc::noInSitu (_pOutWk3RealImg,_pOutOptWk1RealImg)) &&
  (ipsdk::imaproc::noInSitu (_pOutWk4RealImg,_pOutOptWk1RealImg)) &&
  (ipsdk::imaproc::noInSitu (_pOutRealImg,_pOutOptWk1RealImg)))) &&
(ipsdk::processor::ifIsSet (
  _pOutOptWk2RealImg, (
   ipsdk::imaproc::matchSize (_pInImg3d1,_pOutOptWk2RealImg)) &&
  (ipsdk::imaproc::noInSitu (_pInImg3d1,_pOutOptWk2RealImg)) &&
  (ipsdk::imaproc::noInSitu (_pOutWk1RealImg,_pOutOptWk2RealImg)) &&
  (ipsdk::imaproc::noInSitu (_pOutWk2RealImg,_pOutOptWk2RealImg)) &&
  (ipsdk::imaproc::noInSitu (_pOutWk3RealImg,_pOutOptWk2RealImg)) &&
  (ipsdk::imaproc::noInSitu (_pOutWk4RealImg,_pOutOptWk2RealImg)) &&
  (ipsdk::imaproc::noInSitu (_pOutRealImg,_pOutOptWk2RealImg))))

Member Function Documentation

◆ getStorage()

template<typename TAttribute >

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

◆ preProcess()

ipsdk::core::ExecResult ipsdk::imaproc::filter::FastCrossCorrelation3dImgLvl1::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/FastCrossCorrelation3dImg/FastCrossCorrelation3dImgLvl1.h

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members