Base class used to split image into sub images for data dispatch. More...

#include <BaseSubImageSplit.h>

Inheritance diagram for ipsdk::imaproc::BaseSubImageSplit< InOutStorageType >:

Public Types
typedef InOutStorageType	InputStorageType
	input data type for split operation

Public Member Functions
processor::eSplitStaticType	getSplitStaticType () const
	retrieve static split operation type

eImageSplitType	getImageSplitType () const
	retrieve image split operation type

const eSubImageSplitType &	getSubImageSplitType () const
	retrieve sub image split type More...

const eVolumeParsingType &	getVolumeParsingType () const
	retrieve volume geometry parsing flag More...

const eColorParsingType &	getColorParsingType () const
	retrieve color geometry parsing flag More...

const eTemporalParsingType &	getTemporalParsingType () const
	retrieve temporal geometry parsing flag More...

const image::BaseImage &	getImage () const
	retrieve image to be splitted More...

Constructors and destructors
	BaseSubImageSplit ()

virtual	~BaseSubImageSplit ()=0

Public Member Functions inherited from ipsdk::processor::BaseStaticSplit
eSplitBaseType	getSplitBaseType () const
	retrieve split operation base type

BoolResult	initAttribute (BaseProcessor &processor, const ipUInt32 elementIdx, const core::BaseRequestOrigin &requestOrigin)
	initialize processor attribute associate to split operation for a starting element index and a number of elements More...

	BaseStaticSplit ()

virtual	~BaseStaticSplit ()=0

Public Member Functions inherited from ipsdk::processor::BaseDataSplit
virtual const std::string &	getAttributeName () const =0
	retrieve attribute name associated to split operation

virtual const std::string &	getAttributeToolTip () const =0
	retrieve attribute tooltip associated to split operation

bool	isInit () const
	retrieve object initialization flag

bool	isSplitted () const
	check whether object will be associated to split operation More...

const ElementsLocationInfo &	getElementsLocationInfo () const
	retrieve data location informations More...

ipUInt64	getFullMemorySize () const
	retrieve full memory data size for elements More...

bool	areDataLocalized () const
	check whether data are localized More...

bool	hasLocalData () const
	check whether some data are local data More...

bool	hasRemoteData () const
	check whether some data are remote data More...

void	disableDataLocalization ()
	method allowing to disable data localization More...

	BaseDataSplit ()

virtual	~BaseDataSplit ()=0

ipUInt64	getNbElements () const
	retrieve total number of elements associated to input data More...

ipUInt64	getDataMemorySize (const ipUInt64 elementIdx) const
	retrieve memory size of data for a given element More...

ipUInt64	getDataMemorySize () const
	retrieve memory size of data for a given element More...

Protected Member Functions
void	initBase (const eSubImageSplitType &subImageSplitType, const eVolumeParsingType &volumeParsingType, const eColorParsingType &colorParsingType, const eTemporalParsingType &temporalParsingType, const InOutStorageType &pImage)
	base class initialization method for splitted objects More...

void	initBase (const eSubImageSplitType &subImageSplitType, const InOutStorageType &pImage)
	base class initialization method for un-splitted objects More...

BoolResult	getSubImage (ipUInt64 elementIdx, InOutStorageType &pSubImage) const
	retrieve sub image associated to a given index More...

Protected Member Functions inherited from ipsdk::processor::BaseStaticSplit
virtual BoolResult	processAttribute (BaseProcessor &processor, const ipUInt32 elementIdx, const core::BaseRequestOrigin &requestOrigin)=0
	initialize processor attribute associate to split operation for a given element index More...

Protected Member Functions inherited from ipsdk::processor::BaseDataSplit
void	initBaseSplitted (const ElementsLocationInfo &elementsLocationInfo)
	base class initialization method for splitted elements More...

void	initBaseUnSplitted (const ElementsLocationInfo &elementsLocationInfo)
	base class initialization method for un splitted elements More...

virtual bool	checkProcessorType (const processor::BaseProcessor &processor)=0
	check processor type in derived class

void	throwNullInputSharedPtr ()

Protected Attributes
eSubImageSplitType	_subImageSplitType
	sub image split type associated to operation

eVolumeParsingType	_volumeParsingType
	image volume geometry parsing flag

eColorParsingType	_colorParsingType
	image color geometry parsing flag

