vicar-loader

Utility for loading Vicar file data formats as described here.

Use

import { VicarLoader } from '@gov.nasa.jpl.honeycomb/vicar-loader';
const loader = new VicarLoader();
loader.load('./path/to/file.vicar').then(texture => {

    // ... vicar file contents as data texture ...

});

API

VicarLoader

Three.js implementation of VicarLoaderBase.

extends VicarLoaderBase

manager

manager : LoadingManager = DefaultLoadingManager

constructor

constructor( manager : LoadingManager = DefaultLoadingManager ) : void

load

load( url : String, texture : DataTexture = new DataTexture() ) : DataTexture

Loads and parses the Vicar file and returns a DataTexture. If a DataTexture is passed into the function the data is applied to it.

parse

parse( buffer : Uint8Array | ArrayBuffer, texture : DataTexture = new DataTexture() ) : DataTexture

Parses the contents of the given Vicar file and returns a texture with the contents. The content of the arrays is mapped to a 255 bit color value based on the max values.

VicarResult

labels

labels : Array<{ isLabelGroup : Boolean, name : String, value : any }>

The set of header labels in the file. This includes both the header and EOL extension labels if present.

data

data : TypedArray

The data of the file in a typed array of the type defined by the labels.FORMAT field with the binary prefix data stripped out.

The array is of length width * height * depth. If complex is true then the length will be width * height * depth * 2 to account for the imaginary and real components of the values.

width

width : Number

The row stride of the image as defined by the labels.N1 field.

height

height : Number

The height of the image as defined by the labels.N2 field.

depth

depth : Number

The depth of the image as defined by the labels.N3 field.

prefixData

prefixData : Uint8Array

The binary prefix data for each row defined at a Uint8Array. The array is of length width * prefixWidth.

prefixWidth

prefixWidth : Number

The width of the binary prefix as defined by the labels.NBB field.

complex

complex : Boolean

Whether the values are complex or not as dependent on the labels.FORMAT field. This will be true if labels.FORMAT is COMP or COMPLEX.

VicarLoaderBase

Class for loading and parsing Vicar files

fetchOptions

fetchOptions : Object = { credentials: 'same-origin' }

Fetch options for loading the file.

load

load( url : String ) : Promise<VicarResult>

Loads and parses the Vicar file. The promise resolves with the returned data from the parse function.

parse

parse( buffer : Uint8Array | ArrayBuffer ) : VicarResult

Parses the contents of the given Vicar file and returns an object describing the telemetry.