.. _CreateSkeleton:

CreateSkeleton
==============

.. plugin:: CreateSkeleton(FramePass)

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

    Computes optimal skeletal link distances and then constructs a skeleton to be used by :py:plugin:`~diplomat.predictors.frame_passes.MITViterbi`. The links can be passed directly to this frame pass or are otherwise inferred from the config file.

    .. rubric:: Settings


    .. py:setting:: linked_parts
        :type: cast_skeleton
        :value: None

    None, a boolean, a list of strings, or a list of strings to strings (as tuples). Determines what parts should be linked together. with a skeleton. If None, attempts to use the skeleton pulled form the tracking project. If false, specifies no skeleton should be made, basically disabling this pass. If True, connect all body parts to each other. If a list of strings, connect the body parts in that list to every other body part in that list. If a list of strings to strings, specifies exact links that should be made between body parts. Defaults to None.

    .. py:setting:: part_weights
        :type: Optional[List[Tuple[str, str, RangedFloat[min=0.0, max=inf]]]]
        :value: None

    Optional list of tuples. Each tuple contains the edge (two strings) and the distance to use betweenthose two parts, measured in pixels. This allows for manual specification of the skeleton weights.This value defaults to None, meaning run automated skeleton selection.

    .. py:setting:: bin_size
        :type: RoundedDecimal[precision=5]
        :value: 0.25

    A decimal, the size of each bin used in the histogram for computing the mode.

    .. py:setting:: bin_offset
        :type: RoundedDecimal[precision=5]
        :value: 0

    A decimal, the offset of the first bin used in the histogram for computing the mode.

    .. py:setting:: max_amplitude
        :type: float
        :value: 1

    A float, the max amplitude of the skeletal curves.

    .. py:setting:: min_amplitude
        :type: float
        :value: 0.8

    A float the min amplitude of the skeletal curves.

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

    Set to True to print skeleton information to console while this pass is running.