Updated documentation for version 0.0.2

TheJacksonLaboratory · Aug 22, 2024 · 8b4a26e · 8b4a26e
1 parent 33dd07a
commit 8b4a26e
Show file tree

Hide file tree

Showing 101 changed files with 2,111 additions and 865 deletions.
diff --git a/.gitignore b/.gitignore
@@ -137,3 +137,6 @@ tests/test_zarrs/*
 tests/test_tiffs/*
 tests/*.png
 .vscode/settings.json
+
+/docs_build/
+/jupyter_execute/
diff --git a/docs/.buildinfo b/docs/.buildinfo
@@ -1,4 +1,4 @@
 # Sphinx build info version 1
 # This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
-config: 5704830082c07750dd4f65112d73bff2
+config: ca6db5e3c63f8be4f91f3b82db3b81cf
 tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/docs/.doctrees/autoapi/index.doctree b/docs/.doctrees/autoapi/index.doctree
diff --git a/docs/.doctrees/autoapi/zarrdataset/_augs/index.doctree b/docs/.doctrees/autoapi/zarrdataset/_augs/index.doctree
diff --git a/docs/.doctrees/autoapi/zarrdataset/_imageloaders/index.doctree b/docs/.doctrees/autoapi/zarrdataset/_imageloaders/index.doctree
diff --git a/docs/.doctrees/autoapi/zarrdataset/_maskfuncs/index.doctree b/docs/.doctrees/autoapi/zarrdataset/_maskfuncs/index.doctree
diff --git a/docs/.doctrees/autoapi/zarrdataset/_samplers/index.doctree b/docs/.doctrees/autoapi/zarrdataset/_samplers/index.doctree
diff --git a/docs/.doctrees/autoapi/zarrdataset/_utils/index.doctree b/docs/.doctrees/autoapi/zarrdataset/_utils/index.doctree
diff --git a/docs/.doctrees/autoapi/zarrdataset/_zarrdataset/index.doctree b/docs/.doctrees/autoapi/zarrdataset/_zarrdataset/index.doctree
diff --git a/docs/.doctrees/autoapi/zarrdataset/index.doctree b/docs/.doctrees/autoapi/zarrdataset/index.doctree
diff --git a/docs/.doctrees/environment.pickle b/docs/.doctrees/environment.pickle
diff --git a/docs/.doctrees/examples/advanced_example_pytorch.doctree b/docs/.doctrees/examples/advanced_example_pytorch.doctree
diff --git a/docs/.doctrees/examples/advanced_example_pytorch_inference.doctree b/docs/.doctrees/examples/advanced_example_pytorch_inference.doctree
diff --git a/docs/.doctrees/examples/advanced_masked_datasets_example.doctree b/docs/.doctrees/examples/advanced_masked_datasets_example.doctree
diff --git a/docs/.doctrees/examples/basic_example.doctree b/docs/.doctrees/examples/basic_example.doctree
diff --git a/docs/.doctrees/examples/basic_example_pytorch.doctree b/docs/.doctrees/examples/basic_example_pytorch.doctree
diff --git a/docs/.doctrees/examples/basic_example_tensorflow.doctree b/docs/.doctrees/examples/basic_example_tensorflow.doctree
diff --git a/docs/.doctrees/examples/basic_labeled_datasets_example.doctree b/docs/.doctrees/examples/basic_labeled_datasets_example.doctree
diff --git a/docs/.doctrees/examples/basic_masked_datasets_example.doctree b/docs/.doctrees/examples/basic_masked_datasets_example.doctree
diff --git a/docs/.doctrees/index.doctree b/docs/.doctrees/index.doctree
diff --git a/docs/.doctrees/license_link.doctree b/docs/.doctrees/license_link.doctree
diff --git a/docs/.doctrees/readme_link.doctree b/docs/.doctrees/readme_link.doctree
diff --git a/docs/_images/0493ea7949336c8bafa6c2a4a4fb0b6f684533792c8a8aee276b84450c0c67ea.png b/docs/_images/0493ea7949336c8bafa6c2a4a4fb0b6f684533792c8a8aee276b84450c0c67ea.png
diff --git a/docs/_images/14f77fdbefbffee0f204c62d7ca15a5007c9e1ccf295938f7dfbce40dff911db.png b/docs/_images/14f77fdbefbffee0f204c62d7ca15a5007c9e1ccf295938f7dfbce40dff911db.png
diff --git a/docs/_images/1b9d3ae60591d9fa3d3765b22339938d8e2e0f747098c8f8890f0dfd31350263.png b/docs/_images/1b9d3ae60591d9fa3d3765b22339938d8e2e0f747098c8f8890f0dfd31350263.png
diff --git a/docs/_images/2aa6d8e78d812bedbf9cb39408d1225ee70f51ceba3d55b2907fc903dfca5cac.png b/docs/_images/2aa6d8e78d812bedbf9cb39408d1225ee70f51ceba3d55b2907fc903dfca5cac.png
diff --git a/docs/_images/35caf5d6a16a402da32ca7028c903bf35d4a356a2cc6d94421b48e1413335fa9.png b/docs/_images/35caf5d6a16a402da32ca7028c903bf35d4a356a2cc6d94421b48e1413335fa9.png
diff --git a/docs/_images/4e0e23bdb35ff463a282b0662c51ebe482fdeb0fb21e017109fefe9fe682fff5.png b/docs/_images/4e0e23bdb35ff463a282b0662c51ebe482fdeb0fb21e017109fefe9fe682fff5.png
diff --git a/docs/_images/51bb3e68b17996eba92cdf91265cc913643519e5f5dde09c75ea57aded64d6e8.png b/docs/_images/51bb3e68b17996eba92cdf91265cc913643519e5f5dde09c75ea57aded64d6e8.png
diff --git a/docs/_images/5e5194f3aacd660f1d602d50e46aff1b64a2b0f19f6be64ea92299b4973e7d97.png b/docs/_images/5e5194f3aacd660f1d602d50e46aff1b64a2b0f19f6be64ea92299b4973e7d97.png
diff --git a/docs/_images/6e34f8ee7b278bfd8a09e6905ef8262eb47d5a1d1fb29441f644e0aa49eb63dd.png b/docs/_images/6e34f8ee7b278bfd8a09e6905ef8262eb47d5a1d1fb29441f644e0aa49eb63dd.png
diff --git a/docs/_images/754e8e0d0d095c71d66538d669e039318c29e89bca3e925b23b587a091be1603.png b/docs/_images/754e8e0d0d095c71d66538d669e039318c29e89bca3e925b23b587a091be1603.png
diff --git a/docs/_images/845f208486df8f8430ae79295cf9999af568961227d3a7f74143891b3feaf295.png b/docs/_images/845f208486df8f8430ae79295cf9999af568961227d3a7f74143891b3feaf295.png
diff --git a/docs/_images/8c2a029504368753fc523a63f10d74fc682d6cf97a23a2d3d607c1a82ed61aba.png b/docs/_images/8c2a029504368753fc523a63f10d74fc682d6cf97a23a2d3d607c1a82ed61aba.png
diff --git a/docs/_images/9d6d81e4243d6ff0402a7e6324a0f516f03ecf71cdee64ec322aa28e8e1ef266.png b/docs/_images/9d6d81e4243d6ff0402a7e6324a0f516f03ecf71cdee64ec322aa28e8e1ef266.png
diff --git a/docs/_images/a29b08481e2598a61febed5711e2d9285586fdc5a6112febb2b8b4f32587e173.png b/docs/_images/a29b08481e2598a61febed5711e2d9285586fdc5a6112febb2b8b4f32587e173.png
diff --git a/docs/_images/a89460b27e574359592e522b7085cd793e44415667461cfb486dd68e3e154352.png b/docs/_images/a89460b27e574359592e522b7085cd793e44415667461cfb486dd68e3e154352.png
diff --git a/docs/_images/db7d97bf2f0692371951419e0014fc7f39aecdce0e091723176657940810f457.png b/docs/_images/db7d97bf2f0692371951419e0014fc7f39aecdce0e091723176657940810f457.png
diff --git a/docs/_images/e16ff8424e5b53a5108a7f2c87a24cb50ae3850bb800f3a40b6d89a3c87b4be8.png b/docs/_images/e16ff8424e5b53a5108a7f2c87a24cb50ae3850bb800f3a40b6d89a3c87b4be8.png
diff --git a/docs/_images/ee452c4ccae35fc77d15bea56dce7c6a644de67d7e546c281e6b1cc08f9c7b2e.png b/docs/_images/ee452c4ccae35fc77d15bea56dce7c6a644de67d7e546c281e6b1cc08f9c7b2e.png
diff --git a/docs/_images/efb0e0c981a2a37c61e11c54650023abd22cd8217f80b9af551ca2c50a0ee414.png b/docs/_images/efb0e0c981a2a37c61e11c54650023abd22cd8217f80b9af551ca2c50a0ee414.png
diff --git a/docs/_images/f99c6c24479005965377053093c7c4b95248d8010913dabe394641feeb087266.png b/docs/_images/f99c6c24479005965377053093c7c4b95248d8010913dabe394641feeb087266.png
diff --git a/docs/_images/fad1bda0fb99150f350bad3eb2d11531e570bf1fb182fda50859b693662a8898.png b/docs/_images/fad1bda0fb99150f350bad3eb2d11531e570bf1fb182fda50859b693662a8898.png
diff --git a/docs/_modules/index.html b/docs/_modules/index.html
@@ -6,7 +6,7 @@
   <title>Overview: module code &mdash; ZarrDataset  documentation</title>
       <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=80d5e7a1" />
       <link rel="stylesheet" type="text/css" href="../_static/css/theme.css?v=19f00094" />
-      <link rel="stylesheet" type="text/css" href="../_static/mystnb.4510f1fc1dee50b3e5859aac5469c37c29e427902b24a333a5f9fcb2f0b3ac41.css" />
+      <link rel="stylesheet" type="text/css" href="../_static/mystnb.4510f1fc1dee50b3e5859aac5469c37c29e427902b24a333a5f9fcb2f0b3ac41.css?v=be8a1c11" />
       <link rel="stylesheet" type="text/css" href="../_static/graphviz.css?v=fd3f3429" />
 
 

diff --git a/docs/_modules/zarrdataset/_samplers.html b/docs/_modules/zarrdataset/_samplers.html
diff --git a/docs/_sources/autoapi/zarrdataset/_augs/index.rst.txt b/docs/_sources/autoapi/zarrdataset/_augs/index.rst.txt
@@ -1,32 +1,34 @@
-:py:mod:`zarrdataset._augs`
-===========================
+zarrdataset._augs
+=================
 
 .. py:module:: zarrdataset._augs
 
 
-Module Contents
----------------
-
 Classes
-~~~~~~~
+-------
 
 .. autoapisummary::
 
    zarrdataset._augs.ToDtype
 
 
-
+Module Contents
+---------------
 
 .. py:class:: ToDtype(dtype: numpy.dtype)
 
-
    Bases: :py:obj:`object`
 
+
    Converted a numpy NDArray to the specified data type.
 
    :param dtype: The data type to cast the input array.
    :type dtype: numpy.dtype
 
+
+   .. py:attribute:: _dtype
+
+
    .. py:method:: __call__(image: numpy.ndarray) -> numpy.ndarray
 
       Casts the type of `image` to the data type specified with `dtype`.
@@ -38,6 +40,7 @@ Classes
       :rtype: numpy.ndarray
 
 
+
    .. py:method:: __repr__() -> str
 
       Return repr(self).

diff --git a/docs/_sources/autoapi/zarrdataset/_imageloaders/index.rst.txt b/docs/_sources/autoapi/zarrdataset/_imageloaders/index.rst.txt
@@ -1,14 +1,19 @@
-:py:mod:`zarrdataset._imageloaders`
-===================================
+zarrdataset._imageloaders
+=========================
 
 .. py:module:: zarrdataset._imageloaders
 
 
-Module Contents
----------------
+Attributes
+----------
+
+.. autoapisummary::
+
+   zarrdataset._imageloaders.TIFFFILE_SUPPORT
+
 
 Classes
-~~~~~~~
+-------
 
 .. autoapisummary::
 
@@ -17,28 +22,20 @@ Classes
    zarrdataset._imageloaders.ImageCollection
 
 
-
 Functions
-~~~~~~~~~
+---------
 
 .. autoapisummary::
 
    zarrdataset._imageloaders.image2array
 
 
-
-Attributes
-~~~~~~~~~~
-
-.. autoapisummary::
-
-   zarrdataset._imageloaders.TIFFFILE_SUPPORT
-
+Module Contents
+---------------
 
 .. py:data:: TIFFFILE_SUPPORT
    :value: True
 
-
 
 .. py:function:: image2array(arr_src: Union[str, zarr.Group, zarr.Array, numpy.ndarray], data_group: Union[str, int, None] = None, zarr_store: Union[zarr.storage.Store, None] = None)
 
@@ -62,88 +59,91 @@ Attributes
 
 .. py:class:: ImageBase(shape: Iterable[int], chunk_size: Union[Iterable[int], None] = None, source_axes: str = '', mode: str = '')
 
-
    Bases: :py:obj:`object`
 
-   .. py:property:: shape
-      :type: Iterable[int]
-
-
-   .. py:property:: chunk_size
-      :type: Iterable[int]
-
-
-   .. py:property:: scale
-      :type: dict
-
 
    .. py:attribute:: arr
+      :value: None
+
 
-      
 
    .. py:attribute:: spatial_axes
       :value: 'ZYX'
 
-      
+
 
    .. py:attribute:: source_axes
+      :value: None
+
 
-      
 
    .. py:attribute:: axes
+      :value: None
+
 
-      
 
    .. py:attribute:: mode
       :value: ''
 
-      
+
 
    .. py:attribute:: permute_order
+      :value: None
+
 
-      
 
    .. py:attribute:: _store
+      :value: None
+
 
-      
 
    .. py:attribute:: _new_axes
       :value: ''
 
-      
+
 
    .. py:attribute:: _drop_axes
       :value: ''
 
-      
+
 
    .. py:attribute:: _scale
+      :value: None
+
 
-      
 
    .. py:attribute:: _shape
+      :value: None
+
 
-      
 
    .. py:attribute:: _spatial_reference_shape
+      :value: None
+
 
-      
 
    .. py:attribute:: _spatial_reference_axes
+      :value: None
+
 
-      
 
    .. py:attribute:: _chunk_size
+      :value: None
+
 
-      
 
    .. py:attribute:: _cached_coords
+      :value: None
+
 
-      
 
    .. py:attribute:: _image_func
+      :value: None
+
+
+
+   .. py:attribute:: roi
 
-      
 
    .. py:method:: _iscached(coords)
 
@@ -169,11 +169,26 @@ Attributes
 
 
 
-.. py:class:: ImageLoader(filename: str, source_axes: str, data_group: Union[str, None] = None, axes: Union[str, None] = None, roi: Union[str, slice, Iterable[slice], None] = None, image_func: Union[Callable, None] = None, zarr_store: Union[zarr.storage.Store, None] = None, spatial_axes: str = 'ZYX', mode: str = '')
+   .. py:property:: shape
+      :type: Iterable[int]
+
+
+
+   .. py:property:: chunk_size
+      :type: Iterable[int]
+
+
+
+   .. py:property:: scale
+      :type: dict
+
 
 
+.. py:class:: ImageLoader(filename: str, source_axes: str, data_group: Union[str, None] = None, axes: Union[str, None] = None, roi: Union[str, slice, Iterable[slice], None] = None, image_func: Union[Callable, None] = None, zarr_store: Union[zarr.storage.Store, None] = None, spatial_axes: str = 'ZYX', mode: str = '')
+
    Bases: :py:obj:`ImageBase`
 
+
    Image lazy loader class.
 
    Opens the zarr file, or any image that can be open by TiffFile or PIL, as a
@@ -198,15 +213,36 @@ Attributes
    :param mode:
    :type mode: str
 
-   .. py:method:: __del__()
 
+   .. py:attribute:: mode
 
 
-.. py:class:: ImageCollection(collection_args: dict, spatial_axes: str = 'ZYX')
+   .. py:attribute:: spatial_axes
+
+
+   .. py:attribute:: roi_slices
 
 
+   .. py:attribute:: roi
+
+
+   .. py:attribute:: source_axes
+
+
+   .. py:attribute:: axes
+
+
+   .. py:attribute:: _image_func
+
+
+   .. py:method:: __del__()
+
+
+.. py:class:: ImageCollection(collection_args: dict, spatial_axes: str = 'ZYX')
+
    Bases: :py:obj:`object`
 
+
    A class to contain a collection of inputs from different modalities.
 
    This is used to match images with their respective labels and masks.
@@ -218,6 +254,16 @@ Attributes
                         modalities using as reference these axes from the `images` collection.
    :type spatial_axes: str
 
+
+   .. py:attribute:: reference_mode
+
+
+   .. py:attribute:: spatial_axes
+
+
+   .. py:attribute:: collection
+
+
    .. py:method:: _generate_mask()
 
 
@@ -227,7 +273,7 @@ Attributes
       collection shape on the `spatial_axes` only.
 
 
-   .. py:method:: __getitem__(index)
 
+   .. py:method:: __getitem__(index)