ipsdk::image::Border3dPolicy Class Reference

Class used to define policy for 3d strip borders management during a kernel algorithm processing. More...

#include <Border3dPolicy.h>

Inheritance diagram for ipsdk::image::Border3dPolicy:

Public Member Functions
bool	isInit () const
	check for object initialization
const eBorder3dType &	getBorder3dType () const
	retrieve 3d border type More...
void	clear ()
	clear objet data
Constructors and destructors
	Border3dPolicy ()
	~Border3dPolicy ()
Object initialization
void	initValued (const ipReal64 fillValue)
void	initValuedMax ()
void	initValuedMin ()
void	initContinue ()
	initialization for a continue border policy type
void	initMiror ()
	initialization for a miror border policy type
Object configuration
const eValuedBorder3dType &	getValuedBorderType () const
	retrieve border type More...
ipReal64	getFillValue () const
	retrieve fill value used for continue border policy More...
Public Member Functions inherited from ipsdk::BaseSerializationObject
	BaseSerializationObject ()
	Default constructor.
virtual	~BaseSerializationObject ()=0
	destructor
Public Member Functions inherited from ipsdk::BaseDynamicObject
virtual const std::string &	getClassName () const
	method allowing to retrieve object class name
virtual BaseDynamicObject *	createNew () const =0
	method allowing to create new instance of current object type
virtual DynamicObjectPtr	createShared () const =0
	method allowing to create new shared instance of current object type
virtual bool	hasCopySupport () const =0
	check whether objet has copy support
virtual BaseDynamicObject *	duplicate () const =0
	method allowing to duplicate current object More...
virtual DynamicObjectPtr	duplicateShared () const =0
	method allowing shared duplication of current object More...
	BaseDynamicObject ()
virtual	~BaseDynamicObject ()=0

Protected Attributes
eBorder3dType	_border3dType
	3d border type
eValuedBorder3dType	_valuedBorderType
	valued border used value type
ipReal64	_fillValue
	value used for continue border policy
bool	_bInit
	object initialization flag

Additional Inherited Members
Static Public Member Functions inherited from ipsdk::BaseSerializationObject
static ipUInt32	getVersion ()
	method allowing to retrieve class version information for serialization
Static Public Member Functions inherited from ipsdk::BaseDynamicObject
static const std::string &	getTypeName ()
	method allowing to retrieve name associated to class
Protected Member Functions inherited from ipsdk::BaseSerializationObject
virtual BoolResult	write (BaseOArchive &ar) const
	method allowing to ensure serialization write part for object
virtual BoolResult	read (BaseIArchive &ar)
	method allowing to ensure serialization read part for object
Protected Member Functions inherited from ipsdk::BaseDynamicObject
virtual void	initCtorCopy (const BaseDynamicObject &object)
virtual void	copy (const BaseDynamicObject &object)
	method allowing to copy data from another object

Detailed Description

Class used to define policy for 3d strip borders management during a kernel algorithm processing.

Author

E.Noirfalise

Date

2015/01/21

Copyright

2015 Reactiv'IP, all right reserved.

Member Function Documentation

getBorder3dType()

const eBorder3dType& ipsdk::image::Border3dPolicy::getBorder3dType

(

)

const

retrieve 3d border type

Exceptions

ipsdk::image::IPSDKImageException

if isInit() == false

initValued()

void ipsdk::image::Border3dPolicy::initValued

(

const ipReal64

fillValue

)

initialization for a valued border policy type using an input value

initValuedMax()

void ipsdk::image::Border3dPolicy::initValuedMax

(

)

initialization for a valued border policy type using a maximum value for a given image type

initValuedMin()

void ipsdk::image::Border3dPolicy::initValuedMin

(

)

initialization for a valued border policy type using a minimum value for a given image type

getValuedBorderType()

const eValuedBorder3dType& ipsdk::image::Border3dPolicy::getValuedBorderType

(

)

const

retrieve border type

Exceptions

ipsdk::image::IPSDKImageException

if getBorderType() != eBorder3dType::eB3DT_Valued

getFillValue()

ipReal64 ipsdk::image::Border3dPolicy::getFillValue

(

)

const

retrieve fill value used for continue border policy

Exceptions

ipsdk::image::IPSDKImageException

if getValuedBorderType() != eValuedBorder3dType::eVB3DT_Custom

---

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

• /media/reactivipdev/Nightly/IPSDK_Patch/IPSDK_4_1/IPSDK_Nightly/include/public/IPSDKImage/Fragment/BorderPolicy/3d/Border3dPolicy.h