.. _FixFrame:

FixFrame
========

.. plugin:: FixFrame(FramePass)

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

    Scores frames by peak separation, and then selects a single frame to remain clustered (with peaks separated). The rest of the frames are restored, and :py:plugin:`~diplomat.predictors.frame_passes.MITViterbi` uses the fixed frame as it's ground truth frame.

    .. rubric:: Settings


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

    Set to True to dump additional information while the pass is running.

    .. py:setting:: fix_frame_override
        :type: Union[Literal[None], RangedInteger[min=0.0, max=inf]]
        :value: None

    Specify the fixed frame manually by setting to an integer index.

    .. py:setting:: skeleton_assignment_algorithm
        :type: Literal['greedy', 'hungarian']
        :value: 'hungarian'

    The algorithm to use for assigning body parts to skeletons when creating the fix frame.

    .. py:setting:: outlier_threshold
        :type: float
        :value: 3.0

    The threshold z-score used to detect when a pose is an outlier in the skeletal distance distribution.