ipsdk::imaproc::CustomImageInitializer< OutputAttributeType > Class Template Reference

Class allowing to initialize an output image from an object allowing to define output image properties. More...

#include <CustomImageInitializer.h>

Inheritance diagram for ipsdk::imaproc::CustomImageInitializer< OutputAttributeType >:

Public Member Functions
eImageInitializerType	getImageInitializerType () const
	retrieve image initializer type
Constructors and destructor
	CustomImageInitializer ()
	~CustomImageInitializer ()
void	init (const ImageAttributeWeakPtr &pOutputAttribute, const CustomImageInfoPtr &pCustomImageInfo, const eImageInitializerStoragePolicy &storagePolicy)
	initialize object More...
void	init (const ImageAttributeWeakPtr &pOutputAttribute, const CustomImageInfoPtr &pCustomImageInfo)
	initialize object More...
Public Member Functions inherited from ipsdk::imaproc::BaseImageInitializer
eImageProcessingInitializerType	getImageProcessingInitializerType () const
	retrieve image processing initializer type
	BaseImageInitializer ()
virtual	~BaseImageInitializer ()=0
Public Member Functions inherited from ipsdk::imaproc::BaseImageProcessingOutputInitializer
processor::eOutputInitializerType	getOutputInitializerType () const
	retrieve initializer type
	BaseImageProcessingOutputInitializer ()
	~BaseImageProcessingOutputInitializer ()
Public Member Functions inherited from ipsdk::processor::BaseOutputInitializer
bool	isInit () const
	retrieve object initialization flag
const BaseAttribute &	getOutputAttribute () const
	retrieve output attribute to be initialized More...
BoolResult	initOutputAttribute ()
	initialize ouput attribute More...
std::string	getInitializerFormalString () const
	retrieve string expliciting initializer content More...
std::string	getInitializerEvaluatedString () const
	retrieve initializer evaluation string More...
	BaseOutputInitializer ()
virtual	~BaseOutputInitializer ()=0

Static Public Attributes
static const eImageInitializerType::domain	g_imageInitializerType = eImageInitializerType::eIIT_CustomInitialize
	image output initializer type
Static Public Attributes inherited from ipsdk::imaproc::BaseImageInitializer
static const eImageProcessingInitializerType::domain	g_imageProcessingInitializerType = eImageProcessingInitializerType::eIPIT_Image
	image processing output initializer type
Static Public Attributes inherited from ipsdk::imaproc::BaseImageProcessingOutputInitializer
static const processor::eOutputInitializerType::domain	g_outputInitializerType = processor::eOutputInitializerType::eOIT_ImageProcessing
	output initializer type

Protected Member Functions
BoolResult	initAttribute ()
	initialize ouput attribute More...
std::string	createInitializerFormalString () const
	retrieve string expliciting initializer content
std::string	createInitializerEvaluatedString () const
	retrieve initializer evaluation string
Protected Member Functions inherited from ipsdk::processor::BaseOutputInitializer
void	initBase (const AttributeWeakPtr &pOutputAttribute)
	base class initialization method More...
BaseAttribute &	getOutputAttribute ()
	retrieve output attribute to be initialized More...

Protected Attributes
CustomImageInfoPtr	_pCustomImageInfo
	object allowing to define image initialization rules
eImageInitializerStoragePolicy	_imageInitializerStoragePolicy
	flag indicating whether the output image is a memory, a disk image or if the output is inherited from the input image

Detailed Description

template<typename OutputAttributeType>
class ipsdk::imaproc::CustomImageInitializer< OutputAttributeType >

Class allowing to initialize an output image from an object allowing to define output image properties.

Author

E. Noirfalise

Date

2016/04/22

Copyright

2016 Reactiv'IP, all right reserved.

Member Function Documentation

init() [1/2]

template<typename OutputAttributeType >

void ipsdk::imaproc::CustomImageInitializer< OutputAttributeType >::init	(	const ImageAttributeWeakPtr &	pOutputAttribute,
		const CustomImageInfoPtr &	pCustomImageInfo,
		const eImageInitializerStoragePolicy &	storagePolicy
	)

initialize object

if no image buffer type is provided type, initialization is processed with other image buffer type. (case where imageBufferType == eImageBufferType::eIBT_None)

Exceptions

ipsdk::processor::IPSDKBaseProcessingException	if pOutputAttribute.get() == 0
ipsdk::processor::IPSDKBaseProcessingException	if pOutputAttribute->getIOStatus() != eAttributeIO::eIOS_Output
ipsdk::processor::IPSDKBaseProcessingException	if pCustomImageInfo.get() == 0

init() [2/2]

template<typename OutputAttributeType >

void ipsdk::imaproc::CustomImageInitializer< OutputAttributeType >::init	(	const ImageAttributeWeakPtr &	pOutputAttribute,
		const CustomImageInfoPtr &	pCustomImageInfo
	)

initialize object

if no image buffer type is provided type, initialization is processed with other image buffer type. (case where imageBufferType == eImageBufferType::eIBT_None)

Exceptions

ipsdk::processor::IPSDKBaseProcessingException	if pOutputAttribute.get() == 0
ipsdk::processor::IPSDKBaseProcessingException	if pOutputAttribute->getIOStatus() != eAttributeIO::eIOS_Output
ipsdk::processor::IPSDKBaseProcessingException	if pCustomImageInfo.get() == 0

initAttribute()

template<typename OutputAttributeType >

BoolResult ipsdk::imaproc::CustomImageInitializer< OutputAttributeType >::initAttribute ( )

protectedvirtual

initialize ouput attribute

Returns

false in case of failure

Implements ipsdk::processor::BaseOutputInitializer.

---

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

• /media/reactivipdev/Nightly/IPSDK_Patch/IPSDK_4_1/IPSDK_Nightly/include/public/IPSDKImageProcessing/OutputInitializer/Image/CustomInitializer/CustomImageInitializer.h