.. _OptimizeStandardDeviation:

OptimizeStandardDeviation
=========================

.. plugin:: OptimizeStandardDeviation(FramePass)

    Plugin Type: :py:class:`~diplomat.predictors.fpe.frame_pass.FramePass`

    Runs across the video and determines the optimal value for the standard deviation for the 2D gaussian transition function used in :py:plugin:`~diplomat.predictors.frame_passes.MITViterbi`.

    .. rubric:: Settings


    .. py:setting:: bin_size
        :type: RoundedDecimal[precision=5]
        :value: 2

    A decimal, the size of each bin used in the histogram for computing the mode, in pixels.

    .. py:setting:: ignore_bins_below
        :type: RoundedDecimal[precision=5]
        :value: 1

    A decimal, the offset of the first bin used in the histogram for computing the mode, in pixels. Defaults to 1.

    .. py:setting:: std_multiplier
        :type: RangedFloat[min=0.0, max=inf]
        :value: 3

    A positive float, the computed standard deviation is multiplied by this value before 

    .. py:setting:: DEBUG
        :type: bool
        :value: False

    Set to True to print the optimal standard deviation found...