Base class for z strip 3d parsed line by line and associated to a kernel. More...

#include <BaseLineZStrip3dWithKernelParser.h>

Inheritance diagram for ipsdk::imaproc::BaseLineZStrip3dWithKernelParser< BaseStripAttributeClassType >:

Public Types
typedef BaseStripAttributeClassType::ValueType	ValueType
	value type associated to object

typedef BaseStripAttributeClassType::StorageType	StorageType
	storage type associated to object

Public Member Functions
eStripParserType	getStripParserType () const
	retrieve strip parser type

void	init (const StorageType &pImageZStrip3dWithKernel)
	object initialization method More...

void	setBorder3dPolicy (const image::Border3dPolicy &border3dPolicy)
	set border policy associated to data parser More...

const image::Border3dPolicy &	getBorder3dPolicy () const
	retrieve border policy associated to data parser More...

const ValueType &	getImageZStrip3dWithKernel () const
	retrieve input z strip 3d with kernel associated to object More...

virtual ipUInt64	getBufferSize () const =0
	retrieve buffer size associated to current operation (number of elements for given buffer type) More...

template<typename T >
const T *	getBuffer (const ipUInt64 knlPlanIdx, const ipUInt64 knlRowIdx) const
	retrieve buffer associated to current operation More...

Constructors and destructors
	BaseLineZStrip3dWithKernelParser ()

virtual	~BaseLineZStrip3dWithKernelParser ()=0

Kernel informations
ipUInt64	getKernelSizeX () const
	retrieve full kernel X size associated to object More...

ipUInt64	getKernelSizeY () const
	retrieve full kernel Y size associated to object More...

ipUInt64	getKernelSizeZ () const
	retrieve full kernel Z size associated to object More...

ipUInt64	getStartingKernelSizeX () const
	retrieve starting kernel X size associated to object More...

ipUInt64	getEndingKernelSizeX () const
	retrieve ending kernel X size associated to object More...

ipUInt64	getStartingKernelSizeY () const
	retrieve starting kernel Y size associated to object More...

ipUInt64	getEndingKernelSizeY () const
	retrieve ending kernel Y size associated to object More...

ipUInt64	getStartingKernelSizeZ () const
	retrieve starting kernel Z size associated to object More...

ipUInt64	getEndingKernelSizeZ () const
	retrieve ending kernel Z size associated to object More...

Public Member Functions inherited from ipsdk::imaproc::BaseStripParser
eImageParserType	getImageParserType () const
	retrieve image parser type

	BaseStripParser ()

virtual	~BaseStripParser ()=0

Public Member Functions inherited from ipsdk::imaproc::BaseImageParser
processor::eDataParserType	getDataParserType () const
	retrieve data parser type

	BaseImageParser ()

virtual	~BaseImageParser ()=0

Public Member Functions inherited from ipsdk::processor::BaseDataParser
bool	isInit () const
	retrieve object initialization flag

bool	areDataInit () const
	retrieve data initialization flag More...

ipUInt64	getNbInitData () const
	retrieve number of initial data More...

ipUInt64	getNbMainData () const
	retrieve number of main data More...

ipUInt64	getNbFinalData () const
	retrieve number of final data More...

ipUInt64	getNbRealFinalData () const
	retrieve number of real final data (not virtual for alignment purpose only) More...

void	clear ()
	clear object data

	BaseDataParser ()

virtual	~BaseDataParser ()=0

const eIOStatus &	getAttributeIO () const
	retrieve associated attribute input/output status More...

ipUInt64	getNbElements () const
	retrieve number of elements associated to object More...

ipUInt64	getNbDataByElement () const
	retrieve total number of data by element More...

ipUInt64	getNbMinInitData () const
	retrieve minimum number of initial data to be processed More...

ipUInt64	getNbMinFinalData () const
	retrieve minimum number of final data to be processed More...

ipUInt64	getCurElementIdx () const
	retrieve current element index for iteration process More...

