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

#include <KernelXYZ.h>

Inheritance diagram for ipsdk::KernelXYZ:

Public Types
typedef OffsetXYZ	OffsetType
	offset type associated to object

typedef ipReal32	ValueType
	value type associated to object

typedef std::map< OffsetType, ValueType >	DataColl
	collection of offsets associated to values

Public Member Functions
eKernelType	getKernelType () const
	retrieve kernel type associated to object

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

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

void	insert (const OffsetType &offset, const ValueType &value)
	insert a value into collection More...

void	replace (const OffsetType &offset, const ValueType &value)
	replace an existing value into collection More...

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

void	multiply (const ValueType value)
	multiply all values by a constant value

ValueType	getValue (const OffsetType &offset) const
	retrieve value associated to a given offset More...

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

const ValueType	getCoefSum () const
	retrieve sum of coefficients associated to kernel

const ValueType	getCoefAbsSum () const
	retrieve sum of absolute values of coefficients associated to kernel

Constructors and destructors
	KernelXYZ ()

	~KernelXYZ ()


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::BaseKernel
	BaseKernel ()

virtual	~BaseKernel ()=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 Member Functions
const ValueType	computeAbsCoefSum ()

void	clear ()
	clear of object data

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

Protected Attributes
DataColl	_dataColl
	collection of data associated to kernel

ValueType	_coefSum
	sum of kernel coefficients and absolute values of kernel coefficients

ValueType	_absCoefSum


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

Detailed Description

Class encapsulating a 3d kernel spanning along x, y and z axis.

Author: E. Noirfalise

Date: 2014/07/08

Copyright: 2014 Reactiv'IP, all right reserved.

Member Function Documentation

◆ insert()

void ipsdk::KernelXYZ::insert	(	const OffsetType &	offset,
		const ValueType &	value
	)

insert a value into collection

Exceptions

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

◆ replace()

void ipsdk::KernelXYZ::replace	(	const OffsetType &	offset,
		const ValueType &	value
	)

replace an existing value into collection

Exceptions

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

◆ remove()

void ipsdk::KernelXYZ::remove ( const OffsetType & offset )

remove an existing value from collection

Exceptions

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

◆ getValue()

ValueType ipsdk::KernelXYZ::getValue ( const OffsetType & offset ) const

retrieve value associated to a given offset

Exceptions

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

Member Data Documentation

◆ _minX

ipInt32 ipsdk::KernelXYZ::_minX

protected

minimum offsets along x and y axis

◆ _minY

ipInt32 ipsdk::KernelXYZ::_minY

protected

minimum offsets along x and y axis

◆ _minZ

ipInt32 ipsdk::KernelXYZ::_minZ

protected

minimum offsets along x and y axis

◆ _sizeX

ipUInt32 ipsdk::KernelXYZ::_sizeX

protected

kernel size along x and y axis

◆ _sizeY

ipUInt32 ipsdk::KernelXYZ::_sizeY

protected

kernel size along x and y axis

◆ _sizeZ

ipUInt32 ipsdk::KernelXYZ::_sizeZ

protected

kernel size along x and y 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/Kernel/KernelXYZ.h

Public Types

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ insert()

◆ replace()

◆ remove()

◆ getValue()

Member Data Documentation

◆ _minX

◆ _minY

◆ _minZ

◆ _sizeX

◆ _sizeY

◆ _sizeZ