API

gifti : Object

gifti

Kind: global variable

• gifti : Object
  • .DataArray : function
    • new gifti.DataArray()
    • .isPointSet() ⇒ boolean
    • .isTriangles() ⇒ boolean
    • .isNormals() ⇒ boolean
    • .isColors() ⇒ boolean
    • .getDimensions() ⇒ number
    • .getNumElements(dimIndex) ⇒ number
    • .isScalar() ⇒ boolean
    • .isTriple() ⇒ boolean
    • .isQuad() ⇒ boolean
    • .isAscii() ⇒ boolean
    • .isBase64Binary() ⇒ boolean
    • .isGzipBase64Binary() ⇒ boolean
    • .isBase64Encoded() ⇒ boolean
    • .isFloat32() ⇒ boolean
    • .isInt32() ⇒ boolean
    • .isUnsignedInt8() ⇒ boolean
    • .getData() ⇒ Float32Array | Uint8Array | Int32Array
  • .GIFTI : function
    • new gifti.GIFTI()
    • .getPointsDataArray() ⇒ DataArray
    • .getTrianglesDataArray() ⇒ DataArray
    • .getNormalsDataArray() ⇒ DataArray
    • .getColorsDataArray() ⇒ DataArray
    • .getNumPoints() ⇒ number
    • .getNumTriangles() ⇒ number
  • .Label : function | *
    • new gifti.Label(attributes)
  • .Transform : function
    • new gifti.Transform()
  • .isThisFormat(filename) ⇒ boolean
  • .parse(xmlStr) ⇒ GIFTI

gifti.DataArray : function

Kind: static class of gifti
Properties

Name	Type
attributes	object
metadata	object
transforms	Array.<Transform>
data	Float32Array | Uint8Array | Int32Array

• .DataArray : function
  • new gifti.DataArray()
  • .isPointSet() ⇒ boolean
  • .isTriangles() ⇒ boolean
  • .isNormals() ⇒ boolean
  • .isColors() ⇒ boolean
  • .getDimensions() ⇒ number
  • .getNumElements(dimIndex) ⇒ number
  • .isScalar() ⇒ boolean
  • .isTriple() ⇒ boolean
  • .isQuad() ⇒ boolean
  • .isAscii() ⇒ boolean
  • .isBase64Binary() ⇒ boolean
  • .isGzipBase64Binary() ⇒ boolean
  • .isBase64Encoded() ⇒ boolean
  • .isFloat32() ⇒ boolean
  • .isInt32() ⇒ boolean
  • .isUnsignedInt8() ⇒ boolean
  • .getData() ⇒ Float32Array | Uint8Array | Int32Array

new gifti.DataArray()

The DataArray constructor.

dataArray.isPointSet() ⇒ boolean

Returns true if this data array represents a point set.

Kind: instance method of DataArray

dataArray.isTriangles() ⇒ boolean

Returns true if this data array represents triangle indices.

Kind: instance method of DataArray

dataArray.isNormals() ⇒ boolean

Returns true if this data array represents normals.

Kind: instance method of DataArray

dataArray.isColors() ⇒ boolean

Returns true if this data array represents normals.

Kind: instance method of DataArray

dataArray.getDimensions() ⇒ number

Returns the number of dimensions of this data array.

Kind: instance method of DataArray

dataArray.getNumElements(dimIndex) ⇒ number

Returns the number of elements in the specified dimension.

Kind: instance method of DataArray

Param	Type
dimIndex	number

dataArray.isScalar() ⇒ boolean

Returns true if this data array represents scalar data.

Kind: instance method of DataArray

dataArray.isTriple() ⇒ boolean

Returns true if this data array is in triples.

Kind: instance method of DataArray

dataArray.isQuad() ⇒ boolean

Returns true if this data array is in quads.

Kind: instance method of DataArray

dataArray.isAscii() ⇒ boolean

Returns true if this data array is encoded in ASCII format.

Kind: instance method of DataArray

dataArray.isBase64Binary() ⇒ boolean

Returns true if this data array is encoded in Base64 format.

Kind: instance method of DataArray

dataArray.isGzipBase64Binary() ⇒ boolean

Returns true if this data array is encoded in GZIP-Base64 format.

Kind: instance method of DataArray

dataArray.isBase64Encoded() ⇒ boolean

Returns true if this data array uses Base64 encoding.

Kind: instance method of DataArray

dataArray.isFloat32() ⇒ boolean

Returns true if the datatype is 32-bit floating point.

Kind: instance method of DataArray

dataArray.isInt32() ⇒ boolean

Returns true if the datatype is 32-bit signed integer.

Kind: instance method of DataArray

dataArray.isUnsignedInt8() ⇒ boolean

Returns true if the datatype is 8-bit unsigned integer.

Kind: instance method of DataArray

dataArray.getData() ⇒ Float32Array | Uint8Array | Int32Array

Returns the data as a typed array (either Float32Array, Uint8Array or Int32Array)

Kind: instance method of DataArray

gifti.GIFTI : function

Kind: static class of gifti
Properties

Name	Type
attributes	object
metadata	object
labelTable	Array.<Label>
dataArrays	Array.<DataArray>

• .GIFTI : function
  • new gifti.GIFTI()
  • .getPointsDataArray() ⇒ DataArray
  • .getTrianglesDataArray() ⇒ DataArray
  • .getNormalsDataArray() ⇒ DataArray
  • .getColorsDataArray() ⇒ DataArray
  • .getNumPoints() ⇒ number
  • .getNumTriangles() ⇒ number

new gifti.GIFTI()

The GIFTI constructor.

giftI.getPointsDataArray() ⇒ DataArray

Returns the point set data array.

Kind: instance method of GIFTI

giftI.getTrianglesDataArray() ⇒ DataArray

Returns the triangle indices data array.

Kind: instance method of GIFTI

giftI.getNormalsDataArray() ⇒ DataArray

Returns the normals data array.

Kind: instance method of GIFTI

giftI.getColorsDataArray() ⇒ DataArray

Returns the colors data array.

Kind: instance method of GIFTI

giftI.getNumPoints() ⇒ number

Returns the number of points.

Kind: instance method of GIFTI

giftI.getNumTriangles() ⇒ number

Returns the number of triangles.

Kind: instance method of GIFTI

gifti.Label : function | *

Kind: static class of gifti
Properties

Name	Type
key	string
r	number
g	number
b	number
a	number
label	string

new gifti.Label(attributes)

The Label constructor.

Param	Type
attributes	object

gifti.Transform : function

Kind: static class of gifti
Properties

Name	Type
dataSpace	string
transformedSpace	string
matrixData	Array.<number>

new gifti.Transform()

The Transform constructor.

gifti.isThisFormat(filename) ⇒ boolean

Returns true if this filename contains ".gii"

Kind: static method of gifti

Param
filename

gifti.parse(xmlStr) ⇒ GIFTI

Parses GIFTI data.

Kind: static method of gifti

Param	Type
xmlStr	string