axes_widget
Widget for specifying axes order.
AxesWidget
#
Bases: QWidget
A widget allowing users to specify axes.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
n_axes | int | Number of axes. | 3 |
is_3D | bool | Whether the data is 3D. | False |
training_signal | TrainingSignal or None | Signal holding all training parameters to be set by the user. | None |
Source code in src/careamics_napari/widgets/axes_widget.py
83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 |
|
__init__(n_axes=3, is_3D=False, training_signal=None)
#
Initialize the widget.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
n_axes | int | Number of axes. | 3 |
is_3D | bool | Whether the data is 3D. | False |
training_signal | TrainingSignal or None | Signal holding all training parameters to be set by the user. | None |
Source code in src/careamics_napari/widgets/axes_widget.py
get_axes()
#
get_default_text()
#
Return the default text.
Returns:
Type | Description |
---|---|
str | Default text. |
Source code in src/careamics_napari/widgets/axes_widget.py
is_valid()
#
Return whether the axes are valid.
Returns:
Type | Description |
---|---|
bool | Whether the axes are valid. |
set_text_field(text)
#
Set the text field.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
text | str | Text to set. | required |
Highlight
#
Bases: Enum
Axes highlight types.
Source code in src/careamics_napari/widgets/axes_widget.py
LettersValidator
#
Bases: QValidator
Custom validator.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
options | str | Allowed characters. | required |
*args | Any | Variable length argument list. | () |
**kwargs | Any | Arbitrary keyword arguments. | {} |
Source code in src/careamics_napari/widgets/axes_widget.py
__init__(options, *args, **kwargs)
#
Initialize the validator.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
options | str | Allowed characters. | required |
*args | Any | Variable length argument list. | () |
**kwargs | Any | Arbitrary keyword arguments. | {} |
Source code in src/careamics_napari/widgets/axes_widget.py
validate(value, pos)
#
Validate the input.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
value | str | Input value. | required |
pos | int | Position of the cursor. | required |
Returns:
Type | Description |
---|---|
(State, str, int) | Validation state, value, and position. |