Skip to content

Class: AFNIFormat

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

AFNI file format descriptor.

Extends

Constructors

Constructor

ts
new AFNIFormat(): AFNIFormat;

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

Returns

AFNIFormat

Overrides

FileFormat.constructor

Properties

fileFormat

ts
readonly fileFormat: string;

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

Inherited from

FileFormat.fileFormat


headerEncoding

ts
readonly headerEncoding: string;

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

Inherited from

FileFormat.headerEncoding


headerExtension

ts
readonly headerExtension: string;

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

Inherited from

FileFormat.headerExtension


dataEncoding

ts
readonly dataEncoding: string;

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

Inherited from

FileFormat.dataEncoding


dataExtension

ts
readonly dataExtension: string;

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

Inherited from

FileFormat.dataExtension

Methods

headerFileMatches()

ts
headerFileMatches(fileName): boolean;

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

Check if file name matches header format.

Parameters

fileName

string

Returns

boolean

Inherited from

FileFormat.headerFileMatches


dataFileMatches()

ts
dataFileMatches(fileName): boolean;

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

Check if file name matches data format.

Parameters

fileName

string

Returns

boolean

Inherited from

FileFormat.dataFileMatches


stripExtension()

ts
stripExtension(fileName): string;

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

Strip extension from filename.

Parameters

fileName

string

Returns

string

Inherited from

FileFormat.stripExtension


getHeaderFile()

ts
getHeaderFile(baseName): string;

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

Get header filename from base name.

Parameters

baseName

string

Returns

string

Inherited from

FileFormat.getHeaderFile


getDataFile()

ts
getDataFile(baseName): string;

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

Get data filename from base name.

Parameters

baseName

string

Returns

string

Inherited from

FileFormat.getDataFile


fileMatches()

ts
fileMatches(fileName): Promise<boolean>;

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

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

Parameters

fileName

string

Returns

Promise<boolean>

Overrides

FileFormat.fileMatches

Released under the MIT License.