HED API reference

HED models

hed.models

Data structures for HED tag handling.

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

Superclass representing a basic columnar file.

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

Mapping of a base input file columns into HED tags.

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

Column in a ColumnMapper or top-level Sidecar dict.

hed.models.DefinitionDict()

Gathers definitions from a single source.

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

A single definition.

hed.models.DefMapper([def_dicts])

Handles converting Def/ and Def-expand/.

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

A single parenthesized hed string.

hed.models.HedGroupBase([hed_string, ...])

Base class for the HedGroup API.

hed.models.HedGroupFrozen(contents[, hed_string])

A frozen version of the HedGroup.

hed.models.HedOps(*args, **kwargs)

Base class to support HedOps.

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

A HED string.

hed.models.HedStringGroup(hed_string_obj_list)

A container with hed string objects.

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

A single HED tag.

hed.models.OnsetMapper(def_mapper)

HedOps responsible for matching onset/offset pairs.

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

Contents of a JSON file or merged file.

hed.models.SpreadsheetInput([file, ...])

A spreadsheet of HED tags.

hed.models.TabularInput([file, sidecar, ...])

A BIDS tabular tsv file with sidecar.

hed.models.hed_ops

Infrastructure for processing HED operations.

HED schema handling

hed.schema

Data structures for handling the HED schema.

hed.schema.HedSchema()

A HED schema suitable for processing.

hed.schema.HedSchemaEntry(name, section)

A single node in a HedSchema.

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

A single unit class entry in the HedSchema.

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

A single unit entry with modifiers in the HedSchema.

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

A single tag entry in the HedSchema.

hed.schema.HedSchemaGroup(schema_list)

Container for multiple HedSchema objects.

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

Container with entries in one section of the schema.

hed.schema.hed_cache

Infrastructure for caching HED schema.

hed.schema.hed_schema_io

Utilities for loading and outputting HED schema.

hed.schema.schema_compliance

Utilities for HED schema checking.

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[, schema, ...])

A BIDS dataset primarily focused on HED evaluation.

hed.tools.BidsDatasetSummary(dataset)

Summary of a BIDS dataset events and other info.

hed.tools.BidsFile(file_path)

A BIDS file with entity dictionary.

hed.tools.BidsFileDictionary(...[, entities])

A dictionary of BidsFile keyed by entity pairs.

hed.tools.BidsFileGroup(root_path[, suffix, ...])

Container for BIDS files with a specified suffix.

hed.tools.BidsSidecarFile(file_path)

A BIDS sidecar file.

hed.tools.BidsTabularDictionary(...[, entities])

A key tabular-file dictionary for tabular files.

hed.tools.BidsTabularFile(file_path)

A BIDS tabular file including its associated sidecar.

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

Summarize the contents of BIDS tabular files.

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

A file dictionary keyed by entity pair indices.

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

A map of unique column values for remapping columns.

hed.tools.TagSummary(file_group, schema[, ...])

A HED tag summary for a BID file group.

hed.tools.analysis.analysis_util

Utilities for downstream analysis such as searching.

hed.tools.analysis.annotation_util

Utilities to facilitate annotation of events in BIDS.

hed.tools.analysis.summary_util

Utilities used in computing dataset annotation.

hed.tools.HedLogger([name])

Log status messages organized by key.

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 for 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

Utilities to support HED validation.