Open Inventor Release 2023.2.3
 
Loading...
Searching...
No Matches
Public Types | Public Member Functions | Public Attributes | List of all members
SoTopHatProcessing Class Reference
ImageViz » Engines » Image Segmentation » Binarization

ImageViz SoTopHatProcessing image filter More...

#include <ImageViz/Engines/ImageSegmentation/Binarization/SoTopHatProcessing.h>

+ Inheritance diagram for SoTopHatProcessing:

Public Types

enum  ElementShape {
  ROUGH = 0 ,
  SMOOTH = 1
}
 
enum  ObjectLightness {
  BRIGHT_OBJECTS = 0 ,
  DARK_OBJECTS = 1
}
 
- 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

 SoTopHatProcessing ()
 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 elementShape
 Select the type of structuring element shape.
 
SoSFImageDataAdapter inGrayImage
 Input grey level image.
 
SoSFInt32 elementSize
 The half size of the structuring element.
 
SoSFEnum objectLightness
 Select the lightness mode for object to detect.
 
SoSFVec2f thresholdLevel
 The low and high threshold levels.
 
SoImageVizEngineOutput< SoSFImageDataAdapter, SoImageDataAdapter * > outBinaryImage
 The output binary 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

ImageViz SoTopHatProcessing image filter

The SoTopHatProcessing engine performs a Top-Hat algorithm on a gray level image.

The Top-Hat segmentation extracts small elements and details from given images. It detects the dark or the bright area, corresponding to the valleys or the narrow peaks. There exist two types of Top-Hat transform:

  • The Black Top-Hat: it is defined as the difference between the closing with a particular kernel and the input image. The smaller is the kernel, the smaller are the elements in the Top-Hat image. A threshold allows selecting the darker elements of the Top-Hat result, i.e., the depth of the selected valleys. See Figure 1.
  • The White Top-Hat: it is defined as the difference between the input image and its opening (using a particular kernel). The threshold allows selecting the brighter elements of the Top-Hat result.
Figure 1: Black Top-Hat computation

The Top-Hat module is divided into two phases:

  • The Top-Hat image computation, depending on the Top-Hat type and the closing/opening parameters; (step 1 and 2 on figure 1)
  • The Thresholding, to select the valleys/narrow peaks depth. (step 3 on figure 1)

The SoTopHatProcessing engine also includes a rough and a smooth mode. Whereas the rough mode uses a standard structuring element, the smooth mode employs a more sophisticated volumic structuring element, a rhombodecahedron, which usually generates a much more precise Top-Hat.

FILE FORMAT/DEFAULT

    TopHatProcessing {
    computeMode MODE_AUTO
    elementShape ROUGH
    inGrayImage NULL
    elementSize 3
    objectLightness BRIGHT_OBJECTS
    thresholdLevel 128.0f 255.0f
    }


Library references: high_tophat tophat

Definition at line 86 of file SoTopHatProcessing.h.

Member Enumeration Documentation

◆ ElementShape

enum SoTopHatProcessing::ElementShape
Enumerator
ROUGH 

The Top-Hat uses a cubic structuring element.

SMOOTH 

The Top-Hat uses a rhombodecahedron structuring element.

Definition at line 103 of file SoTopHatProcessing.h.

◆ ObjectLightness

enum SoTopHatProcessing::ObjectLightness
Enumerator
BRIGHT_OBJECTS 

The engine applies a white Top-Hat and detects small bright area.

DARK_OBJECTS 

The engine applies a black Top-Hat and detects small dark area.

SEE ALSO

SoOpeningCubeProcessing, SoClosingCubeProcessing, SoThresholdingProcessing.

Definition at line 130 of file SoTopHatProcessing.h.

Constructor & Destructor Documentation

◆ SoTopHatProcessing()

SoTopHatProcessing::SoTopHatProcessing ( )

Constructor.

Member Data Documentation

◆ computeMode

SoSFEnum SoTopHatProcessing::computeMode

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

Default is MODE_AUTO

Definition at line 98 of file SoTopHatProcessing.h.

◆ elementShape

SoSFEnum SoTopHatProcessing::elementShape

Select the type of structuring element shape.

Use enum ElementShape. Default is ROUGH

Definition at line 117 of file SoTopHatProcessing.h.

◆ elementSize

SoSFInt32 SoTopHatProcessing::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 125 of file SoTopHatProcessing.h.

◆ inGrayImage

SoSFImageDataAdapter SoTopHatProcessing::inGrayImage

Input grey level image.

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

Definition at line 120 of file SoTopHatProcessing.h.

◆ objectLightness

SoSFEnum SoTopHatProcessing::objectLightness

Select the lightness mode for object to detect.

Use enum ObjectLightness. Default is BRIGHT_OBJECTS

Definition at line 146 of file SoTopHatProcessing.h.

◆ outBinaryImage

SoImageVizEngineOutput<SoSFImageDataAdapter,SoImageDataAdapter*> SoTopHatProcessing::outBinaryImage

The output binary image.

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

Definition at line 152 of file SoTopHatProcessing.h.

◆ thresholdLevel

SoSFVec2f SoTopHatProcessing::thresholdLevel

The low and high threshold levels.

Default value is SbVec2f(128.0f,255.0f).

Definition at line 149 of file SoTopHatProcessing.h.

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