Class encapsulating a 3d structuring element spanning along x, y and z axis. More...

#include <StructuringElementXYZ.h>

Inheritance diagram for ipsdk::StructuringElementXYZ:

Public Member Functions
eStructuringElementType	getStructuringElementType () const
	retrieve structuring element type associated to object

ipUInt32	getNbData () const
	retrieve number of data associated to object

bool	exists (const OffsetXYZ &offset) const
	check whether a given offset exists into collection

void	insert (const OffsetXYZ &offset)
	insert an offset into collection More...

void	remove (const OffsetXYZ &offset)
	remove an existing offset from collection More...

const XYZOffsetColl &	getDataColl () const
	retrieve data collection associated to object

void	setDataColl (const XYZOffsetColl &dataColl)
	set data collection associated to object

void	clear ()
	remove all data form structuring element

Constructors and destructors
	StructuringElementXYZ ()

	~StructuringElementXYZ ()


const ipUInt32	getSizeX () const
	retrieve kernel size along x, y and z axis

const ipUInt32	getSizeY () const
	retrieve kernel size along x, y and z axis

const ipUInt32	getSizeZ () const
	retrieve kernel size along x, y and z axis


const ipInt32	getMinX () const
	retrieve kernel minimum offsets along x, y and z axis

const ipInt32	getMinY () const
	retrieve kernel minimum offsets along x, y and z axis

const ipInt32	getMinZ () const
	retrieve kernel minimum offsets along x, y and z axis


const ipInt32	getMaxX () const
	retrieve kernel maximum offsets along x, y and z axis

const ipInt32	getMaxY () const
	retrieve kernel maximum offsets along x, y and z axis

const ipInt32	getMaxZ () const
	retrieve kernel maximum offsets along x, y and z axis


const ipUInt32	getStartingSizeX () const
	retrieve starting size for kernel along x, y and z axis (absolute value of lower negative offset or 0)

const ipUInt32	getStartingSizeY () const
	retrieve starting size for kernel along x, y and z axis (absolute value of lower negative offset or 0)

const ipUInt32	getStartingSizeZ () const
	retrieve starting size for kernel along x, y and z axis (absolute value of lower negative offset or 0)


const ipUInt32	getEndingSizeX () const
	retrieve ending size for kernel along x, y and z axis (upper positive offset or 0)

const ipUInt32	getEndingSizeY () const
	retrieve ending size for kernel along x, y and z axis (upper positive offset or 0)

const ipUInt32	getEndingSizeZ () const
	retrieve ending size for kernel along x, y and z axis (upper positive offset or 0)

Public Member Functions inherited from ipsdk::BaseStructuringElement
	BaseStructuringElement ()

virtual	~BaseStructuringElement ()=0

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
XYZOffsetColl	_dataColl
	collection of data associated to kernel


ipInt32	_minX

ipInt32	_minY

ipInt32	_minZ


ipUInt32	_sizeX

ipUInt32	_sizeY

ipUInt32	_sizeZ

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 encapsulating a 3d structuring element spanning along x, y and z axis.

Author: E. Noirfalise

Date: 2014/09/19

Copyright: 2014 Reactiv'IP, all right reserved.

Member Function Documentation

◆ insert()

void ipsdk::StructuringElementXYZ::insert ( const OffsetXYZ & offset )

insert an offset into collection

Exceptions

ipsdk::IPSDKBaseDataException if exists(offset) == true

◆ remove()

void ipsdk::StructuringElementXYZ::remove ( const OffsetXYZ & offset )

remove an existing offset from collection

Exceptions

ipsdk::IPSDKBaseDataException if exists(offset) == false

Member Data Documentation

◆ _minX

ipInt32 ipsdk::StructuringElementXYZ::_minX

protected

minimum offsets along x, y and z axis

◆ _minY

ipInt32 ipsdk::StructuringElementXYZ::_minY

protected

minimum offsets along x, y and z axis

◆ _minZ

ipInt32 ipsdk::StructuringElementXYZ::_minZ

protected

minimum offsets along x, y and z axis

◆ _sizeX

ipUInt32 ipsdk::StructuringElementXYZ::_sizeX

protected

kernel size along x, y and z axis

◆ _sizeY

ipUInt32 ipsdk::StructuringElementXYZ::_sizeY

protected

kernel size along x, y and z axis

◆ _sizeZ

ipUInt32 ipsdk::StructuringElementXYZ::_sizeZ

protected

kernel size along x, y and z axis

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

/media/reactivipdev/Nightly/IPSDK_Patch/IPSDK_4_1/IPSDK_Nightly/include/public/IPSDKBaseData/Pattern/StructuringElement/StructuringElementXYZ.h

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ insert()

◆ remove()

Member Data Documentation

◆ _minX

◆ _minY

◆ _minZ

◆ _sizeX

◆ _sizeY

◆ _sizeZ