From 9b330757369cb8b8966a9d78bc13c84012eb2671 Mon Sep 17 00:00:00 2001 From: pauladkisson Date: Wed, 22 May 2024 14:34:31 -0700 Subject: [PATCH] removed redundant module docstrings --- src/roiextractors/__init__.py | 2 -- .../example_datasets/__init__.py | 13 ------- .../example_datasets/toy_example.py | 8 +---- src/roiextractors/extraction_tools.py | 8 +---- src/roiextractors/extractors/__init__.py | 1 - .../extractors/caiman/__init__.py | 13 ------- .../caiman/caimansegmentationextractor.py | 8 ----- .../hdf5imagingextractor/__init__.py | 14 -------- .../hdf5imagingextractor.py | 8 ----- .../extractors/inscopixextractors/__init__.py | 2 -- .../inscopiximagingextractor.py | 2 -- .../extractors/memmapextractors/__init__.py | 17 +-------- .../memmapextractors/memmapextractors.py | 8 ----- .../memmapextractors/numpymemampextractor.py | 8 ----- .../miniscopeimagingextractor/__init__.py | 13 ------- .../miniscopeimagingextractor.py | 8 ----- .../extractors/numpyextractors/__init__.py | 15 -------- .../numpyextractors/numpyextractors.py | 10 ------ .../extractors/nwbextractors/__init__.py | 15 -------- .../extractors/nwbextractors/nwbextractors.py | 10 ------ .../sbximagingextractor/__init__.py | 13 ------- .../sbximagingextractor.py | 8 ----- .../extractors/schnitzerextractor/__init__.py | 21 ----------- .../cnmfesegmentationextractor.py | 8 ----- .../extractsegmentationextractor.py | 12 ------- .../extractors/simaextractor/__init__.py | 13 ------- .../simasegmentationextractor.py | 8 ----- .../extractors/suite2p/__init__.py | 13 ------- .../suite2p/suite2psegmentationextractor.py | 8 ----- .../tiffimagingextractors/__init__.py | 35 ------------------- .../brukertiffimagingextractor.py | 10 ------ .../micromanagertiffimagingextractor.py | 8 ----- .../scanimagetiffimagingextractor.py | 8 ----- .../tiffimagingextractor.py | 8 ----- src/roiextractors/imagingextractor.py | 10 ------ src/roiextractors/multiimagingextractor.py | 8 ----- .../multisegmentationextractor.py | 8 ----- src/roiextractors/segmentationextractor.py | 12 ------- .../volumetricimagingextractor.py | 2 -- 39 files changed, 3 insertions(+), 393 deletions(-) diff --git a/src/roiextractors/__init__.py b/src/roiextractors/__init__.py index 1f7ec5be..2b75355b 100644 --- a/src/roiextractors/__init__.py +++ b/src/roiextractors/__init__.py @@ -1,5 +1,3 @@ -"""Python-based module for extracting from, converting between, and handling recorded and optical imaging data from several file formats.""" - from importlib.metadata import version __version__ = version("roiextractors") diff --git a/src/roiextractors/example_datasets/__init__.py b/src/roiextractors/example_datasets/__init__.py index 4532ba9d..135ecd47 100644 --- a/src/roiextractors/example_datasets/__init__.py +++ b/src/roiextractors/example_datasets/__init__.py @@ -1,14 +1 @@ -"""Toy example ImagingExtractor and SegmentationExtractor for testing. - -Modules -------- -toy_example - Create a toy example of an ImagingExtractor and a SegmentationExtractor. - -Functions ---------- -toy_example - Create a toy example of an ImagingExtractor and a SegmentationExtractor. -""" - from .toy_example import toy_example diff --git a/src/roiextractors/example_datasets/toy_example.py b/src/roiextractors/example_datasets/toy_example.py index f6dc99e6..4d2d5457 100644 --- a/src/roiextractors/example_datasets/toy_example.py +++ b/src/roiextractors/example_datasets/toy_example.py @@ -1,10 +1,4 @@ -"""Toy example ImagingExtractor and SegmentationExtractor for testing. - -Functions ---------- -toy_example - Create a toy example of an ImagingExtractor and a SegmentationExtractor. -""" +"""Toy example ImagingExtractor and SegmentationExtractor for testing.""" import numpy as np diff --git a/src/roiextractors/extraction_tools.py b/src/roiextractors/extraction_tools.py index c7866f2d..5e914546 100644 --- a/src/roiextractors/extraction_tools.py +++ b/src/roiextractors/extraction_tools.py @@ -1,10 +1,4 @@ -"""Various tools for extraction of ROIs from imaging data. - -Classes -------- -VideoStructure - A data class for specifying the structure of a video. -""" +"""Various tools for extraction of ROIs from imaging data.""" import sys import importlib.util diff --git a/src/roiextractors/extractors/__init__.py b/src/roiextractors/extractors/__init__.py index 25e0445d..e69de29b 100644 --- a/src/roiextractors/extractors/__init__.py +++ b/src/roiextractors/extractors/__init__.py @@ -1 +0,0 @@ -"""All specialized ImagingExtractors and SegmentationExtractors are defined here.""" diff --git a/src/roiextractors/extractors/caiman/__init__.py b/src/roiextractors/extractors/caiman/__init__.py index 42ac0036..3f7fd8d9 100644 --- a/src/roiextractors/extractors/caiman/__init__.py +++ b/src/roiextractors/extractors/caiman/__init__.py @@ -1,14 +1 @@ -"""A Segmentation Extractor for Caiman. - -Modules -------- -caimansegmentationextractor - A Segmentation Extractor for Caiman. - -Classes -------- -CaimanSegmentationExtractor - A class for extracting segmentation from Caiman output. -""" - from .caimansegmentationextractor import CaimanSegmentationExtractor diff --git a/src/roiextractors/extractors/caiman/caimansegmentationextractor.py b/src/roiextractors/extractors/caiman/caimansegmentationextractor.py index d88dabd4..e47a94bf 100644 --- a/src/roiextractors/extractors/caiman/caimansegmentationextractor.py +++ b/src/roiextractors/extractors/caiman/caimansegmentationextractor.py @@ -1,11 +1,3 @@ -"""A SegmentationExtractor for CaImAn. - -Classes -------- -CaimanSegmentationExtractor - A class for extracting segmentation from CaImAn output. -""" - from pathlib import Path try: diff --git a/src/roiextractors/extractors/hdf5imagingextractor/__init__.py b/src/roiextractors/extractors/hdf5imagingextractor/__init__.py index e2b176e0..876ed4b4 100644 --- a/src/roiextractors/extractors/hdf5imagingextractor/__init__.py +++ b/src/roiextractors/extractors/hdf5imagingextractor/__init__.py @@ -1,15 +1 @@ -"""An imaging extractor for HDF5. - -Modules -------- -hdf5imagingextractor - An imaging extractor for HDF5. - - -Classes -------- -Hdf5ImagingExtractor - An imaging extractor for HDF5. -""" - from .hdf5imagingextractor import Hdf5ImagingExtractor diff --git a/src/roiextractors/extractors/hdf5imagingextractor/hdf5imagingextractor.py b/src/roiextractors/extractors/hdf5imagingextractor/hdf5imagingextractor.py index 5ce5dbf7..f787967a 100644 --- a/src/roiextractors/extractors/hdf5imagingextractor/hdf5imagingextractor.py +++ b/src/roiextractors/extractors/hdf5imagingextractor/hdf5imagingextractor.py @@ -1,11 +1,3 @@ -"""An imaging extractor for HDF5. - -Classes -------- -Hdf5ImagingExtractor - An imaging extractor for HDF5. -""" - from pathlib import Path from typing import Optional, Tuple from warnings import warn diff --git a/src/roiextractors/extractors/inscopixextractors/__init__.py b/src/roiextractors/extractors/inscopixextractors/__init__.py index 60c67ef7..c7850bbb 100644 --- a/src/roiextractors/extractors/inscopixextractors/__init__.py +++ b/src/roiextractors/extractors/inscopixextractors/__init__.py @@ -1,3 +1 @@ -"""Defines extactors for Inscopix data.""" - from .inscopiximagingextractor import InscopixImagingExtractor diff --git a/src/roiextractors/extractors/inscopixextractors/inscopiximagingextractor.py b/src/roiextractors/extractors/inscopixextractors/inscopiximagingextractor.py index ccd83189..382fbee0 100644 --- a/src/roiextractors/extractors/inscopixextractors/inscopiximagingextractor.py +++ b/src/roiextractors/extractors/inscopixextractors/inscopiximagingextractor.py @@ -1,5 +1,3 @@ -"""Inscopix Imaging Extractor.""" - import warnings from typing import Optional, Tuple diff --git a/src/roiextractors/extractors/memmapextractors/__init__.py b/src/roiextractors/extractors/memmapextractors/__init__.py index 64351fe6..3c35055f 100644 --- a/src/roiextractors/extractors/memmapextractors/__init__.py +++ b/src/roiextractors/extractors/memmapextractors/__init__.py @@ -1,19 +1,4 @@ -"""Defines memmap-based ImagingExtractors. Currently, only numpy.memmap is supported. - -Modules -------- -memmapextractors - The base class for memmapable imaging extractors. -numpymemampextractor - The class for reading optical imaging data stored in a binary format with numpy.memmap. - -Classes -------- -MemmapImagingExtractor - The base class for memmapable imaging extractors. -NumpyMemmapImagingExtractor - The class for reading optical imaging data stored in a binary format with numpy.memmap. -""" +"""Defines memmap-based ImagingExtractors. Currently, only numpy.memmap is supported.""" from .memmapextractors import MemmapImagingExtractor from .numpymemampextractor import NumpyMemmapImagingExtractor diff --git a/src/roiextractors/extractors/memmapextractors/memmapextractors.py b/src/roiextractors/extractors/memmapextractors/memmapextractors.py index 88b7e52d..7018f7f8 100644 --- a/src/roiextractors/extractors/memmapextractors/memmapextractors.py +++ b/src/roiextractors/extractors/memmapextractors/memmapextractors.py @@ -1,11 +1,3 @@ -"""Defines the base class for memmapable imaging extractors. - -Classes -------- -MemmapImagingExtractor - The base class for memmapable imaging extractors. -""" - from pathlib import Path import numpy as np diff --git a/src/roiextractors/extractors/memmapextractors/numpymemampextractor.py b/src/roiextractors/extractors/memmapextractors/numpymemampextractor.py index bd25b33a..b5715de7 100644 --- a/src/roiextractors/extractors/memmapextractors/numpymemampextractor.py +++ b/src/roiextractors/extractors/memmapextractors/numpymemampextractor.py @@ -1,11 +1,3 @@ -"""NumpyMemmapImagingExtractor class. - -Classes -------- -NumpyMemmapImagingExtractor - The class for reading optical imaging data stored in a binary format with numpy.memmap. -""" - import os from pathlib import Path diff --git a/src/roiextractors/extractors/miniscopeimagingextractor/__init__.py b/src/roiextractors/extractors/miniscopeimagingextractor/__init__.py index 9cf2517c..a9b783a6 100644 --- a/src/roiextractors/extractors/miniscopeimagingextractor/__init__.py +++ b/src/roiextractors/extractors/miniscopeimagingextractor/__init__.py @@ -1,14 +1 @@ -"""An ImagingExtractor for the Miniscope video (.avi) format. - -Modules -------- -miniscopeimagingextractor - An ImagingExtractor for the Miniscope video (.avi) format. - -Classes -------- -MiniscopeImagingExtractor - An ImagingExtractor for the Miniscope video (.avi) format. -""" - from .miniscopeimagingextractor import MiniscopeImagingExtractor diff --git a/src/roiextractors/extractors/miniscopeimagingextractor/miniscopeimagingextractor.py b/src/roiextractors/extractors/miniscopeimagingextractor/miniscopeimagingextractor.py index e619f8b2..c670cb67 100644 --- a/src/roiextractors/extractors/miniscopeimagingextractor/miniscopeimagingextractor.py +++ b/src/roiextractors/extractors/miniscopeimagingextractor/miniscopeimagingextractor.py @@ -1,11 +1,3 @@ -"""MiniscopeImagingExtractor class. - -Classes -------- -MiniscopeImagingExtractor - An ImagingExtractor for the Miniscope video (.avi) format. -""" - import json import re from pathlib import Path diff --git a/src/roiextractors/extractors/numpyextractors/__init__.py b/src/roiextractors/extractors/numpyextractors/__init__.py index f7d945dc..584143a0 100644 --- a/src/roiextractors/extractors/numpyextractors/__init__.py +++ b/src/roiextractors/extractors/numpyextractors/__init__.py @@ -1,16 +1 @@ -"""Imaging and Segmenation Extractors for .npy files. - -Modules -------- -numpyextractors - Imaging and Segmenation Extractors for .npy files. - -Classes -------- -NumpyImagingExtractor - An ImagingExtractor specified by timeseries .npy file, sampling frequency, and channel names. -NumpySegmentationExtractor - A Segmentation extractor specified by image masks and traces .npy files. -""" - from .numpyextractors import NumpyImagingExtractor, NumpySegmentationExtractor diff --git a/src/roiextractors/extractors/numpyextractors/numpyextractors.py b/src/roiextractors/extractors/numpyextractors/numpyextractors.py index e5ea0c67..d95fd123 100644 --- a/src/roiextractors/extractors/numpyextractors/numpyextractors.py +++ b/src/roiextractors/extractors/numpyextractors/numpyextractors.py @@ -1,13 +1,3 @@ -"""Imaging and Segmenation Extractors for .npy files. - -Classes -------- -NumpyImagingExtractor - An ImagingExtractor specified by timeseries .npy file, sampling frequency, and channel names. -NumpySegmentationExtractor - A Segmentation extractor specified by image masks and traces .npy files. -""" - from pathlib import Path from typing import Optional, Tuple diff --git a/src/roiextractors/extractors/nwbextractors/__init__.py b/src/roiextractors/extractors/nwbextractors/__init__.py index 87fb7d50..e9bcaa63 100644 --- a/src/roiextractors/extractors/nwbextractors/__init__.py +++ b/src/roiextractors/extractors/nwbextractors/__init__.py @@ -1,16 +1 @@ -"""Imaging and segmentation extractors for NWB files. - -Modules -------- -nwbextractors - Imaging and segmentation extractors for NWB files. - -Classes -------- -NwbImagingExtractor - Extracts imaging data from NWB files. -NwbSegmentationExtractor - Extracts segmentation data from NWB files. -""" - from .nwbextractors import NwbImagingExtractor, NwbSegmentationExtractor diff --git a/src/roiextractors/extractors/nwbextractors/nwbextractors.py b/src/roiextractors/extractors/nwbextractors/nwbextractors.py index 61ff9f44..0417505f 100644 --- a/src/roiextractors/extractors/nwbextractors/nwbextractors.py +++ b/src/roiextractors/extractors/nwbextractors/nwbextractors.py @@ -1,13 +1,3 @@ -"""Imaging and segmentation extractors for NWB files. - -Classes -------- -NwbImagingExtractor - Extracts imaging data from NWB files. -NwbSegmentationExtractor - Extracts segmentation data from NWB files. -""" - from pathlib import Path from typing import Union, Optional, Iterable, Tuple diff --git a/src/roiextractors/extractors/sbximagingextractor/__init__.py b/src/roiextractors/extractors/sbximagingextractor/__init__.py index 82897450..1f76a590 100644 --- a/src/roiextractors/extractors/sbximagingextractor/__init__.py +++ b/src/roiextractors/extractors/sbximagingextractor/__init__.py @@ -1,14 +1 @@ -"""A segmentation extractor for Scanbox imaging data. - -Modules -------- -sbximagingextractor - A segmentation extractor for Scanbox imaging data. - -Classes -------- -SbxImagingExtractor - An ImagingExtractor for Scanbox Image files. -""" - from .sbximagingextractor import SbxImagingExtractor diff --git a/src/roiextractors/extractors/sbximagingextractor/sbximagingextractor.py b/src/roiextractors/extractors/sbximagingextractor/sbximagingextractor.py index e013fb75..61d68332 100644 --- a/src/roiextractors/extractors/sbximagingextractor/sbximagingextractor.py +++ b/src/roiextractors/extractors/sbximagingextractor/sbximagingextractor.py @@ -1,11 +1,3 @@ -"""Imaging Extractors for Scanbox files. - -Classes -------- -SbxImagingExtractor - An ImagingExtractor for Scanbox Image files. -""" - from multiprocessing.sharedctypes import Value import os from pathlib import Path diff --git a/src/roiextractors/extractors/schnitzerextractor/__init__.py b/src/roiextractors/extractors/schnitzerextractor/__init__.py index c2799ad2..0effe27e 100644 --- a/src/roiextractors/extractors/schnitzerextractor/__init__.py +++ b/src/roiextractors/extractors/schnitzerextractor/__init__.py @@ -1,24 +1,3 @@ -"""Segmentation extractors for CNMF-E and EXTRACT ROI segmentation method. - -Modules -------- -cnmfesegmentationextractor - A segmentation extractor for CNMF-E ROI segmentation method. -extractsegmentationextractor - A segmentation extractor for EXTRACT segmentation method. - -Classes -------- -CnmfeSegmentationExtractor - A segmentation extractor for CNMF-E ROI segmentation method. -ExtractSegmentationExtractor - Abstract class that defines which EXTRACT class to use for a given file (new vs old). -NewExtractSegmentationExtractor - Extractor for reading the segmentation data that results from calls to newer versions of EXTRACT. -LegacyExtractSegmentationExtractor - Extractor for reading the segmentation data that results from calls to older versions of EXTRACT. -""" - from .cnmfesegmentationextractor import CnmfeSegmentationExtractor from .extractsegmentationextractor import ( LegacyExtractSegmentationExtractor, diff --git a/src/roiextractors/extractors/schnitzerextractor/cnmfesegmentationextractor.py b/src/roiextractors/extractors/schnitzerextractor/cnmfesegmentationextractor.py index 4deb3cae..3fd17e99 100644 --- a/src/roiextractors/extractors/schnitzerextractor/cnmfesegmentationextractor.py +++ b/src/roiextractors/extractors/schnitzerextractor/cnmfesegmentationextractor.py @@ -1,11 +1,3 @@ -"""A segmentation extractor for CNMF-E ROI segmentation method. - -Classes -------- -CnmfeSegmentationExtractor - A segmentation extractor for CNMF-E ROI segmentation method. -""" - from pathlib import Path try: diff --git a/src/roiextractors/extractors/schnitzerextractor/extractsegmentationextractor.py b/src/roiextractors/extractors/schnitzerextractor/extractsegmentationextractor.py index 3923df06..6a1a9ce8 100644 --- a/src/roiextractors/extractors/schnitzerextractor/extractsegmentationextractor.py +++ b/src/roiextractors/extractors/schnitzerextractor/extractsegmentationextractor.py @@ -1,15 +1,3 @@ -"""Extractor for reading the segmentation data that results from calls to EXTRACT. - -Classes -------- -ExtractSegmentationExtractor - Abstract class that defines which extractor class to use for a given file. -NewExtractSegmentationExtractor - Extractor for reading the segmentation data that results from calls to newer versions of EXTRACT. -LegacyExtractSegmentationExtractor - Extractor for reading the segmentation data that results from calls to older versions of EXTRACT. -""" - from abc import ABC from pathlib import Path from typing import Optional diff --git a/src/roiextractors/extractors/simaextractor/__init__.py b/src/roiextractors/extractors/simaextractor/__init__.py index 62957c71..a42c6d42 100644 --- a/src/roiextractors/extractors/simaextractor/__init__.py +++ b/src/roiextractors/extractors/simaextractor/__init__.py @@ -1,14 +1 @@ -"""A segmentation extractor for Sima. - -Modules -------- -simasegmentationextractor - A segmentation extractor for Sima. - -Classes -------- -SimaSegmentationExtractor - A segmentation extractor for Sima. -""" - from .simasegmentationextractor import SimaSegmentationExtractor diff --git a/src/roiextractors/extractors/simaextractor/simasegmentationextractor.py b/src/roiextractors/extractors/simaextractor/simasegmentationextractor.py index 71905a2c..9a423602 100644 --- a/src/roiextractors/extractors/simaextractor/simasegmentationextractor.py +++ b/src/roiextractors/extractors/simaextractor/simasegmentationextractor.py @@ -1,11 +1,3 @@ -"""A segmentation extractor for Sima. - -Classes -------- -SimaSegmentationExtractor - A segmentation extractor for Sima. -""" - import os import pickle import re diff --git a/src/roiextractors/extractors/suite2p/__init__.py b/src/roiextractors/extractors/suite2p/__init__.py index 4da2a048..f3ba893f 100644 --- a/src/roiextractors/extractors/suite2p/__init__.py +++ b/src/roiextractors/extractors/suite2p/__init__.py @@ -1,14 +1 @@ -"""A segmentation extractor for Suite2p. - -Modules -------- -suite2psegmentationextractor - A segmentation extractor for Suite2p. - -Classes -------- -Suite2pSegmentationExtractor - A segmentation extractor for Suite2p. -""" - from .suite2psegmentationextractor import Suite2pSegmentationExtractor diff --git a/src/roiextractors/extractors/suite2p/suite2psegmentationextractor.py b/src/roiextractors/extractors/suite2p/suite2psegmentationextractor.py index eb55b98c..3cba2a90 100644 --- a/src/roiextractors/extractors/suite2p/suite2psegmentationextractor.py +++ b/src/roiextractors/extractors/suite2p/suite2psegmentationextractor.py @@ -1,11 +1,3 @@ -"""A segmentation extractor for Suite2p. - -Classes -------- -Suite2pSegmentationExtractor - A segmentation extractor for Suite2p. -""" - import shutil from pathlib import Path from typing import Optional diff --git a/src/roiextractors/extractors/tiffimagingextractors/__init__.py b/src/roiextractors/extractors/tiffimagingextractors/__init__.py index 5d37e2bc..fb6cf084 100644 --- a/src/roiextractors/extractors/tiffimagingextractors/__init__.py +++ b/src/roiextractors/extractors/tiffimagingextractors/__init__.py @@ -1,38 +1,3 @@ -"""A collection of ImagingExtractors for TIFF files with various formats. - -Modules -------- -tiffimagingextractor - A ImagingExtractor for TIFF files. -scanimagetiffimagingextractor - Specialized extractor for reading TIFF files produced via ScanImage. -brukertiffimagingextractor - Specialized extractor for reading TIFF files produced via Bruker. -micromanagertiffimagingextractor - Specialized extractor for reading TIFF files produced via Micro-Manager. - -Classes -------- -TiffImagingExtractor - A ImagingExtractor for TIFF files. -ScanImageTiffImagingExtractor - Legacy extractor for reading TIFF files produced via ScanImage v3.8. -ScanImageTiffSinglePlaneImagingExtractor - Specialized extractor for reading single-plane TIFF files produced via ScanImage. -ScanImageTiffMultiPlaneImagingExtractor - Specialized extractor for reading multi-plane TIFF files produced via ScanImage. -ScanImageTiffSinglePlaneMultiFileImagingExtractor - Specialized extractor for reading single-plane multi-file TIFF files produced via ScanImage. -ScanImageTiffMultiPlaneMultiFileImagingExtractor - Specialized extractor for reading multi-plane multi-file TIFF files produced via ScanImage. -BrukerTiffMultiPlaneImagingExtractor - Specialized extractor for reading TIFF files produced via Bruker. -BrukerTiffSinglePlaneImagingExtractor - Specialized extractor for reading TIFF files produced via Bruker. -MicroManagerTiffImagingExtractor - Specialized extractor for reading TIFF files produced via Micro-Manager. -""" - from .tiffimagingextractor import TiffImagingExtractor from .scanimagetiffimagingextractor import ( ScanImageTiffImagingExtractor, diff --git a/src/roiextractors/extractors/tiffimagingextractors/brukertiffimagingextractor.py b/src/roiextractors/extractors/tiffimagingextractors/brukertiffimagingextractor.py index 780ce4eb..4ae143f1 100644 --- a/src/roiextractors/extractors/tiffimagingextractors/brukertiffimagingextractor.py +++ b/src/roiextractors/extractors/tiffimagingextractors/brukertiffimagingextractor.py @@ -1,13 +1,3 @@ -"""ImagingExtractors for the TIFF image format produced by Bruker. - -Classes -------- -BrukerTiffSinglePlaneImagingExtractor - A ImagingExtractor for TIFF files produced by Bruker with only 1 plane. -BrukerTiffMultiPlaneImagingExtractor - A MultiImagingExtractor for TIFF files produced by Bruker with multiple planes. -""" - import logging import re from collections import Counter diff --git a/src/roiextractors/extractors/tiffimagingextractors/micromanagertiffimagingextractor.py b/src/roiextractors/extractors/tiffimagingextractors/micromanagertiffimagingextractor.py index 1df9f3d7..1c27c761 100644 --- a/src/roiextractors/extractors/tiffimagingextractors/micromanagertiffimagingextractor.py +++ b/src/roiextractors/extractors/tiffimagingextractors/micromanagertiffimagingextractor.py @@ -1,11 +1,3 @@ -"""A ImagingExtractor for TIFF files produced by Micro-Manager. - -Classes -------- -MicroManagerTiffImagingExtractor - A ImagingExtractor for TIFF files produced by Micro-Manager. -""" - import json import logging import re diff --git a/src/roiextractors/extractors/tiffimagingextractors/scanimagetiffimagingextractor.py b/src/roiextractors/extractors/tiffimagingextractors/scanimagetiffimagingextractor.py index bdc1bc38..c929ffa8 100644 --- a/src/roiextractors/extractors/tiffimagingextractors/scanimagetiffimagingextractor.py +++ b/src/roiextractors/extractors/tiffimagingextractors/scanimagetiffimagingextractor.py @@ -1,11 +1,3 @@ -"""Specialized extractor for reading TIFF files produced via ScanImage. - -Classes -------- -ScanImageTiffImagingExtractor - Specialized extractor for reading TIFF files produced via ScanImage. -""" - from pathlib import Path from typing import Optional, Tuple, List, Iterable from warnings import warn diff --git a/src/roiextractors/extractors/tiffimagingextractors/tiffimagingextractor.py b/src/roiextractors/extractors/tiffimagingextractors/tiffimagingextractor.py index 9ae0a09d..93bf65eb 100644 --- a/src/roiextractors/extractors/tiffimagingextractors/tiffimagingextractor.py +++ b/src/roiextractors/extractors/tiffimagingextractors/tiffimagingextractor.py @@ -1,11 +1,3 @@ -"""A TIFF imaging extractor for TIFF files. - -Classes -------- -TiffImagingExtractor - A TIFF imaging extractor for TIFF files. -""" - from pathlib import Path from typing import Optional from warnings import warn diff --git a/src/roiextractors/imagingextractor.py b/src/roiextractors/imagingextractor.py index 44a1d39e..752c84b6 100644 --- a/src/roiextractors/imagingextractor.py +++ b/src/roiextractors/imagingextractor.py @@ -1,13 +1,3 @@ -"""Base class definitions for all ImagingExtractors. - -Classes -------- -ImagingExtractor - Abstract class that contains all the meta-data and input data from the imaging data. -FrameSliceImagingExtractor - Class to get a lazy frame slice. -""" - from abc import ABC, abstractmethod from typing import Union, Optional, Tuple from copy import deepcopy diff --git a/src/roiextractors/multiimagingextractor.py b/src/roiextractors/multiimagingextractor.py index 294daa24..c6d4413f 100644 --- a/src/roiextractors/multiimagingextractor.py +++ b/src/roiextractors/multiimagingextractor.py @@ -1,11 +1,3 @@ -"""Defines the MultiImagingExtractor class. - -Classes -------- -MultiImagingExtractor - This class is used to combine multiple ImagingExtractor objects by frames. -""" - from collections import defaultdict from typing import Tuple, List, Iterable, Optional diff --git a/src/roiextractors/multisegmentationextractor.py b/src/roiextractors/multisegmentationextractor.py index ca787e93..0b8cc521 100644 --- a/src/roiextractors/multisegmentationextractor.py +++ b/src/roiextractors/multisegmentationextractor.py @@ -1,11 +1,3 @@ -"""Defines the MultiSegmentationExtractor class. - -Classes -------- -MultiSegmentationExtractor - This class is used to combine multiple SegmentationExtractor objects by frames. -""" - import numpy as np from .segmentationextractor import SegmentationExtractor diff --git a/src/roiextractors/segmentationextractor.py b/src/roiextractors/segmentationextractor.py index 3c2881c1..1adb45b9 100644 --- a/src/roiextractors/segmentationextractor.py +++ b/src/roiextractors/segmentationextractor.py @@ -1,15 +1,3 @@ -"""Base segmentation extractors. - -Classes -------- -SegmentationExtractor - Abstract class that contains all the meta-data and output data from the ROI segmentation operation when applied to - the pre-processed data. It also contains methods to read from and write to various data formats output from the - processing pipelines like SIMA, CaImAn, Suite2p, CNMF-E. -FrameSliceSegmentationExtractor - Class to get a lazy frame slice. -""" - from abc import ABC, abstractmethod from typing import Union, Optional, Tuple, Iterable, List diff --git a/src/roiextractors/volumetricimagingextractor.py b/src/roiextractors/volumetricimagingextractor.py index 44f84968..06d3c8e6 100644 --- a/src/roiextractors/volumetricimagingextractor.py +++ b/src/roiextractors/volumetricimagingextractor.py @@ -1,5 +1,3 @@ -"""Base class definition for volumetric imaging extractors.""" - from typing import Tuple, List, Iterable, Optional import numpy as np