Skip to main content

Python tools for generating vegetation index timeseries from PhenoCam images.

Project description

PyPI Package latest release Github CI Action Status Documentation Status Supported versions

Python tools for generating vegetation index timeseries from PhenoCam images.

  • Free software: MIT license

Introduction

The PhenoCam Network is a project designed to study the patterns of seasonal variation (phenology) of vegetation. The project website is at https://phenocam.nau.edu/. The network consists of many cameras collecting images of various types of vegetation. By analysing the images we can quantify the seasonal changes at a particular camera site.

A “vegetation index” refers to a quantity calculated using information from various spectral bands of an image of a vegetated area. The image is typically obtained from a remote-sensing instrument on an earth orbiting satellite. There are several vegetation index values in common usage. The most widely used are NDVI (Normalized Difference Vegetation Index) and EVI (Enhanced Vegetation Index). For the PhenoCam project the Green Chromatic Coordinate or GCC is our standard vegetation index.

For the PhenoCam network, the images are obtained from webcams (usually installed on towers) looking across a vegetated landscape. These images are typically in JPEG format and have 3-bands (Red, Green, and Blue). For some cameras a separate image dominated by an IR (infrared) band is collected.

The algorithms used in in this package have been discussed in numerous publications. You can find a list of publications for the PhenoCam Network project here. The details of the calculation of GCC are presented in this jupyter notebook .

After the package is installed several python scripts should be available as commands:

  • generate_roi_timeseries

  • update_roi_timeseries

  • plot_roistats

  • generate_summary_timeseries

  • generate_roi_ir_timeseries

  • update_roi_ir_timeseries

  • generate_ndvi_timeseries

  • generate_ndvi_summary_timeseries

These scripts allow you to reproduce the PhenoCam network “standard timeseries products” from downloaded data. For a description of the products see the project Tools Page.

Quick Installation

From the command line type:

pip install vegindex

Some of the packages that vegindex depends on may not install automatically (using pip) since they depend on system libraries. If the above command does not work you can try:

pip install Pillow
pip install vegindex

The latest version of the documentation can be found at readthedocs.io

Changelog

0.10.2 (2022-07-27) * Fix bug in update_summary_timeseries * change references to UNH to NAU

0.10.0 (2021-11-30)

  • Add 3.9 tox environment to tox.ini

  • Add IR and camera NDVI processing scripts

  • Drop support for python2

0.7.2 (2020-04-12)

  • Add 3.8 tox environment to tox.ini

0.7.0 (2020-04-01)

  • Add checks when reading an ROI List CSV file that the time ranges are in order and don’t overlap

0.6.1 (2019-07-15)

  • Update installation doc.

  • Simple test for reading roistats file.

0.6.0 (2019-07-12)

  • Add awbflag (auto white-balance) to roistats file

0.5.3 (2019-04-03)

  • Update requirements for python 3.7

  • Add prefix to regular expressions

0.5.2 (2018-04-09)

  • Really fix bug in plot_roistats when no data are filtered.

0.5.1 (2018-04-09)

  • Fix bug in plot_roistats when no data are filtered.

  • Update docs

0.5.0 (2017-11-29)

  • Fix header on roistats.csv file

  • Add plotting script (matplotlib library is now required)

  • Remove timeout on requests query which was causing tests to fail.

  • Update usage docs

0.4.0 (2017-11-27)

  • Add fallback to local site_info.csv file to get basic site metadata

  • Update exception handling (removed bare exceptions)

0.3.1 (2017-10-06)

  • Change data product name from _roi_statistics.csv to _roistats.csv

0.3.0 (2017-09-12)

  • Added support for .meta files

  • Change data product name from _timeseries.csv to _roi_statistics.csv

0.2.0rc1 (2017-06-14)

  • Added support for python3

0.1.1rc3 (2017-06-13)

  • First release on PyPI.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

vegindex-0.10.2.tar.gz (19.3 MB view details)

Uploaded Source

Built Distribution

vegindex-0.10.2-py3-none-any.whl (76.8 kB view details)

Uploaded Python 3

File details

Details for the file vegindex-0.10.2.tar.gz.

File metadata

  • Download URL: vegindex-0.10.2.tar.gz
  • Upload date:
  • Size: 19.3 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.7.0 importlib_metadata/4.8.2 pkginfo/1.8.2 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.9.7

File hashes

Hashes for vegindex-0.10.2.tar.gz
Algorithm Hash digest
SHA256 8715e0c0f5a4a07a588762c4dce76bfb679b3dd3f33898d93d1dda39ec8dcae6
MD5 62dce20bd33e759cfbb3ea77ab2a8c0f
BLAKE2b-256 d6ec3f22d8f66282535f078ebca9d78a98ff10279563e748cda2215d3da77ec9

See more details on using hashes here.

File details

Details for the file vegindex-0.10.2-py3-none-any.whl.

File metadata

  • Download URL: vegindex-0.10.2-py3-none-any.whl
  • Upload date:
  • Size: 76.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.7.0 importlib_metadata/4.8.2 pkginfo/1.8.2 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.9.7

File hashes

Hashes for vegindex-0.10.2-py3-none-any.whl
Algorithm Hash digest
SHA256 88db82f3583e454a870ba390b3f689d0e9681e64d09e1c3175bb3fac9a99fd18
MD5 d22529ff0113fb1d8c192f9ce2528021
BLAKE2b-256 ee96a69bd42b9a95c384552cece00a7e644b4bf15474d3b5c76dc147aad66bec

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page