added to docstring

TomographicImaging · Jul 31, 2023 · 5302f23 · 5302f23
1 parent 99c2c50
commit 5302f23
Showing 1 changed file with 12 additions and 0 deletions.
diff --git a/Wrappers/Python/ccpi/viewer/ui/dialogs.py b/Wrappers/Python/ccpi/viewer/ui/dialogs.py
@@ -62,6 +62,18 @@ class RawInputDialog(FormDialog):
     - data type
     - endianness
     - fortran ordering
+
+    The dialog can let the user preview the data and verify that it is correct.
+
+    Example:
+    --------
+
+    One can instantiate this dialog and reduce the supported types by overriding the 
+    default supported_types with SetSupportedTypes:
+
+    >>> dialog = RawInputDialog(parent, fname)
+    >>> dialog.setSupportedTypes(['float32', 'float64'])
+
     '''
 
     supported_types =  [ np.dtype(f) for f in ['int8', 'uint8', 'int16', 'uint16', \