<commit_before>API documentation
=================

The :mod:`jicimagelib` package
------------------------------

.. automodule:: jicimagelib
   :members:

The :mod:`jicimagelib.image` module
-----------------------------------

.. automodule:: jicimagelib.image
   :members:

The :mod:`jicimagelib.io` module
--------------------------------

.. automodule:: jicimagelib.io
   :members:

The :mod:`jicimagelib.transform` module
---------------------------------------<commit_msg>Added some more structure to API documentation.<commit_after>API documentation
=================

The :mod:`jicimagelib` package
------------------------------

.. automodule:: jicimagelib
   :members:

The :mod:`jicimagelib.image` module
-----------------------------------

.. automodule:: jicimagelib.image

Image classes
^^^^^^^^^^^^^

.. autoclass:: jicimagelib.image.Image
   :members:

.. autoclass:: jicimagelib.image.ProxyImage
   :members:

.. autoclass:: jicimagelib.image.MicroscopyImage
   :members:

Collection classes
^^^^^^^^^^^^^^^^^^

.. autoclass:: jicimagelib.image.ImageCollection
   :members:

.. autoclass:: jicimagelib.image.MicroscopyCollection
   :members:

The :class:`jicimagelib.image.DataManager` class
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

.. autoclass:: jicimagelib.image.DataManager
   :members:

The :mod:`jicimagelib.io` module
--------------------------------

.. automodule:: jicimagelib.io
   :members:

The :mod:`jicimagelib.transform` module
---------------------------------------
{'fraction_non_alphanumeric': 0.34478203434610305, 'fraction_numerical': 0.0, 'mean_word_length': 2.1761006289308176, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 3, 'https://': 0, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '7087303', 'n_tokens_mistral': 457, 'n_tokens_neox': 446, 'n_words': 76}