Skip to main content

A compilation of vegetative spectral indices and transformations in Python

Project description

vegspec

A compilation of spectral vegetation indices and transformations in Python

The goal of the vegspec package is to encapsulate computations of 1) more than 145 published spectral vegetation indices and 2) several published pretreatment transformations for vegetative spectral reflectance data.

Scientific background material for the methods implemented in the vegspec package is given here.

Source Code

The spectral methodologies are contained in one Python module (i.e., vegspec.py). The module defines a class (i.e., VegSpec) to encapsulate all the computations for one vegetative reflectance spectrum. To analyze sets of multiple spectral measurements, users can develop a list of unique VegSpec instances for each measurement. At minimum, each VegSpec instance requires inputting two 1-dimensional lists that specify the spectral reflecance factors and associated wavelengths.

The source code is available here.

Install

pip install vegspec

Quickstart

Import the package

import vegspec as vs

Instantiate a VegSpec class

spectrum = vs.VegSpec(wl,rf)

where required inputs are defined as follows:

  • wl : list, Wavelengths (nm) corresponding to the data in rf
  • rf : list, Reflectance factors (0 to 1) for a single spectral scan

Other optional arguments for the VegSpec constructor are as follows:

  • fs1 : int, optional, Filter size for Savitsky-Golay first derivatives, (default = 7)
  • po1 : int, optional, Polynomial order for Savitsky-Golay first derivatives, (default = 2)
  • fs2 : int, optional, Filter size for Savitsky-Golay second derivatives, (default = 15)
  • po2 : int, optional, Polynomial order for Savitsky-Golay second derivatives, (default = 2)
  • wlblu : float, optional, Primary wavelength of visible blue light (nm), (default = 480.)
  • wlgrn : float, optional, Primary wavelength of visible green light (nm), (default = 550.)
  • wlred : float, optional, Primary wavelength of visible red light (nm), (default = 670.)
  • wlnir : float, optional, Primary wavelength of near-infrared light (nm), (default = 800.)
  • solslp : float, optional, Slope of the soil line, (default = 1.166)
  • solicpt : float, optional, Intercept of the soil line, (default = 0.042)
  • getlirf : boolean, optional, If True, compute log inverse reflectance, (default = True)
  • getcrrf : boolean, optional, If True, compute continuum removed spectra, (default = True)

The VegSpec class constructor will automatically compute all spectral vegetation indices and spectral data pretreatment transformations unless optional arguments (i.e., getlirf and getcrrf) are changed to False. If increased computational efficiency is needed, consider changing getcrrf to False.

Access the results

for key in spectrum.indices.keys():
    print(key+',{:f}'.format(spectrum.indices[key]))

print(spectrum.rfd1)

The VegSpec class stores the computational results in the following attribute variables:

  • rfd1 : numpy.ndarray, A 1D array of the Savitsky-Golay first derivative of rf
  • rfd2 : numpy.ndarray, A 1D array of the Savitsky-Golay second derivative of rf
  • lirf : numpy.ndarray, A 1D array of the logarithm of inverse rf (log10(1/rf))
  • lirfd1 : numpy.ndarray, A 1D array of the Savitsky-Golay first derivative of lirf
  • lirfd2 : numpy.ndarry, A 1D array of the Savitsky-Golay second derivative of lirf
  • crrf : numpy.ndarray, A 1D array of the continuum removal of rf
  • indices : dict, A dictionary of 145+ published spectral vegetation indices

For further information on the keys of the indices attribute, see the documentation here.

Test suite and further examples

A test suite and further example scripts for using the vegspec package are here.

test0 - Demonstrates the computation of spectral transformations for one example spectrum, collected from a cotton leaf at Maricopa, Arizona.

test1 - Demonstrates computation of spectral vegetation indices for cotton leaf spectra collected at Maricopa, Arizona in 2021 and 2022 and correlates the indices with leaf chlorophyll.

test2 - Demonstrates computation of spectral vegetation indices for cotton leaf spectra collected at Maricopa, Arizona in 2019 and 2020 and correlates the indices with leaf chlorophyll and leaf nitrogen.

test3 - Demonstrates computation of spectral vegetation indices for wheat canopy spectra collected at Maricopa, Arizona in 2011 and 2012 and correlates the indices with leaf area index, canopy weight, and plant nitrogen.

test4 - Demonstrates computation of spectral vegetation indices for cotton canopy spectra collected at Maricopa, Arizona in 2010, 2011, and 2012 and correlates the indices with leaf chlorophyll, leaf water thickness, specific leaf weight, and leaf area index.

test5 - Demonstrates computation of spectral vegetation indices for lesquerella canopy spectra collected at Maricopa, Arizona in 2008 and 2009 and correlates the indices with canopy weight, flower count, silique count, and silique dry weight.

test6 - Demonstrates computation of spectral vegetation indices for maize canopy spectra collected at Ames, Iowa in 2004 and correlates the indices with plant stand density.

test7 - Demonstrates computation of spectral vegetation indices for soybean canopy spectra collected at Urbana, Illinois in 2001 and correlates the indices with vegetation and weed cover.

Further information

The vegspec package is further described in the following article:

Thorp, K. R., 2024. vegspec: A compilation of spectral vegetation indices and transformations in Python. SoftwareX. In review.

Also, the vegspec package was used to conduct the following research:

Thorp, K. R., Thompson, A. L., Herritt, M. T., 2024. Phenotyping cotton leaf chlorophyll via proximal hyperspectral reflectance sensing, spectral vegetation indices, and machine learning. Frontiers in Plant Science. In prep.

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

vegspec-1.0.4.tar.gz (16.7 kB view details)

Uploaded Source

Built Distribution

vegspec-1.0.4-py3-none-any.whl (15.2 kB view details)

Uploaded Python 3

File details

Details for the file vegspec-1.0.4.tar.gz.

File metadata

  • Download URL: vegspec-1.0.4.tar.gz
  • Upload date:
  • Size: 16.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.9.7

File hashes

Hashes for vegspec-1.0.4.tar.gz
Algorithm Hash digest
SHA256 132c1b9f52b44077a9135ca75904feff15339dbfecbe4f20c48c53b05e4cdf8d
MD5 2d2f2e402228b8270bb2c17fd76f35dd
BLAKE2b-256 9f43db7b04e7db75d4530e66a13151328b0b946118c5c247da6b1e086678734d

See more details on using hashes here.

File details

Details for the file vegspec-1.0.4-py3-none-any.whl.

File metadata

  • Download URL: vegspec-1.0.4-py3-none-any.whl
  • Upload date:
  • Size: 15.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.9.7

File hashes

Hashes for vegspec-1.0.4-py3-none-any.whl
Algorithm Hash digest
SHA256 7d770090aa5dd63d1d95c11b88bcb5ba4ce53c1334b53481851439cc93fed5aa
MD5 d661fcc8d7c0a35d992fffc5d1cb4951
BLAKE2b-256 77e116e37fe9cac1826b1cd17fc5566aacc77abbbbf03887e380e6d82fc303a6

See more details on using hashes here.

Supported by

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