JSPM

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

Saves an ndarray as an image to a file

Package Exports

  • save-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 (save-pixels) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

save-pixels

Saves an ndarray to an image.

Example

var zeros = require("zeros")
var savePixels = require("save-pixels")

//Create an image
var x = zeros([32, 32])
x.set(16, 16, 255)

//Save to a file
savePixels(x, "png").pipe(process.stdout)

This writes the following image to stdout:

Install

npm install save-pixels

require("save-pixels")(array, type[, options])

Saves an ndarray as an image with the given format

  • array is an ndarray of pixels. Assumes that shape is [width, height, channels]

  • type is the type of the image to save. Currently supported formats:

    • "jpeg", "jpg" - Joint Photographic Experts Group format
    • "gif" - Graphics Interchange Format
    • "png" - Portable Network Graphics format
    • "canvas" - A canvas element
  • options is an object that alters saving behavior

    • quality is the Number to use for saved image quality

      • This can only be used with a "jpeg" image
      • It range between 1 (low quality) and 100 (high quality) inclusively

Returns A stream that you can pipe to serialize the result, or a canvas element if the type is "canvas".

Credits

(c) 2013 Mikola Lysenko. MIT License