README

:warning: This project is a work in progress.

aux-xml

Identify and Read Auxiliary XML Files (e.g., .jpg.aux.xml, .png.aux.xml, and .tif.aux.xml)

install

npm install aux-xml

usage

identify aux.xml files

const fs = require("fs");
const isAuxXML = require("aux-xml/is-aux-xml");

isAuxXML("test.aux.xml");
// true

const text = readFileSync("test.aux.xml", "utf-8");
isAuxXML(text);
// true

const buffer = readFileSync("test.aux.xml");
isAuxXML(buffer);
// true

read aux.xml files

const fs = require("fs");
const readAuxXML = require("aux-xml/read-aux-xml");

const file = readFileSync("test.aux.xml");
const data = readAuxXml(file);
/*
{
  srs: 'PROJCS["WGS_1984_Web_Mercator_Auxiliary_Sphere",GEO...',
  interleave: 'pixel',
  pyramidResamplingType: 'nearest'
}
*/

For larger example of sample output of readAuxXML see flower.jpg.aux.xml.json.

write aux.xml files

const fs = require("fs");
const writeAuxXML = require("aux-xml/write-aux-xml");

const file = readFileSync("test.aux.xml");
const text = writeAuxXML({
  srs: 'PROJCS["WGS_1984_Web_Mercator_Auxiliary_Sphere",GEOGCS["GCS_WGS_1984",DATUM["WGS_1984",SPHEROID["WGS_1984",6378137.0,298.257223563]],PRIMEM["Greenwich",0.0],UNIT["Degree",0.0174532925199433]],PROJECTION["Mercator_Auxiliary_Sphere"],PARAMETER["False_Easting",0.0],PARAMETER["False_Northing",0.0],PARAMETER["Central_Meridian",0.0],PARAMETER["Standard_Parallel_1",0.0],PARAMETER["Auxiliary_Sphere_Type",0.0],UNIT["Meter",1.0]]',
  interleave: 'pixel'
});

text will be

`<PAMDataset>
  <SRS>PROJCS["WGS_1984_Web_Mercator_Auxiliary_Sphere",GEOGCS["GCS_WGS_1984",DATUM["WGS_1984",SPHEROID["WGS_1984",6378137.0,298.257223563]],PRIMEM["Greenwich",0.0],UNIT["Degree",0.0174532925199433]],PROJECTION["Mercator_Auxiliary_Sphere"],PARAMETER["False_Easting",0.0],PARAMETER["False_Northing",0.0],PARAMETER["Central_Meridian",0.0],PARAMETER["Standard_Parallel_1",0.0],PARAMETER["Auxiliary_Sphere_Type",0.0],UNIT["Meter",1.0]]</SRS>
  <Metadata domain="IMAGE_STRUCTURE">
    <MDI key="INTERLEAVE">PIXEL</MDI>
  </Metadata>
</PAMDataset>`

Usage no npm install needed!