===
ROI
===

.. currentmodule:: easyidp.roi

Class
=====

A summary of class ``easyidp.roi.ROI``, can be simple accessed by ``easyidp.ROI``


+-------------------------------------------------+---------------------------------------------------------------------------------------+
| :doc:`easyidp.ROI <manualdoc/easyidp.roi.ROI>`  | A Region of Interest (ROI) object, can be either 2D or 3D, often read from shp file.  |
+-------------------------------------------------+---------------------------------------------------------------------------------------+


.. toctree::
   :hidden:

   easyidp.roi.ROI <manualdoc/easyidp.roi.ROI>

Functions
=========

.. caution::
    
    The :class:`easyidp.ROI <easyidp.roi.ROI>` class is an advanced wrapper around the following functions, which is generally sufficient for most simple application cases, please don't use the following functions unless you really need to.

.. autosummary::
    :toctree: autodoc

    read_cc_txt