Level 3 algorithm: computes the Pearson correlation coefficient in the 3d image. More...

#include <PearsonCorrelationCoefficient3dLvl3.h>

Inheritance diagram for ipsdk::imaproc::glbmsr::PearsonCorrelationCoefficient3dLvl3:

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

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

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

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

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

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

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

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

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

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

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

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

Public Member Functions inherited from ipsdk::processor::BaseSyncProcessor
eProcessorType	getProcessorType () const

Public Member Functions inherited from ipsdk::processor::BaseProcessor
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

ItemNames	getHeaderKeys () const

const BaseDataItem &	getHeaderItem (const std::string &key) const

BaseDataItem &	getHeaderItem (const std::string &key)

void	addHeaderItem (const std::string &key, const DataItemPtr &pItem)

void	removeHeaderItem (const std::string &key)

void	clearHeader ()

ipUInt32	getNbAttributes () const

const BaseAttribute &	getAttribute (ipUInt32 index) const

BaseAttribute &	getAttribute (ipUInt32 index)

bool	existsAttribute (const std::string &attributeName) const

StringVector	getAttributeNameColl () const

const BaseAttribute &	getAttribute (const std::string &attributeName) const

BaseAttribute &	getAttribute (const std::string &attributeName)

bool	hasOutputInitializer (const std::string &attributeName) const

const BaseOutputInitializer &	getOutputInitializer (const std::string &attributeName) const

bool	existsHeaderKey (const std::string &key) const

ItemNames	getHeaderKeys () const

const BaseDataItem &	getHeaderItem (const std::string &key) const

BaseDataItem &	getHeaderItem (const std::string &key)

void	addHeaderItem (const std::string &key, const DataItemPtr &pItem)

void	removeHeaderItem (const std::string &key)

void	clearHeader ()

ipUInt32	getNbAttributes () const

const BaseAttribute &	getAttribute (ipUInt32 index) const

BaseAttribute &	getAttribute (ipUInt32 index)

bool	existsAttribute (const std::string &attributeName) const

StringVector	getAttributeNameColl () const

const BaseAttribute &	getAttribute (const std::string &attributeName) const

BaseAttribute &	getAttribute (const std::string &attributeName)

bool	hasOutputInitializer (const std::string &attributeName) const

const BaseOutputInitializer &	getOutputInitializer (const std::string &attributeName) const

Public Member Functions inherited from ipsdk::core::BaseComplexAction
bool	isComplexAction () const

Public Member Functions inherited from ipsdk::core::BaseAction
bool	isInit () const

eExecutionStatus	getStatus () const

const ePriority &	getActionPriority () const

void	setActionPriority (const BasePriority &actionPriority)

void	addCompletionCB (const ActionCompletionCB &completionCB)

ExecResult	run (const eSynchroType &synchroType=eSynchroType::eST_Default)

void	requestCancellation ()

bool	isCancellationRequested () const

void	waitForCompletion ()

ExecResult	getActionResult () const

double	getFullActionDuration () const

double	getExecutionActionDuration () const

BoolResult	clear ()

bool	hasSocketGuid () const

void	setSocketGuid (const Guid &socketGuid)

const Guid &	getSocketGuid () const

bool	hasSocketGuid () const

void	setSocketGuid (const Guid &socketGuid)

const Guid &	getSocketGuid () const

Public Member Functions inherited from ipsdk::SerializationObjectWithGuid
const Guid &	getGuid () const

Public Member Functions inherited from ipsdk::BaseDynamicObject
virtual const std::string &	getClassName () const

virtual BaseDynamicObject *	createNew () const=0

virtual DynamicObjectPtr	createShared () const=0

virtual bool	hasCopySupport () const=0

virtual BaseDynamicObject *	duplicate () const=0

virtual DynamicObjectPtr	duplicateShared () const=0

Static Public Member Functions
static boost::shared_ptr< PearsonCorrelationCoefficient3dLvl3 >	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

