ipsdk::imaproc::BaseCustomCheckedImageProperty Class Reference

Base class for custom checked image properties. More...

#include <BaseCustomCheckedImageProperty.h>

Inheritance diagram for ipsdk::imaproc::BaseCustomCheckedImageProperty:

Public Member Functions
bool	isInit () const
	check for object initialization
virtual bool	areChecksDisable () const
	method allowing to disable all checks on attributes (can be usefull in case of optional attributes left uninitialized) More...
bool	isChecked (const eCheckableImageProperty &checkableImageProperty) const
	check whether a given property should be checked More...
virtual ImageBufferTypeColl	getAllowedImageBufferTypes () const
	retrieve allowed image buffer types for check More...
Constructors and destructor
	BaseCustomCheckedImageProperty ()
virtual	~BaseCustomCheckedImageProperty ()=0
virtual ipUInt64	getSizeX () const
	retrieve used image plan size for check More...
virtual ipUInt64	getSizeY () const
	retrieve used image plan size for check More...
virtual image::VolumeGeometry	getVolumeGeometry () const
	retrieve used image volume geometry informations for check More...
ipUInt64	getSizeZ () const
	retrieve used image volume geometry informations for check More...
bool	is2d () const
	retrieve used image volume geometry informations for check More...
bool	is3d () const
	retrieve used image volume geometry informations for check More...
virtual image::ColorGeometry	getColorGeometry () const
	retrieve used image color geometry informations for check More...
ipUInt64	getSizeC () const
	retrieve used image color geometry informations for check More...
bool	isGreyLevel () const
	retrieve used image color geometry informations for check More...
bool	isColor () const
	retrieve used image color geometry informations for check More...
virtual image::TemporalGeometry	getTemporalGeometry () const
	retrieve used image temporal geometry informations for check More...
ipUInt64	getSizeT () const
	retrieve used image temporal geometry informations for check More...
bool	isSingleGeometry () const
	retrieve used image temporal geometry informations for check More...
bool	isSequenceGeometry () const
	retrieve used image temporal geometry informations for check More...

Protected Member Functions
void	initBase (const ImageAttributeConstWeakPtr &pInputAttribute=ImageAttributeConstWeakPtr())
	base class initialization More...
void	enableCheck (const eCheckableImageProperty &checkableImageProperty)
	method allowing to enable a property check in derived classes More...
bool	isInputImageSet () const
	check whether input image has been set More...
const image::BaseImage &	getInputImage () const
	retrieve image associated to input attribute More...

Detailed Description

Base class for custom checked image properties.

Author

E.Noirfalise

Date

2016/06/13

Copyright

2016 Reactiv'IP, all right reserved.

Member Function Documentation

areChecksDisable()

virtual bool ipsdk::imaproc::BaseCustomCheckedImageProperty::areChecksDisable ( ) const

virtual

method allowing to disable all checks on attributes (can be usefull in case of optional attributes left uninitialized)

Note

if this method returns true, nothing will be checked

Exceptions

ipsdk::processor::IPSDKBaseProcessingException

if isInit() == false

isChecked()

bool ipsdk::imaproc::BaseCustomCheckedImageProperty::isChecked

(

const eCheckableImageProperty &

checkableImageProperty

)

const

check whether a given property should be checked

Exceptions

ipsdk::processor::IPSDKBaseProcessingException

if isInit() == false

getAllowedImageBufferTypes()

virtual ImageBufferTypeColl ipsdk::imaproc::BaseCustomCheckedImageProperty::getAllowedImageBufferTypes ( ) const

virtual

retrieve allowed image buffer types for check

Exceptions

ipsdk::processor::IPSDKBaseProcessingException

if isInit() == 0

getSizeX()

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

virtual

retrieve used image plan size for check

Exceptions

ipsdk::processor::IPSDKBaseProcessingException

if isInit() == 0

getSizeY()

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

virtual

retrieve used image plan size for check

Exceptions

ipsdk::processor::IPSDKBaseProcessingException

if isInit() == 0

getVolumeGeometry()

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

virtual

retrieve used image volume geometry informations for check

Exceptions

ipsdk::processor::IPSDKBaseProcessingException

