AnalysisColorMap (Object)

oDiscreteMode

Output Boolean for the Discrete Mode True : indicates that Discrete mode is enabled for the color map. False: indicates that Discrete mode is disabled for the color map. This Method Returns E_FAIL if the Parent Image is not uptodate.

: analysisColorMap is the ColorMap Object oDiscreteMode = analysisColorMap.DiscreteMode
 In this example, oDiscreteMode is the output Discrete Mode for analysisColorMap.

oDistMode

Returns the Distribution Mode (ColorMap type) SPM_LINEAR : For Linear Distribution Mode SPM_HISTOGRAM : For Histogram Distribution Mode SPM_LOG : For Logarithmic Distribution Mode This Method Returns E_FAIL if the Parent Image is not uptodate.

: analysisColorMap is the ColorMap Object oDistMode = analysisColorMap.DistributionMode
 In this example, oDistMode is the output distribution mode for analysisColorMap.

oMaxValue

Returns Imposed Maximum value Returned value will be in CATIA Units. This Method Returns E_FAIL if the Parent Image is not uptodate.

: analysisColorMap is the ColorMap Object oMaxValue = analysisColorMap.ImposedMaxValue
 In this example, oMaxValue is the output Imposed Maximum value for analysisColorMap.

oMinValue

Returns imposed minimum value Returned value will be in CATIA Units. This Method Returns E_FAIL if the Parent Image is not uptodate.

: analysisColorMap is the ColorMap Object oMinValue = analysisColorMap.ImposedMinValue
 In this example, oMinValue is the output Imposed Minimum value for analysisColorMap.

oInverseMode

Output Boolean for the Inverse Mode True : indicates that Inverse mode is enabled for the color map. False: indicates that Inverse mode is disabled for the color map. This Method Returns E_FAIL if the Parent Image is not uptodate.

: analysisColorMap is the ColorMap Object oInverseMode = analysisColorMap.InverseMode
 In this example, oInverseMode is the output Inverse Mode for analysisColorMap.

oNbColors

returns number of colors as output from the color map. This Method Returns E_FAIL if the Parent Image is not uptodate.

: analysisColorMap is the ColorMap Object oNbColors = analysisColorMap.NbColors
 In this example, oNbColors is the output Number of colors for analysisColorMap.

oSmoothMode

Output Boolean for the Smooth Mode True : indicates that Smooth mode is enabled for the color map. False: indicates that Smooth mode is disabled for the color map. This Method Returns E_FAIL if the Parent Image is not uptodate.

: analysisColorMap is the ColorMap Object oSmoothMode = analysisColorMap.SmoothMode
 In this example, oSmoothMode is the output Smooth Mode for analysisColorMap.

indexValue

The index whose Value we get. This integer should be greater than 0 and less than NbColors. Else Method Fails.

oModeValue

Returns the value @param indexValue Returned value will be in CATIA Units. This Method Returns E_FAIL if the Parent Image is not uptodate.

: analysisColorMap is the ColorMap Object Set oModeValue = analysisColorMap.GetDistributionValue (3)
 In this example, oModeValue is the output value of the Distribution list at Index 3.

indexValue

The index whose Value will be set. This integer should be greater than 0 and less than NbColors. Else Method Fails.

iModeValue

The Value to be set. This value should be in between Computed/Imposed Min/Max values. Else Method Fails. In addition if @param iSmootheningFlag is False, this value should be in between the immediate lower and upper values. Else Method Fails. Value has to be provided in CATIA Units.

iSmootheningFlag

if True: Does either upper or lower smoothening of values. if False: Does not smoothen values. But sets only the given index value. This Method Returns E_FAIL if Color Map is Discrete.

: analysisColorMap is the ColorMap Object  Example 1:

 Call analysisColorMap.SetDistributionValue(3, 3e+09, True)

 This sets the value 3e+09 at 3rd Index of the list. It will smoothen the distribution values
 for the color-map object analysisColorMap.
 Should be in between Computed/Imposed Min/Max values.
 
 Example 2:

 Call analysisColorMap.SetDistributionValue(3, 10e+09, False)

 This sets the value 10e+09 at 3rd Index of the list. It will not smoothen the distribution
 for the color-map object analysisColorMap.
 10e+09 should be greater than Index 2 value and lesser than Index 4 value.
 Should be in between Computed/Imposed Min/Max values.