Giter Club home page Giter Club logo

js-cubehelix's Introduction

cubehelix

A JavaScript library implementing Dave Green's `cubehelix' algorithm to generate a family of mapping functions. I.e., a family of functions that map values in the [0, 1] domain to points in the RGB colorspace employing a wide variety of color and ensuring that the perceived brightness monotonically increases.

For a description of the algorithm see:

A demo of the wide variety of colormap functions that this algorithm can generate is available here. The demo can also help users in choosing configuration parameters different than the default.

how to use

import {cubehelix, defaultHelixConfig} from 'cubehelix';

/*
 * Generate a mapping function with the default
 * helix configuration. I.e. default start, rotations,
 * hue and gamma are assumed
 */
var mappingFunction = cubehelix();

/*
 * Get the RGB values (scaled in the [0, 1] range) for a
 * value with intensity 0.5 (0 being the lowest, 1 the highest)
 */        
var rgb = mappingFunction(0.5);

/*
 * Generate a different mapping function by providing
 * a full helix configuration different than the default
 */
mappingFunction = cubehelix({start: 0.75, r:-0.5, hue:0.8, gamma:2.0});

/*
 * Alternatively, you may choose to provide only some of the configuration
 * parameters while keeping default values for the rest
 */
mappingFunction = cubehelix({r:-0.5, gamma: 2.0});

/*
 * NB: for many non-default helix configuration values the mapping
 * function may generate RGB components outside of the [0, 1] range
 * The client programmer is responsible for clipping to [0, 1].
 * The more clipping occurs, the more the monotonicity of perceived luminosity 
 * may suffer.
 */

/*
 * Print the default helix configuration
 */
console.log(JSON.stringify(defaultHelixConfig));

js-cubehelix's People

Contributors

mperdikeas avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar

Forkers

smalldice

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.