:github_url: https://github.com/Project-MONAI/MONAI

.. _data:

Data
====

Generic Interfaces
------------------
.. currentmodule:: monai.data

`Dataset`
~~~~~~~~~
.. autoclass:: Dataset
  :members:
  :special-members: __getitem__

`IterableDataset`
~~~~~~~~~~~~~~~~~
.. autoclass:: IterableDataset
  :members:
  :special-members: __next__

`DatasetFunc`
~~~~~~~~~~~~~
.. autoclass:: DatasetFunc
  :members:
  :special-members: __next__

`ShuffleBuffer`
~~~~~~~~~~~~~~~
.. autoclass:: ShuffleBuffer
  :members:
  :special-members: __next__

`CSVIterableDataset`
~~~~~~~~~~~~~~~~~~~~
.. autoclass:: CSVIterableDataset
  :members:
  :special-members: __next__

`PersistentDataset`
~~~~~~~~~~~~~~~~~~~
.. autoclass:: PersistentDataset
  :members:
  :special-members: __getitem__

`GDSDataset`
~~~~~~~~~~~~~~~~~~~
.. autoclass:: GDSDataset
  :members:
  :special-members: __getitem__


`CacheNTransDataset`
~~~~~~~~~~~~~~~~~~~~
.. autoclass:: CacheNTransDataset
  :members:
  :special-members: __getitem__

`LMDBDataset`
~~~~~~~~~~~~~
.. autoclass:: LMDBDataset
  :members:
  :special-members: __getitem__

`CacheDataset`
~~~~~~~~~~~~~~
.. autoclass:: CacheDataset
  :members:
  :special-members: __getitem__

`SmartCacheDataset`
~~~~~~~~~~~~~~~~~~~
.. autoclass:: SmartCacheDataset
  :members:
  :special-members: __getitem__

`ZipDataset`
~~~~~~~~~~~~
.. autoclass:: ZipDataset
  :members:
  :special-members: __getitem__

`ArrayDataset`
~~~~~~~~~~~~~~
.. autoclass:: ArrayDataset
  :members:
  :special-members: __getitem__

`ImageDataset`
~~~~~~~~~~~~~~
.. autoclass:: ImageDataset
  :members:
  :special-members: __getitem__

`NPZDictItemDataset`
~~~~~~~~~~~~~~~~~~~~
.. autoclass:: NPZDictItemDataset
  :members:
  :special-members: __getitem__

`CSVDataset`
~~~~~~~~~~~~
.. autoclass:: CSVDataset
  :members:
  :special-members: __getitem__

Patch-based dataset
-------------------

`GridPatchDataset`
~~~~~~~~~~~~~~~~~~
.. autoclass:: GridPatchDataset
  :members:

`PatchDataset`
~~~~~~~~~~~~~~
.. autoclass:: PatchDataset
  :members:

