.. _ClusterFrames:

ClusterFrames
=============

.. plugin:: ClusterFrames(FramePass)

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

    Breaks up each frame and separates it into a fixed number of frames, where each frame contains typically a single peak.

    .. rubric:: Settings


    .. py:setting:: minimum_cluster_size
        :type: float
        :value: 0.1

    The minimum size a cluster is allowed to be (As compared to average of all clusters).If the cluster is smaller, it get thrown out and a forest is resolved using the rest ofthe data.

    .. py:setting:: max_throwaway_count
        :type: float
        :value: 10

    The maximum number of clusters to throw away before giving up on clustering a given frame.

    .. py:setting:: thread_count
        :type: Union[Literal[None], RangedInteger[min=0.0, max=inf]]
        :value: None

    The number of threads to use during processing. If None, uses os.cpu_count(). If 0 disables multithreading.