.. _FastPlotterArgMax:

FastPlotterArgMax
=================

.. plugin:: FastPlotterArgMax(Predictor)

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

    Identical to :py:plugin:`~diplomat.predictors.PlotterArgMax`, but avoids using matplotlib to generate probability maps, and instead directly uses cv2 to generate the plots. This means it runs much faster, but doesn't offer as much customization nor a 3D mode...

    .. rubric:: Settings


    .. py:setting:: video_name
        :type: str
        :value: '$VIDEO-fast-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:: title_font_size
        :type: RangedFloat[min=0.1, max=inf]
        :value: 2

    The font size of the main title

    .. py:setting:: title_font
        :type: cv2_font
        :value: 'FONT_HERSHEY_SIMPLEX'

    String, the cv2 font to be used in the title, options for this are:
	 - FONT_HERSHEY_COMPLEX
	 - FONT_HERSHEY_COMPLEX_SMALL
	 - FONT_HERSHEY_DUPLEX
	 - FONT_HERSHEY_PLAIN
	 - FONT_HERSHEY_SCRIPT_COMPLEX
	 - FONT_HERSHEY_SCRIPT_SIMPLEX
	 - FONT_HERSHEY_SIMPLEX
	 - FONT_HERSHEY_TRIPLEX

    .. py:setting:: subplot_font_size
        :type: RangedFloat[min=0.1, max=inf]
        :value: 1.5

    The font size of the titles of each subplot.

    .. py:setting:: subplot_font
        :type: cv2_font
        :value: 'FONT_HERSHEY_SIMPLEX'

    String, the cv2 font used in the subplot titles, look at options for 'title_font'.

    .. py:setting:: background_color
        :type: Tuple[RangedInteger[min=0.0, max=255.0], RangedInteger[min=0.0, max=255.0], RangedInteger[min=0.0, max=255.0]]
        :value: (255, 255, 255)

    Tuple of 3 integers, color of the background in BGR format

    .. py:setting:: title_font_color
        :type: Tuple[RangedInteger[min=0.0, max=255.0], RangedInteger[min=0.0, max=255.0], RangedInteger[min=0.0, max=255.0]]
        :value: (0, 0, 0)

    Tuple of 3 integers, color of the title text in BGR format

    .. py:setting:: subplot_font_color
        :type: Tuple[RangedInteger[min=0.0, max=255.0], RangedInteger[min=0.0, max=255.0], RangedInteger[min=0.0, max=255.0]]
        :value: (0, 0, 0)

    Tuple of 3 integers, color of the title text in BGR format

    .. py:setting:: colormap
        :type: cv2_colormap
        :value: 'COLORMAP_VIRIDIS'

    String, the cv2 colormap to use, options for this are:
	 - COLORMAP_AUTUMN
	 - COLORMAP_BONE
	 - COLORMAP_CIVIDIS
	 - COLORMAP_COOL
	 - COLORMAP_DEEPGREEN
	 - COLORMAP_HOT
	 - COLORMAP_HSV
	 - COLORMAP_INFERNO
	 - COLORMAP_JET
	 - COLORMAP_MAGMA
	 - COLORMAP_OCEAN
	 - COLORMAP_PARULA
	 - COLORMAP_PINK
	 - COLORMAP_PLASMA
	 - COLORMAP_RAINBOW
	 - COLORMAP_SPRING
	 - COLORMAP_SUMMER
	 - COLORMAP_TURBO
	 - COLORMAP_TWILIGHT
	 - COLORMAP_TWILIGHT_SHIFTED
	 - COLORMAP_VIRIDIS
	 - COLORMAP_WINTER

    .. py:setting:: font_thickness
        :type: RangedInteger[min=1.0, max=inf]
        :value: 2

    Integer, the thickness of the font being drawn.

    .. py:setting:: source_map_upscale
        :type: RangedInteger[min=1.0, max=100.0]
        :value: 4

    Integer, The amount to upscale the probability maps.

    .. py:setting:: padding
        :type: RangedInteger[min=1.0, max=inf]
        :value: 20

    Integer, the padding to be applied around plots in pixels.