From 67ab8cb8919e657a4eb5a780ad81b7764a54ec5c Mon Sep 17 00:00:00 2001 From: pauladkisson Date: Wed, 20 Sep 2023 10:36:02 -0700 Subject: [PATCH] added note about version support for extract_extra_metadata --- .../tiffimagingextractors/scanimagetiffimagingextractor.py | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/src/roiextractors/extractors/tiffimagingextractors/scanimagetiffimagingextractor.py b/src/roiextractors/extractors/tiffimagingextractors/scanimagetiffimagingextractor.py index e39f3c3c..f462f408 100644 --- a/src/roiextractors/extractors/tiffimagingextractors/scanimagetiffimagingextractor.py +++ b/src/roiextractors/extractors/tiffimagingextractors/scanimagetiffimagingextractor.py @@ -38,6 +38,10 @@ def extract_extra_metadata( ------- extra_metadata: dict Dictionary of metadata extracted from the TIFF file. + + Notes + ----- + Known to work on SI versions v3.8.0, v2019bR0, and v2022.0.0. """ ScanImageTiffReader = _get_scanimage_reader() io = ScanImageTiffReader(str(file_path)) @@ -74,7 +78,7 @@ def parse_metadata(metadata): Notes ----- - Known to work on SI version v2019bR0 and v2022.0.0. + Known to work on SI versions v2019bR0 and v2022.0.0. SI.hChannels.channelsActive = '[1;2;...;N]' where N is the number of active channels. SI.hChannels.channelName = "{'channel_name_1' 'channel_name_2' ... 'channel_name_M'}" where M is the number of channels (active or not).