Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add visualizations to documentation #10

Merged
merged 1 commit into from
Sep 30, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Binary file added docs/source/images/chm.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/source/images/hag.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/source/images/pai.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/source/images/voxel_metrics.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
25 changes: 25 additions & 0 deletions docs/source/introduction.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,13 @@
Introduction
============

.. figure:: images/hag.png
:alt: Height above ground
:align: center
:figclass: align-center

Height Above Ground visualization of LiDAR point cloud data.

`pyforestscan` is a Python package designed for processing and analyzing LiDAR point cloud data. It simplifies complex LiDAR workflows, making it easier to extract and visualize forest structure metrics such as canopy height, plant area density, and more.

Key Features
Expand All @@ -13,6 +20,24 @@ Key Features
- **Outlier Removal and Point Cloud Cleaning**: Efficiently clean data and remove statistical outliers.
- **Visualization Tools**: Plot 2D and 3D representations of point clouds and vegetation metrics.

.. list-table::
:widths: 45 5 45
:header-rows: 0

* - .. figure:: images/chm.png
:alt: Canopy Height Model
:width: 300

Canopy Height Model

-

- .. figure:: images/pai.png
:alt: Plant Area Index
:width: 300

Plant Area Index

Core Modules
------------

Expand Down
7 changes: 7 additions & 0 deletions docs/source/metric_calculation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,13 @@ Forest Structure Metrics Calculations

The core forest structural metrics generated by PyForestScan are based on well-established methods in ecology.

.. figure:: images/voxel_metrics.jpg
:alt: Forest structure from voxels.
:align: center
:figclass: align-center

Forest structural metrics as calculated from points within voxels. Voxel resolution is given by Δx, Δy, Δz.

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

Expand Down
Loading