ipReal64	getUnAlignedValue () const
	retrieve used value for unaligned data More...

void	setUnAlignedValue (const ipReal64 unAlignedValue)
	set used value for unaligned data More...

Static Public Attributes
static const eIOStatus::domain	g_attributeIO = BaseStripAttributeClassType::g_dataIOStatus
	associated attribute Input/Output status

Protected Member Functions
virtual const void *	accessBuffer (const ipUInt64 knlPlanIdx, const ipUInt64 knlRowIdx) const =0
	access buffer associated to current operation More...

virtual void	clearDerived ()
	clear object data in derived class

Protected Member Functions inherited from ipsdk::processor::BaseDataParser
void	initBase (const eIOStatus &attributeIO, const ipUInt64 nbElements, const ipUInt64 nbDataByElement, const ipUInt64 nbMinInitData, const ipUInt64 nbMinFinalData, const ipReal64 unAlignedDefaultValue)
	base class initialization method More...

virtual void	initDataDerived (const ipUInt64 nbInitData, const ipUInt64 nbMainData, const ipUInt64 nbFinalData, const ipUInt64 nbRealFinalData, const ipReal64 unAlignedValue)=0
	initialize data for processing in derived class

virtual void	prepareDataDerived (const ipUInt64 elementIdx)=0

virtual void	updateToInitDataDerived ()=0
	update processed data to initial data in derived class

virtual void	updateToMainDataDerived ()=0
	update processed data to main data in derived class

virtual void	updateToFinalDataDerived ()=0
	update processed data to final data in derived class

virtual void	syncOutFinalDataDerived ()
	synchronize final output data after processing

void	initData (const ipUInt64 nbInitData, const ipUInt64 nbMainData, const ipUInt64 nbFinalData, const ipUInt64 nbRealFinalData)
	prepare data for processing for a given element index More...

void	prepareData (const ipUInt64 elementIdx)
	prepare data for processing for a given element index More...

Protected Attributes
image::Border3dPolicyPtr	_pBorder3dPolicy
	border policy associated to object More...

StorageType	_pImageZStrip3dWithKernel
	shared pointer to z strip 3d with kernel

image::eStripParsingDirection	_stripParsingDirection
	strip parsing direction

Detailed Description

template<typename BaseStripAttributeClassType>
class ipsdk::imaproc::BaseLineZStrip3dWithKernelParser< BaseStripAttributeClassType >

Base class for z strip 3d parsed line by line and associated to a kernel.

Author: E.Noirfalise

Date: 2015/01/20

Copyright: 2015 Reactiv'IP, all right reserved.

Member Function Documentation

◆ init()

template<typename BaseStripAttributeClassType >

void ipsdk::imaproc::BaseLineZStrip3dWithKernelParser< BaseStripAttributeClassType >::init ( const StorageType & pImageZStrip3dWithKernel )

object initialization method

Exceptions

ipsdk::processor::IPSDKBaseProcessingException	if pImageZStrip3dWithKernel.get() == 0
ipsdk::processor::IPSDKBaseProcessingException	if pImageZStrip3dWithKernel->isInit() == false

◆ setBorder3dPolicy()

template<typename BaseStripAttributeClassType >

void ipsdk::imaproc::BaseLineZStrip3dWithKernelParser< BaseStripAttributeClassType >::setBorder3dPolicy ( const image::Border3dPolicy & border3dPolicy )

set border policy associated to data parser

Exceptions

ipsdk::processor::IPSDKBaseProcessingException if borderPolicy.isInit() == false

◆ getBorder3dPolicy()

template<typename BaseStripAttributeClassType >

const image::Border3dPolicy& ipsdk::imaproc::BaseLineZStrip3dWithKernelParser< BaseStripAttributeClassType >::getBorder3dPolicy ( ) const

retrieve border policy associated to data parser

Note: default value : valuedBorder3d(0)

