| SoColorSpaceConversionProcessing Class |
OIV.ImageViz.Engines.ImageFiltering.ColorTransforms.SoColorSpaceConversionProcessing engine.
Inheritance HierarchyOIV.InventorSoNetBase
OIV.InventorSoDisposable
OIV.Inventor.MiscSoBase
OIV.Inventor.FieldsSoFieldContainer
OIV.Inventor.EnginesSoEngine
OIV.ImageViz.EnginesSoImageVizEngine
OIV.ImageViz.Engines.ImageFiltering.ColorTransformsSoColorSpaceConversionProcessing
Namespace: OIV.ImageViz.Engines.ImageFiltering.ColorTransforms
Assembly: OIV.ImageViz (in OIV.ImageViz.dll) Version: 2023.1.3.0 (2023.1.3)
SyntaxThe SoColorSpaceConversionProcessing type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | SoColorSpaceConversionProcessing | 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 | |
|---|---|---|
 | baseMode | Select the output color space. |
| computeMode | Select the compute Mode (2D or 3D or AUTO) . |
| inColorImage | The input color image. |
| IsDisposable | ISafeDisposable interface implementation.
(Inherited from SoDisposable.) |
| outColorImage | The output color image. |
| 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 to color transforms, see section OIV.ImageViz.Engines.ImageFiltering.ColorTransforms.
The OIV.ImageViz.Engines.ImageFiltering.ColorTransforms.SoColorSpaceConversionProcessing engine performs conversion between two color image formats or bases. You may choose between RGB and HLS.
RGB to HLS Conversion
If we define 
the HLS components are:
Intensity component:
Chromatic components:
S is equal to 0 for grey level images (R = G = B) and is maximum for a fully saturated color. 
The H value varies from 0 to
as it goes from red ( 
) through green ( 
) and blue ( 
) and back to red.Hue is converted from radians to a value between 0-255 and is not defined if the saturation is equal to 0.
Please note that an image cannot be transformed into a color space which it already belongs to. By default ImageViz considers color images belonging to RGB color space. Thus converting a color image to the RGB space without having performed a conversion to HLS before will raise an exception "Input image type must be different from output type !" .
FILE FORMAT/DEFAULT
ColorSpaceConversionProcessing {
| computeMode | MODE_AUTO |
| inColorImage | NULL |
| baseMode | HLS |
Library references: colorbase
See Also