#include <ImageViz/Engines/ImageFiltering/SmoothingAndDenoising/SoMedianFilterProcessing.h>

Inheritance diagram for SoMedianFilterProcessing:

Public Types
enum	KernelMode { ITERATIVE = 0 , CUBE = 1 , BALL = 2 }

Public Types inherited from SoImageVizEngine
enum	ComputeMode { MODE_2D = 0 , MODE_3D = 1 , MODE_AUTO = 2 }
	Compute Mode This enum specifies whether the main input will be interpreted as a 3D volume or a stack of 2D images for processing. More...

enum	Neighborhood3d { CONNECTIVITY_6 = 0 , CONNECTIVITY_18 = 1 , CONNECTIVITY_26 = 2 }
	Neighborhood Connectivity 3D. More...

Public Member Functions
	SoMedianFilterProcessing ()
	Constructor.

Public Member Functions inherited from SoImageVizEngine
virtual SoType	getTypeId () const
	Returns the type identifier for this specific instance.

virtual void	startEvaluate ()
	Evaluate engine and dependencies in another thread without blocking the current one.

virtual void	waitEvaluate ()
	Wait for the end of engine evaluation.

virtual void	abortEvaluate ()
	Abort current processing as soon as possible.

virtual bool	isEvaluating ()
	Returns true if the engine evaluation is in progress.

Public Member Functions inherited from SoEngine
virtual int	getOutputs (SoEngineOutputList &list) const
	Returns a list of outputs in this engine.

SoEngineOutput *	getOutput (const SbName &outputName) const
	Returns a reference to the engine output with the given name.

SbBool	getOutputName (const SoEngineOutput *output, SbName &outputName) const
	Returns (in outputName) the name of the engine output (output).

SoEngine *	copy () const
	Creates and returns an exact copy of the engine.

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.

Public Attributes
SoSFEnum	computeMode
	Select the compute Mode (2D or 3D or AUTO) Use enum ComputeMode.

SoSFEnum	neighborhood3d
	In 3D configuration (see computeMode), the neighborhood connectivity defines the connectivity considered for processing adjacent voxels.

SoSFImageDataAdapter	inImage
	The input grayscale image.

SoSFInt32	elementSize
	The half size of the structuring element.

SoSFEnum	kernelMode
	The shape of the 3D neighborhood.

SoImageVizEngineOutput< SoSFImageDataAdapter, SoImageDataAdapter * >	outImage
	The output image.

Public Attributes inherited from SoImageVizEngine
SbEventHandler< EventArg & >	onBegin
	Event raised when the processing begins.

SbEventHandler< EventArg & >	onEnd
	Event raised when processing ends and the result is available.

SbEventHandler< EventArg & >	onProgress
	Event raised while processing is running.

Additional Inherited Members
Static Public Member Functions inherited from SoImageVizEngine
static SoType	getClassTypeId ()
	Returns the type identifier for this class.

Static Public Member Functions inherited from SoEngine
static SoType	getClassTypeId ()
	Returns the type identifier for the SoEngine class.

static SoEngine *	getByName (const SbName &name)
	Looks up engine(s) by name.

static int	getByName (const SbName &name, SoEngineList &list)
	Looks up engine(s) by name.

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

SoMedianFilterProcessing engine

The SoMedianFilterProcessing engine smoothes the image using morphological operators.

For an introduction to image filters, see section Images Filters.

This module uses morphological operators to set the pixel value to the median for the defined neighborhood. The SoMedianFilterProcessing usually works well when images contain non-Gaussian noise and/or very small artifacts. It does not cause blurring to the same extend as the SoBoxFilterProcessing, but does take considerably longer to execute.

The gray levels of all pixels in the neighborhood are sorted from the smallest value to the largest one. The central pixel in the sort is then the median value, i.e. the value for which there are as many lower gray levels as higher ones. The process may be iterated.

To explain this, consider the array:

