hdf5view

https://tgwoodcock.github.io/hdf5view
Admin
hdf5view is a simple Qt and Python based viewer designed to inspect the structure of HDF5 files,...
Tokens:15,151
Snippets:242
Trust Score:9.7
Update:1 month ago
Show doc for...
Tokens:
Raw
### Install hdf5view from source

Source: https://tgwoodcock.github.io/hdf5view/_sources/user/installation.rst.txt

Clone the repository and install the package locally using pip.

```bash
git clone https://github.com/tgwoodcock/hdf5view.git
cd hdf5view
pip install .
```

--------------------------------

### Install Qt API bindings

Source: https://tgwoodcock.github.io/hdf5view/_sources/user/installation.rst.txt

Install one of the required Qt API bindings to enable the hdf5view GUI.

```bash
pip install pyqt5
```

--------------------------------

### Install project dependencies

Source: https://tgwoodcock.github.io/hdf5view/_sources/dev/installing_a_development_environment.rst.txt

Installs the package in editable mode including development-specific dependencies.

```bash
pip install -e .[dev]
```

--------------------------------

### Launch hdf5view from terminal

Source: https://tgwoodcock.github.io/hdf5view/_sources/user/basic_usage.rst.txt

Start the application directly from the command line.

```shell
hdf5view
```

--------------------------------

### Install required dependencies

Source: https://tgwoodcock.github.io/hdf5view/_sources/user/make_demo_data.rst.txt

Installs the numpy and Pillow packages required to run the demo generation script.

```shell
pip install numpy, Pillow
```

--------------------------------

### Install Pre-commit Hook

Source: https://tgwoodcock.github.io/hdf5view/_sources/dev/code_style.rst.txt

Command to install the pre-commit hook for automatic linting and formatting.

```bash
pre-commit install
```

--------------------------------

### Install hdf5view via pip

Source: https://tgwoodcock.github.io/hdf5view/_sources/user/installation.rst.txt

Use this command to install the current release of hdf5view from PyPI.

```bash
pip install hdf5view
```

--------------------------------

### Locate the demo generation script

Source: https://tgwoodcock.github.io/hdf5view/_sources/user/make_demo_data.rst.txt

Shows the directory structure to find the make_demo_hdf5.py script within the hdf5view installation.

```none
-- path-to-my-python-distribution
    |-- Lib
      |-- site-packages
         |-- hdf5view
            |-- resources
               |-- make_demo_hdf5.py
```

--------------------------------

### Specify Qt API via environment variable

Source: https://tgwoodcock.github.io/hdf5view/_sources/user/installation.rst.txt

Set the QT_API environment variable to force the use of a specific Qt binding when multiple are installed.

```powershell
$env:QT_API = 'pyside2'
```

```bash
export QT_API=pyside2
```

--------------------------------

### MainWindow.init_menus()

Source: https://tgwoodcock.github.io/hdf5view/reference/generated/hdf5view.mainwindow.MainWindow.init_menus.html

Initializes the menus for the main application window.

```APIDOC
## MainWindow.init_menus()

### Description
Initializes the menu structure for the MainWindow instance. This method sets up the application's menu bar and associated actions.

### Signature
`MainWindow.init_menus()`
```

--------------------------------

### MainWindow.load_settings()

Source: https://tgwoodcock.github.io/hdf5view/_sources/reference/generated/hdf5view.mainwindow.MainWindow.load_settings.rst.txt

Loads the application settings for the MainWindow instance.

```APIDOC
## MainWindow.load_settings()

### Description
Loads the saved settings for the MainWindow instance, typically used during application initialization to restore the user's previous configuration.

### Signature
`hdf5view.mainwindow.MainWindow.load_settings()`
```

--------------------------------

### MainWindow.init_statusbar()

Source: https://tgwoodcock.github.io/hdf5view/reference/generated/hdf5view.mainwindow.MainWindow.init_statusbar.html

Initializes the status bar for the main window.

```APIDOC
## MainWindow.init_statusbar()

### Description
Initializes the status bar component of the MainWindow.

### Signature
`MainWindow.init_statusbar()`
```

--------------------------------

### MainWindow.init_menus

Source: https://tgwoodcock.github.io/hdf5view/_sources/reference/generated/hdf5view.mainwindow.MainWindow.init_menus.rst.txt

Initializes the menus for the main window of the hdf5view application.

```APIDOC
## MainWindow.init_menus

### Description
Initializes the menu bar and associated menu items for the main application window.

### Signature
`hdf5view.mainwindow.MainWindow.init_menus()`
```

--------------------------------

### MainWindow.init_dock_widgets

Source: https://tgwoodcock.github.io/hdf5view/_sources/reference/generated/hdf5view.mainwindow.MainWindow.init_dock_widgets.rst.txt

Initializes the dock widgets for the main window interface.

```APIDOC
## MainWindow.init_dock_widgets

### Description
Initializes and sets up the dockable widgets for the `MainWindow` instance in `hdf5view.mainwindow`.

### Signature
`MainWindow.init_dock_widgets()`
```

--------------------------------

### MainWindow.init_toolbars

Source: https://tgwoodcock.github.io/hdf5view/_sources/reference/generated/hdf5view.mainwindow.MainWindow.init_toolbars.rst.txt

Initializes the toolbars for the main application window.

```APIDOC
## MainWindow.init_toolbars

### Description
Initializes the toolbars for the main application window. This method is part of the `hdf5view.mainwindow` module.
```

--------------------------------

### Create a virtual environment

Source: https://tgwoodcock.github.io/hdf5view/_sources/dev/installing_a_development_environment.rst.txt

Initializes a new Python virtual environment named dev_hdf5view.

```bash
python -m venv dev_hdf5view
```

--------------------------------

### MainWindow.handle_open_docs()

Source: https://tgwoodcock.github.io/hdf5view/reference/generated/hdf5view.mainwindow.MainWindow.handle_open_docs.html

This method opens the hdf5view documentation in the user's default browser or documentation viewer.

```APIDOC
## MainWindow.handle_open_docs()

### Description
Triggers the opening of the hdf5view documentation.

### Signature
`MainWindow.handle_open_docs()`

### Parameters
None

### Returns
None
```

--------------------------------

### MainWindow.handle_open_prefs()

Source: https://tgwoodcock.github.io/hdf5view/reference/generated/hdf5view.mainwindow.MainWindow.handle_open_prefs.html

