Skip to content

Commit 29dda58

Browse files
authored
add documentation to LayerViewConfiguration (#691)
1 parent dc37dca commit 29dda58

File tree

1 file changed

+19
-0
lines changed

1 file changed

+19
-0
lines changed

webknossos/webknossos/dataset/properties.py

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -86,13 +86,32 @@ class LayerViewConfiguration:
8686
"""
8787

8888
color: Optional[Tuple[int, int, int]] = None
89+
"""Color in RGB from 0 to 255. The webKnossos default is [255, 255, 255]."""
90+
8991
alpha: Optional[float] = None
92+
"""Alpha value from 0 to 100. The webKnossos default is 100 except for segmentation
93+
layers where it is 20."""
94+
9095
intensity_range: Optional[Tuple[float, float]] = None
96+
"""Min and max data value range (dependent on the layer's data type). Can be used to threshold the value range.
97+
The webKnossos default is the full value range."""
98+
9199
min: Optional[float] = None # pylint: disable=redefined-builtin
100+
"""Minimum data value that might be encountered. This will restrict the histogram in webKnossos and possibly overwrite
101+
the min value of the `intensityRange` (if that is lower)."""
102+
92103
max: Optional[float] = None # pylint: disable=redefined-builtin
104+
"""Maximum data value that might be encountered. This will restrict the histogram in webKnossos and possibly overwrite
105+
the max value of the `intensityRange` (if that is higher)."""
106+
93107
is_disabled: Optional[bool] = None
108+
"""Disable a layer. The webKnossos default is False."""
109+
94110
is_inverted: Optional[bool] = None
111+
"""Invert a layer. The webKnossos default is False."""
112+
95113
is_in_edit_mode: Optional[bool] = None
114+
"""Enable the histogram edit mode. The webKnossos default is False."""
96115

97116

98117
# --- Property --------------------

0 commit comments

Comments
 (0)