Skip to content

Commit

Permalink
Add module docstring for image data in NWB files
Browse files Browse the repository at this point in the history
  • Loading branch information
bendichter committed Jan 29, 2025
1 parent 574d846 commit ed2c1db
Showing 1 changed file with 19 additions and 0 deletions.
19 changes: 19 additions & 0 deletions src/pynwb/image.py
Original file line number Diff line number Diff line change
@@ -1,3 +1,22 @@
"""
Module for image data in NWB files.
This module provides classes for storing and manipulating image data in NWB files.
The following classes are available:
- :class:`~pynwb.image.ImageSeries`: General image data that is common between acquisition and stimulus time series
- :class:`~pynwb.image.IndexSeries`: Stores indices to image frames stored in an ImageSeries
- :class:`~pynwb.image.OpticalSeries`: Image data that is presented or recorded
- :class:`~pynwb.image.GrayscaleImage`: Single-channel (grayscale) image data
- :class:`~pynwb.image.RGBImage`: Three-channel (RGB) image data
- :class:`~pynwb.image.RGBAImage`: Four-channel (RGBA) image data with transparency
- :class:`~pynwb.base.Images`: Container for storing a collection of images (imported from :mod:`pynwb.base`)
- :class:`~pynwb.base.Image`: Base class for image data (imported from :mod:`pynwb.base`)
Note: While the :class:`~pynwb.base.Image` and :class:`~pynwb.base.Images` classes are defined in :mod:`pynwb.base`, they can be imported directly from this module:
from pynwb.image import Image, Images
"""

import warnings
from collections.abc import Iterable

Expand Down

0 comments on commit ed2c1db

Please sign in to comment.