Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Images in image mod docs #2029

Open
wants to merge 2 commits into
base: dev
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,9 @@ build/
dist/
*.egg-info

# Virtual Environment
venv/

# Jupyter Notebook
.ipynb_checkpoints

Expand Down
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
Loading