Displays the preferences dialog for the main window.

```APIDOC
## MainWindow.handle_open_prefs()

### Description
Displays the preferences dialog to the user within the main application window.

### Signature
`MainWindow.handle_open_prefs()`
```

--------------------------------

### main()

Source: https://tgwoodcock.github.io/hdf5view/_sources/reference/generated/hdf5view.main.rst.txt

The main entry point function for the hdf5view application.

```APIDOC
## main()

### Description
This function serves as the primary entry point for the hdf5view application, typically used to initialize and launch the viewer interface.

### Signature
`hdf5view.main.main()`
```

--------------------------------

### PlotView.set_up_plot()

Source: https://tgwoodcock.github.io/hdf5view/reference/generated/hdf5view.views.PlotView.set_up_plot.html

Initializes the plot display and configures axis labels.

```APIDOC
## PlotView.set_up_plot()

### Description
Sets up the plot shown including the axis labels.

### Signature
`PlotView.set_up_plot()`
```

--------------------------------

### MainWindow.handle_open_about

Source: https://tgwoodcock.github.io/hdf5view/_sources/reference/generated/hdf5view.mainwindow.MainWindow.handle_open_about.rst.txt

Triggers the 'About' dialog for the application.

```APIDOC
## MainWindow.handle_open_about

### Description
Triggers the display of the 'About' dialog within the main application window.

### Signature
`handle_open_about()`

### Module
`hdf5view.mainwindow`
```

--------------------------------

### MainWindow.handle_add_image()

Source: https://tgwoodcock.github.io/hdf5view/reference/generated/hdf5view.mainwindow.MainWindow.handle_add_image.html

Displays an image window within the application.

```APIDOC
## MainWindow.handle_add_image()

### Description
Displays an image window.

### Signature
`MainWindow.handle_add_image()`
```

--------------------------------

### PlotView.set_up_plot

Source: https://tgwoodcock.github.io/hdf5view/_sources/reference/generated/hdf5view.views.PlotView.set_up_plot.rst.txt

Initializes the plot view settings for the HDF5 data visualization.

```APIDOC
## PlotView.set_up_plot

### Description
Initializes the plot view configuration. This method is used to set up the necessary parameters and environment for rendering plots within the PlotView interface.

### Signature
`PlotView.set_up_plot()`
```

--------------------------------

### MainWindow.init_central_widget

Source: https://tgwoodcock.github.io/hdf5view/_sources/reference/generated/hdf5view.mainwindow.MainWindow.init_central_widget.rst.txt

Initializes the central widget for the MainWindow instance.

```APIDOC
## MainWindow.init_central_widget

### Description
Initializes the central widget component within the main application window. This method is part of the `hdf5view.mainwindow` module.

### Signature
`MainWindow.init_central_widget()`
```

--------------------------------

### Clone the repository

Source: https://tgwoodcock.github.io/hdf5view/_sources/dev/installing_a_development_environment.rst.txt

Navigates into the virtual environment directory and clones the user's fork of the repository.

```bash
cd dev_hdf5view
git clone https://github.com/your-username/hdf5view.git
```

--------------------------------

### MainWindow.handle_open_file()

Source: https://tgwoodcock.github.io/hdf5view/reference/generated/hdf5view.mainwindow.MainWindow.handle_open_file.html

This method is used to open a file within the MainWindow interface.

```APIDOC
## MainWindow.handle_open_file()

### Description
Opens a file dialog or triggers the file opening process within the main application window.

### Signature
`MainWindow.handle_open_file()`
```

--------------------------------

### MainWindow

Source: https://tgwoodcock.github.io/hdf5view/_sources/reference/generated/hdf5view.mainwindow.rst.txt

The MainWindow class is the primary entry point for the hdf5view graphical user interface.

```APIDOC
## class MainWindow

### Description
Represents the main application window for hdf5view. This class manages the primary interface and user interactions for viewing HDF5 files.
```

--------------------------------

### MainWindow.open_file

Source: https://tgwoodcock.github.io/hdf5view/_sources/reference/generated/hdf5view.mainwindow.MainWindow.open_file.rst.txt

Opens an HDF5 file in the main window application.

```APIDOC
## MainWindow.open_file

### Description
Opens a specified HDF5 file within the application's main window interface.

### Signature
`MainWindow.open_file(filename)`
```

--------------------------------

### Activate the virtual environment

Source: https://tgwoodcock.github.io/hdf5view/_sources/dev/installing_a_development_environment.rst.txt

Activates the virtual environment based on the host operating system.

```powershell
.\Scripts\Activate.ps1
```

```bash
source bin/activate
```

--------------------------------

### MainWindow.handle_open_file

Source: https://tgwoodcock.github.io/hdf5view/_sources/reference/generated/hdf5view.mainwindow.MainWindow.handle_open_file.rst.txt

The handle_open_file method is a member of the MainWindow class in the hdf5view.mainwindow module. It is intended to be invoked to initiate the file selection and opening workflow.

```APIDOC
## MainWindow.handle_open_file

### Description
Triggers the file opening dialog and handles the subsequent loading of an HDF5 file into the application.

### Signature
`handle_open_file()`
```

--------------------------------

### Windows Registry structure for context menu

Source: https://tgwoodcock.github.io/hdf5view/_sources/user/basic_usage.rst.txt

The required registry key hierarchy for adding the application to the context menu.

```none
-- Computer
    |-- HKEY_CLASSES_ROOT
      |-- *
         |-- shell
            |-- Open with hdf5view
               |-- command
```

--------------------------------

### MainWindow.handle_open_docs

Source: https://tgwoodcock.github.io/hdf5view/_sources/reference/generated/hdf5view.mainwindow.MainWindow.handle_open_docs.rst.txt

The handle_open_docs method is a member of the MainWindow class used to trigger the opening of documentation.

```APIDOC
## MainWindow.handle_open_docs

### Description
Triggers the action to open the documentation associated with the application.

### Signature
`hdf5view.mainwindow.MainWindow.handle_open_docs()`
```

--------------------------------

### HDF5Widget.init_signals()

Source: https://tgwoodcock.github.io/hdf5view/reference/generated/hdf5view.views.HDF5Widget.init_signals.html

Initializes the view signals for the HDF5Widget instance.

```APIDOC
## HDF5Widget.init_signals()

### Description
Initialise the view signals for the HDF5Widget component.

### Signature
`HDF5Widget.init_signals()`
```

--------------------------------

### MainWindow.save_settings

Source: https://tgwoodcock.github.io/hdf5view/_sources/reference/generated/hdf5view.mainwindow.MainWindow.save_settings.rst.txt

Saves the current settings for the MainWindow.

```APIDOC
## MainWindow.save_settings

### Description
Persists the current configuration settings of the MainWindow instance to the application's settings storage.

### Signature
`MainWindow.save_settings()`
```

--------------------------------

### MainWindow.dragEnterEvent(event)

Source: https://tgwoodcock.github.io/hdf5view/reference/generated/hdf5view.mainwindow.MainWindow.dragEnterEvent.html

Handles the drag enter event to accept dropped files into the MainWindow.

```APIDOC
## MainWindow.dragEnterEvent(event)

### Description
Accepts any dropped files during a drag-and-drop operation within the MainWindow.

### Parameters
- **event** (QDragEnterEvent) - Required - The drag enter event object.
```

--------------------------------

### Open HDF5 Files via Command Line

Source: https://tgwoodcock.github.io/hdf5view/user/basic_usage.html

Open one or multiple HDF5 files by passing paths as arguments to the -f flag.

```bash
hdf5view -f <path/to/my/hdf5file>
```

```bash
hdf5view -f <path/to/first_hdf5file> -f <path/to/second_hdf5file>
```

--------------------------------

### MainWindow.handle_add_image

Source: https://tgwoodcock.github.io/hdf5view/_sources/reference/generated/hdf5view.mainwindow.MainWindow.handle_add_image.rst.txt

The handle_add_image method is an internal method of the MainWindow class used to trigger the image addition workflow.

```APIDOC
## MainWindow.handle_add_image

### Description
Handles the action of adding an image to the current HDF5 view interface.

### Signature
`MainWindow.handle_add_image()`
```

--------------------------------

### ImageView.init_signals

Source: https://tgwoodcock.github.io/hdf5view/_sources/reference/generated/hdf5view.views.ImageView.init_signals.rst.txt

Initializes the signals for the ImageView component.

```APIDOC
## ImageView.init_signals

### Description
Initializes the signals for the ImageView component within the hdf5view.views module.
```

--------------------------------

### MainWindow.handle_open_recent_file

Source: https://tgwoodcock.github.io/hdf5view/_sources/reference/generated/hdf5view.mainwindow.MainWindow.handle_open_recent_file.rst.txt

Method to trigger the opening of a file from the recent files list within the main application window.

```APIDOC
## MainWindow.handle_open_recent_file

### Description
Handles the action of opening a file that has been previously accessed, typically triggered by a user selection from a 'Recent Files' menu.

### Signature
`handle_open_recent_file()`
```

--------------------------------

### PlotView.init_signals

Source: https://tgwoodcock.github.io/hdf5view/_sources/reference/generated/hdf5view.views.PlotView.init_signals.rst.txt

Initializes the signals for the PlotView instance.

```APIDOC
## PlotView.init_signals

### Description
Initializes the signal connections for the PlotView component. This method is typically called during the initialization phase of the view to set up event handling.

### Signature
`PlotView.init_signals()`
```

--------------------------------

### Stage and commit changes

Source: https://tgwoodcock.github.io/hdf5view/_sources/dev/using_git.rst.txt

Stages files and commits them with a descriptive message, triggering linting and formatting.

```bash
git add my-file-or-directory
git commit -m "An explanatory commit message"
```

--------------------------------

### MainWindow.handle_close_all_files

Source: https://tgwoodcock.github.io/hdf5view/_sources/reference/generated/hdf5view.mainwindow.MainWindow.handle_close_all_files.rst.txt

Method to trigger the closing of all files currently managed by the MainWindow instance.

```APIDOC
## MainWindow.handle_close_all_files

### Description
Closes all files currently open in the MainWindow application instance.

### Signature
`handle_close_all_files()`
```

--------------------------------

### Create a new feature branch

Source: https://tgwoodcock.github.io/hdf5view/_sources/dev/using_git.rst.txt

Initializes a new branch tracking the upstream develop branch.

```bash
git checkout develop -b your-awesome-feature-name upstream/develop
```

--------------------------------

### Windows Registry command value

Source: https://tgwoodcock.github.io/hdf5view/_sources/user/basic_usage.rst.txt

The command string to be entered in the registry for the context menu action.

```text
C:\Program Files\PythonXXX\Scripts\hdf5view.exe -f "%1"
```

--------------------------------

### Ruff Linter Configuration Rules

Source: https://tgwoodcock.github.io/hdf5view/_sources/dev/code_style.rst.txt

List of rule sets enabled for the ruff linter and formatter.

```text
"B",   # flake8-bugbear
"D",   # pydocstyle
"E",   # pycodestyle
"F",   # Pyflakes
"I",   # isort
"SIM", # flake8-simplify
"UP",  # pyupgrade
```

--------------------------------

### MainWindow.update_file_menus

Source: https://tgwoodcock.github.io/hdf5view/_sources/reference/generated/hdf5view.mainwindow.MainWindow.update_file_menus.rst.txt

Updates the file menus in the main window to reflect current state or open files.

```APIDOC
## MainWindow.update_file_menus

### Description
Updates the file-related menus in the main application window. This method is typically called when the state of open files changes to ensure the UI accurately reflects the current file list.

### Signature
`update_file_menus()`
```

--------------------------------

### Configure upstream remote

Source: https://tgwoodcock.github.io/hdf5view/_sources/dev/installing_a_development_environment.rst.txt

Adds the main hdf5view repository as an upstream remote for tracking changes.

```bash
cd hdf5view
git remote add upstream https://github.com/tgwoodcock/hdf5view.git
```

--------------------------------

### Open HDF5 file from terminal

Source: https://tgwoodcock.github.io/hdf5view/_sources/user/basic_usage.rst.txt

Open a specific HDF5 file by providing its path as an argument.

```shell
hdf5view -f <path/to/my/hdf5file>
```

--------------------------------

### MainWindow.handle_tab_changed(index)

Source: https://tgwoodcock.github.io/hdf5view/reference/generated/hdf5view.mainwindow.MainWindow.handle_tab_changed.html

Updates the dock widget views based on the provided tab index.

