@thi.ng/pixel-analysis 0.1.0 → 0.2.0

package/CHANGELOG.md

@@ -1,6 +1,6 @@
 # Change Log
 
-- **Last updated**: 2025-05-28T12:02:40Z
+- **Last updated**: 2025-06-02T21:17:03Z
 - **Generator**: [thi.ng/monopub](https://thi.ng/monopub)
 
 All notable changes to this project will be documented in this file.
@@ -11,6 +11,15 @@ See [Conventional Commits](https://conventionalcommits.org/) for commit guidelin
 **Note:** Unlisted _patch_ versions only involve non-code or otherwise excluded changes
 and/or version bumps of transitive dependencies.
 
+## [0.2.0](https://github.com/thi-ng/umbrella/tree/@thi.ng/pixel-analysis@0.2.0) (2025-06-02)
+
+#### 🚀 Features
+
+- update hue range fns ([27d43aa](https://github.com/thi-ng/umbrella/commit/27d43aa))
+  - simplify/optimize warmIntensityHsv()
+  - update args to accept int buffers
+  - add tests
+
 ## [0.1.0](https://github.com/thi-ng/umbrella/tree/@thi.ng/pixel-analysis@0.1.0) (2025-05-28)
 
 #### 🚀 Features

package/README.md

@@ -15,6 +15,7 @@
 > GitHub](https://github.com/sponsors/postspectacular). Thank you! ❤️
 
 - [About](#about)
+  - [Color analysis](#color-analysis)
 - [Status](#status)
 - [Installation](#installation)
 - [Dependencies](#dependencies)
@@ -26,6 +27,27 @@
 
 Image color & feature analysis utilities. This is a support package for [@thi.ng/pixel](https://github.com/thi-ng/umbrella/tree/develop/packages/pixel).
 
+### Color analysis
+
+-   Dominant colors in different color modes/formats:
+    -   CSS
+    -   sRGB
+    -   HSV
+    -   Oklch (perceptual)
+-   Normalized areas of dominant color clusters
+-   Min/max HSV hue range of dominant colors
+-   Min/max HSV saturation range of dominant colors
+-   Min/max Oklch chroma range of dominant colors
+-   Min/max luminance range of dominant colors (obtained from SRGB)
+-   Min/max luminance range of entire grayscale image (obtained from SRGB)
+-   Normalized warmth, i.e. the area-weighted intensity of "warm" colors in the image
+-   Luminance contrast of dominant colors
+-   Luminance contrast of entire grayscale image
+-   Max. normalized WCAG color contrast of dominant colors
+-   Average luminance of dominant colors, weighted by area
+-   Average HSV saturation of dominant colors, weighted by area
+-   Average Oklch chroma of dominant colors, weighted by area
+
 ## Status
 
 **BETA** - possibly breaking changes forthcoming
@@ -58,7 +80,7 @@ For Node.js REPL:
 const pa = await import("@thi.ng/pixel-analysis");
 ```
 
-Package sizes (brotli'd, pre-treeshake): ESM: 1.29 KB
+Package sizes (brotli'd, pre-treeshake): ESM: 1.28 KB
 
 ## Dependencies
 

package/hues.d.ts

@@ -1,4 +1,5 @@
 import type { FloatBuffer } from "@thi.ng/pixel/float";
+import type { IntBuffer } from "@thi.ng/pixel/int";
 /**
  * Iterator yielding HSV pixel values/colors matching given hue range and
  * minimum saturation.
@@ -8,7 +9,7 @@ import type { FloatBuffer } from "@thi.ng/pixel/float";
  * @param maxHue
  * @param minSat
  */
-export declare function selectHueRangeHsv(img: FloatBuffer, minHue: number, maxHue: number, minSat: number): Generator<Float32Array<ArrayBufferLike>, void, unknown>;
+export declare function selectHueRangeHsv(img: IntBuffer | FloatBuffer, minHue: number, maxHue: number, minSat: number): Generator<Float32Array<ArrayBufferLike> | Uint8Array<ArrayBufferLike> | Uint8ClampedArray<ArrayBufferLike> | Uint16Array<ArrayBufferLike> | Uint32Array<ArrayBufferLike>, void, unknown>;
 /**
  * Similar to {@link selectHueRangeHsv}, but only returns a count of HSV pixel
  * values/colors matching given hue range and minimum saturation (all
@@ -19,7 +20,7 @@ export declare function selectHueRangeHsv(img: FloatBuffer, minHue: number, maxH
  * @param maxHue
  * @param minSat
  */
-export declare const countHueRangeHsv: (img: FloatBuffer, minHue: number, maxHue: number, minSat: number) => number;
+export declare const countHueRangeHsv: (img: IntBuffer | FloatBuffer, minHue: number, maxHue: number, minSat: number) => number;
 /**
  * Takes a list of hue ranges and computes the area-weighted mean intensity of
  * matching pixels in the given image. Also see {@link warmIntensityHsv}.
@@ -31,7 +32,7 @@ export declare const countHueRangeHsv: (img: FloatBuffer, minHue: number, maxHue
  * @param hues
  * @param minSat
  */
-export declare const hueRangeIntensityHsv: (img: FloatBuffer, hues: [number, number][], minSat?: number) => number;
+export declare const hueRangeIntensityHsv: (img: IntBuffer | FloatBuffer, hues: [number, number][], minSat?: number) => number;
 /**
  * Syntax sugar for {@link hueRangeIntensityHsv} to compute the area-weighted mean
  * intensity of pixels in the yellow/orange/red hue ranges.
@@ -39,5 +40,5 @@ export declare const hueRangeIntensityHsv: (img: FloatBuffer, hues: [number, num
  * @param img
  * @param minSat
  */
-export declare const warmIntensityHsv: (img: FloatBuffer, minSat?: number) => number;
+export declare const warmIntensityHsv: (img: IntBuffer | FloatBuffer, minSat?: number) => number;
 //# sourceMappingURL=hues.d.ts.map

package/hues.js

@@ -43,9 +43,8 @@ const hueRangeIntensityHsv = (img, hues, minSat = 0.2) => {
 const warmIntensityHsv = (img, minSat) => hueRangeIntensityHsv(
   img,
   [
-    [15 / 360, 35 / 360],
-    [35 / 360, 55 / 360],
-    [345 / 360, 15 / 360]
+    [345 / 360, 55 / 360]
+    // red, orange, yellow
   ],
   minSat
 );

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@thi.ng/pixel-analysis",
-  "version": "0.1.0",
+  "version": "0.2.0",
   "description": "Image color & feature analysis utilities",
   "type": "module",
   "module": "./index.js",
@@ -106,5 +106,5 @@
     "status": "beta",
     "year": 2024
   },
-  "gitHead": "61c3833b7ef7d044621454b5ea4af885d39f065e\n"
+  "gitHead": "1a4408bfd547a11330b80c2a0b37f85e2c65ab17\n"
 }