| SoVolumeHistogram Class |
Volume Data Histogram.
Inheritance HierarchyNamespace: OIV.LDM
Assembly: OIV.LDM (in OIV.LDM.dll) Version: 2024.1.0.0 (2024.1.0)
SyntaxThe SoVolumeHistogram type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | SoVolumeHistogram | Constructor. |
Methods| Name | Description | |
|---|---|---|
| AddValues(SoBufferObject, SbVec3i32) | Add to the histogram a 3D array of values. |
| AddValues(SoBufferObject, Int32) | Add to the histogram a 1D array of values. |
| AddValues(SoBufferObject, SbVec3i32, SbBox3i32) | Add to the histogram the values in the specified range inside the given array. |
 | ComputeMinMax | Compute min max. |
| ComputeMinMaxWithUndefined | Compute min max. |
| Equals | Determines whether the specified Object is equal to the current Object. (Inherited from Object.) |
| GetHashCode |
Overrides GetHashCode().
(Inherited from SoNetBase.) |
| GetHistogram | Returns a 64 bit integer pointer to the histogram data, the size of the histogram array is () . |
| GetHistoSize | Obsolete. Returns the size of the histogram . |
| GetMax | Obsolete. Returns the max value of the dataset according to the specified data type . |
| GetMaxValue | Obsolete. Returns the max value of the dataset for integer data types . |
| GetMaxValueD | Obsolete. Returns the max value of the dataset for floating data types . |
| GetMin | Obsolete. Returns the max value of the dataset according to the specified data type . |
| GetMinValue | Obsolete. Returns the min value of the dataset for integer data types . |
| GetMinValueD | Obsolete. Returns the min value of the dataset for floating data types . |
| GetNumSignificantBits | Obsolete. Returns the number of significant bits for the dataset, only relevant for integer data types . |
| GetNumValues | Returns the histogram value corresponding to the entry. |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| GetUndefinedValue | Obsolete. return the current undefined value. |
| GetValue | Returns the value corresponding to the entry for integer data types. |
| GetValueD | Returns the value corresponding to the entry for floating data types. |
| Set(IListInt64) | Set the histogram. |
| Set(Queue) | Obsolete. Set the histogram. |
| Set(IListInt64, IListDouble) | Set the histogram. |
| Set(Queue, Queue) | Obsolete. Set the histogram. |
| SetInputValueRange | For floating data type, specifies the range the histogram has to be computed in. |
| SetUndefinedValue | Obsolete. Setup the undefined value to ignore when computing the histogram. |
| ToString | Returns a string that represents the current object. (Inherited from Object.) |
Properties| Name | Description | |
|---|---|---|
 | HistoSize | Returns the size of the histogram . |
| Max | Returns the max value of the dataset according to the specified data type . |
| MaxValue | Returns the max value of the dataset for integer data types . |
| MaxValueD | Returns the max value of the dataset for floating data types . |
| Min | Returns the max value of the dataset according to the specified data type . |
| MinValue | Returns the min value of the dataset for integer data types . |
| MinValueD | Returns the min value of the dataset for floating data types . |
| NumSignificantBits | Returns the number of significant bits for the dataset, only relevant for integer data types . |
| UndefinedValue | Setup the undefined value to ignore when computing the histogram. |
RemarksThis class allows building a histogram from a dataset or a portion of a dataset.
To implement the histogram computation, follow the steps below:
Instantiate this class by passing the data type to the constructor.
Pass the values by calling the method OIV.LDM.SoVolumeHistogram.AddValues(OIV.Inventor.Devices.SoBufferObject, System.Int32) multiple times.
Get the results using methods (), OIV.LDM.SoVolumeHistogram.GetHistogram(), OIV.LDM.SoVolumeHistogram.GetNumValues(System.UInt64), OIV.LDM.SoVolumeHistogram.GetValue(System.UInt64), getMinValue, (), ().
Delete the object.
OIV.LDM.SoVolumeHistogram has different behavior depending on the datatype:
For integer data types:
If sizeof(dataType) == 1, histogram will have 256 bins with a bin width of 1.
Else, histogram will have 65536 bins with a bin width of (Datatype_max - DataType_min) / 65536.
For floating types: The Histogram will have 65536 bins with a bin width of (rangeMax - rangeMin) / 65536, where rangeMin and rangeMax are specified with OIV.LDM.SoVolumeHistogram.SetInputValueRange(System.Double, System.Double).
See Also