```APIDOC
## MainWindow.handle_tab_changed(index)

### Description
Sets the views in the dock widgets appropriately when a tab change event is triggered.

### Parameters
- **index** (int) - The index of the newly selected tab.
```

--------------------------------

### MainWindow.get_dropped_files

Source: https://tgwoodcock.github.io/hdf5view/_sources/reference/generated/hdf5view.mainwindow.MainWindow.get_dropped_files.rst.txt

Retrieves the list of files dropped onto the main window.

```APIDOC
## MainWindow.get_dropped_files

### Description
Retrieves a list of file paths that have been dropped onto the MainWindow instance.

### Signature
`MainWindow.get_dropped_files()`
```

--------------------------------

### Convert dimension strings to indexing objects

Source: https://tgwoodcock.github.io/hdf5view/reference/generated/hdf5view.models.get_dims_from_str.html

Demonstrates converting user-provided dimension strings into Python slice and integer objects for array indexing.

```python
>>> from hdf5view.models import get_dims_from_str
>>> get_dims_from_str(("0", "0", ":"))
(0, 0, slice(None, None, None))
>>> get_dims_from_str(("2:6:2", ":", "2", "3"))
(slice(2, 6, 2), slice(None, None, None), 2, 3)
```

--------------------------------

### MainWindow.handle_close_file(index=None)

Source: https://tgwoodcock.github.io/hdf5view/reference/generated/hdf5view.mainwindow.MainWindow.handle_close_file.html

Closes a file associated with the provided index in the MainWindow.

```APIDOC
## MainWindow.handle_close_file(index=None)

### Description
Closes an HDF5 file currently managed by the MainWindow. If an index is provided, it closes the specific file; otherwise, it handles the close operation for the current context.

### Parameters
- **index** (optional) - The index of the file to be closed.
```

--------------------------------

### MainWindow.dropEvent

Source: https://tgwoodcock.github.io/hdf5view/_sources/reference/generated/hdf5view.mainwindow.MainWindow.dropEvent.rst.txt

Handles the drop event for the MainWindow component.

```APIDOC
## MainWindow.dropEvent

### Description
Handles the drop event for the MainWindow component, allowing the application to process files or data dropped onto the interface.

### Signature
`hdf5view.mainwindow.MainWindow.dropEvent(event)`
```

--------------------------------

### HDF5Widget.check_node_size(memory_ratio, path)

Source: https://tgwoodcock.github.io/hdf5view/reference/generated/hdf5view.views.HDF5Widget.check_node_size.html

Checks if the memory ratio of a dataset exceeds the system limit and prompts the user for confirmation if it does.

```APIDOC
## HDF5Widget.check_node_size(memory_ratio, path)

### Description
Checks if the provided memory_ratio exceeds the internal memory limit. If exceeded, a warning dialog is displayed to the user to confirm whether to proceed with loading the node.

### Parameters
- **memory_ratio** (FLOAT) - The ratio of the critical dimension of the dataset selected, in bytes, to the available memory on the system.
- **path** (STR) - Path to a dataset within the HDF5 file.

### Returns
- **Bool** - Returns True if the memory_ratio is within limits or if the user confirms to proceed. Returns False if the user cancels the operation.
```

--------------------------------

### HDF5Widget Methods

Source: https://tgwoodcock.github.io/hdf5view/_sources/reference/generated/hdf5view.views.HDF5Widget.rst.txt

Public methods available for the HDF5Widget class.

```APIDOC
## HDF5Widget Methods

- **add_image**: Adds an image to the widget.
- **add_plot**: Adds a plot to the widget.
- **calculate_memory_ratio**: Calculates the memory ratio for the widget.
- **check_node_size**: Checks the size of a specific node.
- **close_file**: Closes the currently opened HDF5 file.
- **handle_close_tab**: Handles the closing of a tab.
- **handle_dims_data_changed**: Handles changes in dimension data.
- **handle_selection_changed**: Handles changes in user selection.
- **handle_tab_changed**: Handles changes in the active tab.
- **init_signals**: Initializes the signals for the widget.
```

--------------------------------

### HDF5Widget.add_image

Source: https://tgwoodcock.github.io/hdf5view/_sources/reference/generated/hdf5view.views.HDF5Widget.add_image.rst.txt

Method signature and documentation for adding an image to the HDF5Widget.

```APIDOC
## HDF5Widget.add_image

### Description
Adds an image to the HDF5Widget instance.

### Signature
`hdf5view.views.HDF5Widget.add_image()`
```

--------------------------------

### HDF5Widget.calculate_memory_ratio(path)

Source: https://tgwoodcock.github.io/hdf5view/reference/generated/hdf5view.views.HDF5Widget.calculate_memory_ratio.html

Calculates the memory ratio for a specified dataset path, representing the proportion of the dataset's critical dimension relative to available system memory.

```APIDOC
## HDF5Widget.calculate_memory_ratio(path)

### Description
Calculates the memory ratio for a dataset. It identifies the critical dimension (dim_crit) in bytes and returns the ratio of this value to the total available memory on the system.

### Parameters
- **path** (STR) - Required - The path to a dataset within the HDF5 file.

### Returns
- **Float** - The ratio of the critical dimension of the selected dataset to the available system memory.
```

--------------------------------

### MainWindow.handle_close_file

Source: https://tgwoodcock.github.io/hdf5view/_sources/reference/generated/hdf5view.mainwindow.MainWindow.handle_close_file.rst.txt

The handle_close_file method is used to trigger the file closing process in the main window interface.

```APIDOC
## MainWindow.handle_close_file

### Description
Handles the closing of a file within the hdf5view main window application.

### Signature
`hdf5view.mainwindow.MainWindow.handle_close_file()`
```

--------------------------------

### ImageView Methods

Source: https://tgwoodcock.github.io/hdf5view/_sources/reference/generated/hdf5view.views.ImageView.rst.txt

The following methods are available for the ImageView class to manage image interaction, signals, and display updates.

```APIDOC
## ImageView Methods

- **handle_mouse_moved**: Handles mouse movement events within the image view.
- **handle_scroll**: Handles scroll events for zooming or panning the image.
- **horizontalOffset**: Retrieves or sets the horizontal scroll offset.
- **init_signals**: Initializes the signal-slot connections for the view.
- **moveCursor**: Updates the position of the cursor in the view.
- **update_image**: Refreshes the displayed image content.
- **verticalOffset**: Retrieves or sets the vertical scroll offset.
```

