types¶
- class BidsData()¶
Note
Deprecated: Will be removed in v4.0.0.
Base class for BIDS data.
- BidsData.definitions¶
Note
Deprecated: Will be removed in v4.0.0.
type: Map.<string, ParsedHedGroup>
A Mapping from definition names to their associated ParsedHedGroup objects.
- BidsData.hedIssues¶
Note
Deprecated: Will be removed in v4.0.0.
type: Array.<Issue>
A list of HED validation issues. This will be converted to BidsIssue objects later on.
- BidsData.parsedStringMapping¶
Note
Deprecated: Will be removed in v4.0.0.
type: Map.<string, ParsedHedString>
A mapping from unparsed HED strings to ParsedHedString objects.
- class BidsFile(name, file)¶
A BIDS file.
- BidsFile.file¶
type: object
The file object representing this file data. This is used to generate BidsIssue objects.
- BidsFile.name¶
type: string
The name of this file.
- class BidsJsonFile()¶
A BIDS JSON file.
- BidsJsonFile.BidsJsonFile¶
- BidsJsonFile.jsonData¶
type: object
This file’s JSON data.
- class BidsTsvFile(name, tsvData, file, potentialSidecars, mergedDictionary)¶
A BIDS TSV file.
Constructor.
- Arguments:
name (string) – The name of the TSV file.
tsvData (Object|string) – This file’s TSV data.
file (object) – The file object representing this file.
potentialSidecars (Array.<string>) – The list of potential JSON sidecars.
mergedDictionary (object) – The merged sidecar data.
- BidsTsvFile.BidsTsvFile¶
Constructor.
- BidsTsvFile.hedColumnHedStrings¶
type: Array.<string>
HED strings in the “HED” column of the TSV data.
- BidsTsvFile.mergedSidecar¶
type: BidsSidecar
The pseudo-sidecar object representing the merged sidecar data.
- BidsTsvFile.parsedTsv¶
type: Object
This file’s parsed TSV data.
- BidsTsvFile.potentialSidecars¶
type: Array.<string>
The list of potential JSON sidecars.
- BidsTsvFile.sidecarHedData¶
type: Map.<string, (string|Object.<string, string>)>
The extracted HED data for the merged pseudo-sidecar.
- class BidsEventFile(name, potentialSidecars, mergedDictionary, tsvData, file)¶
A BIDS events.tsv file.
Constructor.
- Arguments:
name (string) – The name of the event TSV file.
potentialSidecars (Array.<string>) – The list of potential JSON sidecars.
mergedDictionary (object) – The merged sidecar data.
tsvData (Object|string) – This file’s TSV data.
file (object) – The file object representing this file.
- BidsEventFile.BidsEventFile¶
Constructor.
- class BidsTabularFile(name, potentialSidecars, mergedDictionary, tsvData, file)¶
A BIDS TSV file other than an events.tsv file.
Constructor.
- Arguments:
name (string) – The name of the TSV file.
potentialSidecars (Array.<string>) – The list of potential JSON sidecars.
mergedDictionary (object) – The merged sidecar data.
tsvData (Object|string) – This file’s TSV data.
file (object) – The file object representing this file.
- BidsTabularFile.BidsTabularFile¶
Constructor.
- class BidsSidecar(name, sidecarData, file)¶
Constructor.
- Arguments:
name (string) – The name of the sidecar file.
sidecarData (Object) – The raw JSON data.
file (Object) – The file object representing this file.