.. _PlotterArgMax:

PlotterArgMax
=============

.. plugin:: PlotterArgMax(Predictor)

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

    Identical to :plugin:`~diplomat.predictors.ArgMax`, but plots probability frames in form of video to the user using matplotlib...

    .. rubric:: Settings


    .. py:setting:: video_name
        :type: str
        :value: '$VIDEO-prob-dlc.mp4'

    Name of the video file that plotting data will be saved to. Can use $VIDEO to place the name of original video somewhere in the text.

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

    A list of body parts to plot. None means plot all the body parts.

    .. py:setting:: codec
        :type: codec_string
        :value: 'mp4v'

    The codec to be used by the opencv library to save info to, typically a 4-byte string.

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

    Boolean, determines whether to apply log scaling to the frames in the video.

    .. py:setting:: 3d_projection
        :type: bool
        :value: False

    Boolean, determines if probability frames should be plotted in 3d.

    .. py:setting:: 3d_render_method
        :type: Literal['surface', 'bar', 'shaded_bar']
        :value: 'shaded_bar'

    Method to use for rendering a 3D heatmap.

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

    Apply antialiasing to plots, makes plots smoother at cost of possible gaps between surfaces in 3d plots.

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

    Boolean, determines if offset vectors are displayed additionally.

    .. py:setting:: arrow_color
        :type: to_rgba
        :value: 'red'

    Matplotlib color type, the color of the offset arrows if enabled.

    .. py:setting:: arrow_args
        :type: optional_dict
        :value: None

    A dictionary, miscellaneous arguments to pass to plt.quiver.

    .. py:setting:: arrow_displacement_threshold
        :type: RangedFloat[min=0.0, max=inf]
        :value: 0.1

    A float, the threshold under which not to plot an arrow for a given location.

    .. py:setting:: z_shrink_factor
        :type: RangedFloat[min=1.0, max=inf]
        :value: 5

    Float, determines how much to shrink the z-axis if in 3D mode...

    .. py:setting:: dpi
        :type: RangedInteger[min=1.0, max=inf]
        :value: 100.0

    The dpi of the final video, the higher the dpi the more crisp...

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

    Boolean, determines if axis, or tick marks and grids of subplots are shown.

    .. py:setting:: axes_args
        :type: optional_dict
        :value: None

    A dictionary, miscellaneous arguments to pass to matplotlib axes when constructing them.

    .. py:setting:: figure_args
        :type: optional_dict
        :value: None

    A dictionary, miscellaneous arguments to pass to matplotlib figure when constructing it.