`PatchIter`
"""""""""""
.. autoclass:: PatchIter
    :members:
    :special-members: __call__

`PatchIterd`
""""""""""""
.. autoclass:: PatchIterd
    :members:
    :special-members: __call__

Image reader
------------

ImageReader
~~~~~~~~~~~
.. autoclass:: ImageReader
  :members:

ITKReader
~~~~~~~~~
.. autoclass:: ITKReader
  :members:

NibabelReader
~~~~~~~~~~~~~
.. autoclass:: NibabelReader
  :members:

NumpyReader
~~~~~~~~~~~
.. autoclass:: NumpyReader
  :members:

PILReader
~~~~~~~~~
.. autoclass:: PILReader
  :members:

NrrdReader
~~~~~~~~~~
.. autoclass:: NrrdReader
  :members:

Image writer
------------

resolve_writer
~~~~~~~~~~~~~~
.. autofunction:: resolve_writer

register_writer
~~~~~~~~~~~~~~~
.. autofunction:: register_writer

ImageWriter
~~~~~~~~~~~
.. autoclass:: ImageWriter
  :members:

ITKWriter
~~~~~~~~~
.. autoclass:: ITKWriter
  :members:

NibabelWriter
~~~~~~~~~~~~~
.. autoclass:: NibabelWriter
  :members:

PILWriter
~~~~~~~~~
.. autoclass:: PILWriter
  :members:

Synthetic
---------
.. automodule:: monai.data.synthetic
  :members:


Ouput folder layout
-------------------
.. automodule:: monai.data.folder_layout
  :members:


Utilities
---------
.. automodule:: monai.data.utils
  :members:

Partition Dataset
~~~~~~~~~~~~~~~~~
.. autofunction:: monai.data.partition_dataset

Partition Dataset based on classes
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. autofunction:: monai.data.partition_dataset_classes

DistributedSampler
~~~~~~~~~~~~~~~~~~
.. autoclass:: monai.data.DistributedSampler

DistributedWeightedRandomSampler
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. autoclass:: monai.data.DistributedWeightedRandomSampler

DatasetSummary
~~~~~~~~~~~~~~
.. autoclass:: monai.data.DatasetSummary

Decathlon Datalist
~~~~~~~~~~~~~~~~~~
.. autofunction:: monai.data.load_decathlon_datalist
.. autofunction:: monai.data.load_decathlon_properties
.. autofunction:: monai.data.check_missing_files
.. autofunction:: monai.data.create_cross_validation_datalist


DataLoader
~~~~~~~~~~
.. autoclass:: monai.data.DataLoader


ThreadBuffer
~~~~~~~~~~~~
.. autoclass:: monai.data.ThreadBuffer

ThreadDataLoader
~~~~~~~~~~~~~~~~
.. autoclass:: monai.data.ThreadDataLoader

TestTimeAugmentation
~~~~~~~~~~~~~~~~~~~~
.. autoclass:: monai.data.TestTimeAugmentation

N-Dim Fourier Transform
~~~~~~~~~~~~~~~~~~~~~~~~~
.. automodule:: monai.data.fft_utils
.. autofunction:: monai.data.fft_utils.fftn_centered
.. autofunction:: monai.data.fft_utils.ifftn_centered

ITK Torch Bridge
~~~~~~~~~~~~~~~~
.. automodule:: monai.data.itk_torch_bridge
  :members:


Meta Object
-----------
.. automodule:: monai.data.meta_obj
  :members:

MetaTensor
----------
.. autoclass:: monai.data.MetaTensor
  :members:
  :show-inheritance:
  :inherited-members: MetaObj



Whole slide image reader
------------------------

BaseWSIReader
~~~~~~~~~~~~~
.. autoclass:: monai.data.BaseWSIReader
  :members:

WSIReader
~~~~~~~~~
.. autoclass:: monai.data.WSIReader
  :members:

CuCIMWSIReader
~~~~~~~~~~~~~~
.. autoclass:: monai.data.CuCIMWSIReader
  :members:

OpenSlideWSIReader
~~~~~~~~~~~~~~~~~~
.. autoclass:: monai.data.OpenSlideWSIReader
  :members:

TiffFileWSIReader
~~~~~~~~~~~~~~~~~
.. autoclass:: monai.data.TiffFileWSIReader
  :members:


Whole slide image datasets
--------------------------

PatchWSIDataset
~~~~~~~~~~~~~~~
.. autoclass:: monai.data.PatchWSIDataset
    :members:

MaskedPatchWSIDataset
~~~~~~~~~~~~~~~~~~~~~~
.. autoclass:: monai.data.MaskedPatchWSIDataset
    :members:

SlidingPatchWSIDataset
~~~~~~~~~~~~~~~~~~~~~~
.. autoclass:: monai.data.SlidingPatchWSIDataset
    :members:

Bounding box
------------
.. automodule:: monai.data.box_utils
    :members:

Video datasets
--------------

VideoDataset
~~~~~~~~~~~~
.. autoclass:: monai.data.video_dataset.VideoDataset

VideoFileDataset
~~~~~~~~~~~~~~~~
.. autoclass:: monai.data.video_dataset.VideoFileDataset

CameraDataset
~~~~~~~~~~~~~
.. autoclass:: monai.data.video_dataset.CameraDataset