ipsdk::imaproc::BaseFromImageCustomImageInfo Class Reference

Base class for custom image informations constructed from an other image. More...

#include <BaseFromImageCustomImageInfo.h>

Inheritance diagram for ipsdk::imaproc::BaseFromImageCustomImageInfo:

Public Member Functions
virtual image::eImageBufferType	getImageBufferType () const
	retrieve image buffer type for output image initialization More...
virtual image::ImageBufferTypeVector	getImageBufferTypeVector () const
	retrieve image buffers type for output image initialization More...
virtual image::VolumeGeometry	getVolumeGeometry () const
	retrieve used image volume geometry informations for output image initialization More...
virtual image::ColorGeometry	getColorGeometry () const
	retrieve used image color geometry informations for output image initialization More...
virtual image::TemporalGeometry	getTemporalGeometry () const
	retrieve used image temporal geometry informations for output image initialization More...
bool	hasInputImage () const
	check whether custom image information has underlying input support image More...
image::ImageConstPtr	getInputImage () const
	retrieve image associated to input attribute More...
Constructors and destructor
	BaseFromImageCustomImageInfo ()
virtual	~BaseFromImageCustomImageInfo ()=0
virtual ipUInt64	getSizeX () const
	retrieve used image plan size for output image initialization More...
virtual ipUInt64	getSizeY () const
	retrieve used image plan size for output image initialization More...
Public Member Functions inherited from ipsdk::imaproc::BaseCustomImageInfo
bool	isInit () const
	check for object initialization
virtual bool	isOutputInitNeeded () const
image::ImageGeometryPtr	createOutputGeometry () const
	function allowing to create a geometry for output image initialization More...
virtual eImageInitializerDistributionPolicy	getImageInitializerDistributionPolicy () const
	retrieve flag indicating whether distributed output image creation is allowed More...
	BaseCustomImageInfo ()
virtual	~BaseCustomImageInfo ()=0
ipUInt64	getSizeZ () const
	retrieve used image volume geometry informations for output image initialization More...
bool	is2d () const
	retrieve used image volume geometry informations for output image initialization More...
bool	is3d () const
	retrieve used image volume geometry informations for output image initialization More...
ipUInt64	getSizeC () const
	retrieve used image color geometry informations for output image initialization More...
bool	isGreyLevel () const
	retrieve used image color geometry informations for output image initialization More...
bool	isColor () const
	retrieve used image color geometry informations for output image initialization More...
ipUInt64	getSizeT () const
	retrieve used image temporal geometry informations for output image initialization More...
bool	isSingleGeometry () const
	retrieve used image temporal geometry informations for output image initialization More...
bool	isSequenceGeometry () const
	retrieve used image temporal geometry informations for output image initialization More...

Protected Member Functions
void	initBase (const ImageAttributeConstWeakPtr &pInputAttribute)
	base class initialization More...
Protected Member Functions inherited from ipsdk::imaproc::BaseCustomImageInfo
void	initBase ()
	base class initialization

Protected Attributes
ImageAttributeConstWeakPtr	_pInputAttribute
	weak pointer to input image attribute
Protected Attributes inherited from ipsdk::imaproc::BaseCustomImageInfo
bool	_bInit
	object initialization flag

Detailed Description

Base class for custom image informations constructed from an other image.

Author

E.Noirfalise

Date

2016/09/05

Copyright

2016 Reactiv'IP, all right reserved.

Member Function Documentation

getImageBufferType()

virtual image::eImageBufferType ipsdk::imaproc::BaseFromImageCustomImageInfo::getImageBufferType ( ) const

virtual

retrieve image buffer type for output image initialization

Exceptions

ipsdk::processor::IPSDKBaseProcessingException

if isInit() == 0

Note

may return eImageBufferType::eIBT_None in case of heterogeneous geometry

Implements ipsdk::imaproc::BaseCustomImageInfo.

getImageBufferTypeVector()

virtual image::ImageBufferTypeVector ipsdk::imaproc::BaseFromImageCustomImageInfo::getImageBufferTypeVector ( ) const

virtual

retrieve image buffers type for output image initialization

Exceptions

ipsdk::processor::IPSDKBaseProcessingException

if isInit() == 0

Reimplemented from ipsdk::imaproc::BaseCustomImageInfo.

getSizeX()

virtual ipUInt64 ipsdk::imaproc::BaseFromImageCustomImageInfo::getSizeX ( ) const

virtual

retrieve used image plan size for output image initialization

Exceptions

ipsdk::processor::IPSDKBaseProcessingException

if isInit() == 0

Implements ipsdk::imaproc::BaseCustomImageInfo.

getSizeY()

virtual ipUInt64 ipsdk::imaproc::BaseFromImageCustomImageInfo::getSizeY ( ) const

virtual

retrieve used image plan size for output image initialization

Exceptions

ipsdk::processor::IPSDKBaseProcessingException

if isInit() == 0

Implements ipsdk::imaproc::BaseCustomImageInfo.

getVolumeGeometry()

virtual image::VolumeGeometry ipsdk::imaproc::BaseFromImageCustomImageInfo::getVolumeGeometry ( ) const

virtual

retrieve used image volume geometry informations for output image initialization

Exceptions

ipsdk::processor::IPSDKBaseProcessingException

if isInit() == 0

Implements ipsdk::imaproc::BaseCustomImageInfo.

getColorGeometry()

virtual image::ColorGeometry ipsdk::imaproc::BaseFromImageCustomImageInfo::getColorGeometry ( ) const

virtual

retrieve used image color geometry informations for output image initialization

Exceptions

ipsdk::processor::IPSDKBaseProcessingException

if isInit() == 0

Implements ipsdk::imaproc::BaseCustomImageInfo.

getTemporalGeometry()

virtual image::TemporalGeometry ipsdk::imaproc::BaseFromImageCustomImageInfo::getTemporalGeometry ( ) const

virtual

retrieve used image temporal geometry informations for output image initialization

Exceptions

ipsdk::processor::IPSDKBaseProcessingException

if isInit() == 0

Implements ipsdk::imaproc::BaseCustomImageInfo.

hasInputImage()

bool ipsdk::imaproc::BaseFromImageCustomImageInfo::hasInputImage ( ) const

virtual

check whether custom image information has underlying input support image

Exceptions

ipsdk::processor::IPSDKBaseProcessingException

if isInit() == false

Reimplemented from ipsdk::imaproc::BaseCustomImageInfo.

getInputImage()

image::ImageConstPtr ipsdk::imaproc::BaseFromImageCustomImageInfo::getInputImage ( ) const

virtual

retrieve image associated to input attribute

Exceptions

ipsdk::processor::IPSDKBaseProcessingException

if isInit() == false

Reimplemented from ipsdk::imaproc::BaseCustomImageInfo.

initBase()

void ipsdk::imaproc::BaseFromImageCustomImageInfo::initBase ( const ImageAttributeConstWeakPtr &  pInputAttribute )

protected

base class initialization

Exceptions

ipsdk::processor::IPSDKBaseProcessingException

if pInputAttribute.lock() == 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/OutputInitializer/Image/CustomInitializer/BaseFromImageCustomImageInfo.h