Giter Club home page Giter Club logo

canopy-cover's Introduction

CANOPY-COVER LIBRARY FOR NODEJS PROJECTS

A Node-JS library to calculate the green canopy cover of a crop.

npm npm bundle size node-current NPM checks release last-commit

import canopyCover from 'canopy-cover';
// For CommonJs modules:
// const canopyCover = require('canopy-cover')

 const param1 = 0.95;
 const param2 = 0.95;
 const param3 = 20;
 const imagePath = 'path-to-your-image';

canopyCover
  .canopeo({ imagePath, param1, param2, param3 })
  .getCanopyCover()
  .then(result => console.log(result))
  .catch(err => console.log(err));

Installation

$ npm install canopy-cover

About Canopy Cover

The library has been designed with the aim of analyzing crop images and obtaining the vegetation cover. It uses the sharp module to quickly analyze the images.

For now the only model used is Canopeo, you can see more about this model in this web site: canopeo and in the following article:

  • Patrignani, A. and Ochsner, T.E., 2015. Canopeo: A powerful new tool for measuring fractional green canopy cover . Agronomy Journal, 107(6), pp.2312-2320. Link (Open access)

Docs

The library has 1 method (canopeo):

CANOPEO

Canopeo classifies green canopy cover using the following criteria

Red/Green < Param1 and Blue/Green < Param2 and 2Green-Red-Blue > Param3

This conditional is applied to each pixel, if it is fulfilled, that pixel is considered to be vegetation.

Parameter 1 and parameter 2 have values close to 1 and classify pixels that are mainly in the green band.

Parameter 3 establishes the minimum green excess index, which usually has a value around 20 to select green vegetation.

Example of use:

import canopyCover from 'canopy-cover';
// For CommonJs modules:
// const canopyCover = require('canopy-cover')

 const param1 = 0.95;
 const param2 = 0.95;
 const param3 = 20;
 const imagePath = 'path-to-your-image';

canopyCover
  .canopeo({ imagePath, param1, param2, param3 })
  .getCanopyCover()
  .then(result => console.log(result))
  .catch(err => console.log(err));

canopy-cover's People

Contributors

pacs27 avatar

Stargazers

 avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.