SoMorphoLut2D Class Reference

Class that represents a morphological look-up table (LUT). More...

#include <ImageViz/Nodes/Luts/SoMorphoLut2D.h>

Inheritance diagram for SoMorphoLut2D:

Public Types
enum	InsertMode {   INSERT_NEW ,   INSERT_OR }

Public Member Functions
virtual SoType	getTypeId () const
	Returns the type identifier for this specific instance.
	SoMorphoLut2D ()
	Default constructor.
void	insertKernel (SbKernel2i32 kernel2d, InsertMode insertMode, unsigned int kernelRotation)
	Inserts a kernel into the LUT.
size_t	getNumKernels () const
	Return the number of kernels registered in the LUT.
SbKernel2i32	getKernel (int indexKernel) const
	Returns the specified kernel.
Public Member Functions inherited from SoFieldContainer
void	setToDefaults ()
	Sets all fields in this object to their default values.
SbBool	hasDefaultValues () const
	Returns TRUE if all of the object's fields have their default values.
SbBool	fieldsAreEqual (const SoFieldContainer *fc) const
	Returns TRUE if this object's fields are exactly equal to fc's fields.
void	copyFieldValues (const SoFieldContainer *fc, SbBool copyConnections=FALSE)
	Copies the contents of fc's fields into this object's fields.
SoNONUNICODE SbBool	set (const char *fieldDataString)
	Sets one or more fields in this object to the values specified in the given string, which should be a string in the Open Inventor file format.
SbBool	set (const SbString &fieldDataString)
	Sets one or more fields in this object to the values specified in the given string, which should be a string in the Open Inventor file format.
void	get (SbString &fieldDataString)
	Returns the values of the fields of this object in the Open Inventor ASCII file format in the given string.
virtual int	getFields (SoFieldList &list) const
	Appends references to all of this object's fields to resultList, and returns the number of fields appended.
virtual int	getAllFields (SoFieldList &list) const
	Returns a list of fields, including the eventIn's and eventOut's.
virtual SoField *	getField (const SbName &fieldName) const
	Returns a the field of this object whose name is fieldName.
virtual SoField *	getEventIn (const SbName &fieldName) const
	Returns a the eventIn with the given name.
virtual SoField *	getEventOut (const SbName &fieldName) const
	Returns the eventOut with the given name.
SbBool	getFieldName (const SoField *field, SbName &fieldName) const
	Returns the name of the given field in the fieldName argument.
SbBool	enableNotify (SbBool flag)
	Notification at this Field Container is enabled (if flag == TRUE) or disabled (if flag == FALSE).
SbBool	isNotifyEnabled () const
	Notification is the process of telling interested objects that this object has changed.
virtual void	setUserData (void *data)
	Sets application data.
void *	getUserData (void) const
	Gets user application data.
Public Member Functions inherited from SoBase
virtual void	touch ()
	Marks an instance as modified, simulating a change to it.
virtual SbName	getName () const
	Returns the name of an instance.
virtual void	setName (const SbName &name)
	Sets the name of an instance.
void	setSynchronizable (const bool b)
	Sets this to be a ScaleViz synchronizable object.
bool	isSynchronizable () const
	Gets the ScaleViz synchronizable state of this object.
Public Member Functions inherited from SoRefCounter
void	ref () const
	Adds a reference to an instance.
void	unref () const
	Removes a reference from an instance.
void	unrefNoDelete () const
	unrefNoDelete() should be called when it is desired to decrement the reference count, but not delete the instance if this brings the reference count to zero.
int	getRefCount () const
	Returns current reference count.
void	lock () const
	lock this instance.
void	unlock () const
	unlock this instance.
Public Member Functions inherited from SoTypedObject
SbBool	isOfType (const SoType &type) const
	Returns TRUE if this object is of the type specified in type or is derived from that type.
template<typename TypedObjectClass >
SbBool	isOfType () const
	Returns TRUE if this object is of the type of class TypedObjectClass or is derived from that class.

Static Public Member Functions
static SoType	getClassTypeId ()
	Returns the type identifier for this class.
Static Public Member Functions inherited from SoFieldContainer
static SoType	getClassTypeId ()
	Returns the type of this class.
Static Public Member Functions inherited from SoBase
static SoType	getClassTypeId ()
	Returns type identifier for this class.
Static Public Member Functions inherited from SoTypedObject
static SoType	getClassTypeId ()
	Returns the type identifier for this class.

Detailed Description

Class that represents a morphological look-up table (LUT).

Class that represents a 2D morphological look-up table (LUT).

[C++] This is a reference counted object, similar to a node. It can only be destroyed by incrementing and decrementing the reference count. The initial reference count is 0. You may use the ref() and unref() methods or the SoRef "smart pointer" template.

SEE ALSO

SoFieldContainer, SbKernel2i32

Definition at line 47 of file SoMorphoLut2D.h.

Member Enumeration Documentation

InsertMode

enum SoMorphoLut2D::InsertMode

Enumerator
INSERT_NEW	Reset the LUT (clear all kernels) before insertion. Should be used for the first insertion.
INSERT_OR	Append to the list of kernels.

Definition at line 52 of file SoMorphoLut2D.h.

Constructor & Destructor Documentation

SoMorphoLut2D()

SoMorphoLut2D::SoMorphoLut2D

(

)

Default constructor.

Member Function Documentation

getClassTypeId()

static SoType SoMorphoLut2D::getClassTypeId ( )

static

Returns the type identifier for this class.

getKernel()

SbKernel2i32 SoMorphoLut2D::getKernel

(

int

indexKernel

)

const

Returns the specified kernel.

Parameters

indexKernel

index of the kernel (cannot exceed registered number of kernels).

getNumKernels()

size_t SoMorphoLut2D::getNumKernels

(

)

const

Return the number of kernels registered in the LUT.

getTypeId()

virtual SoType SoMorphoLut2D::getTypeId ( ) const

virtual

Returns the type identifier for this specific instance.

Implements SoTypedObject.

insertKernel()

void SoMorphoLut2D::insertKernel	(	SbKernel2i32	kernel2d,
		InsertMode	insertMode,
		unsigned int	kernelRotation
	)

Inserts a kernel into the LUT.

Parameters

[in]	kernel2d	The kernel to add. A 2D-kernel should contain exactly 9 values and indexes matching the following table. Accepted values for the kernel are: 0: pixel is off 1: pixel is on 2: pixel is ignored
[in]	insertMode	The insertion mode of the kernel. See SoMorphoLut2D::InsertMode.
[in]	kernelRotation	Rotation applied to the kernel before insertion. Value should be between 0 (no rotation) and 7. Rotation is counter-clockwise.

As an example, if kernelRotation = 1, the resulting kernel inserted is:

An SbException is thrown if the size of the kernel is not 3x3.

---

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

• ImageViz/Nodes/Luts/SoMorphoLut2D.h