Interface for 2D-convolution filter kernel. More...

#include <IConvolutionKernel2d.h>

Inheritance diagram for iipr::IConvolutionKernel2d:

Collaboration diagram for iipr::IConvolutionKernel2d:

Public Types
enum	SeparationType { ST_AUTO , ST_HOR_VERT }

Public Types inherited from istd::IChangeable
enum	ChangeFlags { CF_ICF_INTERNAL = 0 , CF_ALL_DATA , CF_ANY , CF_DESTROYING , CF_DELEGATED , CF_NO_UNDO }
	Data model change notification flags. More...

enum	SupportedOperations { SO_NONE = 0 , SO_OBSERVE = 1 << 0 , SO_COPY = 1 << 1 , SO_CLONE = 1 << 2 , SO_COMPARE = 1 << 3 , SO_RESET = 1 << 4 , SO_CHANGE_LOCK = 1 << 5 }
	Flags for supported operations. More...

enum	CompatibilityMode { CM_STRICT , CM_WITHOUT_REFS , CM_WITH_REFS , CM_CONVERT }
	Control how relationship betweeen objects are interpreted. More...

Public Member Functions
virtual istd::CIndex2d	GetKernelSize () const =0
	Get size of this kernel.

virtual void	SetKernelSize (const istd::CIndex2d &kernelSize, double value=0.0)=0
	Set size of this kernel.

virtual double	GetKernelElement (const istd::CIndex2d &index) const =0
	Get kernel element value at the given position `index`.

virtual bool	SetKernelElement (const istd::CIndex2d &index, double value)=0
	Set kernel element value at the given position `index`.

virtual double	GetOffsetValue () const =0
	Get offset value will be added to convolution result.

virtual bool	SetOffsetValue (double offset)=0
	Set offset value will be added to convolution result.

virtual bool	GetCombinedKernel (const IConvolutionKernel2d &kernel, IConvolutionKernel2d &result) const =0
	Get some kernel beeing combination of this and some other kernel.

virtual bool	TrySeparateKernels (IConvolutionKernel2d &result1, IConvolutionKernel2d &result2, int separationType=ST_AUTO, double tolerance=I_BIG_EPSILON) const =0
	Try separate this kernel into two separated kernels.

Public Member Functions inherited from iser::ISerializable
virtual bool	Serialize (IArchive &archive)=0
	Load or store state of this object as a archive stream.

virtual quint32	GetMinimalVersion (int versionId) const
	Get minimal needed version to correct storing of this data.

Public Member Functions inherited from istd::IChangeable
virtual int	GetSupportedOperations () const
	Get set of flags for supported operations.

virtual bool	CopyFrom (const IChangeable &object, CompatibilityMode mode=CM_WITHOUT_REFS)
	Copy this object from another one.

virtual bool	IsEqual (const IChangeable &object) const
	Compare this object with another object.

virtual std::unique_ptr< IChangeable >	CloneMe (CompatibilityMode mode=CM_WITHOUT_REFS) const
	Make a copy of this object.

virtual bool	ResetData (CompatibilityMode mode=CM_WITHOUT_REFS)
	Reset data to its default state.

virtual QMutex *	GetChangesLock () const
	Get mutex beeing locked during changes, if available.

virtual void	BeginChanges (const ChangeSet &changeSet)
	Starts the change transaction.

virtual void	EndChanges (const ChangeSet &changeSet)
	Ends the change transaction.

virtual void	BeginChangeGroup (const ChangeSet &changeSet)
	Starts group of changes.

virtual void	EndChangeGroup (const ChangeSet &changeSet)
	Ends group of changes.

Additional Inherited Members
Static Public Member Functions inherited from istd::IChangeable
static const ChangeSet &	GetNoChanges ()
	Get empty set of changes.

static const ChangeSet &	GetAnyChange ()
	Get anonymous change set.

static const ChangeSet &	GetAllChanges ()
	Get anonymous change set.

static const ChangeSet &	GetDelegatedChanges ()
	Get delegated change set.

Protected Member Functions inherited from istd::IChangeable
virtual void	OnBeginChanges ()
	Callback function for begin change event.

virtual void	OnEndChanges (const ChangeSet &changeSet)
	Callback function for end change event.

Detailed Description

Interface for 2D-convolution filter kernel.

Definition at line 23 of file IConvolutionKernel2d.h.

Member Enumeration Documentation

◆ SeparationType

enum iipr::IConvolutionKernel2d::SeparationType

Enumerator
ST_AUTO
ST_HOR_VERT	Separation to horizontal and vertical kernels.

Definition at line 26 of file IConvolutionKernel2d.h.

Member Function Documentation

◆ GetCombinedKernel()

virtual bool iipr::IConvolutionKernel2d::GetCombinedKernel	(	const IConvolutionKernel2d &	kernel,
		IConvolutionKernel2d &	result ) const

pure virtual

Get some kernel beeing combination of this and some other kernel.

Implemented in iipr::CConvolutionKernel2d.

◆ GetKernelElement()

virtual double iipr::IConvolutionKernel2d::GetKernelElement ( const istd::CIndex2d & index ) const

pure virtual

Get kernel element value at the given position index.

Implemented in iipr::CConvolutionKernel2d.

◆ GetKernelSize()

virtual istd::CIndex2d iipr::IConvolutionKernel2d::GetKernelSize ( ) const

pure virtual

Get size of this kernel.

Implemented in iipr::CConvolutionKernel2d.

◆ GetOffsetValue()

virtual double iipr::IConvolutionKernel2d::GetOffsetValue ( ) const

pure virtual

Get offset value will be added to convolution result.

Implemented in iipr::CConvolutionKernel2d.

◆ SetKernelElement()

virtual bool iipr::IConvolutionKernel2d::SetKernelElement	(	const istd::CIndex2d &	index,
		double	value )

pure virtual

Set kernel element value at the given position index.

The method returns true, if the value could be set and false otherwise.

Implemented in iipr::CConvolutionKernel2d.

◆ SetKernelSize()

virtual void iipr::IConvolutionKernel2d::SetKernelSize	(	const istd::CIndex2d &	kernelSize,
		double	value = 0.0 )

pure virtual

Set size of this kernel.

It initialize all values to defined value.

Implemented in iipr::CConvolutionKernel2d.

◆ SetOffsetValue()

virtual bool iipr::IConvolutionKernel2d::SetOffsetValue ( double offset )

pure virtual

Set offset value will be added to convolution result.

Implemented in iipr::CConvolutionKernel2d.

◆ TrySeparateKernels()

virtual bool iipr::IConvolutionKernel2d::TrySeparateKernels	(	IConvolutionKernel2d &	result1,
		IConvolutionKernel2d &	result2,
		int	separationType = ST_AUTO,
		double	tolerance = I_BIG_EPSILON ) const

pure virtual

Try separate this kernel into two separated kernels.

Implemented in iipr::CConvolutionKernel2d.

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

iipr/IConvolutionKernel2d.h

Public Types

Public Member Functions

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ SeparationType

Member Function Documentation

◆ GetCombinedKernel()

◆ GetKernelElement()

◆ GetKernelSize()

◆ GetOffsetValue()

◆ SetKernelElement()

◆ SetKernelSize()

◆ SetOffsetValue()

◆ TrySeparateKernels()