$\left[\begin{array}{ccc} 12 & 17 & 15 \\ 20 & 14 & 16 \\ 18 & 19 & 14 \end{array}\right]$

The sorted gray level values will be: 12 14 14 15 17 18 19 20.
The median value is 16, and it will be the value of the output pixel.

The Median filtering considers the lines and then the columns.

FILE FORMAT/DEFAULT

computeMode	MODE_AUTO
neighborhood3d	CONNECTIVITY_26
inImage	NULL
elementSize	3
kernelMode	CUBE

Library references: medianfilter medianfilter3d

Definition at line 83 of file SoMedianFilterProcessing.h.

Member Enumeration Documentation

◆ KernelMode

enum SoMedianFilterProcessing::KernelMode

Enumerator

ITERATIVE

This mode performs an iterative median filtering of the input image.

In 2D: iteratively, a pixel is assigned to the median value in a 3x3 neighborhood around the corresponding pixel in the previous iteration. The same goes in 3D but the neighborhood is controlled by the 3D connectivity (6-, 18- or 26-direct neighbors). In ITERATIVE mode the elementSize field represents the number of iterations. The ITERATIVE mode is recommended to be used with 2D image with an elementSize lower than 3. For greater values, ITERATIVE mode is faster than SQUARE mode but doesn't change significantly the results, while SQUARE mode applies the filter in the effective window size.

CUBE

This mode specifies a square neighborhood in 2D or a cube neighborhood in 3D.

In 2D, it will produce a square of side 2 x elementSize + 1 pixels. In 3D, it will produce a cube with of size 2 x elementSize + 1 voxels.

BALL

This mode specifies a disk neighborhood in 2D or a sphere neighborhood in 3D.

In 2D, it will produce a disk with of diameter 2 x + 1 pixels. In 3D, it will produce a spshee of diameter 2 x elementSize + 1 voxels.

Definition at line 115 of file SoMedianFilterProcessing.h.

Constructor & Destructor Documentation

◆ SoMedianFilterProcessing()

SoMedianFilterProcessing::SoMedianFilterProcessing ( )

Constructor.

Member Data Documentation

◆ computeMode

SoSFEnum SoMedianFilterProcessing::computeMode

Select the compute Mode (2D or 3D or AUTO) Use enum ComputeMode.

Default is MODE_AUTO

Definition at line 95 of file SoMedianFilterProcessing.h.

◆ elementSize

SoSFInt32 SoMedianFilterProcessing::elementSize

The half size of the structuring element.

A structuring element always has an odd side length (3x3, 5x5, etc) which is defined by 2 * elementSize + 1. Default value is 3.

Definition at line 110 of file SoMedianFilterProcessing.h.

◆ inImage

SoSFImageDataAdapter SoMedianFilterProcessing::inImage

The input grayscale image.

Default value is NULL. Supported types include: grayscale binary label image.

Definition at line 105 of file SoMedianFilterProcessing.h.

◆ kernelMode

SoSFEnum SoMedianFilterProcessing::kernelMode

The shape of the 3D neighborhood.

Use enum KernelMode. Default is CUBE

Definition at line 142 of file SoMedianFilterProcessing.h.

◆ neighborhood3d

SoSFEnum SoMedianFilterProcessing::neighborhood3d

In 3D configuration (see computeMode), the neighborhood connectivity defines the connectivity considered for processing adjacent voxels.

Use enum Neighborhood3d. Default is CONNECTIVITY_26.

Definition at line 102 of file SoMedianFilterProcessing.h.

◆ outImage

SoImageVizEngineOutput<SoSFImageDataAdapter,SoImageDataAdapter*> SoMedianFilterProcessing::outImage

The output image.

Default value is NULL. Supported types include: grayscale binary label color image.

Definition at line 145 of file SoMedianFilterProcessing.h.

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

ImageViz/Engines/ImageFiltering/SmoothingAndDenoising/SoMedianFilterProcessing.h

Open Inventor Release 2023.2.3

Public Types

Public Member Functions

Public Attributes

Additional Inherited Members