| SoMarkerBasedWatershedProcessing Class |
OIV.ImageViz.Engines.ImageSegmentation.RegionGrowing.SoMarkerBasedWatershedProcessing engine performs a fast determination of the watershed lines.
Inheritance HierarchyOIV.InventorSoNetBase
OIV.InventorSoDisposable
OIV.Inventor.MiscSoBase
OIV.Inventor.FieldsSoFieldContainer
OIV.Inventor.EnginesSoEngine
OIV.ImageViz.EnginesSoImageVizEngine
OIV.ImageViz.Engines.ImageSegmentation.RegionGrowingSoMarkerBasedWatershedProcessing
Namespace: OIV.ImageViz.Engines.ImageSegmentation.RegionGrowing
Assembly: OIV.ImageViz (in OIV.ImageViz.dll) Version: 2023.1.3.0 (2023.1.3)
SyntaxThe SoMarkerBasedWatershedProcessing type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | SoMarkerBasedWatershedProcessing | Constructor. |
Methods| Name | Description | |
|---|---|---|
| AbortEvaluate | Abort current processing as soon as possible. |
| Copy | Creates and returns an exact copy of the engine. |
| CopyFieldValues(SoFieldContainer) | Calls CopyFieldValues(fc, false). (Inherited from SoFieldContainer.) |
| CopyFieldValues(SoFieldContainer, Boolean) | Copies the contents of fc's fields into this object's fields. |
| Dispose |
Releases all resources used by SoDisposable.
(Inherited from SoDisposable.) |
| EnableNotify | Notification at this Field Container is enabled (if flag == true) or disabled (if flag == false). |
| Equals | Determines whether the specified Object is equal to the current Object. (Inherited from Object.) |
| FieldsAreEqual | Returns true if this object's fields are exactly equal to fc's fields. |
| Get | Returns the values of the fields of this object in the Open Inventor ASCII file format in the given string. |
| GetAllFields | Returns a list of fields, including the eventIn's and eventOut's. |
| GetEventIn | Returns a the eventIn with the given name. |
| GetEventOut | Returns the eventOut with the given name. |
| GetField | Returns a the field of this object whose name is fieldName. |
| GetFieldName | Returns the name of the given field in the fieldName argument. |
| GetFields | Appends references to all of this object's fields to resultList, and returns the number of fields appended. |
| GetHashCode |
Overrides GetHashCode().
(Inherited from SoNetBase.) |
| GetName | Returns the name of an instance. |
| GetOutput | Returns a reference to the engine output with the given name. |
| GetOutputName | Returns (in outputName) the name of the engine output (output). |
| GetOutputs | Returns a list of outputs in this engine. |
| GetStringName | (Inherited from SoBase.) |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| HasDefaultValues | Returns true if all of the object's fields have their default values. |
| IsEvaluating | Returns true if the engine evaluation is in progress. |
| IsNotifyEnabled | Notification is the process of telling interested objects that this object has changed. |
| IsSynchronizable | Gets the ScaleViz synchronizable state of this object. |
| Set | 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. |
| SetName | (Inherited from SoBase.) |
| SetSynchronizable | Sets this to be a ScaleViz synchronizable object. |
| SetToDefaults | Sets all fields in this object to their default values. |
| StartEvaluate | Evaluate engine and dependencies in another thread without blocking the current one. |
| ToString |
Converts this SoBase structure to a human readable string.
(Inherited from SoBase.) |
| Touch | Marks an instance as modified, simulating a change to it. |
| WaitEvaluate | Wait for the end of engine evaluation. |
Properties| Name | Description | |
|---|---|---|
 | computeMode | Select the compute Mode (2D or 3D or AUTO) . |
| inGrayImage | The input grayscale image. |
| inMarkerImage | The input marker (label) image. |
| IsDisposable | ISafeDisposable interface implementation.
(Inherited from SoDisposable.) |
| neighborhood3d | In 3D configuration (see OIV.ImageViz.Engines.ImageSegmentation.RegionGrowing.SoMarkerBasedWatershedProcessing.computeMode), the neighborhood connectivity defines the connectivity considered for processing adjacent voxels. |
| outObjectImage | The output image. |
| outputMode | Select the type of output mode. |
| precisionMode | Select the mode of algorithm precision for watershed. |
| UserData |
Gets or sets the user data to be contained by the field container.
(Inherited from SoFieldContainer.) |
Events| Name | Description | |
|---|---|---|
 | OnBegin | Event raised when the processing begins. |
| OnEnd | Event raised when processing ends and the result is available. |
| OnProgress | Event raised while processing is running. |
RemarksFor an introduction, see Watershed principle.
OIV.ImageViz.Engines.ImageSegmentation.RegionGrowing.SoMarkerBasedWatershedProcessing has 2 configurations. See outputMode field.
This engine performs a fast determination of the watershed lines from specified markers in a label image, followed by a labelling of the complementary set. It can be viewed as the zones of influence of the markers.
Either the separated basins are output in a label image, the crest lines being part of the complementary (not a label), or the crest lines are output in a binary image.
Note: Because two bits are used to code the pixels during the algorithm, input gray levels image should range from 0 to 16383. If the range is greater, a normalization is applied to reduce the dynamic of this image.
| Notice: This engine requires to preliminarily load the whole input data set into memory to be computed. As a consequence the input data set will be automatically loaded before the execution of this engine, ignoring the maximum memory parameter of the OIV.ImageViz.SbImageDataAdapterHelper.GetAppropriateAdapter(System.String, System.UInt64) function or OIV.ImageViz.Nodes.Images.SoFileDataAdapter class | If the input data set cannot fit in memory, this engine will fail during its computation. |
FILE FORMAT/DEFAULT
MarkerBasedWatershedProcessing {
| computeMode | MODE_AUTO |
| neighborhood3d | CONNECTIVITY_26 |
| outputMode | WATERSHED_RIDGES |
| inGrayImage | NULL |
| inMarkerImage | NULL |
| precisionMode | REPEATABLE |
Library references: catchbasin fastwatershed
See Also