Static Public Member Functions inherited from ipsdk::BaseSerializationObject
static ipUInt32	getVersion ()

Static Public Member Functions inherited from ipsdk::BaseDynamicObject
static const std::string &	getTypeName ()

Protected Member Functions
	PearsonCorrelationCoefficient3dLvl3 ()
	constructor

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

template<typename BufType1 , typename BufType2 , ipsdk::eInstructionSet::domain IS>
ipsdk::BoolResult	genericProcessFunction (const ipsdk::processor::ProcessingInfo &info)
	generic processing function associated to class

Protected Member Functions inherited from ipsdk::processor::BaseProcessingAlgorithm
virtual const FunctionSelector &	getFunctionSelector () const=0

virtual const InstructionSetsIdentifier &	getForcedInstructionSets () const=0

virtual void	getDataTypeIdColl (DataTypeIdColl &dataTypeIdColl) const=0

virtual void	initDataParserColl (DataParserColl &dataParserColl)=0

virtual void	clearDataParserColl ()=0

virtual core::ExecResult	postProcess ()

virtual void	getNoParseInfo (ipUInt64 &nbDataByElement, ipUInt64 &nbMaxInitData, ipUInt64 &nbMaxFinalData) const

Protected Member Functions inherited from ipsdk::processor::BaseSyncProcessor
virtual core::ExecResult	mainProcess ()=0

Protected Member Functions inherited from ipsdk::processor::BaseProcessor
virtual BoolResult	initDerived (AttributeColl &attributeColl, OutputInitializerColl &outputInitializerColl, ProcessorDispatchPolicy &dispatchPolicy, RulePtr &pGlobalRule, const eProcessorRulePolicy &rulePolicy)=0

Protected Member Functions inherited from ipsdk::core::BaseComplexAction
virtual ExecResult	initProcess ()

virtual ExecResult	endProcess ()

ExecResult	execInitProcess ()

ExecResult	execEndProcess ()

Protected Member Functions inherited from ipsdk::core::BaseAction
bool	isSynchronismForced () const

BoolResult	initBase (const BasePriority &defaultPriority=NormalPriority())

virtual BoolResult	globalCleanDerived ()

virtual BoolResult	cleanOnErrorDerived (const eCleanReason &cleanReason)

virtual ExecResultDerived	runDerived ()=0

virtual void	requestCancellationdDerived ()

void	notifyCompletion (const ExecResult &bCompletionResult)

ExecResultDerived	toExecResultDerived (const ExecResult &execResult) const

virtual BoolResult	syncInputDataDerived (const Guid &processingSocketGuid)

virtual BoolResult	syncOutputDataDerived (const Guid &processingSocketGuid)

virtual void	clearInputData ()

virtual void	clearIntermediateData ()

virtual void	clearOutputData ()

Protected Member Functions inherited from ipsdk::BaseSerializationObject
virtual BoolResult	write (BaseOArchive &ar) const

virtual BoolResult	read (BaseIArchive &ar)

Protected Member Functions inherited from ipsdk::BaseDynamicObject
virtual void	initCtorCopy (const BaseDynamicObject &object)

virtual void	copy (const BaseDynamicObject &object)

Protected Attributes
Attribute members
boost::shared_ptr< ipsdk::imaproc::attr::InZStrip3d1 >	_pInZStrip3d1

boost::shared_ptr< ipsdk::imaproc::attr::InZStrip3d2 >	_pInZStrip3d2

boost::shared_ptr< ipsdk::imaproc::attr::InImgMean1 >	_pInImgMean1

boost::shared_ptr< ipsdk::imaproc::attr::InImgMean2 >	_pInImgMean2

boost::shared_ptr< ipsdk::imaproc::attr::InFactor >	_pInFactor

boost::shared_ptr< ipsdk::imaproc::attr::OutPearsonCCResult >	_pOutPearsonCCResult