--------------------------------

### Open multiple HDF5 files from terminal

Source: https://tgwoodcock.github.io/hdf5view/_sources/user/basic_usage.rst.txt

Open several files in a single window by repeating the -f flag.

```shell
hdf5view -f <path/to/first_hdf5file> -f <path/to/second_hdf5file>
```

--------------------------------

### Push changes to remote

Source: https://tgwoodcock.github.io/hdf5view/_sources/dev/using_git.rst.txt

Pushes the local branch to the remote origin repository.

```bash
git push -u origin your-awesome-feature-name
```

--------------------------------

### ImageView.horizontalOffset

Source: https://tgwoodcock.github.io/hdf5view/_sources/reference/generated/hdf5view.views.ImageView.horizontalOffset.rst.txt

Reference documentation for the horizontalOffset method within the ImageView class.

```APIDOC
## ImageView.horizontalOffset

### Description
Retrieves or sets the horizontal offset for the ImageView component.

### Signature
`hdf5view.views.ImageView.horizontalOffset`
```

--------------------------------

### Uninstall hdf5view

Source: https://tgwoodcock.github.io/hdf5view/_sources/user/installation.rst.txt

Remove the hdf5view package from the current environment.

```bash
pip uninstall hdf5view
```

--------------------------------

### HDF5Widget.check_node_size

Source: https://tgwoodcock.github.io/hdf5view/_sources/reference/generated/hdf5view.views.HDF5Widget.check_node_size.rst.txt

Method signature and documentation for checking the size of a node in the HDF5 widget.

```APIDOC
## HDF5Widget.check_node_size

### Description
Checks the size of a specific node within the HDF5 widget interface.

### Signature
`hdf5view.views.HDF5Widget.check_node_size()`
```

--------------------------------

### HDF5Widget.calculate_memory_ratio

Source: https://tgwoodcock.github.io/hdf5view/_sources/reference/generated/hdf5view.views.HDF5Widget.calculate_memory_ratio.rst.txt

Calculates the memory ratio for the HDF5Widget component.

```APIDOC
## HDF5Widget.calculate_memory_ratio

### Description
Calculates the memory ratio for the HDF5Widget instance. This method is used to determine memory usage characteristics within the widget.

### Signature
`HDF5Widget.calculate_memory_ratio()`
```

--------------------------------

### HDF5Widget.handle_selection_changed

Source: https://tgwoodcock.github.io/hdf5view/_sources/reference/generated/hdf5view.views.HDF5Widget.handle_selection_changed.rst.txt

Method signature for handling selection changes in the HDF5Widget.

```APIDOC
## HDF5Widget.handle_selection_changed

### Description
Handles the selection changed event for the HDF5Widget component.

### Signature
`hdf5view.views.HDF5Widget.handle_selection_changed()`
```

--------------------------------

### ImageModel.headerData(section, orientation, role)

Source: https://tgwoodcock.github.io/hdf5view/reference/generated/hdf5view.models.ImageModel.headerData.html

Retrieves data concerning the header for a specific section, orientation, and role.

```APIDOC
## ImageModel.headerData(section, orientation, role)

### Description
Returns data concerning the header for the specified section, orientation, and role.

### Parameters
- **section** (int) - The section index.
- **orientation** (Qt.Orientation) - The orientation of the header (horizontal or vertical).
- **role** (int) - The role for which the data is requested.
```

--------------------------------

### DatasetTableModel.headerData(section, orientation, role)

Source: https://tgwoodcock.github.io/hdf5view/reference/generated/hdf5view.models.DatasetTableModel.headerData.html

Retrieves data concerning the header for a specific section, orientation, and role.

```APIDOC
## DatasetTableModel.headerData(section, orientation, role)

### Description
Returns data concerning the header for the specified section, orientation, and role.

### Parameters
- **section** (int) - The section index of the header.
- **orientation** (Qt.Orientation) - The orientation of the header (horizontal or vertical).
- **role** (int) - The role for which the data is requested.
```

--------------------------------

### HDF5Widget(hdf)

Source: https://tgwoodcock.github.io/hdf5view/reference/generated/hdf5view.views.html

The main container widget for displaying HDF5 data structures.

```APIDOC
## HDF5Widget(hdf)

### Description
Main HDF5 view container widget used to host and display HDF5 data.

### Parameters
- **hdf** (object) - The HDF5 data source to be displayed in the widget.
```

--------------------------------

### PlotView.horizontalOffset

Source: https://tgwoodcock.github.io/hdf5view/_sources/reference/generated/hdf5view.views.PlotView.horizontalOffset.rst.txt

Reference documentation for the horizontalOffset method of the PlotView class.

```APIDOC
## PlotView.horizontalOffset

### Description
Retrieves or sets the horizontal offset for the PlotView component.

### Signature
`hdf5view.views.PlotView.horizontalOffset`
```

--------------------------------

### MainWindow.handle_tree_selection_changed

Source: https://tgwoodcock.github.io/hdf5view/_sources/reference/generated/hdf5view.mainwindow.MainWindow.handle_tree_selection_changed.rst.txt

Handles the event triggered when the selection in the tree view changes.

```APIDOC
## MainWindow.handle_tree_selection_changed

### Description
This method is an internal handler for the tree selection change event within the main window of the hdf5view application. It is triggered when a user selects a different item in the tree view interface.

### Signature
`handle_tree_selection_changed(self)`
```

--------------------------------

### HDF5Widget.handle_close_tab

Source: https://tgwoodcock.github.io/hdf5view/_sources/reference/generated/hdf5view.views.HDF5Widget.handle_close_tab.rst.txt

Method signature and documentation for handling the closing of a tab in the HDF5Widget interface.

```APIDOC
## HDF5Widget.handle_close_tab

### Description
Handles the event triggered when a tab is closed within the HDF5Widget component.

### Signature
`hdf5view.views.HDF5Widget.handle_close_tab()`
```

--------------------------------

### ImageView(model, dims_model)

Source: https://tgwoodcock.github.io/hdf5view/reference/generated/hdf5view.views.html

A view class for rendering greyscale or RGB(A) images from an ImageModel.

```APIDOC
## ImageView(model, dims_model)

### Description
Displays a greyscale or rgb(a) image view based on the provided data model.

### Parameters
- **model** (object) - The ImageModel containing the image data.
- **dims_model** (object) - The dimensions model defining the image structure.
```

