@thi.ng/pixel-dominant-colors 1.1.1 → 1.1.2

package/CHANGELOG.md

@@ -1,6 +1,6 @@
 # Change Log
 
-- **Last updated**: 2024-07-22T13:15:57Z
+- **Last updated**: 2024-07-25T11:43:52Z
 - **Generator**: [thi.ng/monopub](https://thi.ng/monopub)
 
 All notable changes to this project will be documented in this file.
@@ -9,6 +9,12 @@ 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.
 
+### [1.1.2](https://github.com/thi-ng/umbrella/tree/@thi.ng/pixel-dominant-colors@1.1.2) (2024-07-25)
+
+#### ♻️ Refactoring
+
+- add/extract `dominantColorsArray()` ([4aea78e](https://github.com/thi-ng/umbrella/commit/4aea78e))
+
 ## [1.1.0](https://github.com/thi-ng/umbrella/tree/@thi.ng/pixel-dominant-colors@1.1.0) (2024-07-22)
 
 #### 🚀 Features

package/README.md

@@ -123,7 +123,7 @@ For Node.js REPL:
 const pdc = await import("@thi.ng/pixel-dominant-colors");
 ```
 
-Package sizes (brotli'd, pre-treeshake): ESM: 246 bytes
+Package sizes (brotli'd, pre-treeshake): ESM: 223 bytes
 
 ## Dependencies
 

package/index.d.ts

@@ -1,4 +1,4 @@
-import type { Fn2 } from "@thi.ng/api";
+import type { Fn2, NumericArray } from "@thi.ng/api";
 import type { KMeansOpts } from "@thi.ng/k-means";
 import type { FloatBuffer } from "@thi.ng/pixel/float";
 /**
@@ -24,6 +24,8 @@ export interface DominantColorOpts extends KMeansOpts {
  * `area` the normalized cluster size.
  *
  * @remarks
+ * This function is syntax sugar for {@link dominantColorsArray}.
+ *
  * See thi.ng/k-means for details about clustering implementation & options.
  *
  * @param img -
@@ -33,5 +35,19 @@ export interface DominantColorOpts extends KMeansOpts {
 export declare const dominantColors: (img: FloatBuffer, num: number, opts?: Partial<DominantColorOpts>) => {
     color: number[];
     area: number;
+    ids: number[];
+}[];
+/**
+ * Similar to {@link dominantColors}, but accepting an array of color samples
+ * instead of a `FloatBuffer` image.
+ *
+ * @param num
+ * @param samples
+ * @param opts
+ */
+export declare const dominantColorsArray: (num: number, samples: NumericArray[], opts?: Partial<KMeansOpts>) => {
+    color: number[];
+    area: number;
+    ids: number[];
 }[];
 //# sourceMappingURL=index.d.ts.map

package/index.js

@@ -1,15 +1,20 @@
 import { kmeans } from "@thi.ng/k-means/kmeans";
-const dominantColors = (img, num, opts = {}) => {
-  const n = img.width * img.height;
-  const mapped = [];
-  const filter = opts.filter || (() => true);
-  for (let i = 0, j = 0, s = img.stride[0]; i < n; i++, j += s) {
-    const p = img.data.subarray(j, j + s);
-    if (filter(p, i)) mapped.push(p);
+const dominantColors = (img, num, opts) => {
+  const samples = [];
+  const filter = opts?.filter || (() => true);
+  let i = 0;
+  for (let p of img) {
+    if (filter(p, i)) samples.push(p);
+    i++;
   }
-  if (!mapped.length) return [];
-  return kmeans(Math.min(num, mapped.length), mapped, opts).sort((a, b) => b.items.length - a.items.length).map((c) => ({ color: [...c.centroid], area: c.items.length / n }));
+  return samples.length ? dominantColorsArray(num, samples, opts) : [];
 };
+const dominantColorsArray = (num, samples, opts) => kmeans(Math.min(num, samples.length), samples, opts).sort((a, b) => b.items.length - a.items.length).map((c) => ({
+  color: [...c.centroid],
+  area: c.items.length / samples.length,
+  ids: c.items
+}));
 export {
-  dominantColors
+  dominantColors,
+  dominantColorsArray
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@thi.ng/pixel-dominant-colors",
-  "version": "1.1.1",
+  "version": "1.1.2",
   "description": "k-means based dominant color extraction from images/pixel buffers",
   "type": "module",
   "module": "./index.js",
@@ -37,8 +37,8 @@
   },
   "dependencies": {
     "@thi.ng/api": "^8.11.7",
-    "@thi.ng/k-means": "^0.6.95",
-    "@thi.ng/pixel": "^7.0.0"
+    "@thi.ng/k-means": "^0.7.0",
+    "@thi.ng/pixel": "^7.1.0"
   },
   "devDependencies": {
     "@microsoft/api-extractor": "^7.47.0",
@@ -77,5 +77,5 @@
     "parent": "@thi.ng/pixel",
     "year": 2021
   },
-  "gitHead": "bd22b0826134b79064169371665b4d6caa9b6066\n"
+  "gitHead": "ec052b25dff4db6c4d1748e946c38fb5cf403dbf\n"
 }