Parsed data attributes
boost::shared_ptr< RawStripParser >	_pInZStrip3d1Buf
	Data preparator associated to attribute InZStrip3d1.

boost::shared_ptr< RawStripParser >	_pInZStrip3d2Buf
	Data preparator associated to attribute InZStrip3d2.

Protected Attributes inherited from ipsdk::processor::BaseProcessor
eProcessorProgressAvailability	_processorProgressAvailability

ipUInt32	_nbIter

Protected Attributes inherited from ipsdk::core::BaseAction
	eCR_Failure

	eCR_Exception

	eCR_Cancellation

	eERD_Success

	eERD_Failure

	eERD_Canceled

	eERD_Running

Protected Attributes inherited from ipsdk::SerializationObjectWithGuid
Guid	_guid

Additional Inherited Members
Public Types inherited from ipsdk::processor::BaseProcessingAlgorithm
typedef DataTypeIdentifierColl	DataTypeIdColl

typedef AlgorithmFunctionIdentifier	FunctionId

typedef AlgorithmFunctionSelector	FunctionSelector

typedef BoolResult(BaseProcessingAlgorithm::*	FunctionType) (const ProcessingInfo &info)

Protected Types inherited from ipsdk::processor::BaseProcessingAlgorithm
typedef std::vector< DataParserPtr >	DataParserColl

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

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

Protected Types inherited from ipsdk::core::BaseAction
enum	eCleanReason

enum	eExecutionResultDerived

typedef ProcessingResult< eExecutionResultDerived >	ExecResultDerived

Detailed Description

Level 3 algorithm: computes the Pearson correlation coefficient in the 3d image.

See Pearson Correlation Coefficient 3d for a complete algorithm description.

Author: R. Abbal

Date: 2017/07/27

Copyright: 2017 Reactiv'IP, all right reserved.

Algorithm associated library :

IPSDKIPLGlobalMeasure

Attribute description for algorithm :

Name	ToolTip	Default Initializer
ipsdk::imaproc::attr::InZStrip3d1	[Input] First z strip 3d for operation	X
ipsdk::imaproc::attr::InZStrip3d2	[Input] Second z strip 3d for operation	X
ipsdk::imaproc::attr::InImgMean1	[Input] Mean value of the first input image	X
ipsdk::imaproc::attr::InImgMean2	[Input] Mean value of the second input image	X
ipsdk::imaproc::attr::InFactor	[Input] Multiplying factor. Used for instance by shading correction algorithm	X
ipsdk::imaproc::attr::OutPearsonCCResult	[Output] Pearson correlation coefficient	X

Global attributes rule :

Global rule on attributes is given by
ipsdk::imaproc::matchSize (_pInZStrip3d1,_pInZStrip3d2)

Data type algorithm function selector informations :

Processing function selection for this algorithm is based on following attribute data types :

InZStrip3d1
InZStrip3d2

For More informations about algorithm function selection see AlgorithmFunctionSelection

Algorithm parsed data informations :

Algorithm parsed data is based on following attributes :

InZStrip3d1
InZStrip3d2

For More informations about algorithm parsed data see AlgorithmParsedData

Member Function Documentation

◆ getStorage()

template<typename TAttribute >

TAttribute::StorageType ipsdk::imaproc::glbmsr::PearsonCorrelationCoefficient3dLvl3::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

◆ preProcess()

ipsdk::core::ExecResult ipsdk::imaproc::glbmsr::PearsonCorrelationCoefficient3dLvl3::preProcess ( )

protectedvirtual

method called before processing

Returns: execution result

Reimplemented from ipsdk::processor::BaseProcessingAlgorithm.

The documentation for this class was generated from the following file:

/media/reactivipdev/Nightly/IPSDK_Patch/IPSDK_4_1/IPSDK_Nightly/include/public/IPSDKIPL/IPSDKIPLGlobalMeasure/Processor/PearsonCorrelationCoefficient3d/PearsonCorrelationCoefficient3dLvl3.h

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members