--------------------------------

### ImageView.moveCursor

Source: https://tgwoodcock.github.io/hdf5view/_sources/reference/generated/hdf5view.views.ImageView.moveCursor.rst.txt

Method to move the cursor in the ImageView component.

```APIDOC
## ImageView.moveCursor

### Description
Updates the cursor position within the ImageView instance.

### Signature
`ImageView.moveCursor()`
```

--------------------------------

### PlotView.moveCursor

Source: https://tgwoodcock.github.io/hdf5view/_sources/reference/generated/hdf5view.views.PlotView.moveCursor.rst.txt

Method signature and usage for moving the cursor in the PlotView component.

```APIDOC
## PlotView.moveCursor

### Description
Updates the cursor position within the PlotView instance.

### Signature
`hdf5view.views.PlotView.moveCursor()`
```

--------------------------------

### ImageView.handle_mouse_moved

Source: https://tgwoodcock.github.io/hdf5view/_sources/reference/generated/hdf5view.views.ImageView.handle_mouse_moved.rst.txt

Handles mouse movement events for the ImageView component.

```APIDOC
## ImageView.handle_mouse_moved

### Description
Handles mouse movement events within the ImageView component. This method is part of the hdf5view.views module.

### Signature
`ImageView.handle_mouse_moved(event)`
```

--------------------------------

### MainWindow.handle_tree_selection_changed()

Source: https://tgwoodcock.github.io/hdf5view/reference/generated/hdf5view.mainwindow.MainWindow.handle_tree_selection_changed.html

Enables or disables the plots toolbar when the tree selection changes in the user interface.

```APIDOC
## MainWindow.handle_tree_selection_changed()

### Description
Enables or disables the plots toolbar when the tree selection changes.

### Signature
`MainWindow.handle_tree_selection_changed()`
```

--------------------------------

### Update local develop branch

Source: https://tgwoodcock.github.io/hdf5view/_sources/dev/using_git.rst.txt

Switches to the develop branch and pulls the latest changes from upstream.

```bash
git checkout develop
git pull upstream develop --tags
```

--------------------------------

### PlotView.handle_scroll

Source: https://tgwoodcock.github.io/hdf5view/_sources/reference/generated/hdf5view.views.PlotView.handle_scroll.rst.txt

Method signature for handling scroll events in the PlotView component.

```APIDOC
## PlotView.handle_scroll

### Description
Handles scroll events for the PlotView component.

### Signature
`hdf5view.views.PlotView.handle_scroll`
```

--------------------------------

### Default Slice Configuration

Source: https://tgwoodcock.github.io/hdf5view/_sources/user/plot_tab.rst.txt

The default slice applied to a dataset depends on its number of dimensions and specific shape characteristics.

```text
ndim = 1: all the data are plotted against the index, Slice: ``:``
ndim = 1 with compound names: the data in the first column are plotted, Slice: ``:, 0``.
ndim = 2: all the rows of the first column are plotted, Slice: ``:, 0``
ndim > 2 and shape[-1] in [3, 4]: here we assume that the data are rgb(a) images and plot as default all the rows of the -3rd axis in the first column of the -2nd axis and the first column of the -1st axis (red channel), last 3 axes of Slice: ``:, 0, 0``.
ndim > 2 and shape[-1] Not in [3, 4]: we plot as default all the rows of the -2nd axis in the first column of the -1st axis, last 2 axes of Slice ``:, 0``.
```

--------------------------------

### MainWindow.handle_add_plot

Source: https://tgwoodcock.github.io/hdf5view/_sources/reference/generated/hdf5view.mainwindow.MainWindow.handle_add_plot.rst.txt

The handle_add_plot method is a member of the MainWindow class used to trigger the plot addition functionality within the application interface.

```APIDOC
## MainWindow.handle_add_plot

### Description
Triggers the action to add a new plot to the current view within the MainWindow.

### Signature
`handle_add_plot()`
```

--------------------------------

### HDF5Widget.handle_tab_changed()

Source: https://tgwoodcock.github.io/hdf5view/reference/generated/hdf5view.views.HDF5Widget.handle_tab_changed.html

This method handles the logic for tab changes in the HDF5Widget, ensuring that dimension settings are preserved per tab while resetting the view dimensions.

```APIDOC
## HDF5Widget.handle_tab_changed()

### Description
This method is triggered when a tab is changed within the HDF5Widget. It preserves the dimensions for each tab and resets the `dims_view` property.

### Signature
`HDF5Widget.handle_tab_changed()`
```

--------------------------------

### ImageView.handle_mouse_moved(pos)

Source: https://tgwoodcock.github.io/hdf5view/reference/generated/hdf5view.views.ImageView.handle_mouse_moved.html

Updates the cursor position when the mouse moves in the image scene.

```APIDOC
## ImageView.handle_mouse_moved(pos)

### Description
Updates the cursor position when the mouse moves in the image scene.

### Parameters
- **pos** (object) - Required - The position coordinates of the mouse.
```

--------------------------------

### get_dims_from_str(dims_as_str)

Source: https://tgwoodcock.github.io/hdf5view/reference/generated/hdf5view.models.get_dims_from_str.html

Converts user-provided dimension strings into Python indexing objects (ints or slices).

```APIDOC
## get_dims_from_str(dims_as_str)

### Description
Takes a tuple of strings describing desired dimensions and converts them into a tuple of integers and/or slice objects, which can be used to index a dataset.

### Parameters
- **dims_as_str** (Tuple) - Required - A tuple of strings representing dimensions, e.g., ("0", "0", ":") or ("2:6:2", ":", "2", "3").

### Returns
- **Tuple** - A tuple of ints and/or slice objects, e.g., (0, 0, slice(None, None, None)).

### Example
```python
from hdf5view.models import get_dims_from_str
get_dims_from_str(("0", "0", ":"))
# Returns: (0, 0, slice(None, None, None))

get_dims_from_str(("2:6:2", ":", "2", "3"))
# Returns: (slice(2, 6, 2), slice(None, None, None), 2, 3)
```
```

--------------------------------

### get_dims_from_str

Source: https://tgwoodcock.github.io/hdf5view/_sources/reference/generated/hdf5view.models.get_dims_from_str.rst.txt

Parses a string representation of dimensions into a usable format.

