.. _stat_tool_reference:


Reference guide
###############
.. contents::


C++ binding guide
=================
.. automodule:: openalea.stat_tool._stat_tool
    :members:
    :undoc-members:
    :inherited-members:
    :show-inheritance:
    :private-members:



Data structures
===================

.. module:: openalea.stat_tool.compound
.. module:: compound

:mod:`openalea.stat_tool.compound` module
---------------------------------------------------

.. automodule:: openalea.stat_tool.compound
    :members:
    :undoc-members:
    :inherited-members:
    :show-inheritance:
    :synopsis: Compound module


.. currentmodule:: openalea.stat_tool.convolution
.. module:: convolution

:mod:`openalea.stat_tool.convolution` module
---------------------------------------------------
.. automodule:: openalea.stat_tool.convolution
    :members:
    :undoc-members:
    :inherited-members:
    :show-inheritance:
    :synopsis:  Convolution module 

.. currentmodule:: openalea.stat_tool.distribution
.. module:: distribution

:mod:`openalea.stat_tool.distribution` module
---------------------------------------------------
.. automodule:: openalea.stat_tool.distribution
    :members:
    :undoc-members:
    :inherited-members:
    :show-inheritance:
    :synopsis:  Distributions module

.. module:: histogram

:mod:`openalea.stat_tool.histogram` module
---------------------------------------------------
.. automodule:: openalea.stat_tool.histogram
    :members:
    :undoc-members:
    :inherited-members:
    :show-inheritance:
    :synopsis: Histogram functions and classes


.. module:: mixture

:mod:`openalea.stat_tool.mixture` module
---------------------------------------------------
.. automodule:: openalea.stat_tool.mixture
    :members:
    :undoc-members:
    :inherited-members:
    :show-inheritance:
    :synopsis:  Mixture class


.. module:: vectors

:mod:`openalea.stat_tool.vectors` module
------------------------------------------------------
.. automodule:: openalea.stat_tool.vectors
    :members:
    :undoc-members:
    :inherited-members:
    :show-inheritance:
    :synopsis: Vectors function and class


.. module:: multivariate_vmixture

:mod:`openalea.stat_tool.multivariate_mixture` module
------------------------------------------------------
.. automodule:: openalea.stat_tool.multivariate_mixture
    :members:
    :undoc-members:
    :inherited-members:
    :show-inheritance:
    :synopsis: Mv Mixture class


Functionalities
================

.. module:: regression

:mod:`openalea.stat_tool.regression` module
--------------------------------------------
.. automodule:: openalea.stat_tool.regression
    :members:
    :undoc-members:
    :inherited-members:
    :show-inheritance:
    :synopsis: Regression


.. module:: simulate

:mod:`openalea.stat_tool.simulate` module
--------------------------------------------
.. automodule:: openalea.stat_tool.simulate
    :members:
    :undoc-members:
    :inherited-members:
    :show-inheritance:
    :synopsis:  Simulation functions 


.. module:: cluster

:mod:`openalea.stat_tool.cluster` module
------------------------------------------
.. automodule:: openalea.stat_tool.cluster
    :members:
    :undoc-members:
    :inherited-members:
    :show-inheritance:
    :synopsis: Cluster functions and classes


.. module:: comparison

:mod:`openalea.stat_tool.comparison` module
----------------------------------------------
.. automodule:: openalea.stat_tool.comparison
    :members:
    :undoc-members:
    :inherited-members:
    :show-inheritance:
    :synopsis: Comparison functions


.. module:: data_transform

:mod:`openalea.stat_tool.data_transform` module
-------------------------------------------------
.. automodule:: openalea.stat_tool.data_transform
    :members:
    :undoc-members:
    :inherited-members:
    :show-inheritance:
    :synopsis: Data transformation functions

.. module:: estimate

:mod:`openalea.stat_tool.estimate` module
---------------------------------------------------
.. automodule:: openalea.stat_tool.estimate
    :members:
    :undoc-members:
    :inherited-members:
    :show-inheritance:
    :synopsis:  Estimation functions 



Display and Plot functionalities
=================================

.. module:: output

:mod:`openalea.stat_tool.output` module
----------------------------------------------------
.. automodule:: openalea.stat_tool.output
    :members:
    :undoc-members:
    :inherited-members:
    :show-inheritance:
    :synopsis: Output functions


.. module:: plot

:mod:`openalea.stat_tool.plot` module
-----------------------------------------------
.. automodule:: openalea.stat_tool.plot
    :members:
    :undoc-members:
    :inherited-members:
    :show-inheritance:
    :synopsis:  Plot functions 

Others
======

.. module:: error

:mod:`openalea.stat_tool.error` module
----------------------------------------------


.. automodule:: openalea.stat_tool.error
    :members:
    :undoc-members:
    :inherited-members:
    :show-inheritance:
    :synopsis:  Error class to manage standard errors in stat_tool 

.. module:: interface

:mod:`openalea.stat_tool.interface` module
---------------------------------------------
.. automodule:: openalea.stat_tool.interface
    :members:
    :undoc-members:
    :inherited-members:
    :show-inheritance:
    :synopsis:  Interfaces for stat_tool objects