.. detectree2 documentation master file, created by
   sphinx-quickstart on Fri Jul  1 09:57:24 2022.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Detectree2
==========

`Detectree2 <https://github.com/PatBall1/detectree2>`_, based on the 
`Detectron2 <https://github.com/facebookresearch/detectron2>`_ Mask R-CNN
architecture, locates trees in aerial images. It has been designed to delineate
trees in challenging dense tropical forests for a range of ecological
applications. Below is an example image of the predictions made by Detectree2.

.. .. image:: ../../report/figures/plot_13_285520_583300.jpg 
..   :width: 400
..   :alt: Prediction
..   :align: center

.. image:: ../../report/figures/seg.gif
   :width: 500
   :alt: Prediction
   :align: center


|
Code developed by James Ball, Seb Hickman, Thomas Koay, Oscar Jiang, Luran Wang, Panagiotis Ioannou, James Hinton and Matthew Archer in the `Forest Ecology and Conservation Group <https://coomeslab.org/>`_ 
at the University of Cambridge.  The Forest Ecology and Conservation Group is led by Professor David Coomes and is part of the University of Cambridge `Conservation Research Institute <https://www.conservation.cam.ac.uk/>`_.
MRes project repo available `here <https://github.com/shmh40/detectreeRGB/>`_.

Citation
--------

Ball, J.G.C., Hickman, S.H.M., Jackson, T.D., Koay, X.J., Hirst, J., Jay, W., Archer, M., Aubry-Kientz, M., Vincent, G. and Coomes, D.A. (2023)
Accurate delineation of individual tree crowns in tropical forests from aerial RGB imagery using Mask R-CNN.
*Remote Sens Ecol Conserv*. `https://doi.org/10.1002/rse2.332 <https://doi.org/10.1002/rse2.332>`_

.. toctree::
   :numbered:
   :maxdepth: 2
   :caption: Contents:

   installation
   tutorial
   contributing
   using-git
   .. _notebooks/contributing_guide
   .. _notebooks/trainingJB


Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`