if isInit() == 0

getSizeZ()

ipUInt64 ipsdk::imaproc::BaseCustomCheckedImageProperty::getSizeZ

(

)

const

retrieve used image volume geometry informations for check

Exceptions

ipsdk::processor::IPSDKBaseProcessingException

if isInit() == 0

is2d()

bool ipsdk::imaproc::BaseCustomCheckedImageProperty::is2d

(

)

const

retrieve used image volume geometry informations for check

Exceptions

ipsdk::processor::IPSDKBaseProcessingException

if isInit() == 0

is3d()

bool ipsdk::imaproc::BaseCustomCheckedImageProperty::is3d

(

)

const

retrieve used image volume geometry informations for check

Exceptions

ipsdk::processor::IPSDKBaseProcessingException

if isInit() == 0

getColorGeometry()

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

virtual

retrieve used image color geometry informations for check

Exceptions

ipsdk::processor::IPSDKBaseProcessingException

if isInit() == 0

getSizeC()

ipUInt64 ipsdk::imaproc::BaseCustomCheckedImageProperty::getSizeC

(

)

const

retrieve used image color geometry informations for check

Exceptions

ipsdk::processor::IPSDKBaseProcessingException

if isInit() == 0

isGreyLevel()

bool ipsdk::imaproc::BaseCustomCheckedImageProperty::isGreyLevel

(

)

const

retrieve used image color geometry informations for check

Exceptions

ipsdk::processor::IPSDKBaseProcessingException

if isInit() == 0

isColor()

bool ipsdk::imaproc::BaseCustomCheckedImageProperty::isColor

(

)

const

retrieve used image color geometry informations for check

Exceptions

ipsdk::processor::IPSDKBaseProcessingException

if isInit() == 0

getTemporalGeometry()

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

virtual

retrieve used image temporal geometry informations for check

Exceptions

ipsdk::processor::IPSDKBaseProcessingException

if isInit() == 0

getSizeT()

ipUInt64 ipsdk::imaproc::BaseCustomCheckedImageProperty::getSizeT

(

)

const

retrieve used image temporal geometry informations for check

Exceptions

ipsdk::processor::IPSDKBaseProcessingException

if isInit() == 0

isSingleGeometry()

bool ipsdk::imaproc::BaseCustomCheckedImageProperty::isSingleGeometry

(

)

const

retrieve used image temporal geometry informations for check

Exceptions

ipsdk::processor::IPSDKBaseProcessingException

if isInit() == 0

isSequenceGeometry()

bool ipsdk::imaproc::BaseCustomCheckedImageProperty::isSequenceGeometry

(

)

const

retrieve used image temporal geometry informations for check

Exceptions

ipsdk::processor::IPSDKBaseProcessingException

if isInit() == 0

initBase()

void ipsdk::imaproc::BaseCustomCheckedImageProperty::initBase ( const ImageAttributeConstWeakPtr &  pInputAttribute = ImageAttributeConstWeakPtr() )

protected

base class initialization

Warning

in some case input attribute may not be set

enableCheck()

void ipsdk::imaproc::BaseCustomCheckedImageProperty::enableCheck ( const eCheckableImageProperty &  checkableImageProperty )

protected

method allowing to enable a property check in derived classes

Exceptions

ipsdk::processor::IPSDKBaseProcessingException

if isInit() == false

isInputImageSet()

bool ipsdk::imaproc::BaseCustomCheckedImageProperty::isInputImageSet ( ) const

protected

check whether input image has been set

Exceptions

ipsdk::processor::IPSDKBaseProcessingException

if isInit() == false

getInputImage()

const image::BaseImage& ipsdk::imaproc::BaseCustomCheckedImageProperty::getInputImage ( ) const

protected

retrieve image associated to input attribute

Exceptions

ipsdk::processor::IPSDKBaseProcessingException

if isInputImageSet() == false

---

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

• /media/reactivipdev/Nightly/IPSDK_Patch/IPSDK_4_1/IPSDK_Nightly/include/public/IPSDKImageProcessing/Rule/Image/ImageProperty/CustomCheckedImageProperty/BaseCustomCheckedImageProperty.h