Module: DisplayColormap (amira)

Description:

This module allows you to position a colormap icon in the 3D viewer. This is useful, for example, to produce snapshots that contain an explanation of what specific colors mean. Note that although colormaps are ordinary data objects in amira, they often are hidden by default. Use the Pool/Show Object menu of the main window to display their icons in the Pool.

Connections:

Data [required]
The colormap to be displayed.

Ports:

Options

This port provides the following four toggles:

Position

Position of colormap in viewer relative to lower left corner. If one of the numbers is negative, it is interpreted relative to upper right corner.

Size

Length and width of the colormap in pixels. If the option relative size has been selected, the length and width are interpreted relative to a window size of 1000x800. If the actual viewer window is smaller (or larger), then the displayed colormap will be smaller (or larger).

Custom Text

This is only available if the custom text option is selected. You may specify a space-separated list of values to be displayed. In addition, you may specify a text string that is displayed instead of the number by using the '/' character. The example in the image above has been generated using this text: -8/cold 50/hot, which displays "cold" at value -8 and "hot" at the value 50 (the colormap in this case ranges from -8 to 50). If the label text contain blanks, you must enclose the text in double quotes, e.g., 100/"very hot".

Commands:

getFontSize
Returns the current font size.

setFontSize <points>
Changes the font size. The default font size is 14 points.

setBGColor <color>
Sets the color of the background rectangle which is drawn when the transparent background toggle is off.

setColor <color>
Sets the color of the text.