Skip to content
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.

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

Add reader for hamamatsu .img format #87

Merged
merged 19 commits into from
Aug 17, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
22 changes: 22 additions & 0 deletions docs/supported_formats/hamamatsu.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
.. _hamamatsu-format:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Add to index.rst

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It is added in docs/supported_formats/index.rst.


Hamamatsu
---------

Reader for spectroscopy data saved in ``.img`` (ITEX) files from the HPD-TA
(High Performance Digital Temporal Analyzer) or HiPic (High Performance image control)
softwares from Hamamatsu, e.g. for streak cameras or high performance CCD cameras.

If `LumiSpy <https://lumispy.org>`_ is installed, ``Luminescence`` will be
used as the ``signal_type``.

.. Note::

Reading files containing multiple channels or multiple images per channel
is not implemented.

API functions
^^^^^^^^^^^^^

.. automodule:: rsciio.hamamatsu
:members:
1 change: 1 addition & 0 deletions docs/supported_formats/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@ big datasets is supported.
edax
emd
empad
hamamatsu
hspy
image
jeol
Expand Down
2 changes: 2 additions & 0 deletions docs/supported_formats/supported_formats.rst
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,8 @@
+---------------------------------------------------------------------+-------------------------+--------+--------+--------+
| :ref:`FEI TIA <tia-format>` | emi & ser | Yes | No | Yes |
+---------------------------------------------------------------------+-------------------------+--------+--------+--------+
| :ref:`Hamamatsu <hamamatsu-format>` | img | Yes | No | No |
+---------------------------------------------------------------------+-------------------------+--------+--------+--------+
| :ref:`Horiba Jobin Yvon LabSpec <jobinyvon-format>` | xml | Yes | No | No |
+---------------------------------------------------------------------+-------------------------+--------+--------+--------+
| :ref:`HSpy - HyperSpy hdf5 <hspy-format>` | hspy | Yes | Yes | Yes |
Expand Down
10 changes: 10 additions & 0 deletions rsciio/hamamatsu/__init__.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
from ._api import file_reader


__all__ = [
"file_reader",
]


def __dir__():
return sorted(__all__)