JSPM

  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 271367
  • Score
    100M100P100Q168193F
  • License MIT

Reads the pixels of an image as an ndarray

Package Exports

  • get-pixels
  • get-pixels/node-pixels

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (get-pixels) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

get-pixels

Given a URL/path, grab all the pixels in an image and return the result as an ndarray. Written in 100% JavaScript, works both in browserify and in node.js and has no external native dependencies.

Currently the following file formats are supported:

  • PNG
  • PPM
  • JPEG
  • GIF

Example

var getPixels = require("get-pixels")

getPixels("lena.png", function(err, pixels) {
  if(err) {
    console.log("Bad image path")
    return
  }
  console.log("got pixels", pixels.shape.slice())
})

Install

npm install get-pixels

require("get-pixels")(url, cb(err, pixels))

Reads all the pixels from url into an ndarray.

  • url is the path to the file
  • cb(err, pixels) is a callback which gets triggered once the image is loaded.

Returns An ndarray of pixels in raster order having shape equal to [rows, columns, channels].

Note For animated GIFs, a 4D array is returned with shape [numFrames, height, width, 4], where each frame is a slice of the final array.

Credits

(c) 2013 Mikola Lysenko. MIT License