.. _FrameExporter:

FrameExporter
=============

.. plugin:: FrameExporter(Predictor)

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

    Exports probability maps to a binary format that can be passed back into DIPLOMAT again to perform frame predictions later. This allows for a video to be run through the neural network (expensive) on a headless server or supercomputer, and then run through a predictor with gui feedback on a laptop or somewhere else.

    .. rubric:: Settings


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

    Specify whether to optimize and store the data in a sparse format when dumping frames.

    .. py:setting:: threshold
        :type: RangedFloat[min=0.0, max=1.0]
        :value: 1e-07

    The threshold used if sparsify is true. Any values which land below this threshold probability won't be included in the frame.

    .. py:setting:: compression_level
        :type: RangedInteger[min=0.0, max=9.0]
        :value: 6

    Determines the z-lib compression level. Higher compression level means it takes longer to compress the data, while 0 is no compression. Note this only applies if the dlfs format is being used, the hdf5 format ignores this value.

    .. py:setting:: filename_suffix
        :type: str
        :value: 'DATA'

    A string, The suffix to place onto the end of the file name.

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

    A list of body parts to store. None means keep all the body parts.

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

    If true, the video is embedded in the file, making this file fully independent. Defaults to True.