:py:mod:`AFQ.utils.stats`
=========================

.. py:module:: AFQ.utils.stats


Module Contents
---------------


Functions
~~~~~~~~~

.. autoapisummary::

   AFQ.utils.stats.contrast_index



.. py:function:: contrast_index(x1, x2, double=True)

   
   Calculate the contrast index between two arrays.
   The contrast index is symmetrical with respect to
   the choice of the baseline for comparison


   :Parameters:

       **x1** : ndarray of floats
           An ndarray to compare. The contrast index will have positive values
           where x1 > x2.

       **x2** : ndarray of floats
           An ndarray to compare. The contrast index will have negative values
           where x2 > x1.

       **double** : bool, optional
           Double the contrast index.
           This makes it comparable to a percent difference.
           Default: True

   :Returns:

       **contrast_index** : ndarray of floats
           Contrast index calculated by doing (x1 - x2) / (x1 + x2)













   ..
       !! processed by numpydoc !!