Structure
=========

.. currentmodule:: astrodendro

.. autoclass:: Structure
   :show-inheritance:

   .. rubric:: Attributes Summary

   .. autosummary::

      ~Structure.ancestor
      ~Structure.children
      ~Structure.descendants
      ~Structure.height
      ~Structure.is_branch
      ~Structure.is_leaf
      ~Structure.level
      ~Structure.newick
      ~Structure.parent
      ~Structure.smallest_index
      ~Structure.vmax
      ~Structure.vmin

   .. rubric:: Methods Summary

   .. autosummary::

      ~Structure.get_mask
      ~Structure.get_npix
      ~Structure.get_peak
      ~Structure.indices
      ~Structure.sorted_leaves
      ~Structure.values

   .. rubric:: Attributes Documentation

   .. autoattribute:: ancestor
   .. autoattribute:: children
   .. autoattribute:: descendants
   .. autoattribute:: height
   .. autoattribute:: is_branch
   .. autoattribute:: is_leaf
   .. autoattribute:: level
   .. autoattribute:: newick
   .. autoattribute:: parent
   .. autoattribute:: smallest_index
   .. autoattribute:: vmax
   .. autoattribute:: vmin

   .. rubric:: Methods Documentation

   .. automethod:: get_mask
   .. automethod:: get_npix
   .. automethod:: get_peak
   .. automethod:: indices
   .. automethod:: sorted_leaves
   .. automethod:: values