diff --git a/docs/api/interfaces.ophys.rst b/docs/api/interfaces.ophys.rst index ee33a9668..bc4ad7d29 100644 --- a/docs/api/interfaces.ophys.rst +++ b/docs/api/interfaces.ophys.rst @@ -29,6 +29,10 @@ ScanImage Imaging ----------------- .. automodule:: neuroconv.datainterfaces.ophys.scanimage.scanimageimaginginterfaces +ThorLabs Imaging +---------------- +.. automodule:: neuroconv.datainterfaces.ophys.thor.thorimaginginterface + Tiff Imaging ------------ .. automodule:: neuroconv.datainterfaces.ophys.tiff.tiffdatainterface diff --git a/docs/conversion_examples_gallery/imaging/thor.rst b/docs/conversion_examples_gallery/imaging/thor.rst new file mode 100644 index 000000000..84c5ebc72 --- /dev/null +++ b/docs/conversion_examples_gallery/imaging/thor.rst @@ -0,0 +1,29 @@ +ThorLabs data conversion +------------------------ + +Install NeuroConv with the additional dependencies necessary for reading ThorLabs imaging data. + +.. code-block:: bash + + pip install neuroconv[thor] + +Convert single plane single file imaging data +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +Convert ScanImage imaging data to NWB using +:py:class:`~neuroconv.datainterfaces.ophys.thor.thorimaginginterface`. + +.. code-block:: python + + >>> from datetime import datetime + >>> from dateutil import tz + >>> from pathlib import Path + >>> from neuroconv.datainterfaces import ThorTiffImagingInterface + >>> + >>> file_path = OPHYS_DATA_PATH / "imaging_datasets" / "ThorLabs" / "data" + >>> interface = ThorTiffImagingInterface(folder_path=folder_path) + >>> + >>> metadata = interface.get_metadata() + >>> + >>> # Choose a path for saving the nwb file and run the conversion + >>> interface.run_conversion(nwbfile_path=f"{path_to_save_nwbfile}", metadata=metadata) diff --git a/src/neuroconv/datainterfaces/__init__.py b/src/neuroconv/datainterfaces/__init__.py index fa27e7763..a09cc6cc7 100644 --- a/src/neuroconv/datainterfaces/__init__.py +++ b/src/neuroconv/datainterfaces/__init__.py @@ -87,6 +87,7 @@ ) from .ophys.sima.simadatainterface import SimaSegmentationInterface from .ophys.suite2p.suite2pdatainterface import Suite2pSegmentationInterface +from .ophys.thor.thorimaginginterface import ThorTiffImagingInterface from .ophys.tiff.tiffdatainterface import TiffImagingInterface # Text @@ -138,6 +139,7 @@ ExtractSegmentationInterface, SimaSegmentationInterface, SbxImagingInterface, + ThorTiffImagingInterface, TiffImagingInterface, Hdf5ImagingInterface, ScanImageImagingInterface,