Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

luminance

mikolalysenko259MIT1.0.3

Convert RGB to grayscale

luminance, grayscale, ndarray, convert, rgb, red, green, blue, color, black, and, white, intensity, image

readme

luminance

Converts an RGB image into a grayscale luminance image. This is built on the ndarray library.

Example

//Load up a test image
var lena = require("lena")

//Convert to grayscale
var grayscale_lena = require("luminance")(lena)

//Write the resulting png to stdout
require("save-pixels")(grayscale_lena, "png").pipe(process.stdout)

Which creates the following image:

Install

npm install luminance

API

var luminance = require("luminance")

luminance(img)

Returns A gray scale version of img

luminance(result, img)

Returns A gray scale version of img, the result is stored in result

luminance(red, green, blue)

Returns A gray scale image with red, green and blue channels in the given ndarrays

luminance(result, red, green, blue)

Returns A luminance image of red/green/blue with result stored in result.

Credits

(c) 2013 Mikola Lysenko. MIT License