◆ getImageZStrip3dWithKernel()

template<typename BaseStripAttributeClassType >

const ValueType& ipsdk::imaproc::BaseLineZStrip3dWithKernelParser< BaseStripAttributeClassType >::getImageZStrip3dWithKernel ( ) const

retrieve input z strip 3d with kernel associated to object

Exceptions

ipsdk::processor::IPSDKBaseProcessingException if isInit() == false

◆ getKernelSizeX()

template<typename BaseStripAttributeClassType >

ipUInt64 ipsdk::imaproc::BaseLineZStrip3dWithKernelParser< BaseStripAttributeClassType >::getKernelSizeX ( ) const

retrieve full kernel X size associated to object

Exceptions

ipsdk::processor::IPSDKBaseProcessingException if isInit() == false

Returns: getStartingKernelSizeX() + getEndingKernelSizeX() + 1

◆ getKernelSizeY()

template<typename BaseStripAttributeClassType >

ipUInt64 ipsdk::imaproc::BaseLineZStrip3dWithKernelParser< BaseStripAttributeClassType >::getKernelSizeY ( ) const

retrieve full kernel Y size associated to object

Exceptions

ipsdk::processor::IPSDKBaseProcessingException if isInit() == false

Returns: getStartingKernelSizeY() + getEndingKernelSizeY() + 1

◆ getKernelSizeZ()

template<typename BaseStripAttributeClassType >

ipUInt64 ipsdk::imaproc::BaseLineZStrip3dWithKernelParser< BaseStripAttributeClassType >::getKernelSizeZ ( ) const

retrieve full kernel Z size associated to object

Exceptions

ipsdk::processor::IPSDKBaseProcessingException if isInit() == false

Returns: getStartingKernelSizeZ() + getEndingKernelSizeZ() + 1

◆ getStartingKernelSizeX()

template<typename BaseStripAttributeClassType >

ipUInt64 ipsdk::imaproc::BaseLineZStrip3dWithKernelParser< BaseStripAttributeClassType >::getStartingKernelSizeX ( ) const

retrieve starting kernel X size associated to object

Exceptions

ipsdk::processor::IPSDKBaseProcessingException if isInit() == false

◆ getEndingKernelSizeX()

template<typename BaseStripAttributeClassType >

ipUInt64 ipsdk::imaproc::BaseLineZStrip3dWithKernelParser< BaseStripAttributeClassType >::getEndingKernelSizeX ( ) const

retrieve ending kernel X size associated to object

Exceptions

ipsdk::processor::IPSDKBaseProcessingException if isInit() == false

◆ getStartingKernelSizeY()

template<typename BaseStripAttributeClassType >

ipUInt64 ipsdk::imaproc::BaseLineZStrip3dWithKernelParser< BaseStripAttributeClassType >::getStartingKernelSizeY ( ) const

retrieve starting kernel Y size associated to object

Exceptions

ipsdk::processor::IPSDKBaseProcessingException if isInit() == false

◆ getEndingKernelSizeY()

template<typename BaseStripAttributeClassType >

ipUInt64 ipsdk::imaproc::BaseLineZStrip3dWithKernelParser< BaseStripAttributeClassType >::getEndingKernelSizeY ( ) const

retrieve ending kernel Y size associated to object

Exceptions

ipsdk::processor::IPSDKBaseProcessingException if isInit() == false

◆ getStartingKernelSizeZ()

template<typename BaseStripAttributeClassType >

ipUInt64 ipsdk::imaproc::BaseLineZStrip3dWithKernelParser< BaseStripAttributeClassType >::getStartingKernelSizeZ ( ) const

retrieve starting kernel Z size associated to object

Exceptions

ipsdk::processor::IPSDKBaseProcessingException if isInit() == false

◆ getEndingKernelSizeZ()

template<typename BaseStripAttributeClassType >

