README.md

GIFTI-Reader-JS

A JavaScript GIFTI file format reader. This reader parses GIFTI files and supports ASCII, Base64, and GZIP-Base64 datatypes.

Usage

API and more examples

var gii = gifti.parse(giftiXMLString);

// DataArray.getData() will return Float32Array, Uint8Array or Int32Array depending on datatype
var points = gii.getPointsDataArray().getData();
var indices = gii.getTrianglesDataArray().getData();
var normals = gii.getNormalsDataArray().getData();
var colors = gii.getColorsDataArray().getData();
var labels = gii.labelTable;

Install

Get a packaged source file from the release folder:

• gifti-reader.js
• gifti-reader-min.js

Or install via NPM:

npm install gifti-reader-js

Testing

npm test

Building

Build it yourself using:

npm run build

This will output gifti-reader.js and gifti-reader-min.js to build/

Acknowledgements

GIFTI-Reader-JS makes use of the following third-party libraries:

• fflate — for GZIP inflating
• sax-js — for SAX parsing