image-js 1.2.0 → 1.3.0

package/dist/image-js.esm.js

@@ -1,5 +1,5 @@
 /*
- * image-js v1.2.0
+ * image-js v1.3.0
  * Image processing and manipulation in JavaScript
  * https://github.com/image-js/image-js#readme
  *
@@ -16811,6 +16811,10 @@ class Image {
    * Origin of the image relative to a the parent image.
    */
   origin;
+  /**
+   * Original image resolution.
+   */
+  originalResolution;
   meta;
   /**
    * Typed array holding the image data.
@@ -16831,7 +16835,8 @@ class Image {
         row: 0,
         column: 0
       },
-      meta
+      meta,
+      resolution
     } = options;
     if (width < 1 || !Number.isInteger(width)) {
       throw new RangeError(`width must be an integer and at least 1. Received ${width}`);
@@ -16846,6 +16851,7 @@ class Image {
     this.colorModel = colorModel;
     this.origin = origin;
     this.meta = meta;
+    this.originalResolution = resolution;
     const colorModelDef = colorModels[colorModel];
     this.components = colorModelDef.components;
     this.alpha = colorModelDef.alpha;
@@ -16866,6 +16872,38 @@ class Image {
       this.data = data;
     }
   }
+  /**
+   * Returns normalized resolution in pixels per centimeter. If resolution unit is unknown, return null.
+   * @returns Object with x and y resolutions in pixel/cm.
+   */
+  get normalizedResolution() {
+    if (!this.originalResolution) {
+      return undefined;
+    }
+    const centimetersPerInch = 2.54;
+    const centimetersPerMeter = 100;
+    switch (this.originalResolution.unit) {
+      case 'inch':
+        return {
+          x: this.originalResolution.x / centimetersPerInch,
+          y: this.originalResolution.y / centimetersPerInch
+        };
+      case 'centimeter':
+        return {
+          x: this.originalResolution.x,
+          y: this.originalResolution.y
+        };
+      case 'meter':
+        return {
+          x: this.originalResolution.x / centimetersPerMeter,
+          y: this.originalResolution.y / centimetersPerMeter
+        };
+      case 'unknown':
+        return null;
+      default:
+        throw new Error('Unknown resolution unit.');
+    }
+  }
   /**
    * Create a new Image based on the properties of an existing one.
    * @param other - Reference image.
@@ -31540,10 +31578,23 @@ function decodePng(buffer) {
     default:
       throw new RangeError(`invalid number of channels: ${png.channels}`);
   }
+  let resolution;
+  if (png.resolution) {
+    resolution = png.resolution.unit === 1 ? /*If the resolution unit is meters*/{
+      x: png.resolution.x,
+      y: png.resolution.y,
+      unit: 'meter'
+    } : /*If resolution unit is unknown */{
+      x: png.resolution.x,
+      y: png.resolution.y,
+      unit: 'unknown'
+    };
+  }
   return new Image(png.width, png.height, {
     colorModel,
     bitDepth,
-    data: png.data
+    data: png.data,
+    resolution
   });
 }
 /**
@@ -31613,6 +31664,7 @@ function getImageFromIFD(ifd) {
   if (ifd.data instanceof Float32Array || ifd.data instanceof Float64Array) {
     throw new Error('Float TIFF data is not supported.');
   }
+  const resolution = getTiffResolution(ifd);
   if (ifd.type === 3) {
     const hasAlpha = ifd.samplesPerPixel === 2;
     const pixelLength = hasAlpha ? 4 : 3;
@@ -31640,7 +31692,8 @@ function getImageFromIFD(ifd) {
       data,
       colorModel: hasAlpha ? 'RGBA' : 'RGB',
       bitDepth: 16,
-      meta: getMetadata(ifd)
+      meta: getMetadata(ifd),
+      resolution
     });
   } else if (ifd.type === 1 || ifd.type === 0) {
     if (ifd.bitsPerSample !== 1) {
@@ -31648,14 +31701,16 @@ function getImageFromIFD(ifd) {
         data: ifd.data,
         bitDepth: ifd.bitsPerSample,
         colorModel: ifd.alpha ? 'GREYA' : 'GREY',
-        meta: getMetadata(ifd)
+        meta: getMetadata(ifd),
+        resolution
       });
     } else {
       return new Image(ifd.width, ifd.height, {
         data: ifd.data.map(pixel => pixel * 255),
         bitDepth: 8,
         colorModel: 'GREY',
-        meta: getMetadata(ifd)
+        meta: getMetadata(ifd),
+        resolution
       });
     }
   } else {
@@ -31663,10 +31718,41 @@ function getImageFromIFD(ifd) {
       data: ifd.data,
       bitDepth: ifd.bitsPerSample,
       colorModel: ifd.alpha ? 'RGBA' : 'RGB',
-      meta: getMetadata(ifd)
+      meta: getMetadata(ifd),
+      resolution
     });
   }
 }
+/**
+ * Gets image resolution from its metadata and converts it into Pixels per meter, when it's possible. Also keeps original resolution values and units.
+ * @param ifd - Tiff metadata.
+ * @returns Resolution object.
+ */
+function getTiffResolution(ifd) {
+  if (!ifd.xResolution || !ifd.yResolution) {
+    return undefined;
+  }
+  switch (ifd.resolutionUnit) {
+    case 1:
+      return {
+        x: ifd.xResolution,
+        y: ifd.yResolution,
+        unit: 'unknown'
+      };
+    case 3:
+      return {
+        x: ifd.xResolution,
+        y: ifd.yResolution,
+        unit: 'centimeter'
+      };
+    default:
+      return {
+        x: ifd.xResolution,
+        y: ifd.yResolution,
+        unit: 'inch'
+      };
+  }
+}
 
 /**
  * Decode input data. Data format is automatically detected.