Merge pull request #245 from DanielJDufour/241-xml-utils

replaced txml with xml-utils

Author: constantinius

package-lock.json

@@ -28,7 +28,7 @@
     "pako": "^2.0.4",
     "parse-headers": "^2.0.2",
     "threads": "^1.7.0",
-    "txml": "^5.0.0"
+    "xml-utils": "^1.0.2"
   },
   "devDependencies": {
     "@babel/core": "^7.8.7",
@@ -76,8 +76,7 @@
     "fs": false,
     "http": false,
     "https": false,
-    "url": false,
-    "./src/txml": "./src/browser/txml"
+    "url": false
   },
   "sideEffects": false,
   "contributors": [

package.json

@@ -1,7 +1,8 @@
 /* eslint max-len: ["error", { "code": 120 }] */
 
 import { getFloat16 } from '@petamoriken/float16';
-import { parse } from './txml';
+import getAttribute from "xml-utils/get-attribute";
+import findTagsByName from 'xml-utils/find-tags-by-name';
 
 import { photometricInterpretations, ExtraSamplesValues } from './globals';
 import { fromWhiteIsZero, fromBlackIsZero, fromPalette, fromCMYK, fromYCbCr, fromCIELab } from './rgb';
@@ -777,27 +778,16 @@ class GeoTIFFImage {
       return null;
     }
     const string = this.fileDirectory.GDAL_METADATA;
-    const xmlDom = parse(string.substring(0, string.length - 1));
 
-    if (!xmlDom[0].tagName) {
-      throw new Error('Failed to parse GDAL metadata XML.');
-    }
-
-    const root = xmlDom[0];
-    if (root.tagName !== 'GDALMetadata') {
-      throw new Error('Unexpected GDAL metadata XML tag.');
-    }
-
-    let items = root.children
-      .filter((child) => child.tagName === 'Item');
+    let items = findTagsByName(string, 'Item');
 
     if (sample !== null) {
-      items = items.filter((item) => Number(item.attributes.sample) === sample);
+      items = items.filter((item) => Number(getAttribute(item, "sample")) === sample);
     }
 
     for (let i = 0; i < items.length; ++i) {
       const item = items[i];
-      metadata[item.attributes.name] = item.children[0];
+      metadata[getAttribute(item, "name")] = item.inner;
     }
     return metadata;
   }

src/browser/txml.js

@@ -79,3 +79,8 @@ done
 gdal_translate -of GTiff -co NBITS=16 -ot Float32 initial.tiff float_n_bit_16.tiff || true
 gdal_translate -of GTiff -co NBITS=16 -ot Float32 -co TILED=YES initial.tiff float_n_bit_tiled_16.tiff || true
 gdal_translate -of GTiff -co NBITS=16 -ot Float32 -co INTERLEAVE=BAND initial.tiff float_n_bit_interleave_16.tiff || true
+
+# GDAL_METADATA support
+wget https://github.com/GeoTIFF/test-data/archive/8ac198032d8b02160049ca161e8108e3d38176f3.zip -O geotiff-test-data.zip
+unzip -j -o geotiff-test-data.zip "test-data-*/files/*" -d .
+rm geotiff-test-data.zip

src/geotiffimage.js

@@ -529,6 +529,73 @@ describe('Geo metadata tests', async () => {
   });
 });
 
+describe("GDAL_METADATA tests", async () => {
+  it('should parse stats for specific sample', async () => {
+    const tiff = await GeoTIFF.fromSource(createSource('abetow-ERD2018-EBIRD_SCIENCE-20191109-a5cf4cb2_hr_2018_abundance_median.tiff'));
+    const image = await tiff.getImage();
+    const metadata = await image.getGDALMetadata(10);
+    expect(metadata).to.deep.equal({
+      STATISTICS_MAXIMUM: '7.2544522285461',
+      STATISTICS_MEAN: 'nan',
+      STATISTICS_MINIMUM: '0',
+      STATISTICS_STDDEV: 'nan'
+    });
+  });
+
+  it('should parse stats for single-band GeoTIFF', async () => {
+    const tiff = await GeoTIFF.fromSource(createSource('nt_20201024_f18_nrt_s.tif'));
+    const image = await tiff.getImage();
+    const metadata = await image.getGDALMetadata();
+    expect(metadata).to.deep.equal({
+      STATISTICS_MAXIMUM: '100',
+      STATISTICS_MEAN: '28.560288669249',
+      STATISTICS_MINIMUM: '0',
+      STATISTICS_STDDEV: '39.349526064368'
+    });
+  });
+
+  it('should parse layer type', async () => {
+    const tiff = await GeoTIFF.fromSource(createSource('eu_pasture.tiff'));
+    const image = await tiff.getImage();
+    const metadata = await image.getGDALMetadata();
+    expect(metadata).to.deep.equal({
+      LAYER_TYPE: 'athematic'
+    });
+  });
+
+  it('should parse color interpretation', async () => {
+    const tiff = await GeoTIFF.fromSource(createSource('utm.tif'));
+    const image = await tiff.getImage();
+    const metadata = await image.getGDALMetadata();
+    expect(metadata).to.deep.equal({
+      COLORINTERP: 'Palette'
+    });
+  });
+
+  it('should parse stats for another single-band GeoTIFF', async () => {
+    const tiff = await GeoTIFF.fromSource(createSource('vestfold.tif'));
+    const image = await tiff.getImage();
+    const metadata = await image.getGDALMetadata();
+    expect(metadata).to.deep.equal({
+      STATISTICS_MAXIMUM: '332.6073328654',
+      STATISTICS_MEAN: '83.638959236148',
+      STATISTICS_MINIMUM: '18.103807449341',
+      STATISTICS_STDDEV: '69.590554367352'
+    });
+  });
+
+  it('should parse creation times', async () => {
+    const tiff = await GeoTIFF.fromSource(createSource('wind_direction.tif'));
+    const image = await tiff.getImage();
+    const metadata = await image.getGDALMetadata();
+    expect(metadata).to.deep.equal({
+      creationTime: '1497289465',
+      creationTimeString: '2017-06-12T17:44:25.466257Z',
+      name: 'Wind_Dir_SFC'
+    });
+  });
+});
+
 describe('COG tests', async () => {
   it('should parse the header ghost area when present', async () => {
     const tiff = await GeoTIFF.fromSource(createSource('cog.tiff'));