API
===

.. toctree::
    :hidden:

    finder
    background
    detection_curves
    substructure_properties
    visualisation
    misc

.. grid:: 2

    .. grid-item::

        .. card:: Finder
            :link: finder
            :link-type: doc

            Documentation for the :py:class:`~clump_finder.finder.ClumpFinder` class.

    .. grid-item::

        .. card:: Background
            :link: background
            :link-type: doc

            Documentation for functions related to background detection.

    .. grid-item::

        .. card:: Detection curves
            :link: detection_curves
            :link-type: doc

            Documentation for the detection curves used in the intrinsic detection.

    .. grid-item::

        .. card:: Subtructure properties
            :link: substructure_properties
            :link-type: doc

            Documentation for functions related to deriving the properties of substructures.
    
    .. grid-item::

        .. card:: Visualisation
            :link: visualisation
            :link-type: doc

            Documentation for the substructure detection visualisation routine.

    .. grid-item::

        .. card:: Miscellaneous
            :link: misc
            :link-type: doc

            Documentation for other functions.