BlueFileReader

BlueFileReader

new BlueFileReader(optionsnullable)

Bluefile Reader constructor.

Source:
Parameters:
Name Type Attributes Description
options object <nullable>

options that affect how the bluefile is read

Name Type Default Description
ext_header_type string "dict"

if the BlueFile contains extended header keywords, extract them either as a dictionary ("dict", "json", {}, "XMTable", "JSON", "DICT") or as a list of key value pairs. The extended header keywords will be accessible on the hdr.ext_header property after the file has been read.

Extends

Methods

(private) _read(theFile, onload, justHeader)

Internal method that will read a file or stop at the header

Overrides:
Source:
Parameters:
Name Type Description
theFile File

a File object for the Bluefile or Matfile
onload function

callback when the header has been read
justHeader boolean

Whether or not to only read the header

read(theFile, onload)

Read a local Bluefile or Matfile on disk.

Overrides:
Source:
Parameters:
Name Type Description
theFile File

a File object for the Bluefile or Matfile
onload function

callback when the file has been read

read_http(href, onload)

Read a Bluefile or Matfile from a URL

Overrides:
Source:
Parameters:
Name Type Description
href string

the URL for the Bluefile or Matfile
onload function

callback when the header has been read

readheader(theFile, onload)

Read only the header from a local {Blue,Mat}file.

Overrides:
Source:
Parameters:
Name Type Description
theFile File

a File object for the Bluefile or Matfile
onload function

callback when the header has been read