You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
45 lines
1.3 KiB
45 lines
1.3 KiB
4 years ago
|
get-pixels
|
||
|
|
==========
|
||
|
|
Given a URL/path, grab all the pixels in an image and return the result as an [ndarray](https://github.com/mikolalysenko/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`
|
||
|
|
|
||
|
|
Example
|
||
|
|
=======
|
||
|
|
|
||
|
|
```javascript
|
||
|
|
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[, 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](http://nodejs.org/api/buffer.html).
|
||
|
|
* `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.
|
||
|
|
|
||
|
|
Credits
|
||
|
|
=======
|
||
|
|
(c) 2013-2014 Mikola Lysenko. MIT License
|