.. _FramePassEngine:

FramePassEngine
===============

.. plugin:: FramePassEngine(Predictor)

    Plugin Type: :py:class:`~diplomat.processing.predictor.Predictor`

    A predictor that applies a collection of frame passes to the frames dumped by deeplabcut, and then predicts poses by selecting maximums. Contains a collection of useful prediction algorithms which can be listed by calling "get_predictor_settings" on this Predictor.

    .. rubric:: Settings


    .. py:setting:: threshold
        :type: RangedFloat[min=0.0, max=1.0]
        :value: 0.001

    The minimum floating point value a pixel within the probability frame must have in order to be kept and added to the sparse matrix.

    .. py:setting:: max_cells_per_frame
        :type: Optional[RangedInteger[min=1.0, max=inf]]
        :value: 100

    The maximum number of cells allowed in any frame. Defaults to None, meaning no strict limit is placed on cellsper frame except the minimum threshold. Can be any positive integer, which will limit the number of cells in anyframe score map to that value. Useful in cases where frames generated by models contain too many cells slowing computation.

    .. py:setting:: passes
        :type: List[Union[Tuple[str, dict], Tuple[str], str]]
        :value: ['ClusterFrames', 'OptimizeStandardDeviation', 'CreateSkeleton', 'RepairClusters', 'FixFrame', 'MITViterbi']

    A list of lists containing a string (the pass name) and a dictionary (the configuration for the provided plugin). If no configuration is provided, the entry can just be a string. See :ref:`Frame Passes` to see the list of currently supported frame passes and options.

    .. py:setting:: export_frame_path
        :type: Union[Literal[None], str]
        :value: None

    A string or None specifying where to save the post forward backward frames to.If None, does not save the frames to a file. Used for debugging.

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

    If true exports the final probabilities as stored in frame_probs. Otherwise exports the probabilities from src_data. This setting is internal and for debugging. Defaults to true.

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

    If true exports all information, both final/pre-fpe probabilities and the occluded and edge states. This allows for display of several states at once. Only works if export_frame_path is set, and overrides export_final_probs.

    .. py:setting:: relaxed_maximum_radius
        :type: RangedFloat[min=0.0, max=inf]
        :value: 1.8

    Determines the radius of relaxed maximum selection.Set to 0 to disable relaxed maximum selection. This value is measured in cell units, not video units.

    .. py:setting:: sparsification_mode
        :type: Literal['IGNORE_OFFSETS', 'OFFSET_DOMINATION', 'OFFSET_COMBINATION', 'OFFSET_SUMMATION']
        :value: 'OFFSET_DOMINATION'

    The mode to utilize during sparsification.

    .. py:setting:: dipui_file
        :type: Union[Literal[None], str]
        :value: None

    A path specifying where to save the dipui file