Reads the pixels of an image as an ndarray

npm install get-pixels
190 downloads in the last day
3 498 downloads in the last month


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


var getPixels = require("get-pixels")

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


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.


(c) 2013 Mikola Lysenko. MIT License

npm loves you