Open Inventor Release 2023.2.3
 
Loading...
Searching...
No Matches
SoSigmaFilterProcessing Class Reference

ImageViz SoSigmaFilterProcessing engine More...

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

+ Inheritance diagram for SoSigmaFilterProcessing:

Public Member Functions

 SoSigmaFilterProcessing ()
 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.
 
SoEngineOutputgetOutput (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).
 
SoEnginecopy () 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 SoFieldgetField (const SbName &fieldName) const
 Returns a the field of this object whose name is fieldName.
 
virtual SoFieldgetEventIn (const SbName &fieldName) const
 Returns a the eventIn with the given name.
 
virtual SoFieldgetEventOut (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.
 
SoSFVec3i32 kernelSize
 The kernel size in each direction (odd value).
 
SoSFImageDataAdapter inImage
 The input image.
 
SoSFFloat standardDeviation
 The standard deviation.
 
SoSFInt32 populationThreshold
 The population threshold.
 
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

- 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...
 
- 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 SoEnginegetByName (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

ImageViz SoSigmaFilterProcessing engine

The SoSigmaFilterProcessing3d engine computes a local mean, around the central voxel.

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

This engine computes a local mean, around the central voxel, of neighbor's voxel values. Voxel values far from the central voxel intensity $I_c$ are excluded using a user threshold $\sigma$. Only voxels verifying the following formula are kept for computation:

\[I \in [I_c-2\sigma, I_c+2\sigma]\]

A user population threshold allows switching between the above formula and a classical neighbor mean formula. This allows avoiding considering low populated neighborhoods for computation.

SEE ALSO

SoBilateralFilterProcessing, SoNagaoFilterProcessing3d.

FILE FORMAT/DEFAULT

    SigmaFilterProcessing {
    computeMode MODE_AUTO
    kernelSize 3 3 3
    inImage NULL
    standardDeviation 20.0f
    populationThreshold 8
    }


Library references: sigmafilter sigmafilter3d

Definition at line 77 of file SoSigmaFilterProcessing.h.

Constructor & Destructor Documentation

◆ SoSigmaFilterProcessing()

SoSigmaFilterProcessing::SoSigmaFilterProcessing ( )

Constructor.

Member Data Documentation

◆ computeMode

SoSFEnum SoSigmaFilterProcessing::computeMode

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

Default is MODE_AUTO

Definition at line 89 of file SoSigmaFilterProcessing.h.

◆ inImage

SoSFImageDataAdapter SoSigmaFilterProcessing::inImage

The input image.

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

Definition at line 95 of file SoSigmaFilterProcessing.h.

◆ kernelSize

SoSFVec3i32 SoSigmaFilterProcessing::kernelSize

The kernel size in each direction (odd value).

Default value is SbVec3i32(3,3,3)

Definition at line 92 of file SoSigmaFilterProcessing.h.

◆ outImage

SoImageVizEngineOutput<SoSFImageDataAdapter,SoImageDataAdapter*> SoSigmaFilterProcessing::outImage

The output image.

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

Definition at line 104 of file SoSigmaFilterProcessing.h.

◆ populationThreshold

SoSFInt32 SoSigmaFilterProcessing::populationThreshold

The population threshold.

Default value is 8.

Definition at line 101 of file SoSigmaFilterProcessing.h.

◆ standardDeviation

SoSFFloat SoSigmaFilterProcessing::standardDeviation

The standard deviation.

Default value is 20.0f.

Definition at line 98 of file SoSigmaFilterProcessing.h.


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