HED API reference

HED models

hed.models

Data structures for HED tag handling.

hed.models.BaseInput(file[, file_type, ...])

Represents a spreadsheet file.

hed.models.ColumnMapper([sidecars, ...])

Container class for mapping columns in event files into HED tags.

hed.models.ColumnMetadata([column_type, ...])

Represents a single column in a ColumnMapper or Sidecar.

hed.models.DefDict()

Class responsible for gathering and storing a group of definitions to be considered a single source.

hed.models.DefEntry(name, contents, ...)

Represents a single definition tag

hed.models.DefinitionMapper([def_dicts])

Class for handling definitions in hed strings.

hed.models.EventsInput([file, sidecars, ...])

Represents a BIDS tsv file.

hed.models.HedGroup([hed_string, startpos, ...])

Represents a single parenthesized hed string.

hed.models.HedInput([file, file_type, ...])

Represents a spreadsheet of HED tags.

hed.models.HedString(hed_string[, hed_schema])

Represents a hed string.

hed.models.HedTag(hed_string[, span, hed_schema])

Represents a single HED tag.

hed.models.OnsetMapper(def_mapper)

HED operator responsible for matching onset/offset pairs.

hed.models.Sidecar(file[, name])

Contents of a single JSON file with definition dictionaries.

hed.models.hed_ops

Infrastructure for processing lists of HED operations.

HED schema handling

hed.schema

Data structures for handling the HED schema.

hed.schema.HedSchema()

Data structure for a loaded hed schema xml or mediawiki file.

hed.schema.HedSchemaEntry(name, section)

Represents a single node in a HedSchema.

hed.schema.UnitClassEntry(*args, **kwargs)

A single unit class entry in the HedSchema, containing it's units, etc.

hed.schema.UnitEntry(*args, **kwargs)

A single unit entry in the HedSchema, containing its unit modifiers etc.

hed.schema.HedTagEntry(*args, **kwargs)

A single tag entry in the HedSchema, containing its parent tag, unit classes, value classes, etc.

hed.schema.HedSchemaGroup(schema_list)

A container class for multiple HedSchema objects.

hed.schema.HedSchemaSection(section_key[, ...])

A container class holding the HED schema entries in one section of the schema.

hed.schema.hed_cache

Infrastructure for caching HED schema from remote repositories.

hed.schema.hed_schema_io

Utilities for loading and outputting HED schemas.

hed.schema.schema_compliance

Utilities for checking that a HED schema is correct.

hed.schema.schema_validation_util

Utilities used in HED validation using a HED schema.

HED tools

hed.tools

HED tools for analysis and summarization.

hed.tools.BidsDataset(root_path)

Represents the metadata for a BIDS dataset.

hed.tools.BidsDatasetSummary(dataset)

Summarizes a BIDS dataset.

hed.tools.BidsEventFile(file_path)

Represents a BIDS event file including its associated sidecars.

hed.tools.BidsEventFiles(root_path)

Container for the event files and sidecars in a BIDS dataset.

hed.tools.BidsFile(file_path)

Represents the entity and file names for a BIDs file.

hed.tools.BidsJsonFile(file_path[, set_contents])

Represents a BIDS JSON file.

hed.tools.BidsSidecarFile(file_path[, ...])

Represents a BIDS JSON sidecar file.

hed.tools.BidsTsvDictionary(collection_name)

Holds a key-file dictionary, but also reads each tsv file and keeps track of number of rows and column names.

hed.tools.BidsTsvFile(file_path[, set_contents])

Represents a BIDS TSV file, possibly without its contents.

hed.tools.BidsTsvSummary([value_cols, ...])

Summarizes the contents of tsv files.

hed.tools.FileDictionary(collection_name, ...)

Holds a dictionary of path names keyed by specified entity pairs.

hed.tools.HedLogger()

Class to log status messages organized by key

hed.tools.KeyMap(key_cols[, target_cols, name])

Extracts unique column values for remapping columns.

hed.tools.KeyTemplate(columns[, name])

Keeps track of unique key combinations (which could be tuples).

hed.tools.SummaryEntry(name, contents[, ...])

Holds the summary of a group such as a HED definition.

hed.tools.TagSummary(dataset[, breakout_list])

Holds a HED tag summary for a BIDS dataset.

hed.tools.annotation.annotation_util

Utilities to facilitate annotation of events in BIDS.

HED utilities

hed.util

Data and file handling utilities.

hed.util.data_util

Data handling utilities involving dataframes.

hed.util.file_util

Utilities for writing content to files and other file manipulation.

hed.util.io_util

Utilities for generating and handling file names.

HED validators

hed.validator

Validation of HED tags.

hed.validator.HedValidator([hed_schema, ...])

Top level validation of HED strings.

hed.validator.TagValidator([hed_schema, ...])

Validation for individual HED tags.

hed.validator.tag_validator_util

Utitlities to support HED validation.

Modules