.. meta::
    :description: Extensions Object Analysis Statistics

Object Analysis Statistics
==========================

This section explains how to create and edit Object Analysis Statistics.

Usage
-----
An object analysis statistics is an algorithm that will used to extract information about
each object (labelized voxels) contained in a MultiROI.

.. _filesLocationObjectAnalysisStatisticsExtension:

File location
-------------
To be recognized by the application, object analysis statistics should be located in one of these folders:

- %LocalAppData%/ORS/Dragonfly(*version*)/pythonUserExtensions/PythonPluginExtensions/ObjectAnalysis/PythonScriptsStatisticsGenerators (available for the current user)
- %ProgramData%/ORS/Dragonfly(*version*)/pythonAllUsersExtensions/PythonPluginExtensions/ObjectAnalysis/PythonScriptsStatisticsGenerators (available for all users)
- %ProgramData%/ORS/Dragonfly(*version*)/python/OrsPythonPlugins/OrsObjectAnalysis/PythonScriptsStatisticsGenerators (distributed with the application)

File creation
-------------
To create an object analysis statistics, start the application,
start the :mod:`OrsPythonPlugins.OrsObjectAnalysisStatisticsGenerator_5cb03bdc68a611e79023448a5b5d70c0.OrsObjectAnalysisStatisticsGenerator_5cb03bdc68a611e79023448a5b5d70c0`
(found in *Developer/Object Analysis Statistics Generator*),
fill in the required fields and press the button *Create statistics*.

File edition
------------
Open the file in a text editor.
Fill in the required methods.

Demos
-----

**Statistics on object geometry**

In this demonstration, the objective is to get a measure of the empty portion included by an object (like a shell).
There is 2 statistics computed based on the geometry of each object:

- "Porous volume": the volume of the empty portion of the object;
- "Porous volume fraction": the volume of the empty portion of the object on the volume occupied by the filled object.

Source code example:

#. Download the :download:`file </Documentation/Demos/DemoObjectAnalysisStatisticsPorousVolume_21fa7698aac611e787d6448a5b5d70c0.py>`;
#. Put that file into an :ref:`object analysis statistics extension folder <filesLocationObjectAnalysisStatisticsExtension>`;
#. Start the application;
#. Create a ROI having multiple disconnected 3D objects, some of those having holes completely included;
#. Right-click on the ROI and select *New Connectivity Multi-ROI Analysis...*;
#. Open the *Statistical Properties* panel (button in the the top-left section of the *Object Analysis* window);
#. In the left column (*Available datasets:*), make sure the *No dataset required* item is selected;
#. In the right column (*Statistical properties:*), select the items *Porous volume* and *Porous volume fraction*;
#. Press the *OK* button to compute these statistics.

**Statistics on data**

In this demonstration, the objective is to get a measure of the data outliers included over each object.
There is 2 statistics computed based on the data of each object:

- "Outlier count": the count of data samples identified as outliers accordingly to the modified Thompson Tau Test;
- "Outlier fraction": the count of data samples identified as outliers accordingly to the modified Thompson Tau Test
  on the total data samples of that object.

Source code example:

#. Download the :download:`file </Documentation/Demos/DemoObjectAnalysisStatisticsOutliers_eadba00cb29911e79651448a5b5d70c0.py>`;
#. Put that file into an :ref:`object analysis statistics extension folder <filesLocationObjectAnalysisStatisticsExtension>`;
#. Start the application;
#. Import a dataset;
#. Create a ROI from this dataset, having multiple disconnected 3D objects;
#. Right-click on the ROI and select *New Connectivity Multi-ROI Analysis...*;
#. Open the *Statistical Properties* panel (button in the the top-left section of the *Object Analysis* window);
#. In the left column (*Available datasets:*), select the item with the title of the dataset;
#. In the right column (*Statistical properties:*), select the items *Outlier count* and *Outlier fraction*;
#. Press the *OK* button to compute these statistics.