Skip to content

Reading-eScience-Centre/covutils

master
Switch branches/tags

Name already in use

A tag already exists with the provided branch name. Many Git commands accept both tag and branch names, so creating this branch may cause unexpected behavior. Are you sure you want to create this branch?
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
 
 
src
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

covutils

NPM version

JavaScript utilities for creating, transforming, and handling Coverage Data objects.

API docs

Usage

A minified bundle of this library is available on jsDelivr.

Usage is simple:

<script src="https://cdn.jsdelivr.net/npm/covutils@0.6/covutils.min.js"></script>
<script>
var coverage = ... ;

// let's mask the Coverage with a GeoJSON polygon
// any data values outside the polygon become null
var polygon = {
  "type": "Polygon",
  "coordinates": [
    [ [100.0, 0.0], [101.0, 0.0], [101.0, 1.0], [100.0, 1.0], [100.0, 0.0] ]
    ]
}
CovUtils.maskByPolygon(coverage, polygon, ['x','y'])
  .then(function (maskedCov) {
    // work with masked Coverage
  })
</script>

If polygon-related functionality is not needed, then a lite bundle can be used instead:

<script src="https://cdn.jsdelivr.net/npm/covutils-lite@0.6/covutils.min.js"></script>

NPM

You may also use this library within common package managers as it is published on npm.

An ES2015 import may look like that:

import {maskByPolygon} from 'covutils'

Acknowledgments

This library has been developed within the MELODIES project and is maintained as open source software.

About

JavaScript utilities for creating, transforming, and handling Coverage Data objects

Resources

License

Stars

Watchers

Forks

Packages

No packages published