| SoLocalMaximaQuantification Class |
OIV.ImageViz.Engines.ImageAnalysis.Statistics.SoLocalMaximaQuantification engine.
Inheritance HierarchyOIV.InventorSoNetBase
OIV.InventorSoDisposable
OIV.Inventor.MiscSoBase
OIV.Inventor.FieldsSoFieldContainer
OIV.Inventor.EnginesSoEngine
OIV.ImageViz.EnginesSoImageVizEngine
OIV.ImageViz.Engines.ImageAnalysis.StatisticsSoLocalMaximaQuantification
Namespace: OIV.ImageViz.Engines.ImageAnalysis.Statistics
Assembly: OIV.ImageViz (in OIV.ImageViz.dll) Version: 10.12.3.0 (10.12.3.0)
SyntaxThe SoLocalMaximaQuantification type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | SoLocalMaximaQuantification | 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 | Enter input grey level image Default value is NULL. |
| IsDisposable | ISafeDisposable interface implementation.
(Inherited from SoDisposable.) |
| localWindow | The neighborhood size in X, Y and Z. |
| numberOfPatterns | The number of patterns to be detected. |
| outResult | The matching results. |
| precisionMode | Select the precision mode of position. |
| thresholdLevel | Threshold. |
| 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. |
RemarksThe OIV.ImageViz.Engines.ImageAnalysis.Statistics.SoLocalMaximaQuantification engine extracts the local maxima of an image using a neighborhood analysis.
Input_Image[i,j] is a local maximum if the 2 conditions below apply:
1. Considering k in [1,p], l in [1,q] and m in [-p,p], InputImage(i,j) verifies: InputImage( i, j) > InputImage(i + m, j - l) InputImage( i, j) > InputImage(i - k, j) InputImage(i, j) >= InputImage(i + k, j) InputImage(i, j) >= InputImage(i + m, j + l) 2. Input_Image[i,j] is higher than a specified threshold InputImage(i, j) >= threshold
Examples:
Example 1: Input parameters: p=0, q=0, threshold=4, number=50. The local maxima will be the points higher or equal to 4.
Number of local maxima detected: 7 Positions of the local maxima: (7,3) (6,5) (5,7) (6,7) (6,8) (2,9) (6,9) This corresponds to a threshold.
Example 2: Input parameters:p=1, q=1, threshold=3, number=50. Number of local maxima detected: 4 Positions of the local maxima: (7,3) (6,5) (5,7) (2,9)
Remark: If there is an area in the image at constant level, the engine returns the upper left corner of this area. The other points of the area are not considered as �local maxima�.
Example 3: Input parameters: p=2, q=2, threshold=3, number=50. Number of local maxima detected: 2 Positions of the local maxima: (7,3) (5,7)
Remark: The algorithm is not performed on the image border depending on n and m values. That is the reason why the point (2,9) is not considered as a local maximum.
Local Maximum Sub-Pixel Position Determination: On example 3, the algorithm detects 2 local maxima. The positions are converted to sub-pixel positions:
X Sub-pixel Position Determined by Parabola Approximation
Y Sub-pixel Position Determined by Parabola Approximation
FILE FORMAT/DEFAULT
LocalMaximaQuantification {
| computeMode | MODE_AUTO |
| inGrayImage | NULL |
| localWindow | 3 3 3 |
| thresholdLevel | 0.0f |
| precisionMode | PIXEL |
| numberOfPatterns | 1 |
Library references: maxextract maxextract3d
See Also