ipsdk::imaproc::TypedDuplicateImageInitializer< InputAttributeType, OutputAttributeType > Class Template Reference

Class allowing to initialize an output image from an other image and from a given image buffer type attribute. More...

#include <TypedDuplicateImageInitializer.h>

Inheritance diagram for ipsdk::imaproc::TypedDuplicateImageInitializer< InputAttributeType, OutputAttributeType >:

Public Member Functions
eImageInitializerType	getImageInitializerType () const
	retrieve image initializer type
void	init (const boost::weak_ptr< OutputAttributeType > &pOutputAttribute, const boost::weak_ptr< const InputAttributeType > &pInputAttribute, const IBTAttributeConstWeakPtr &pIBTAttribute, const boost::optional< ipUInt64 > &sizeX=boost::optional< ipUInt64 >(), const boost::optional< ipUInt64 > &sizeY=boost::optional< ipUInt64 >(), const image::VolumeGeometry &volumeGeometry=image::VolumeGeometry(), const image::ColorGeometry &colorGeometry=image::ColorGeometry(), const image::TemporalGeometry &temporalGeometry=image::TemporalGeometry())
	initialize object More...
const BaseImageBufferTypeAttribute &	getIBTAttribute () const
	retrieve custom image buffer type attribute associated to object More...
Constructors and destructors
	TypedDuplicateImageInitializer ()
	~TypedDuplicateImageInitializer ()
void	init (const boost::weak_ptr< OutputAttributeType > &pOutputAttribute, const boost::weak_ptr< const InputAttributeType > &pInputAttribute, const IBTAttributeConstWeakPtr &pIBTAttribute, const eImageInitializerStoragePolicy &storagePolicy=eImageInitializerStoragePolicy::eIISP_Inherit, const boost::optional< ipUInt64 > &sizeX=boost::optional< ipUInt64 >(), const boost::optional< ipUInt64 > &sizeY=boost::optional< ipUInt64 >(), const image::VolumeGeometry &volumeGeometry=image::VolumeGeometry(), const image::ColorGeometry &colorGeometry=image::ColorGeometry(), const image::TemporalGeometry &temporalGeometry=image::TemporalGeometry())
	initialize object with a specified storage type More...
Public Member Functions inherited from ipsdk::imaproc::BaseImageUnaryInitializer< InputAttributeType, OutputAttributeType >
const InputAttributeType &	getInputImageAttribute () const
	retrieve input image attribute associated to object More...
	BaseImageUnaryInitializer ()
virtual	~BaseImageUnaryInitializer ()=0
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_TypedDuplicate
	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::imaproc::BaseImageUnaryInitializer< InputAttributeType, OutputAttributeType >
void	initBase (const boost::weak_ptr< OutputAttributeType > &pOutputAttribute, const boost::weak_ptr< const InputAttributeType > &pInputAttribute)
	base class initialization method More...
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
IBTAttributeConstWeakPtr	_pIBTAttribute
boost::optional< ipUInt64 >	_pOptionalSizeX
	Optional x size for generated image.
boost::optional< ipUInt64 >	_pOptionalSizeY
	Optional y size for generated image.
image::VolumeGeometry	_optionalVolumeGeometry
	optional volume geometry for generated image
image::ColorGeometry	_optionalColorGeometry
	optional color geometry for generated image
image::TemporalGeometry	_optionalTemporalGeometry
	optional temporal geometry for generated image
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 InputAttributeType, typename OutputAttributeType>
class ipsdk::imaproc::TypedDuplicateImageInitializer< InputAttributeType, OutputAttributeType >

Class allowing to initialize an output image from an other image and from a given image buffer type attribute.

Author

E. Noirfalise

Date

2014/06/24

Copyright

2014 Reactiv'IP, all right reserved.

Member Function Documentation

init() [1/2]

template<typename InputAttributeType , typename OutputAttributeType >

void ipsdk::imaproc::TypedDuplicateImageInitializer< InputAttributeType, OutputAttributeType >::init	(	const boost::weak_ptr< OutputAttributeType > &	pOutputAttribute,
		const boost::weak_ptr< const InputAttributeType > &	pInputAttribute,
		const IBTAttributeConstWeakPtr &	pIBTAttribute,
		const boost::optional< ipUInt64 > &	sizeX = boost::optional< ipUInt64 >(),
		const boost::optional< ipUInt64 > &	sizeY = boost::optional< ipUInt64 >(),
		const image::VolumeGeometry &	volumeGeometry = image::VolumeGeometry(),
		const image::ColorGeometry &	colorGeometry = image::ColorGeometry(),
		const image::TemporalGeometry &	temporalGeometry = image::TemporalGeometry()
	)

initialize object

Exceptions

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

init() [2/2]

template<typename InputAttributeType , typename OutputAttributeType >

void ipsdk::imaproc::TypedDuplicateImageInitializer< InputAttributeType, OutputAttributeType >::init	(	const boost::weak_ptr< OutputAttributeType > &	pOutputAttribute,
		const boost::weak_ptr< const InputAttributeType > &	pInputAttribute,
		const IBTAttributeConstWeakPtr &	pIBTAttribute,
		const eImageInitializerStoragePolicy &	storagePolicy = eImageInitializerStoragePolicy::eIISP_Inherit,
		const boost::optional< ipUInt64 > &	sizeX = boost::optional< ipUInt64 >(),
		const boost::optional< ipUInt64 > &	sizeY = boost::optional< ipUInt64 >(),
		const image::VolumeGeometry &	volumeGeometry = image::VolumeGeometry(),
		const image::ColorGeometry &	colorGeometry = image::ColorGeometry(),
		const image::TemporalGeometry &	temporalGeometry = image::TemporalGeometry()
	)

initialize object with a specified storage type

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 pInputAttribute.get() == 0

getIBTAttribute()

template<typename InputAttributeType , typename OutputAttributeType >

const BaseImageBufferTypeAttribute& ipsdk::imaproc::TypedDuplicateImageInitializer< InputAttributeType, OutputAttributeType >::getIBTAttribute

(

)

const

retrieve custom image buffer type attribute associated to object

Exceptions

ipsdk::processor::IPSDKBaseProcessingException

if isInit() == false

Warning

attribute may be uninitialized

initAttribute()

template<typename InputAttributeType , typename OutputAttributeType >

BoolResult ipsdk::imaproc::TypedDuplicateImageInitializer< InputAttributeType, OutputAttributeType >::initAttribute ( )

protectedvirtual

initialize ouput attribute

Returns

false in case of failure

Implements ipsdk::processor::BaseOutputInitializer.

Member Data Documentation

_pIBTAttribute

template<typename InputAttributeType , typename OutputAttributeType >

IBTAttributeConstWeakPtr ipsdk::imaproc::TypedDuplicateImageInitializer< InputAttributeType, OutputAttributeType >::_pIBTAttribute

protected

pointer to optionnaly used image buffer type attribute to initialize output image

---

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/TypedDuplicateImageInitializer.h