Reads an image into an ndarray
Switch branches/tags
Nothing to show
Latest commit 7c447cd Feb 22, 2016 1 @mikolalysenko mikolalysenko 3.3.0
Failed to load latest commit information.
test Fix broken HTTP support. Mar 24, 2015
.gitignore Remove `.DS_Store` Mar 5, 2015
.npmignore upgrade to ndarray 1.0 Jun 26, 2013
LICENSE adding files May 14, 2013 Update Nov 2, 2014
dom-pixels.js Fixed #22 Apr 17, 2015
node-pixels.js Update node-pixels.js Feb 22, 2016
package.json 3.3.0 Feb 22, 2016


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
  • 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[, type], cb(err, pixels))

Reads all the pixels from url into an ndarray.

  • url is the path to the file. It can be a relative path, an http url, a data url, or an in-memory Buffer.
  • type is an optional mime type for the image (required when using a Buffer)
  • 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 [width, height, channels].

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


(c) 2013-2014 Mikola Lysenko. MIT License