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/nwbextractors/nwbextractors.py b/src/roiextractors/extractors/nwbextractors/nwbextractors.py index 61ff9f44..bbf56888 100644 --- a/src/roiextractors/extractors/nwbextractors/nwbextractors.py +++ b/src/roiextractors/extractors/nwbextractors/nwbextractors.py @@ -1,12 +1,4 @@ -"""Imaging and segmentation extractors for NWB files. - -Classes -------- -NwbImagingExtractor - Extracts imaging data from NWB files. -NwbSegmentationExtractor - Extracts segmentation data from NWB files. -""" +"""Imaging and segmentation extractors for NWB files.""" from pathlib import Path from typing import Union, Optional, Iterable, Tuple diff --git a/src/roiextractors/extractors/sbximagingextractor/sbximagingextractor.py b/src/roiextractors/extractors/sbximagingextractor/sbximagingextractor.py index e013fb75..99d28ffd 100644 --- a/src/roiextractors/extractors/sbximagingextractor/sbximagingextractor.py +++ b/src/roiextractors/extractors/sbximagingextractor/sbximagingextractor.py @@ -1,10 +1,4 @@ -"""Imaging Extractors for Scanbox files. - -Classes -------- -SbxImagingExtractor - An ImagingExtractor for Scanbox Image files. -""" +"""Imaging Extractors for Scanbox files.""" from multiprocessing.sharedctypes import Value import os diff --git a/src/roiextractors/extractors/schnitzerextractor/cnmfesegmentationextractor.py b/src/roiextractors/extractors/schnitzerextractor/cnmfesegmentationextractor.py index 4deb3cae..a5f7b4eb 100644 --- a/src/roiextractors/extractors/schnitzerextractor/cnmfesegmentationextractor.py +++ b/src/roiextractors/extractors/schnitzerextractor/cnmfesegmentationextractor.py @@ -1,10 +1,4 @@ -"""A segmentation extractor for CNMF-E ROI segmentation method. - -Classes -------- -CnmfeSegmentationExtractor - A segmentation extractor for CNMF-E ROI segmentation method. -""" +"""A segmentation extractor for CNMF-E ROI segmentation method.""" from pathlib import Path diff --git a/src/roiextractors/extractors/schnitzerextractor/extractsegmentationextractor.py b/src/roiextractors/extractors/schnitzerextractor/extractsegmentationextractor.py index 3923df06..1d990b30 100644 --- a/src/roiextractors/extractors/schnitzerextractor/extractsegmentationextractor.py +++ b/src/roiextractors/extractors/schnitzerextractor/extractsegmentationextractor.py @@ -1,14 +1,4 @@ -"""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. -""" +"""Extractor for reading the segmentation data that results from calls to EXTRACT.""" from abc import ABC from pathlib import Path diff --git a/src/roiextractors/extractors/simaextractor/simasegmentationextractor.py b/src/roiextractors/extractors/simaextractor/simasegmentationextractor.py index 71905a2c..54457c1c 100644 --- a/src/roiextractors/extractors/simaextractor/simasegmentationextractor.py +++ b/src/roiextractors/extractors/simaextractor/simasegmentationextractor.py @@ -1,10 +1,4 @@ -"""A segmentation extractor for Sima. - -Classes -------- -SimaSegmentationExtractor - A segmentation extractor for Sima. -""" +"""A segmentation extractor for Sima.""" import os import pickle diff --git a/src/roiextractors/extractors/suite2p/suite2psegmentationextractor.py b/src/roiextractors/extractors/suite2p/suite2psegmentationextractor.py index eb55b98c..a4902240 100644 --- a/src/roiextractors/extractors/suite2p/suite2psegmentationextractor.py +++ b/src/roiextractors/extractors/suite2p/suite2psegmentationextractor.py @@ -1,10 +1,4 @@ -"""A segmentation extractor for Suite2p. - -Classes -------- -Suite2pSegmentationExtractor - A segmentation extractor for Suite2p. -""" +"""A segmentation extractor for Suite2p.""" import shutil from pathlib import Path diff --git a/src/roiextractors/extractors/tiffimagingextractors/brukertiffimagingextractor.py b/src/roiextractors/extractors/tiffimagingextractors/brukertiffimagingextractor.py index 780ce4eb..6a6641ca 100644 --- a/src/roiextractors/extractors/tiffimagingextractors/brukertiffimagingextractor.py +++ b/src/roiextractors/extractors/tiffimagingextractors/brukertiffimagingextractor.py @@ -1,12 +1,4 @@ -"""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. -""" +"""ImagingExtractors for the TIFF image format produced by Bruker.""" import logging import re diff --git a/src/roiextractors/extractors/tiffimagingextractors/micromanagertiffimagingextractor.py b/src/roiextractors/extractors/tiffimagingextractors/micromanagertiffimagingextractor.py index 1df9f3d7..db141dc3 100644 --- a/src/roiextractors/extractors/tiffimagingextractors/micromanagertiffimagingextractor.py +++ b/src/roiextractors/extractors/tiffimagingextractors/micromanagertiffimagingextractor.py @@ -1,10 +1,4 @@ -"""A ImagingExtractor for TIFF files produced by Micro-Manager. - -Classes -------- -MicroManagerTiffImagingExtractor - A ImagingExtractor for TIFF files produced by Micro-Manager. -""" +"""A ImagingExtractor for TIFF files produced by Micro-Manager.""" import json import logging diff --git a/src/roiextractors/extractors/tiffimagingextractors/scanimagetiffimagingextractor.py b/src/roiextractors/extractors/tiffimagingextractors/scanimagetiffimagingextractor.py index bdc1bc38..2962a977 100644 --- a/src/roiextractors/extractors/tiffimagingextractors/scanimagetiffimagingextractor.py +++ b/src/roiextractors/extractors/tiffimagingextractors/scanimagetiffimagingextractor.py @@ -1,10 +1,4 @@ -"""Specialized extractor for reading TIFF files produced via ScanImage. - -Classes -------- -ScanImageTiffImagingExtractor - Specialized extractor for reading TIFF files produced via ScanImage. -""" +"""Specialized extractor for reading TIFF files produced via ScanImage.""" from pathlib import Path from typing import Optional, Tuple, List, Iterable diff --git a/src/roiextractors/extractors/tiffimagingextractors/tiffimagingextractor.py b/src/roiextractors/extractors/tiffimagingextractors/tiffimagingextractor.py index 9ae0a09d..af2c9733 100644 --- a/src/roiextractors/extractors/tiffimagingextractors/tiffimagingextractor.py +++ b/src/roiextractors/extractors/tiffimagingextractors/tiffimagingextractor.py @@ -1,10 +1,4 @@ -"""A TIFF imaging extractor for TIFF files. - -Classes -------- -TiffImagingExtractor - A TIFF imaging extractor for TIFF files. -""" +"""A TIFF imaging extractor for TIFF files.""" from pathlib import Path from typing import Optional diff --git a/src/roiextractors/imagingextractor.py b/src/roiextractors/imagingextractor.py index 44a1d39e..3de0918f 100644 --- a/src/roiextractors/imagingextractor.py +++ b/src/roiextractors/imagingextractor.py @@ -1,12 +1,4 @@ -"""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. -""" +"""Base class definitions for all ImagingExtractors.""" from abc import ABC, abstractmethod from typing import Union, Optional, Tuple diff --git a/src/roiextractors/multiimagingextractor.py b/src/roiextractors/multiimagingextractor.py index 294daa24..d0916a2f 100644 --- a/src/roiextractors/multiimagingextractor.py +++ b/src/roiextractors/multiimagingextractor.py @@ -1,10 +1,4 @@ -"""Defines the MultiImagingExtractor class. - -Classes -------- -MultiImagingExtractor - This class is used to combine multiple ImagingExtractor objects by frames. -""" +"""Defines the MultiImagingExtractor class.""" 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..1ef69312 100644 --- a/src/roiextractors/multisegmentationextractor.py +++ b/src/roiextractors/multisegmentationextractor.py @@ -1,10 +1,4 @@ -"""Defines the MultiSegmentationExtractor class. - -Classes -------- -MultiSegmentationExtractor - This class is used to combine multiple SegmentationExtractor objects by frames. -""" +"""Defines the MultiSegmentationExtractor class.""" import numpy as np diff --git a/src/roiextractors/segmentationextractor.py b/src/roiextractors/segmentationextractor.py index 3c2881c1..c2d92d7d 100644 --- a/src/roiextractors/segmentationextractor.py +++ b/src/roiextractors/segmentationextractor.py @@ -1,14 +1,4 @@ -"""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. -""" +"""Base segmentation extractors.""" from abc import ABC, abstractmethod from typing import Union, Optional, Tuple, Iterable, List