The widgets.selection sub-package

Package with widgets which allow the selection of a specific element.

class pydidas.widgets.selection.DirectoryExplorer(**kwargs: Any)

Bases: WidgetWithParameterCollection

The DirectoryExplorer is an implementation of a QTreeView widget with a file system model to display the contents of directories.

Parameters:

**kwargs (Any) –

Supported keywords are any keywords that are supported by QTreeView as well as:

parentUnion[QWidget, None], optional

The parent widget, if applicable. The default is None.

current_pathstr, optional

The default path in the file system. The default is ‘’.

sizeHint() → QSize

Overload the generic sizeHint.

Returns:

The updated size hint.

Return type:

QtCore.QSize

class pydidas.widgets.selection.Hdf5DatasetSelector(dataset_key_filters=None, **kwargs)

Bases: WidgetWithParameterCollection

A compound widget to select datasets in Hdf5 files.

The Hdf5DatasetSelector is a compound widget which allows to select a hdf5 dataset key and the frame number. By convention, the first dimension of an n-dimensional (n >= 3) dataset is the frame number. Any 2-dimensional datasets will be interpreted as single frames.

Parameters:

• dataset_key_filters (Union[dict, None], optional) – A dictionary with dataset keys to be filtered from the list of displayed datasets. Entries must be in the format {<Key to filter>: <Descriptive text for checkbox>}. The default is None.

• **kwargs (dict) – Any additional keyword arguments. See below for supported arguments.

• **QtAttribute (depends on the attribute) – Any Qt attributes which are supported by the generic QWidget. Use the Qt attribute name with a lowercase first character. Examples are fixedWidth, fixedHeight.

clear()

Clear all entries for the widget.

property dataset: str

Get the currently selected dataset.

display_dataset()

Select a dataset from the drop-down list.

This internal method is called by the Qt event system if the QComBoBox text has changed to notify the main program that the user has selected a different dataset to be visualized. This method also updates the accepted frame range for the sliders.

new_filename(filename: str)

Process the new filename.

If the new filename has a suffix associated with hdf5 files, show the widget.

Parameters:

filename (str) – The full file system path to the new file.

class pydidas.widgets.selection.RawMetadataSelector(**kwargs: dict)

Bases: WidgetWithParameterCollection

A compound widget to select metadata in raw image files.

Parameters:

**kwargs (dict) – Any additional keyword arguments. In addition to all QAttributes supported by QWidget, see below for supported arguments:

new_filename(name: str)

Process the new filename.

If the new filename has a suffix associated with raw files, show the widget.

Parameters:

name (str) – The full file system path to the new file.