# image-filter-contrast

> Small library to apply a contrast transformation to a image

Latest version **1.0.0** (published 2017-01-07) · ISC license · 0 weekly downloads

## Install

```sh
npm install image-filter-contrast
pnpm add image-filter-contrast
yarn add image-filter-contrast
bun add image-filter-contrast
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.0 |
| Published | 2017-01-07 |
| First published | 2016-05-22 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Ricardo Canastro |
| Maintainers | canastro |
| Keywords | image, image-contrast, filter, filters, processing, manipulation, contrast, transformation, pixel |

## Links

- npm: https://www.npmjs.com/package/image-filter-contrast
- Repository: https://github.com/canastro/image-filter-contrast
- Homepage: https://github.com/canastro/image-filter-contrast#readme
- Issues: https://github.com/canastro/image-filter-contrast/issues
- npm.io page: https://npm.io/package/image-filter-contrast

## Dependencies (1)

- [image-filter-core](https://npm.io/package/image-filter-core.md) ^2.0.0

## Alternatives

- [mobx-react](https://npm.io/package/mobx-react.md) — 2.8M weekly downloads
- [rc-tree](https://npm.io/package/rc-tree.md) — 2.6M weekly downloads
- [@react-oauth/google](https://npm.io/package/@react-oauth/google.md) — 1.3M weekly downloads
- [@wagmi/connectors](https://npm.io/package/@wagmi/connectors.md) — 877.0K weekly downloads
- [vee-validate](https://npm.io/package/vee-validate.md) — 836.4K weekly downloads

## Recent versions

- 1.0.0 (latest) — 2017-01-07
- 0.0.3 — 2017-01-02
- 0.0.2 — 2016-06-04
- 0.0.1 — 2016-05-22

## README

![build status](https://travis-ci.org/canastro/image-filter-contrast.svg?branch=master)
[![npm version](https://badge.fury.io/js/image-filter-contrast.svg)](https://badge.fury.io/js/image-filter-contrast)
[![codecov](https://codecov.io/gh/canastro/image-filter-contrast/branch/master/graph/badge.svg)](https://codecov.io/gh/canastro/image-filter-contrast)

# image-filter-contrast

Small library to apply a contrast transformation to a image relying on `image-filter-core` handle the transformation and distribute work with webworkers.

Other related modules:
* [image-filter-core](https://www.npmjs.com/package/image-filter-core)
* [image-filter-contrast](https://www.npmjs.com/package/image-filter-contrast)
* [image-filter-grayscale](https://www.npmjs.com/package/image-filter-grayscale)
* [image-filter-threshold](https://www.npmjs.com/package/image-filter-threshold)
* [image-filter-sepia](https://www.npmjs.com/package/image-filter-sepia)
* [image-filter-invert](https://www.npmjs.com/package/image-filter-invert)
* [image-filter-gamma](https://www.npmjs.com/package/image-filter-gamma)
* [image-filter-colorize](https://www.npmjs.com/package/image-filter-colorize)
* [image-filters](https://www.npmjs.com/package/image-filters)

## Install

```
npm install image-filter-contrast --save
```

## Usage
It applies a contrast transformation to a base64 image. If you want a more complete library, please check image-filters that wraps this and other libraries to provide a more complete suite of image filters.

This library consumes ImageData and outputs ImageData in a Promise. You can use `image-filter-core` to convert from ImageData to dataURL.

JS file:
```js
var imageContrast = require('image-contrast');

imageContrast(IMAGE_DATA, { contrast: 30 });
```

## Frequent questions:
### How can I get image data from a image tag?

```js
var element = document.getElementById('#dummy-image');
var canvas = document.createElement('canvas');
var context = canvas.getContext('2d');
context.drawImage(element, 0, 0 );
var imageData = context.getImageData(0, 0, element.width, element.height);
```

### How can I get image data from url?

```js
var element = document.createElement('img');
element.setAttribute('src', options.url);
//...repeat process from the previous answer
```

### How can I use the output of this?

```js
var imageFilterCore = require('image-filter-core');
imageContrast(IMAGE_DATA, { contrast: 30 })
    .then(function (result) {
        // result === ImageData object
        var image = document.createElement('img');
        image.setAttribute('src', imageFilterCore.convertImageDataToCanvasURL(imageData));
        target.appendChild(image);
    });
```

---
_Source: https://npm.io/package/image-filter-contrast · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
