All Frameworks Class Hierarchy This Framework Previous Next Indexes
CATAnalysisVisuInterfaces Interface CATISamImageColorMap
System.IUnknown
|
+---System.IDispatch
|
+---System.CATBaseUnknown
|
+---CATISamImageColorMap
Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.
interface CATISamImageColorMap
Analysis Images modification.
Role: Analysis Images have a default color map.
Query this interface in to modify the parameters of the color map.
Method Index
- o
DoNotImposeMaxValue()
- To re-activate the automatic computation of the maximum value (deactivated by ImposeMaxValue()).
- o
DoNotImposeMinValue()
- To re-activate the automatic computation of the minimum value (deactivated by ImposeMinValue()).
- o
GetColorsRGB(CATListOfInt&,CATListOfInt&,CATListOfInt&)
- Get the R, G, B values for each color.
- o
GetComments(CATUnicodeString&)
- Get comments to put on the bottom of the color map representation.
- o
GetMinMax(float&,float&)
- Retrieves the minimum and maximum values of the color map.
- o
GetNbColors(int&)
- Retrieves the number of colors.
- o
GetSmoothMode(CATBoolean&)
- Retrieves the smooth mode of the color map.
- o
ImposeMaxValue(float)
- Sets the maximum value of the color map.
- o
ImposeMinValue(float)
- Sets the minimum value of the color map.
- o
IsMaxValueImposed(CATBoolean&)
- Retrieves wether the maximum value is imposed or not.
- o
IsMinValueImposed(CATBoolean&)
- Retrieves wether the minimum value is imposed or not.
- o
SetBoundaryValues(CATListOfFloat&)
- Impose boundary values for each color.
- o
SetColorsRGB(CATListOfInt&,CATListOfInt&,CATListOfInt&)
- Modify the R, G, B values for each color.
- o
SetComments(CATUnicodeString&)
- Set comments to put on the bottom of the color map representation.
- o
SetNbColors(int)
- Sets the number of colors.
- o
SetSmoothMode(CATBoolean)
- Sets or not the color map in smooth mode.
- o
UpdateDisplay()
- Updates the visualization of the color map.
Methods
o DoNotImposeMaxValue
public virtual HRESULT DoNotImposeMaxValue( | )= 0 |
-
To re-activate the automatic computation of the maximum value (deactivated by ImposeMaxValue()).
o DoNotImposeMinValue
public virtual HRESULT DoNotImposeMinValue( | )= 0 |
-
To re-activate the automatic computation of the minimum value (deactivated by ImposeMinValue()).
o GetColorsRGB
-
Get the R, G, B values for each color.
- Parameters:
-
- iRs
- the red value for a color
- iGs
- the green value for a color
- iBs
- the blue value for a color
o GetComments
-
Get comments to put on the bottom of the color map representation.
- Parameters:
-
- oComments
- the comments added to representation.
o GetMinMax
public virtual HRESULT GetMinMax( | float& | oMinValue, |
| float& | oMaxValue)= 0 |
-
Retrieves the minimum and maximum values of the color map.
- Parameters:
-
- oMinValue
- the minimum value.
- oMaxValue
- the maximum value.
o GetNbColors
public virtual HRESULT GetNbColors( | int& | oNbColors)= 0 |
-
Retrieves the number of colors.
- Parameters:
-
- oNbColors
- the current number of colors
o GetSmoothMode
-
Retrieves the smooth mode of the color map.
- Parameters:
-
- oSmoothMode
- the current smooth mode.
o ImposeMaxValue
public virtual HRESULT ImposeMaxValue( | const float | iUserMax)= 0 |
-
Sets the maximum value of the color map.
- Parameters:
-
- iUserMax
- the maximum value.
o ImposeMinValue
public virtual HRESULT ImposeMinValue( | const float | iUserMin)= 0 |
-
Sets the minimum value of the color map.
- Parameters:
-
- iUserMin
- the minimum value.
o IsMaxValueImposed
-
Retrieves wether the maximum value is imposed or not.
- Parameters:
-
- oFlag
- TRUE if the maximum value is imposed
o IsMinValueImposed
-
Retrieves wether the minimum value is imposed or not.
- Parameters:
-
- oFlag
- TRUE if the minimum value is imposed
o SetBoundaryValues
-
Impose boundary values for each color.
- Parameters:
-
- iBoundaries
- the boundary values, which size must be smaller of one than the number of colors.
o SetColorsRGB
-
Modify the R, G, B values for each color.
The size of the lists must be equal to the number of colors returned by GetNbColors method.
- Parameters:
-
- iRs
- the red value for a color
- iGs
- the green value for a color
- iBs
- the blue value for a color
o SetComments
-
Set comments to put on the bottom of the color map representation.
To just remove the current comments, set an empty CATUnicodeString.
- Parameters:
-
- iComments
- the comments to add in representation.
o SetNbColors
public virtual HRESULT SetNbColors( | int | iNbColors)= 0 |
-
Sets the number of colors.
- Parameters:
-
- iNbColors
- the new number of colors to be taken into account
o SetSmoothMode
-
Sets or not the color map in smooth mode.
- Parameters:
-
- iSmoothMode
- the smooth mode.
o UpdateDisplay
public virtual HRESULT UpdateDisplay( | )= 0 |
-
Updates the visualization of the color map.
Note that this method will launch the display update of the associated image(s).
In other words, just call UpdateDisplay() for the color map even if you have modified one associated image.
- See also:
- CATISamImage
This object is included in the file: CATISamImageColorMap.h
If needed, your Imakefile.mk should include the module: CATSamVisuUUID