From 416074d3c15821721e2718b3b1cfa3cb0f61944c Mon Sep 17 00:00:00 2001 From: bendichter Date: Fri, 31 Mar 2023 16:43:17 -0500 Subject: [PATCH] add a note on the TIFF conversion gallery --- docs/conversion_examples_gallery/imaging/tiff.rst | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/docs/conversion_examples_gallery/imaging/tiff.rst b/docs/conversion_examples_gallery/imaging/tiff.rst index ab6de4f64..f6e88bd6e 100644 --- a/docs/conversion_examples_gallery/imaging/tiff.rst +++ b/docs/conversion_examples_gallery/imaging/tiff.rst @@ -28,3 +28,10 @@ Convert TIFF imaging data to NWB using >>> # Choose a path for saving the nwb file and run the conversion >>> nwbfile_path = f"{path_to_save_nwbfile}" >>> interface.run_conversion(nwbfile_path=nwbfile_path, metadata=metadata) + + +.. note:: + + The :py:class:`~neuroconv.datainterfaces.ophys.tiff.tiffdatainterface.TiffImagingInterface` is designed for + imaging data where all of the frames are in a multi-page TIFF file. It is not appropriate for datasets where the + TIFF data is distributed across many files, for example from Bruker acquisition software.