Level 2 algorithm: Phase retrieval from Paganin et al. 2004. More...

#include <DicPhaseRetrieval2dImgLvl2.h>

Inheritance diagram for ipsdk::imaproc::filter::DicPhaseRetrieval2dImgLvl2:

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

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

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

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

template<>
const ipsdk::imaproc::filter::InDicPhaseRetrievalParams &	get () const
	Getter for attribute InDicPhaseRetrievalParams.

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

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::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::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< DicPhaseRetrieval2dImgLvl2 >	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 processor::RetrievalResult(DicPhaseRetrieval2dImgLvl2::*	FunctionType) (const core::BasePriority &, core::ActionProviderPtr &)
	List of the functions to call.

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

processor::RetrievalResult	provideProcessor (const boost::shared_ptr< core::BaseAction > &pProcessor, const core::BasePriority &priority, core::ActionProviderPtr &pProvider)

processor::RetrievalResult	gaussianSmoothing (const core::BasePriority &priority, core::ActionProviderPtr &pProvider)

processor::RetrievalResult	divide (const core::BasePriority &priority, core::ActionProviderPtr &pProvider)

processor::RetrievalResult	fft (const core::BasePriority &priority, core::ActionProviderPtr &pProvider)

processor::RetrievalResult	lvl3Fourier (const core::BasePriority &priority, core::ActionProviderPtr &pProvider)

processor::RetrievalResult	ifft (const core::BasePriority &priority, core::ActionProviderPtr &pProvider)

processor::RetrievalResult	lvl3Final (const core::BasePriority &priority, core::ActionProviderPtr &pProvider)

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
std::vector< FunctionType >	_vFctCalls

Attribute members
boost::shared_ptr< ipsdk::imaproc::attr::InSubImg2d >	_pInSubImg2d

boost::shared_ptr< ipsdk::imaproc::attr::InStdDev >	_pInStdDev

boost::shared_ptr< ipsdk::imaproc::filter::InDicPhaseRetrievalParams >	_pInDicPhaseRetrievalParams

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

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

boost::shared_ptr< ipsdk::imaproc::attr::OutRealImg >	_pOutRealImg

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

ipUInt32	_nbIter

Detailed Description

Level 2 algorithm: Phase retrieval from Paganin et al. 2004.

See Differential Interference Contrast (DIC) Phase Retrieval 2D for a complete algorithm description.

Author: R. Abbal

Date: 2023/08/29

Copyright: 2023 ReactivIP, all right reserved.

Algorithm associated library :

IPSDKIPLFiltering

Attribute description for algorithm :

Name	ToolTip	Default Initializer
ipsdk::imaproc::attr::InSubImg2d	[Input] grey level 2d sub image for operation	X
ipsdk::imaproc::attr::InStdDev	[Input] standard deviation used for operation along all axis	X
ipsdk::imaproc::filter::InDicPhaseRetrievalParams	[Input] Attribute for the set of parameter used for the DIC phase retrieval algorithm	X
ipsdk::imaproc::attr::OutWk1RealImg	[Output] Temporary working image for algorithm	X
ipsdk::imaproc::attr::OutWk2RealImg	[Output] Temporary working image for algorithm	X
ipsdk::imaproc::attr::OutRealImg	[Output] image for processing operation (data contained in image buffer are reals)	X

Global attributes rule :

Global rule on attributes is given by
ipsdk::imaproc::matchSize (_pInSubImg2d,_pOutWk1RealImg) &&
ipsdk::imaproc::matchSize (_pInSubImg2d,_pOutWk2RealImg) &&
ipsdk::imaproc::matchSize (_pInSubImg2d,_pOutRealImg)

Member Function Documentation

◆ getStorage()

template<typename TAttribute >

TAttribute::StorageType ipsdk::imaproc::filter::DicPhaseRetrieval2dImgLvl2::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::DicPhaseRetrieval2dImgLvl2::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::filter::DicPhaseRetrieval2dImgLvl2::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/DicPhaseRetrieval2dImg/DicPhaseRetrieval2dImgLvl2.h

Public Member Functions

Static Public Member Functions

Protected Types

Protected Member Functions

Protected Attributes