Base class for custom image informations. More...

#include <BaseCustomImageInfo.h>

Inheritance diagram for ipsdk::imaproc::BaseCustomImageInfo:

Public Member Functions
bool	isInit () const
	check for object initialization

virtual bool	isOutputInitNeeded () const

virtual image::eImageBufferType	getImageBufferType () const =0
	retrieve image buffer type for output image initialization More...

virtual image::ImageBufferTypeVector	getImageBufferTypeVector () const
	retrieve image buffers type for output image initialization More...

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...

virtual bool	hasInputImage () const
	check whether custom image information has underlying input support image More...

virtual image::ImageConstPtr	getInputImage () const
	retrieve underlying input support image More...

Constructors and destructor
	BaseCustomImageInfo ()

virtual	~BaseCustomImageInfo ()=0


virtual ipUInt64	getSizeX () const =0
	retrieve used image plan size for output image initialization More...

virtual ipUInt64	getSizeY () const =0
	retrieve used image plan size for output image initialization More...


virtual image::VolumeGeometry	getVolumeGeometry () const =0
	retrieve used image volume geometry informations for output image initialization More...

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...


virtual image::ColorGeometry	getColorGeometry () const =0
	retrieve used image color 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...


virtual image::TemporalGeometry	getTemporalGeometry () const =0
	retrieve used image temporal 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 ()
	base class initialization

Protected Attributes
bool	_bInit
	object initialization flag

Detailed Description

Base class for custom image informations.

Author: E.Noirfalise

Date: 2016/06/13

Copyright: 2016 Reactiv'IP, all right reserved.

Member Function Documentation

◆ isOutputInitNeeded()

virtual bool ipsdk::imaproc::BaseCustomImageInfo::isOutputInitNeeded ( ) const

virtual

retrieve flag indicating whether output image needs initialization (can be useful in case of output optional images which may not be initialized in some processing cases)

◆ getImageBufferType()

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

pure virtual

retrieve image buffer type for output image initialization

Exceptions

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

Note: may return eImageBufferType::eIBT_None in case of heterogeneous geometry

Implemented in ipsdk::imaproc::BaseFromImageCustomImageInfo.

◆ getImageBufferTypeVector()

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

virtual

retrieve image buffers type for output image initialization

Exceptions

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

Reimplemented in ipsdk::imaproc::BaseFromImageCustomImageInfo.

◆ getSizeX()

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

pure virtual

retrieve used image plan size for output image initialization

Exceptions

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

Implemented in ipsdk::imaproc::BaseFromImageCustomImageInfo.

◆ getSizeY()

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

pure virtual

retrieve used image plan size for output image initialization

Exceptions

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

Implemented in ipsdk::imaproc::BaseFromImageCustomImageInfo.

◆ getVolumeGeometry()

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

pure virtual

retrieve used image volume geometry informations for output image initialization

Exceptions

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

Implemented in ipsdk::imaproc::BaseFromImageCustomImageInfo.

◆ getSizeZ()

ipUInt64 ipsdk::imaproc::BaseCustomImageInfo::getSizeZ ( ) const

retrieve used image volume geometry informations for output image initialization

Exceptions

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

◆ is2d()

bool ipsdk::imaproc::BaseCustomImageInfo::is2d ( ) const

retrieve used image volume geometry informations for output image initialization

Exceptions

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

◆ is3d()

bool ipsdk::imaproc::BaseCustomImageInfo::is3d ( ) const

retrieve used image volume geometry informations for output image initialization

Exceptions

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

◆ getColorGeometry()

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

pure virtual

retrieve used image color geometry informations for output image initialization

Exceptions

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

Implemented in ipsdk::imaproc::BaseFromImageCustomImageInfo.

◆ getSizeC()

ipUInt64 ipsdk::imaproc::BaseCustomImageInfo::getSizeC ( ) const

retrieve used image color geometry informations for output image initialization

Exceptions

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

◆ isGreyLevel()

bool ipsdk::imaproc::BaseCustomImageInfo::isGreyLevel ( ) const

retrieve used image color geometry informations for output image initialization

Exceptions

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

◆ isColor()

bool ipsdk::imaproc::BaseCustomImageInfo::isColor ( ) const

retrieve used image color geometry informations for output image initialization

Exceptions

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

◆ getTemporalGeometry()

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

pure virtual

retrieve used image temporal geometry informations for output image initialization

Exceptions

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

Implemented in ipsdk::imaproc::BaseFromImageCustomImageInfo.

◆ getSizeT()

ipUInt64 ipsdk::imaproc::BaseCustomImageInfo::getSizeT ( ) const

retrieve used image temporal geometry informations for output image initialization

Exceptions

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

◆ isSingleGeometry()

bool ipsdk::imaproc::BaseCustomImageInfo::isSingleGeometry ( ) const

retrieve used image temporal geometry informations for output image initialization

Exceptions

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

◆ isSequenceGeometry()

bool ipsdk::imaproc::BaseCustomImageInfo::isSequenceGeometry ( ) const

retrieve used image temporal geometry informations for output image initialization

Exceptions

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

◆ createOutputGeometry()

image::ImageGeometryPtr ipsdk::imaproc::BaseCustomImageInfo::createOutputGeometry ( ) const

function allowing to create a geometry for output image initialization

Exceptions

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

◆ getImageInitializerDistributionPolicy()

virtual eImageInitializerDistributionPolicy ipsdk::imaproc::BaseCustomImageInfo::getImageInitializerDistributionPolicy ( ) const

virtual

retrieve flag indicating whether distributed output image creation is allowed

Exceptions

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

◆ hasInputImage()

virtual bool ipsdk::imaproc::BaseCustomImageInfo::hasInputImage ( ) const

virtual

check whether custom image information has underlying input support image

Exceptions

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

Reimplemented in ipsdk::imaproc::BaseFromImageCustomImageInfo.

◆ getInputImage()

virtual image::ImageConstPtr ipsdk::imaproc::BaseCustomImageInfo::getInputImage ( ) const

virtual

retrieve underlying input support image

Exceptions

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

Reimplemented in ipsdk::imaproc::BaseFromImageCustomImageInfo.

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

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Member Function Documentation

◆ isOutputInitNeeded()

◆ getImageBufferType()

◆ getImageBufferTypeVector()

◆ getSizeX()

◆ getSizeY()

◆ getVolumeGeometry()

◆ getSizeZ()

◆ is2d()

◆ is3d()

◆ getColorGeometry()

◆ getSizeC()

◆ isGreyLevel()

◆ isColor()

◆ getTemporalGeometry()

◆ getSizeT()

◆ isSingleGeometry()

◆ isSequenceGeometry()

◆ createOutputGeometry()

◆ getImageInitializerDistributionPolicy()

◆ hasInputImage()

◆ getInputImage()