npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

lerc

v4.0.4

Published

Rapid decoding of Lerc compressed raster data for any standard pixel type.

Downloads

1,855,689

Readme

npm version

Lerc JS

Rapid decoding of Lerc compressed raster data for any standard pixel type, not just rgb or byte.

Breaking changes

  • Web Assembly support is now required.
  • Lerc.load() must be invoked and the returned promise must be resolved prior to Lerc.decode. This only needs to be done once per worker (or the main thread). There's no extra cost when invoked multiple times as the internal wasm loading promise is cached.

Get started

npm install lerc

// es module
import * as Lerc from 'lerc';

// commonJS
const Lerc = require('lerc');
// use umd via a script tag
<script type="text/javascript" src="https://unpkg.com/lerc@latest/LercDecode.min.js"></script>

Sample usage

await Lerc.load();

const arrayBuffer = await fetch('http://elevation3d.arcgis.com/arcgis/rest/services/WorldElevation3D/Terrain3D/ImageServer/tile/0/0/0')
  .then(response => response.arrayBuffer());
const pixelBlock = Lerc.decode(arrayBuffer);
const { height, width, pixels, mask } = pixelBlock;
for (let i = 0; i < height; i++) {
  for (let j = 0; j < width; j++) {
    if (!mask || mask[i * width + j]) {
      // do something with valid pixel (i,j)
    }
  }
}

// use options
const pixelBlock = Lerc.decode(arrayBuffer, {
  inputOffset: 10, // start from the 10th byte (default is 0)
  returnInterleaved: true // only applicable to n-depth lerc blobs (default is false)
});

API Reference

Lerc

A module for decoding LERC blobs.

load([options]) ⇒ Promise

Load the dependencies (web assembly). Check whether dependencies has been loaded using Lerc.isLoaded(). The loading promise is cached so it can be invoked multiple times if needed.

Kind: Exported function

| Param | Type | Description | | --- | --- | --- | | [options.locateFile] | (wasmFileName?: string, scriptDir?: string) => string | The function to locate lerc-wasm.wasm. Used when the web assembly file is moved to a different location. |

decode(input, [options]) ⇒ Object

A function for decoding both LERC1 and LERC2 byte streams capable of handling multiband pixel blocks for various pixel types.

Kind: Exported function

| Param | Type | Description | | --- | --- | --- | | input | ArrayBuffer | The LERC input byte stream | | [options] | object | The decoding options below are optional. | | [options.inputOffset] | number | The number of bytes to skip in the input byte stream. A valid Lerc file is expected at that position. | | [options.noDataValue] | number | It is recommended to use the returned mask instead of setting this value. | | (Deprecated) [options.returnPixelInterleavedDims] | boolean | will be removed in next release, use returnInterleaved instead. | | [options.returnInterleaved] | boolean | (ndepth LERC2 only) If true, returned depth values are pixel-interleaved. |

Result Object Properties

| Name | Type | Description | | --- | --- | --- | | width | number | Width of decoded image. | | height | number | Height of decoded image. | | pixels | array | [band1, band2, …] Each band is a typed array of width * height * depthCount. | | pixelType | string | The type of pixels represented in the output. | | mask | mask | Typed array with a size of width*height, or null if all pixels are valid. | | statistics | array | [statistics_band1, statistics_band2, …] Each element is a statistics object representing min and max values | | (Deprecated) dimCount | number | Will be removed in next release, use depthCount instead. | depthCount | number | Depth count | [bandMasks] | array | [band1_mask, band2_mask, …] Each band is a Uint8Array of width * height * depthCount. |


Licensing

Copyright © 2017-2023 Esri

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

A local copy of the license and additional notices are located with the source distribution at:

http://github.com/Esri/lerc/