```APIDOC
## Function: get_dims_from_str

### Description
Parses a string representation of dimensions into a format suitable for HDF5 data structures.

### Signature
`hdf5view.models.get_dims_from_str(dim_str)`
```

--------------------------------

### ImageView.handle_scroll

Source: https://tgwoodcock.github.io/hdf5view/_sources/reference/generated/hdf5view.views.ImageView.handle_scroll.rst.txt

The handle_scroll method is a member of the ImageView class used to process scroll interactions.

```APIDOC
## ImageView.handle_scroll

### Description
Handles scroll events within the ImageView component.

### Signature
`hdf5view.views.ImageView.handle_scroll(self, event)`
```

--------------------------------

### DataTableModel.headerData(section, orientation, role)

Source: https://tgwoodcock.github.io/hdf5view/reference/generated/hdf5view.models.DataTableModel.headerData.html

Retrieves data concerning the header for a specific section, orientation, and role.

```APIDOC
## DataTableModel.headerData(section, orientation, role)

### Description
Returns data concerning the header for the specified section, orientation, and role.

### Signature
`DataTableModel.headerData(section, orientation, role)`

### Parameters
- **section** (int) - The index of the header section.
- **orientation** (Qt.Orientation) - The orientation of the header (horizontal or vertical).
- **role** (int) - The role for which the data is requested.
```

--------------------------------

### ImageModel.set_dims(dims)

Source: https://tgwoodcock.github.io/hdf5view/reference/generated/hdf5view.models.ImageModel.set_dims.html

Updates the model dimensions to match the provided input dimensions.

```APIDOC
## ImageModel.set_dims(dims)

### Description
Sets the dimensions of the model. This function is typically invoked when the dimensions in the HDF5Widget.dims_view are edited, ensuring the model's internal state remains synchronized with the user-provided dimensions.

### Parameters
- **dims** (Any) - The new dimensions to be applied to the model.
```

--------------------------------

### PlotView(model, dims_model)

Source: https://tgwoodcock.github.io/hdf5view/reference/generated/hdf5view.views.html

A view class for rendering y(x) plots from a PlotModel.

```APIDOC
## PlotView(model, dims_model)

### Description
Displays a y(x) plot view based on the provided data model.

### Parameters
- **model** (object) - The PlotModel containing the plot data.
- **dims_model** (object) - The dimensions model defining the plot axes.
```

--------------------------------

### TreeModel.add_node(parent_item, name, node)

Source: https://tgwoodcock.github.io/hdf5view/reference/generated/hdf5view.models.TreeModel.add_node.html

Adds a node to the tree model and returns the corresponding tree item.

```APIDOC
## TreeModel.add_node(parent_item, name, node)

### Description
Adds a new node to the tree model structure and returns a tree item object describing the added node.

### Parameters
- **parent_item** - The parent item under which the new node will be added.
- **name** - The name of the node to be added.
- **node** - The node object to be added to the tree.

### Returns
- **tree item** - An object representing the newly added node in the tree.
```

--------------------------------

### ImageView.handle_scroll(value)

Source: https://tgwoodcock.github.io/hdf5view/reference/generated/hdf5view.views.ImageView.handle_scroll.html

Changes the image frame based on the scroll value provided.

```APIDOC
## ImageView.handle_scroll(value)

### Description
Changes the image frame on scroll.

### Parameters
- **value** (unknown) - Required - The scroll value used to determine the new image frame.
```

--------------------------------

### HDF5Widget.close_file

Source: https://tgwoodcock.github.io/hdf5view/_sources/reference/generated/hdf5view.views.HDF5Widget.close_file.rst.txt

Closes the currently opened HDF5 file within the HDF5Widget instance.

```APIDOC
## HDF5Widget.close_file

### Description
Closes the HDF5 file currently managed by the HDF5Widget instance.

### Method
Method call on HDF5Widget object

### Signature
`HDF5Widget.close_file()`
```

--------------------------------

### HDF5Widget.handle_selection_changed(selected, deselected)

Source: https://tgwoodcock.github.io/hdf5view/reference/generated/hdf5view.views.HDF5Widget.handle_selection_changed.html

Updates the node path on models and refreshes data in associated table views when the selection changes on the tree view.

```APIDOC
## HDF5Widget.handle_selection_changed(selected, deselected)

### Description
Updates the node path on the models and refreshes the data in the associated table views when the selection changes on the tree view.

### Parameters
- **selected** (Any) - The items that have been selected.
- **deselected** (Any) - The items that have been deselected.
```

--------------------------------

### ImageView.verticalOffset

Source: https://tgwoodcock.github.io/hdf5view/_sources/reference/generated/hdf5view.views.ImageView.verticalOffset.rst.txt

Access the verticalOffset method of the ImageView class.

```APIDOC
## ImageView.verticalOffset

### Description
Retrieves or sets the vertical offset for the ImageView component.

### Signature
`hdf5view.views.ImageView.verticalOffset`
```

--------------------------------

### HDF5Widget.add_plot

Source: https://tgwoodcock.github.io/hdf5view/_sources/reference/generated/hdf5view.views.HDF5Widget.add_plot.rst.txt

Method signature and usage for adding a plot to the HDF5Widget.

```APIDOC
## HDF5Widget.add_plot

### Description
Adds a plot to the HDF5Widget instance.

### Signature
`HDF5Widget.add_plot()`
```

--------------------------------

### Rebase feature branch

Source: https://tgwoodcock.github.io/hdf5view/_sources/dev/using_git.rst.txt

Updates the feature branch by rebasing it onto the current develop branch.

```bash
git checkout your-awesome-feature-name
git rebase develop
```

--------------------------------

### PlotView.handle_mouse_moved(pos)

Source: https://tgwoodcock.github.io/hdf5view/reference/generated/hdf5view.views.PlotView.handle_mouse_moved.html

Updates the cursor position when the mouse moves in the image scene.

```APIDOC
## PlotView.handle_mouse_moved(pos)

### Description
Updates the cursor position when the mouse moves in the image scene.

### Parameters
- **pos** (object) - Required - The position coordinates of the mouse.
```

--------------------------------

### PlotView.verticalOffset

Source: https://tgwoodcock.github.io/hdf5view/_sources/reference/generated/hdf5view.views.PlotView.verticalOffset.rst.txt

The verticalOffset method allows users to manage or retrieve the vertical offset configuration for a PlotView instance.

