ROI Analysis Tools
==================


.. contents:: On this page
   :local:
   :depth: 1

ROI Analyzer
------------

.. autoclass:: simba.roi_tools.ROI_analyzer.ROIAnalyzer
   :members:
   :show-inheritance:

ROI Classification Calculator - Single Core
--------------------------------------------

.. autoclass:: simba.roi_tools.roi_clf_calculator.ROIClfCalculator
   :members:
   :show-inheritance:

ROI Classification Calculator - Multiprocess
--------------------------------------------

.. autoclass:: simba.roi_tools.roi_clf_calculator_mp.ROIClfCalculatorMultiprocess
   :members:
   :show-inheritance:

ROI Movement Analyzer - Single Core
-----------------------------------

.. autoclass:: simba.roi_tools.roi_aggregate_statistics_analyzer.ROIAggregateStatisticsAnalyzer
   :members:
   :show-inheritance:

ROI Movement Analyzer - Multiprocess
-------------------------------------

.. autoclass:: simba.roi_tools.roi_aggregate_stats_mp.ROIAggregateStatisticsAnalyzerMultiprocess
   :members:
   :show-inheritance:

ROI Feature Analyzer
--------------------

.. automodule:: simba.roi_tools.ROI_feature_analyzer
   :members:
   :show-inheritance:

ROI Directing Analyzer
----------------------

.. automodule:: simba.roi_tools.ROI_directing_analyzer
   :members:
   :show-inheritance:

ROI Time-Bin Calculator
-----------------------

.. autoclass:: simba.roi_tools.roi_time_bins_analyzer.ROITimebinAnalyzer
   :members:
   :show-inheritance:

ROI Time-Bin Calculator (Legacy)
--------------------------------

.. autoclass:: simba.roi_tools.ROI_time_bin_calculator.ROITimebinCalculator
   :members:
   :show-inheritance:

ROI Size Standardizer
---------------------

.. autoclass:: simba.roi_tools.ROI_size_standardizer.ROISizeStandardizer
   :members:
   :show-inheritance:

ROI Visualization
=================

ROI Plotter - Single Core
-------------------------

.. autoclass:: simba.plotting.roi_plotter.ROIPlotter
   :members:
   :show-inheritance:
   :noindex:

ROI Plotter - Multiprocess
---------------------------

.. autoclass:: simba.plotting.roi_plotter_mp.ROIPlotMultiprocess
   :members:
   :show-inheritance:
   :noindex:

ROI Feature Visualizer - Single Core
--------------------------------------

.. autoclass:: simba.plotting.ROI_feature_visualizer.ROIfeatureVisualizer
   :members:
   :show-inheritance:
   :noindex:

ROI Feature Visualizer - Multiprocess
---------------------------------------

.. autoclass:: simba.plotting.ROI_feature_visualizer_mp.ROIfeatureVisualizerMultiprocess
   :members:
   :show-inheritance:
   :noindex:

ROI Directing Visualizer
-------------------------

.. autoclass:: simba.plotting.roi_directing_visualizer.DirectingROIVisualizer
   :members:
   :show-inheritance:
   :noindex:

ROI GUI Tools
=============

ROI GUI
-------

.. autoclass:: simba.roi_tools.roi_ui.ROI_ui
   :members:
   :show-inheritance:

ROI GUI Mixin
-------------

.. automodule:: simba.roi_tools.roi_ui_mixin
   :members:
   :show-inheritance:

ROI Ruler
-------

.. autoclass:: simba.roi_tools.roi_ruler.ROIRuler
   :members:
   :show-inheritance:

ROI GUI Utils
-------------

.. automodule:: simba.roi_tools.roi_utils
   :members:
   :undoc-members:
   :show-inheritance:

ROI Shape Selectors
===================

ROI Circle Selector
-------------------

.. automodule:: simba.roi_tools.roi_selector_circle_tkinter
   :members:
   :show-inheritance:

ROI Polygon Selector
--------------------

.. automodule:: simba.roi_tools.roi_selector_polygon_tkinter
   :members:
   :show-inheritance:

ROI Rectangle Selector (Tkinter)
--------------------------------

.. autoclass:: simba.roi_tools.roi_selector_rectangle_tkinter.ROISelector
   :members:
   :show-inheritance:

ROI Interactive Bufferer
-------------------------

.. autoclass:: simba.roi_tools.interactive_roi_bufferer.InteractiveROIBufferer
   :members:
   :show-inheritance:

ROI Interactive Modifiers
=========================

ROI Interactive Modifier UI (Tkinter)
--------------------------------------

.. autoclass:: simba.roi_tools.interactive_roi_modifier_tkinter.InteractiveROIModifier
   :members:
   :show-inheritance:

ROI Interactive Modifier UI - Legacy (OpenCV)
----------------------------------------------

.. autoclass:: simba.roi_tools.interactive_modifier_ui.InteractiveROIModifier
   :members:
   :show-inheritance:

ROI Data Import/Export
======================

ROI CSV Importer
----------------

.. autoclass:: simba.roi_tools.import_roi_csvs.ROIDefinitionsCSVImporter
   :members:
   :show-inheritance: