Level 1 algorithm: ring surface unrolling. More...

#include <UnrollRingImgLvl1.h>

Inheritance diagram for ipsdk::imaproc::gtrans::UnrollRingImgLvl1:

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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< UnrollRingImgLvl1 >	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
	UnrollRingImgLvl1 ()
	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::InImg >	_pInImg

boost::shared_ptr< ipsdk::imaproc::attr::InCenter2d >	_pInCenter2d

boost::shared_ptr< ipsdk::imaproc::attr::InRadius >	_pInRadius

boost::shared_ptr< ipsdk::imaproc::attr::InRingHalfThickness >	_pInRingHalfThickness

boost::shared_ptr< ipsdk::imaproc::attr::InOptTheta0 >	_pInOptTheta0

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

boost::shared_ptr< ipsdk::imaproc::attr::InOptOutSizeX >	_pInOptOutSizeX

boost::shared_ptr< ipsdk::imaproc::attr::InOptTargetTile2dSideLength >	_pInOptTargetTile2dSideLength

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: ring surface unrolling.

See Ring unrolling algorithm for a complete algorithm description.

Author: E.Noirfalise

Date: 2017/04/13

Copyright: 2017 Reactiv'IP, all right reserved.

Algorithm associated library :

IPSDKIPLGeometricTransform

Attribute description for algorithm :

Name	ToolTip	Default Initializer
ipsdk::imaproc::attr::InImg	[Input] image for processing operation	X
ipsdk::imaproc::attr::InCenter2d	[Input] 2d center	X
ipsdk::imaproc::attr::InRadius	[Input] Radius	X
ipsdk::imaproc::attr::InRingHalfThickness	[Input] half thickness for ring used during processing	X
ipsdk::imaproc::attr::InOptTheta0	[Input Optional] starting angle offset value, in radians	X
ipsdk::imaproc::attr::InOptInterpolationPolicy	[Input Optional] interpolation policy used to extract local data from image	X
ipsdk::imaproc::attr::InOptOutSizeX	[Input Optional] size of output image along x-axis	X
ipsdk::imaproc::attr::InOptTargetTile2dSideLength	[Input Optional] target processing size for tile 2d (side length)	X
ipsdk::imaproc::attr::OutImg	[Output] image for processing operation	customOutput (_pOutImg, outputUnrollRing(_pInImg,_pInOptOutSizeX,_pInRingHalfThickness))

Global attributes rule :

Global rule on attributes is given by
ipsdk::imaproc::matchSize (eMatchImageSizeType::eMIST_ZCT,_pInImg,_pOutImg) &&
ipsdk::imaproc::matchBufferType (_pInImg,_pOutImg) &&
ipsdk::imaproc::gtrans::wholeRingIsInsideImg (_pInImg,_pInCenter2d,_pInRadius,_pInRingHalfThickness) &&
ipsdk::imaproc::customImageProperty (_pOutImg,
ipsdk::imaproc::gtrans::matchUnrollingOutput (_pOutImg,_pInOptOutSizeX,_pInRingHalfThickness))

Member Function Documentation

◆ getStorage()

template<typename TAttribute >

TAttribute::StorageType ipsdk::imaproc::gtrans::UnrollRingImgLvl1::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::gtrans::UnrollRingImgLvl1::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/IPSDKIPLGeometricTransform/Processor/UnrollRingImg/UnrollRingImgLvl1.h

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes