API Reference
=============

Indices
=======


Tree Categories

.. autofunction:: shelterbelts.indices.tree_categories.tree_categories

Shelter Categories
------------------

.. autofunction:: shelterbelts.indices.shelter_categories.shelter_categories

Cover Categories
----------------

.. autofunction:: shelterbelts.indices.cover_categories.cover_categories

Buffer Categories
-----------------

.. autofunction:: shelterbelts.indices.buffer_categories.buffer_categories

Shelter Metrics
---------------

Patch Metrics
~~~~~~~~~~~~~

.. autofunction:: shelterbelts.indices.shelter_metrics.patch_metrics

Class Metrics
~~~~~~~~~~~~~

.. autofunction:: shelterbelts.indices.shelter_metrics.class_metrics

Full Indices Pipeline
----------------------

Run the end-to-end indices pipeline on percent-cover rasters.

.. autofunction:: shelterbelts.indices.all_indices.indices_tif

.. autofunction:: shelterbelts.indices.all_indices.indices_csv

.. autofunction:: shelterbelts.indices.all_indices.indices_tifs

Catchments
----------

.. autofunction:: shelterbelts.indices.catchments.catchments

APIs
====

WorldCover
----------

.. autofunction:: shelterbelts.apis.worldcover.worldcover

BARRA Daily
-----------

.. autofunction:: shelterbelts.apis.barra_daily.barra_daily

Canopy Height
-------------

.. autofunction:: shelterbelts.apis.canopy_height.canopy_height