.. _f-imagesegmentation:

module ``ai.image_segmentation``
================================





.. inheritance-diagram:: code_beatrix.ai.image_segmentation


Short summary
+++++++++++++

module ``code_beatrix.ai.image_segmentation``

Extracts objects from an image based on deep learning.


:githublink:`%|py|5`




Classes
+++++++

+---------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------+
| class                                                                                 | truncated documentation                                                                                               |
+=======================================================================================+=======================================================================================================================+
| :class:`DLImageSegmentation <code_beatrix.ai.image_segmentation.DLImageSegmentation>` | Segments an image. Inspired from `infer.py <https://github.com/wkentaro/fcn/blob/master/examples/voc/infer.py>`_. ... |
+---------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------+






Properties
++++++++++

+--------------------------------------------------------------------------------------+------------------------------+
| property                                                                             | truncated documentation      |
+======================================================================================+==============================+
| :meth:`ModelFile <code_beatrix.ai.image_segmentation.DLImageSegmentation.ModelFile>` | Returns the model file name. |
+--------------------------------------------------------------------------------------+------------------------------+




Static Methods
++++++++++++++

+-----------------------------------------------------------------------------------------+-------------------------+
| staticmethod                                                                            | truncated documentation |
+=========================================================================================+=========================+
| :py:meth:`_new_size <code_beatrix.ai.image_segmentation.DLImageSegmentation._new_size>` | Computes a new size.    |
+-----------------------------------------------------------------------------------------+-------------------------+




Methods
+++++++

+---------------------------------------------------------------------------------------------+-------------------------------------------+
| method                                                                                      | truncated documentation                   |
+=============================================================================================+===========================================+
| :py:meth:`__init__ <code_beatrix.ai.image_segmentation.DLImageSegmentation.__init__>`       |                                           |
+---------------------------------------------------------------------------------------------+-------------------------------------------+
| :py:meth:`_load_image <code_beatrix.ai.image_segmentation.DLImageSegmentation._load_image>` | Loads an image as a :epkg:`numpy:array`.  |
+---------------------------------------------------------------------------------------------+-------------------------------------------+
| :py:meth:`_preprocess <code_beatrix.ai.image_segmentation.DLImageSegmentation._preprocess>` | Preprocesses the image before prediction. |
+---------------------------------------------------------------------------------------------+-------------------------------------------+
| :meth:`plot <code_beatrix.ai.image_segmentation.DLImageSegmentation.plot>`                  | Displays the segmentation.                |
+---------------------------------------------------------------------------------------------+-------------------------------------------+
| :meth:`predict <code_beatrix.ai.image_segmentation.DLImageSegmentation.predict>`            | Applies the model on features *X*.        |
+---------------------------------------------------------------------------------------------+-------------------------------------------+


Documentation
+++++++++++++

.. automodule:: code_beatrix.ai.image_segmentation
    :members:
    :special-members: __init__
    :show-inheritance: