Difference between revisions of "Documentation/Nightly/Modules/Colors"
Line 146: | Line 146: | ||
{{documentation/{{documentation/version}}/module-section|Use Cases}} | {{documentation/{{documentation/version}}/module-section|Use Cases}} | ||
− | [[Image: | + | [[Image:Slicer43-Colors-3D.jpeg|thumb|300px|Colors]] |
The Colors module Dispay panel can be popped up as a stand alone widget and used to select colors in other modules of Slicer4. | The Colors module Dispay panel can be popped up as a stand alone widget and used to select colors in other modules of Slicer4. | ||
Line 167: | Line 167: | ||
* Display panel: | * Display panel: | ||
**Color Tables: a drop down menu from which to select from the list of installed color look up tables. | **Color Tables: a drop down menu from which to select from the list of installed color look up tables. | ||
− | **Copy Color Node button: Duplicate the current color table to edit the color entrees as built-in color tables don't allow user | + | **[image:Slicer43-Colors-FolderPlus.jpeg]] Copy Color Node button: Duplicate the current color table to edit the color entrees as built-in color tables don't allow user editing. |
− | **Number of Colors: the number of colors in the currently selected table | + | **Number of Colors: the number of colors in the currently selected table. |
− | **Hide empty Colors: | + | **Hide empty Colors: When checked, hide the unnamed color entries in the list below. |
**Lookup Range: Only change the display range, not the values in the table. | **Lookup Range: Only change the display range, not the values in the table. | ||
**Table of currently selected colors: | **Table of currently selected colors: | ||
− | ***Index: the integer value giving the index of this color in the look up table, used to match it up with a scalar value in a volume voxel | + | ***1st Column: Index: the integer value giving the index of this color in the look up table, used to match it up with a scalar value in a volume voxel. |
− | ***Color: a box showing the current colour | + | ***2nd Column: Color: a box showing the current colour. When viewing an editable table, double click on it to bring up a color picker. |
− | ***Label: the text description of the color, often an anatomical label | + | ***Label: the text description of the color, often an anatomical label. For some tables, the name is automatically generated from the RGBA values. |
− | ***Opacity: a value between 0 and 1 describing how opaque this color is. The background | + | ***Opacity: a value between 0 and 1 describing how opaque this color is. The background color at index 0 is usually set to 0 and other colors to 1. |
| align="right" | | | align="right" | | ||
[[Image:Slicer4-Colors-Display.jpeg|thumb|280px|Display panel]] | [[Image:Slicer4-Colors-Display.jpeg|thumb|280px|Display panel]] | ||
Line 181: | Line 181: | ||
| | | | ||
* Scalar Bar panel: | * Scalar Bar panel: | ||
− | **Display scalar bar: check this box if you wish to see a scalar bar in the 3d view that shows the range of | + | **Display scalar bar: check this box if you wish to see a scalar bar in the 3d view that shows the range of colors for this color look up table. You can drag the widget around in the 3D window, it will resize and switch between horizontal and vertical alignments. |
− | **'''Title properties''' control the display of the scalar bar's title text | + | **'''Title properties''' control the display of the scalar bar's title text. |
− | ***Text: Title text, often showing the measurement units of mm | + | ***Text: Title text, often showing the measurement units of mm. |
− | ***Color: the color to use for the title text | + | ***Color: the color to use for the title text. |
− | ***Opacity: the opacity of the title text | + | ***Opacity: the opacity of the title text. |
− | ***Font: the font used to display the title text | + | ***Font: the font used to display the title text. |
− | ***Style: check these boxes if you wish to adjust the style of the title text font | + | ***Style: check these boxes if you wish to adjust the style of the title text font. |
****bold | ****bold | ||
****italic | ****italic | ||
****shadow | ****shadow | ||
− | **'''Labels properties''' control the display of the scalar bar's label text | + | **'''Labels properties''' control the display of the scalar bar's label text, displayed along the length of the scalar bar. |
− | ***Format: a string format that controls the number of digits in the values displayed as the scalar bar labels | + | ***Format: a string format that controls the number of digits in the values displayed as the scalar bar labels, uses [http://www.cplusplus.com/reference/cstdio/printf/ | standared C++ string format notation]. |
− | ***Color: the color to use for the label text | + | ***Color: the color to use for the label text. |
− | ***Opacity: the opacity of the label text | + | ***Opacity: the opacity of the label text. |
− | ***Font: the font used to display the label text | + | ***Font: the font used to display the label text. |
− | ***Style:check these boxes if you wish to adjust the style of the label text font | + | ***Style: check these boxes if you wish to adjust the style of the label text font. |
****bold | ****bold | ||
****italic | ****italic | ||
****shadow | ****shadow | ||
− | **Maximum number of colors: limit the range of | + | **Maximum number of colors: limit the range of colors displayed on the scalar bar. |
− | **Number of labels: how many labels to display along the scalar bar | + | **Number of labels: how many labels to display along the length of the scalar bar. |
| align="right" | | | align="right" | | ||
[[Image:Slicer4-Colors-ScalarBar.jpeg|thumb|280px|Scalar bar panel]] | [[Image:Slicer4-Colors-ScalarBar.jpeg|thumb|280px|Scalar bar panel]] |
Revision as of 19:31, 14 November 2013
Home < Documentation < Nightly < Modules < Colors
For the latest Slicer documentation, visit the read-the-docs. |
Introduction and Acknowledgements
| |||||||
|
Module Description
The Colors Module manages color look up tables. Color look up tables are used by mappers to translate between an integer and a colour value for display of models and volumes. Slicer supports three kinds of tables:
You can load a color table file from the File -> Add Data dialog. File formatThe color file format is a plain text file with the .txt or .ctbl extension. Each line in the file has: label name R G B A label is an integer, name a string, and RGBA are 0-255. File example: # Comments if the line start with # 0 air 0 0 0 0 1 bone 255 255 255 255 whatever after the Alpha value is discarded 2 tumor 255 128 0 255 ... Custom LUTsYou can create custom LUTs by creating a table with the colors on the wiki, saving to file and then loading them into Slicer. CategoriesThe colors are divided up into categories:
|
Use Cases
The Colors module Dispay panel can be popped up as a stand alone widget and used to select colors in other modules of Slicer4.
- The Models module uses it to select surface model colours.
- The Volumes module uses it to select color maps for label map volumes to control which colors are used to display the scalar values at each voxel
- The Editor uses it to select colors with which to paint on label map volumes.
Tutorials
N/A
Panels and their use
A list of all the panels in the interface, their features, what they mean, and how to use them. For instance:
|
|
|
Similar Modules
- The Volumes, Editor and Models modules use the colours to adjust the display properties for label map volumes and surface models
References
N/A
Information for Developers
Section under construction. |