Level 1 algorithm: function for computing a contrasted image by maximum along the Z axis. More...

#include <ZStackFocusMaximumImgLvl1.h>

Inheritance diagram for ipsdk::imaproc::filter::ZStackFocusMaximumImgLvl1:

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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
Attribute members
boost::shared_ptr< ipsdk::imaproc::attr::InImg3d >	_pInImg3d

boost::shared_ptr< ipsdk::imaproc::attr::InOptZoomFactor >	_pInOptZoomFactor

boost::shared_ptr< ipsdk::imaproc::attr::InOptContrastRadius >	_pInOptContrastRadius

boost::shared_ptr< ipsdk::imaproc::attr::InOptMeanSmoothingValue >	_pInOptMeanSmoothingValue

boost::shared_ptr< ipsdk::imaproc::attr::InOptDepthMap >	_pInOptDepthMap

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::OutOptWk1Img >	_pOutOptWk1Img

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

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

boost::shared_ptr< ipsdk::imaproc::attr::OutWk1BinImg >	_pOutWk1BinImg

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

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

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

boost::shared_ptr< ipsdk::imaproc::attr::OutOptWk1LabelImg >	_pOutOptWk1LabelImg

boost::shared_ptr< ipsdk::imaproc::attr::OutOptWk2LabelImg >	_pOutOptWk2LabelImg

boost::shared_ptr< ipsdk::imaproc::attr::OutWk5RealImg >	_pOutWk5RealImg

boost::shared_ptr< ipsdk::imaproc::attr::OutOptLabelImg2d >	_pOutOptLabelImg2d

boost::shared_ptr< ipsdk::imaproc::attr::OutImg2d >	_pOutImg2d

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

ipUInt32	_nbIter

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

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

Detailed Description

Level 1 algorithm: function for computing a contrasted image by maximum along the Z axis.

See Z Stack Focus Maximum for a complete algorithm description.

Author: W.Aim

Date: 2019/04/26

Copyright: 2019 Reactiv'IP, all right reserved.

Algorithm associated library :

IPSDKIPLFiltering

Attribute description for algorithm :

Name	ToolTip	Default Initializer
ipsdk::imaproc::attr::InImg3d	[Input] 3d image for operation	X
ipsdk::imaproc::attr::InOptZoomFactor	[Input Optional] z-size of 3d output image	X
ipsdk::imaproc::attr::InOptContrastRadius	[Input Optional] contrast radius for Z focus	X
ipsdk::imaproc::attr::InOptMeanSmoothingValue	[Input Optional] mean smoothing value for Z focus	X
ipsdk::imaproc::attr::InOptDepthMap	[Input Optional] bool value for depth map in z focus	X
ipsdk::imaproc::attr::OutWk1Img	[Output] Temporary working image for algorithm	customOutput (_pOutWk1Img, outputZoom3d(_pInImg3d,_pInOptZoomFactor))
ipsdk::imaproc::attr::OutWk2Img	[Output] Temporary working image for algorithm	customOutput (_pOutWk2Img, outputZoom3d(_pInImg3d,_pInOptZoomFactor))
ipsdk::imaproc::attr::OutWk3Img	[Output] Temporary working image for algorithm	customOutput (_pOutWk3Img, outputZoom3dGrey(_pInImg3d,_pInOptZoomFactor))
ipsdk::imaproc::attr::OutOptWk1Img	[Output Optional] Temporary working image for algorithm	X
ipsdk::imaproc::attr::OutWk1RealImg	[Output] Temporary working image for algorithm	customOutput (_pOutWk1RealImg, outputZoom2dGreyReal(_pInImg3d,_pInOptZoomFactor))
ipsdk::imaproc::attr::OutWk2RealImg	[Output] Temporary working image for algorithm	customOutput (_pOutWk2RealImg, outputZoom3dGreyReal(_pInImg3d,_pInOptZoomFactor))
ipsdk::imaproc::attr::OutWk1BinImg	[Output] Temporary working image for algorithm	customOutput (_pOutWk1BinImg, outputZoom3dGreyBin(_pInImg3d,_pInOptZoomFactor))
ipsdk::imaproc::attr::OutWk3RealImg	[Output] Temporary working image for algorithm	customOutput (_pOutWk3RealImg, duplicateGreyReal(_pInImg3d))
ipsdk::imaproc::attr::OutWk4RealImg	[Output] Temporary working image for algorithm	customOutput (_pOutWk4RealImg, duplicate2dGreyReal(_pInImg3d))
ipsdk::imaproc::attr::OutOptWk1RealImg	[Output Optional] Temporary working image for algorithm (data contained in image buffer are reals)	X
ipsdk::imaproc::attr::OutOptWk1LabelImg	[Output Optional] Temporary working image for algorithm	X
ipsdk::imaproc::attr::OutOptWk2LabelImg	[Output Optional] Temporary working image for algorithm	X
ipsdk::imaproc::attr::OutWk5RealImg	[Output] Temporary working image for algorithm	customOutput (_pOutWk5RealImg, duplicate2dReal(_pInImg3d))
ipsdk::imaproc::attr::OutOptLabelImg2d	[Output Optional] label image 2d for processing operation	X
ipsdk::imaproc::attr::OutImg2d	[Output] 2d image for processing operation	duplicate2dInOut (_pOutImg2d, _pInImg3d)

Global attributes rule :

Global rule on attributes is given by
(ipsdk::imaproc::matchSize (eMatchImageSizeType::eMIST_Z,_pInImg3d,_pOutWk1Img) &&
ipsdk::imaproc::matchSize (_pOutWk1Img,_pOutWk2Img) &&
ipsdk::processor::ifIsSet (
  _pOutOptWk1Img, (
   ipsdk::imaproc::isGrey (_pInImg3d) ||
   ipsdk::imaproc::matchSize (_pOutWk1Img,_pOutOptWk1Img))) &&
ipsdk::imaproc::matchSize (eMatchImageSizeType::eMIST_3d,_pOutWk1Img,_pOutWk3Img) &&
ipsdk::imaproc::matchSize (eMatchImageSizeType::eMIST_2d,_pOutWk1Img,_pOutWk1RealImg) &&
ipsdk::imaproc::matchSize (eMatchImageSizeType::eMIST_3d,_pOutWk1Img,_pOutWk2RealImg) &&
ipsdk::imaproc::matchSize (eMatchImageSizeType::eMIST_3d,_pOutWk1Img,_pOutWk1BinImg) &&
ipsdk::imaproc::matchSize (eMatchImageSizeType::eMIST_3d,_pInImg3d,_pOutWk3RealImg) &&
ipsdk::imaproc::matchSize (eMatchImageSizeType::eMIST_2d,_pInImg3d,_pOutWk4RealImg) &&
ipsdk::processor::ifIsSet (
  _pOutOptWk1RealImg, (
   ipsdk::imaproc::isGrey (_pInImg3d) ||
   ipsdk::imaproc::matchSize (_pInImg3d,_pOutOptWk1RealImg))) &&
ipsdk::imaproc::matchSize (eMatchImageSizeType::eMIST_2d,_pInImg3d,_pOutWk5RealImg) &&
ipsdk::imaproc::matchSize (eMatchImageSizeType::eMIST_2d,_pInImg3d,_pOutImg2d) &&
ipsdk::imaproc::matchSize (eMatchImageSizeType::eMIST_C,_pInImg3d,_pOutImg2d))

Member Function Documentation

◆ getStorage()

template<typename TAttribute >

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

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members