Skip to content

Document that NDFileTIFF implements readFile #590

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ericonr merged 1 commit into from
May 27, 2026
Merged

Document that NDFileTIFF implements readFile #590

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions docs/ADCore/NDPluginFile.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,10 +28,10 @@ documentation <../areaDetectorDoxygenHTML/class_n_d_plugin_file.html>`__
describes this class in detail. This class is designed to simplify the
task of supporting a new file format. A derived class to support a new
file format will typically need to implement only the pure virtual
functions ``openFile()``, ``readFile()``, ``writeFile()``, and
``closeFile()``. Note that none of the current file plugins actually
support the ``readFile()`` function yet, but this is planned for future
releases.
functions ``openFile()``, ``readFile()``, ``writeFile()``, and
``closeFile()``. Note that out of the current file plugins, only
:doc:`NDFileTIFF` actually supports the ``readFile()`` function, though
further support is planned for future releases.

The NDArray callback data can be written to disk in 1 of 3 modes:

Expand Down
Loading