ipUInt64 ipsdk::imaproc::BaseLineZStrip3dWithKernelParser< BaseStripAttributeClassType >::getEndingKernelSizeZ ( ) const

retrieve ending kernel Z size associated to object

Exceptions

ipsdk::processor::IPSDKBaseProcessingException if isInit() == false

◆ getBufferSize()

template<typename BaseStripAttributeClassType >

virtual ipUInt64 ipsdk::imaproc::BaseLineZStrip3dWithKernelParser< BaseStripAttributeClassType >::getBufferSize ( ) const

pure virtual

retrieve buffer size associated to current operation (number of elements for given buffer type)

Exceptions

ipsdk::processor::IPSDKBaseProcessingException if current operation has not been set

Implemented in ipsdk::imaproc::LineZStrip3dWithKernelParser< T, BaseStripAttributeClassType >.

◆ getBuffer()

template<typename BaseStripAttributeClassType >

template<typename T >

const T* ipsdk::imaproc::BaseLineZStrip3dWithKernelParser< BaseStripAttributeClassType >::getBuffer	(	const ipUInt64	knlPlanIdx,
		const ipUInt64	knlRowIdx
	)		const

inline

retrieve buffer associated to current operation

Exceptions

ipsdk::processor::IPSDKBaseProcessingException	if current operation has not been set
ipsdk::imaproc::IPSDKImageProcessingException	if knlPlanIdx >= getKernelSizeZ()
ipsdk::imaproc::IPSDKImageProcessingException	if knlRowIdx >= getKernelSizeY()

◆ accessBuffer()

template<typename BaseStripAttributeClassType >

virtual const void* ipsdk::imaproc::BaseLineZStrip3dWithKernelParser< BaseStripAttributeClassType >::accessBuffer	(	const ipUInt64	knlPlanIdx,
		const ipUInt64	knlRowIdx
	)		const

protectedpure virtual

access buffer associated to current operation

Exceptions

ipsdk::processor::IPSDKBaseProcessingException	if current operation has not been set
ipsdk::imaproc::IPSDKImageProcessingException	if knlPlanIdx >= getKernelSizeZ()
ipsdk::imaproc::IPSDKImageProcessingException	if knlRowIdx >= getKernelSizeY()

Member Data Documentation

◆ _pBorder3dPolicy

template<typename BaseStripAttributeClassType >

image::Border3dPolicyPtr ipsdk::imaproc::BaseLineZStrip3dWithKernelParser< BaseStripAttributeClassType >::_pBorder3dPolicy

protected

border policy associated to object

Note: default value : valuedBorder3d(0)

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

/media/reactivipdev/Nightly/IPSDK_Patch/IPSDK_4_1/IPSDK_Nightly/include/public/IPSDKImageProcessing/Algorithm/Parser/Strip/LineZStrip3dWithKernel/BaseLineZStrip3dWithKernelParser.h

Public Types

Public Member Functions

Static Public Attributes

Protected Member Functions

Protected Attributes

Detailed Description

template<typename BaseStripAttributeClassType> class ipsdk::imaproc::BaseLineZStrip3dWithKernelParser< BaseStripAttributeClassType >

Member Function Documentation

◆ init()

◆ setBorder3dPolicy()

◆ getBorder3dPolicy()

◆ getImageZStrip3dWithKernel()

◆ getKernelSizeX()

◆ getKernelSizeY()

◆ getKernelSizeZ()

◆ getStartingKernelSizeX()

◆ getEndingKernelSizeX()

◆ getStartingKernelSizeY()

◆ getEndingKernelSizeY()

◆ getStartingKernelSizeZ()

◆ getEndingKernelSizeZ()

◆ getBufferSize()

◆ getBuffer()

◆ accessBuffer()

Member Data Documentation

◆ _pBorder3dPolicy

template<typename BaseStripAttributeClassType>
class ipsdk::imaproc::BaseLineZStrip3dWithKernelParser< BaseStripAttributeClassType >