Class reference
===============

Parameters
----------

.. autoclass:: myFitter.Parameter
   :members:


Constraints
-----------

.. autoclass:: myFitter.Constraint
   :members:


Chi-square contributions
------------------------

.. autoclass:: myFitter.ChiSquareContribution
   :members:

.. autoclass:: myFitter.GaussianCSC
   :members:

.. autoclass:: myFitter.CorrelatedGaussianCSC
   :members:


Models
------

.. autoclass:: myFitter.Model
   :members:


Fits
----

.. autoclass:: myFitter.FitResult
   :members:

.. autoclass:: myFitter.Fitter
   :members:

.. autofunction:: myFitter.fit


Conversions for p, Z, and chi-square values
-------------------------------------------

.. autofunction:: myFitter.pvalueFromChisq

.. autofunction:: myFitter.chisqFromPvalue

.. autofunction:: myFitter.zvalueFromPvalue

.. autofunction:: myFitter.pvalueFromZvalue

.. autofunction:: myFitter.zvalueFromChisq

.. autofunction:: myFitter.chisqFromZvalue



Profilers
---------

.. autoclass:: myFitter.Profiler1D
   :members:

.. autoclass:: myFitter.Profiler2D
   :members:


Gaussian variates
-----------------

.. autoclass:: myFitter.GVar


Histograms
----------

.. autoclass:: myFitter.Histogram1D
   :members:

.. autoclass:: myFitter.Histogram2D
   :members:

.. autofunction:: myFitter.cumulatedHistogram

.. autofunction:: myFitter.densityHistogram


Integration and toy simulations
-------------------------------

.. autoclass:: myFitter.IntegrationResult
   :members:

.. autofunction:: myFitter.integrationResults

.. autoclass:: myFitter.Integrator
   :members:

.. autoclass:: myFitter.LRTIntegrand
   :members:

.. autoclass:: myFitter.ToySimulator
   :members:


Parallelisation
---------------

.. autoclass:: myFitter.ParallelFunction
   :members:

.. autofunction:: myFitter.parallel

.. autoclass:: myFitter.BasicRunner
   :members:

.. autoclass:: myFitter.LocalRunner

.. autoclass:: myFitter.SlurmRunner