eTemporalParsingType	_temporalParsingType
	image temporal geometry parsing flag

InOutStorageType	_pImage
	pointer to image to be splitted

Additional Inherited Members
Static Public Attributes inherited from ipsdk::processor::BaseStaticSplit
static const eSplitBaseType::domain	g_splitBaseType = eSplitBaseType::eSBT_Static
	data split type associated to object

Detailed Description

template<typename InOutStorageType>
class ipsdk::imaproc::BaseSubImageSplit< InOutStorageType >

Base class used to split image into sub images for data dispatch.

Author: E. Noirfalise

Date: 2014/2/12

Copyright: 2013 Reactiv'IP, all right reserved.

Member Function Documentation

◆ getSubImageSplitType()

template<typename InOutStorageType>

const eSubImageSplitType& ipsdk::imaproc::BaseSubImageSplit< InOutStorageType >::getSubImageSplitType ( ) const

retrieve sub image split type

Exceptions

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

◆ getVolumeParsingType()

template<typename InOutStorageType>

const eVolumeParsingType& ipsdk::imaproc::BaseSubImageSplit< InOutStorageType >::getVolumeParsingType ( ) const

retrieve volume geometry parsing flag

Exceptions

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

◆ getColorParsingType()

template<typename InOutStorageType>

const eColorParsingType& ipsdk::imaproc::BaseSubImageSplit< InOutStorageType >::getColorParsingType ( ) const

retrieve color geometry parsing flag

Exceptions

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

◆ getTemporalParsingType()

template<typename InOutStorageType>

const eTemporalParsingType& ipsdk::imaproc::BaseSubImageSplit< InOutStorageType >::getTemporalParsingType ( ) const

retrieve temporal geometry parsing flag

Exceptions

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

◆ getImage()

template<typename InOutStorageType>

const image::BaseImage& ipsdk::imaproc::BaseSubImageSplit< InOutStorageType >::getImage ( ) const

retrieve image to be splitted

Exceptions

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

◆ initBase() [1/2]

template<typename InOutStorageType>

void ipsdk::imaproc::BaseSubImageSplit< InOutStorageType >::initBase	(	const eSubImageSplitType &	subImageSplitType,
		const eVolumeParsingType &	volumeParsingType,
		const eColorParsingType &	colorParsingType,
		const eTemporalParsingType &	temporalParsingType,
		const InOutStorageType &	pImage
	)

protected

base class initialization method for splitted objects

Exceptions

ipsdk::imaproc::IPSDKImageProcessingException	if sub image split type mismatch with geometry parsing flags
ipsdk::imaproc::IPSDKImageProcessingException	if image geometry mismatch with sub image split type or with geometry parsing flags
ipsdk::imaproc::IPSDKImageProcessingException	if pImage.get() == 0

◆ initBase() [2/2]

template<typename InOutStorageType>

void ipsdk::imaproc::BaseSubImageSplit< InOutStorageType >::initBase	(	const eSubImageSplitType &	subImageSplitType,
		const InOutStorageType &	pImage
	)

protected

base class initialization method for un-splitted objects

Exceptions

ipsdk::imaproc::IPSDKImageProcessingException	if image geometry mismatch with sub image split type
ipsdk::imaproc::IPSDKImageProcessingException	if pImage.get() == 0

◆ getSubImage()

template<typename InOutStorageType>

BoolResult ipsdk::imaproc::BaseSubImageSplit< InOutStorageType >::getSubImage	(	ipUInt64	elementIdx,
		InOutStorageType &	pSubImage
	)		const

protected

retrieve sub image associated to a given index

Warning: there is no chek on object initialization nor on elementIdx value

Returns: false in case of failure

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

/media/reactivipdev/Nightly/IPSDK_Patch/IPSDK_4_1/IPSDK_Nightly/include/public/IPSDKImageProcessing/DataSplit/SubImage/BaseSubImageSplit.h

Public Types

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

template<typename InOutStorageType> class ipsdk::imaproc::BaseSubImageSplit< InOutStorageType >

Member Function Documentation

◆ getSubImageSplitType()

◆ getVolumeParsingType()

◆ getColorParsingType()

◆ getTemporalParsingType()

◆ getImage()

◆ initBase() [1/2]

◆ initBase() [2/2]

◆ getSubImage()

template<typename InOutStorageType>
class ipsdk::imaproc::BaseSubImageSplit< InOutStorageType >