```APIDOC
## PlotView.verticalOffset

### Description
Retrieves or sets the vertical offset for the PlotView component.

### Signature
`hdf5view.views.PlotView.verticalOffset`
```

--------------------------------

### ImageView.update_image

Source: https://tgwoodcock.github.io/hdf5view/_sources/reference/generated/hdf5view.views.ImageView.update_image.rst.txt

Updates the image view component within the hdf5view interface.

```APIDOC
## ImageView.update_image

### Description
Updates the image displayed in the ImageView component.

### Signature
`ImageView.update_image()`
```

--------------------------------

### PlotView.handle_mouse_moved

Source: https://tgwoodcock.github.io/hdf5view/_sources/reference/generated/hdf5view.views.PlotView.handle_mouse_moved.rst.txt

This method handles mouse movement events for the PlotView component.

```APIDOC
## PlotView.handle_mouse_moved

### Description
Handles mouse movement events within the PlotView interface.

### Signature
`hdf5view.views.PlotView.handle_mouse_moved(self, event)`
```

--------------------------------

### HDF5Widget.handle_dims_data_changed

Source: https://tgwoodcock.github.io/hdf5view/_sources/reference/generated/hdf5view.views.HDF5Widget.handle_dims_data_changed.rst.txt

Handles updates to dimension data within the HDF5Widget component.

```APIDOC
## HDF5Widget.handle_dims_data_changed

### Description
This method is triggered when dimension data changes within the HDF5Widget. It updates the internal state or view to reflect the new dimension configuration.

### Signature
`HDF5Widget.handle_dims_data_changed()`
```

--------------------------------

### DatasetTableModel.update_node(path)

Source: https://tgwoodcock.github.io/hdf5view/reference/generated/hdf5view.models.DatasetTableModel.update_node.html

Updates the current node path in the DatasetTableModel.

```APIDOC
## DatasetTableModel.update_node(path)

### Description
Updates the current node path for the DatasetTableModel instance.

### Parameters
- **path** (str) - The new path to be set for the node.
```

--------------------------------

### ImageView.update_image()

Source: https://tgwoodcock.github.io/hdf5view/reference/generated/hdf5view.views.ImageView.update_image.html

Updates the image displayed in the ImageView component.

```APIDOC
## ImageView.update_image()

### Description
Updates the image currently displayed in the ImageView component.

### Signature
`ImageView.update_image()`
```

--------------------------------

### HDF5Widget.handle_dims_data_changed(topLeft, bottomRight, roles)

Source: https://tgwoodcock.github.io/hdf5view/reference/generated/hdf5view.views.HDF5Widget.handle_dims_data_changed.html

Updates the dimensions displayed in the table based on the provided range and roles.

```APIDOC
## HDF5Widget.handle_dims_data_changed

### Description
Sets the dimensions to display in the table.

### Signature
`HDF5Widget.handle_dims_data_changed(topLeft, bottomRight, roles)`

### Parameters
- **topLeft** (object) - The top-left index of the changed data range.
- **bottomRight** (object) - The bottom-right index of the changed data range.
- **roles** (list) - The roles associated with the data change.
```

--------------------------------

### PlotView.moveCursor(cursorAction, modifiers)

Source: https://tgwoodcock.github.io/hdf5view/reference/generated/hdf5view.views.PlotView.moveCursor.html

Moves the cursor within the PlotView based on the specified action and keyboard modifiers.

```APIDOC
## PlotView.moveCursor

### Description
Moves the cursor in the PlotView component based on the provided action and modifier keys.

### Signature
`PlotView.moveCursor(cursorAction, modifiers)`

### Parameters
- **cursorAction** - The action to perform for moving the cursor.
- **modifiers** - The keyboard modifiers associated with the move action.

### Returns
- **QModelIndex** - The resulting index after the move operation.
```

--------------------------------

### PlotView.horizontalOffset()

Source: https://tgwoodcock.github.io/hdf5view/reference/generated/hdf5view.views.PlotView.horizontalOffset.html

Returns the horizontal offset value for the PlotView instance.

```APIDOC
## PlotView.horizontalOffset()

### Description
Returns the horizontal offset value for the PlotView. This method currently returns zero.

### Signature
`PlotView.horizontalOffset()`

### Returns
- **int** - Returns 0.
```

--------------------------------

### PlotView.handle_scroll(value)

Source: https://tgwoodcock.github.io/hdf5view/reference/generated/hdf5view.views.PlotView.handle_scroll.html

Changes the image frame based on the scroll value provided.

```APIDOC
## PlotView.handle_scroll(value)

### Description
Changes the image frame on scroll.

### Parameters
- **value** (Any) - Required - The scroll value used to determine the new image frame.
```

--------------------------------

### DimsTableModel.setData(index, value, role)

Source: https://tgwoodcock.github.io/hdf5view/reference/generated/hdf5view.models.DimsTableModel.setData.html

Updates the dimensions data for the specified index and role.

```APIDOC
## DimsTableModel.setData(index, value, role)

### Description
Update the dimensions data in the model.

### Parameters
- **index** - The index of the data to update.
- **value** - The new value to set.
- **role** - The role associated with the data update.
```

--------------------------------

### PlotView.update_plot

Source: https://tgwoodcock.github.io/hdf5view/_sources/reference/generated/hdf5view.views.PlotView.update_plot.rst.txt

Updates the plot visualization in the PlotView component.

```APIDOC
## Method: update_plot

### Description
Updates the current plot display within the PlotView instance. This method is used to refresh the visual representation of the data.

### Signature
`PlotView.update_plot()`
```

--------------------------------

### DataTableModel.update_node(path)

Source: https://tgwoodcock.github.io/hdf5view/reference/generated/hdf5view.models.DataTableModel.update_node.html

Updates the current node path for the DataTableModel instance.

```APIDOC
## DataTableModel.update_node(path)

### Description
Updates the current node path within the DataTableModel.

### Parameters
- **path** (string) - Required - The path to the node to be updated.
```

--------------------------------

### PlotModel.update_node(path)

Source: https://tgwoodcock.github.io/hdf5view/reference/generated/hdf5view.models.PlotModel.update_node.html

Updates the current node path for the PlotModel instance.

```APIDOC
## PlotModel.update_node(path)

### Description
Updates the current node path within the PlotModel.

### Signature
`PlotModel.update_node(path)`

### Parameters
- **path** (string) - The new path to be set for the current node.
```
Tokens:
Raw