Abstract Class: FileFormat

Defined in: src/io/formats.ts:8

Abstract base class for neuroimaging file formats.

Direct translation of Python's FileFormat class.

Extended by

• NIFTIFormat
• NIFTIDualFormat
• AFNIFormat

Constructors

Constructor

new FileFormat(
   fileFormat, 
   headerEncoding, 
   headerExtension, 
   dataEncoding, 
   dataExtension): FileFormat;

Defined in: src/io/formats.ts:15

Parameters

fileFormat

string

headerEncoding

string

headerExtension

string

dataEncoding

string

dataExtension

string

Returns

FileFormat

Properties

fileFormat

readonly fileFormat: string;

Defined in: src/io/formats.ts:9

---

headerEncoding

readonly headerEncoding: string;

Defined in: src/io/formats.ts:10

---

headerExtension

readonly headerExtension: string;

Defined in: src/io/formats.ts:11

---

dataEncoding

readonly dataEncoding: string;

Defined in: src/io/formats.ts:12

---

dataExtension

readonly dataExtension: string;

Defined in: src/io/formats.ts:13

Methods

fileMatches()

abstract fileMatches(fileName): Promise<boolean>;

Defined in: src/io/formats.ts:32

Check if a file matches this format and both header/data files exist.

Parameters

fileName

string

Returns

Promise<boolean>

---

headerFileMatches()

headerFileMatches(fileName): boolean;

Defined in: src/io/formats.ts:37

Check if file name matches header format.

Parameters

fileName

string

Returns

boolean

---

dataFileMatches()

dataFileMatches(fileName): boolean;

Defined in: src/io/formats.ts:44

Check if file name matches data format.

Parameters

fileName

string

Returns

boolean

---

stripExtension()

stripExtension(fileName): string;

Defined in: src/io/formats.ts:51

Strip extension from filename.

Parameters

fileName

string

Returns

string

---

getHeaderFile()

getHeaderFile(baseName): string;

Defined in: src/io/formats.ts:59

Get header filename from base name.

Parameters

baseName

string

Returns

string

---

getDataFile()

getDataFile(baseName): string;

Defined in: src/io/formats.ts:66

Get data filename from base name.

Parameters

baseName

string

Returns

string