HED Python
stable

Contents:

  • Introduction to HED
    • Why HED?
    • Installing hedtools
    • Finding help
  • HED tools user guide

HED Python API:

  • HED API reference
    • errors
      • error_messages
        • SIDECAR_HED_USED()
        • SIDECAR_HED_USED_COLUMN()
        • def_error_bad_location()
        • def_error_bad_prop_in_definition()
        • def_error_def_tag_in_definition()
        • def_error_duplicate_definition()
        • def_error_invalid_def_extension()
        • def_error_no_group_tags()
        • def_error_no_takes_value()
        • def_error_wrong_number_groups()
        • def_error_wrong_number_tags()
        • def_error_wrong_placeholder_count()
        • invalid_column_ref()
        • malformed_column_ref()
        • nested_column_ref()
        • onset_DURATION_HAS_OTHER_TAGS()
        • onset_DURATION_WRONG_NUMBER_GROUPS()
        • onset_error_def_unmatched()
        • onset_error_inset_before_onset()
        • onset_error_offset_before_onset()
        • onset_error_same_defs_one_row()
        • onset_no_def_found()
        • onset_too_many_defs()
        • onset_too_many_groups()
        • onset_wrong_placeholder()
        • onset_wrong_type_tag()
        • self_column_ref()
        • sidecar_error_blank_hed_string()
        • sidecar_error_hed_data_type()
        • sidecar_error_invalid_pound_sign_count()
        • sidecar_error_too_many_pound_signs()
        • sidecar_error_unknown_column()
        • sidecar_na_used()
        • val_error_CURLY_BRACE_UNSUPPORTED_HERE()
        • val_error_ONSETS_OUT_OF_ORDER()
        • val_error_bad_def_expand()
        • val_error_comma_missing()
        • val_error_def_expand_unmatched()
        • val_error_def_expand_value_extra()
        • val_error_def_expand_value_missing()
        • val_error_def_unmatched()
        • val_error_def_value_extra()
        • val_error_def_value_missing()
        • val_error_duplicate_column()
        • val_error_duplicate_column_between_sources()
        • val_error_duplicate_group()
        • val_error_duplicate_tag()
        • val_error_element_deprecatedr()
        • val_error_empty_group()
        • val_error_extra_column()
        • val_error_extra_comma()
        • val_error_extra_slashes_spaces()
        • val_error_hed_blank_column()
        • val_error_hed_onset_with_no_column()
        • val_error_invalid_char()
        • val_error_invalid_extension()
        • val_error_invalid_parent()
        • val_error_invalid_tag_character()
        • val_error_invalid_unit()
        • val_error_missing_column()
        • val_error_multiple_unique()
        • val_error_no_valid_tag()
        • val_error_no_value()
        • val_error_parentheses()
        • val_error_prefix_invalid()
        • val_error_require_child()
        • val_error_sidecar_key_missing()
        • val_error_sidecar_with_column()
        • val_error_tag_extended()
        • val_error_tag_group_tag()
        • val_error_tildes_not_supported()
        • val_error_top_level_tag()
        • val_error_top_level_tags()
        • val_error_unknown_namespace()
        • val_warning_capitalization()
        • val_warning_default_units_used()
        • val_warning_required_prefix_missing()
      • error_reporter
        • check_for_any_errors()
        • create_doc_link()
        • get_printable_issue_string()
        • get_printable_issue_string_html()
        • hed_error()
        • hed_tag_error()
        • replace_tag_references()
        • sort_issues()
        • ErrorHandler
          • ErrorHandler.__init__()
          • ErrorHandler.add_context_and_filter()
          • ErrorHandler.filter_issues_by_severity()
          • ErrorHandler.format_error()
          • ErrorHandler.format_error_from_context()
          • ErrorHandler.format_error_with_context()
          • ErrorHandler.pop_error_context()
          • ErrorHandler.push_error_context()
          • ErrorHandler.reset_error_context()
          • ErrorHandler.val_error_unknown()
      • error_types
        • ColumnErrors
          • ColumnErrors.__init__()
          • ColumnErrors.INVALID_COLUMN_REF
          • ColumnErrors.MALFORMED_COLUMN_REF
          • ColumnErrors.NESTED_COLUMN_REF
          • ColumnErrors.SELF_COLUMN_REF
        • DefinitionErrors
          • DefinitionErrors.__init__()
          • DefinitionErrors.BAD_DEFINITION_LOCATION
          • DefinitionErrors.BAD_PROP_IN_DEFINITION
          • DefinitionErrors.DEF_TAG_IN_DEFINITION
          • DefinitionErrors.DUPLICATE_DEFINITION
          • DefinitionErrors.INVALID_DEFINITION_EXTENSION
          • DefinitionErrors.NO_DEFINITION_CONTENTS
          • DefinitionErrors.PLACEHOLDER_NO_TAKES_VALUE
          • DefinitionErrors.WRONG_NUMBER_GROUPS
          • DefinitionErrors.WRONG_NUMBER_PLACEHOLDER_TAGS
          • DefinitionErrors.WRONG_NUMBER_TAGS
        • ErrorContext
          • ErrorContext.__init__()
          • ErrorContext.COLUMN
          • ErrorContext.CUSTOM_TITLE
          • ErrorContext.FILE_NAME
          • ErrorContext.HED_STRING
          • ErrorContext.LINE
          • ErrorContext.ROW
          • ErrorContext.SCHEMA_ATTRIBUTE
          • ErrorContext.SCHEMA_SECTION
          • ErrorContext.SCHEMA_TAG
          • ErrorContext.SIDECAR_COLUMN_NAME
          • ErrorContext.SIDECAR_KEY_NAME
        • ErrorSeverity
          • ErrorSeverity.__init__()
          • ErrorSeverity.ERROR
          • ErrorSeverity.WARNING
        • SchemaAttributeErrors
          • SchemaAttributeErrors.__init__()
          • SchemaAttributeErrors.SCHEMA_ALLOWED_CHARACTERS_INVALID
          • SchemaAttributeErrors.SCHEMA_ATTRIBUTE_INVALID
          • SchemaAttributeErrors.SCHEMA_ATTRIBUTE_NUMERIC_INVALID
          • SchemaAttributeErrors.SCHEMA_ATTRIBUTE_VALUE_DEPRECATED
          • SchemaAttributeErrors.SCHEMA_ATTRIBUTE_VALUE_INVALID
          • SchemaAttributeErrors.SCHEMA_CHILD_OF_DEPRECATED
          • SchemaAttributeErrors.SCHEMA_CONVERSION_FACTOR_NOT_POSITIVE
          • SchemaAttributeErrors.SCHEMA_DEFAULT_UNITS_DEPRECATED
          • SchemaAttributeErrors.SCHEMA_DEFAULT_UNITS_INVALID
          • SchemaAttributeErrors.SCHEMA_DEPRECATED_INVALID
          • SchemaAttributeErrors.SCHEMA_DEPRECATION_ERROR
          • SchemaAttributeErrors.SCHEMA_GENERIC_ATTRIBUTE_VALUE_INVALID
          • SchemaAttributeErrors.SCHEMA_IN_LIBRARY_INVALID
        • SchemaErrors
          • SchemaErrors.__init__()
          • SchemaErrors.SCHEMA_DUPLICATE_FROM_LIBRARY
          • SchemaErrors.SCHEMA_DUPLICATE_NODE
          • SchemaErrors.SCHEMA_INVALID_CHILD
          • SchemaErrors.SCHEMA_INVALID_SIBLING
        • SchemaWarnings
          • SchemaWarnings.__init__()
          • SchemaWarnings.SCHEMA_CHARACTER_INVALID
          • SchemaWarnings.SCHEMA_INVALID_CAPITALIZATION
          • SchemaWarnings.SCHEMA_INVALID_CHARACTERS_IN_DESC
          • SchemaWarnings.SCHEMA_INVALID_CHARACTERS_IN_TAG
          • SchemaWarnings.SCHEMA_NON_PLACEHOLDER_HAS_CLASS
          • SchemaWarnings.SCHEMA_PRERELEASE_VERSION_USED
          • SchemaWarnings.SCHEMA_PROLOGUE_CHARACTER_INVALID
        • SidecarErrors
          • SidecarErrors.__init__()
          • SidecarErrors.BLANK_HED_STRING
          • SidecarErrors.INVALID_POUND_SIGNS_CATEGORY
          • SidecarErrors.INVALID_POUND_SIGNS_VALUE
          • SidecarErrors.SIDECAR_BRACES_INVALID
          • SidecarErrors.SIDECAR_HED_USED
          • SidecarErrors.SIDECAR_HED_USED_COLUMN
          • SidecarErrors.SIDECAR_NA_USED
          • SidecarErrors.UNKNOWN_COLUMN_TYPE
          • SidecarErrors.WRONG_HED_DATA_TYPE
        • TemporalErrors
          • TemporalErrors.__init__()
          • TemporalErrors.DURATION_HAS_OTHER_TAGS
          • TemporalErrors.DURATION_WRONG_NUMBER_GROUPS
          • TemporalErrors.HED_ONSET_WITH_NO_COLUMN
          • TemporalErrors.INSET_BEFORE_ONSET
          • TemporalErrors.OFFSET_BEFORE_ONSET
          • TemporalErrors.ONSET_DEF_UNMATCHED
          • TemporalErrors.ONSET_NO_DEF_TAG_FOUND
          • TemporalErrors.ONSET_PLACEHOLDER_WRONG
          • TemporalErrors.ONSET_SAME_DEFS_ONE_ROW
          • TemporalErrors.ONSET_TAG_OUTSIDE_OF_GROUP
          • TemporalErrors.ONSET_TOO_MANY_DEFS
          • TemporalErrors.ONSET_WRONG_NUMBER_GROUPS
        • ValidationErrors
          • ValidationErrors.__init__()
          • ValidationErrors.CHARACTER_INVALID
          • ValidationErrors.COMMA_MISSING
          • ValidationErrors.CURLY_BRACE_UNSUPPORTED_HERE
          • ValidationErrors.DEFINITION_INVALID
          • ValidationErrors.DEF_EXPAND_INVALID
          • ValidationErrors.DEF_INVALID
          • ValidationErrors.DUPLICATE_COLUMN_BETWEEN_SOURCES
          • ValidationErrors.DUPLICATE_COLUMN_IN_LIST
          • ValidationErrors.ELEMENT_DEPRECATED
          • ValidationErrors.HED_BLANK_COLUMN
          • ValidationErrors.HED_DEF_EXPAND_INVALID
          • ValidationErrors.HED_DEF_EXPAND_UNMATCHED
          • ValidationErrors.HED_DEF_EXPAND_VALUE_EXTRA
          • ValidationErrors.HED_DEF_EXPAND_VALUE_MISSING
          • ValidationErrors.HED_DEF_UNMATCHED
          • ValidationErrors.HED_DEF_VALUE_EXTRA
          • ValidationErrors.HED_DEF_VALUE_MISSING
          • ValidationErrors.HED_GROUP_EMPTY
          • ValidationErrors.HED_LIBRARY_UNMATCHED
          • ValidationErrors.HED_MISSING_REQUIRED_COLUMN
          • ValidationErrors.HED_MULTIPLE_TOP_TAGS
          • ValidationErrors.HED_TAG_GROUP_TAG
          • ValidationErrors.HED_TAG_REPEATED
          • ValidationErrors.HED_TAG_REPEATED_GROUP
          • ValidationErrors.HED_TOP_LEVEL_TAG
          • ValidationErrors.HED_UNKNOWN_COLUMN
          • ValidationErrors.INVALID_PARENT_NODE
          • ValidationErrors.INVALID_TAG_CHARACTER
          • ValidationErrors.NODE_NAME_EMPTY
          • ValidationErrors.NO_VALID_TAG_FOUND
          • ValidationErrors.ONSETS_OUT_OF_ORDER
          • ValidationErrors.PARENTHESES_MISMATCH
          • ValidationErrors.PLACEHOLDER_INVALID
          • ValidationErrors.REQUIRED_TAG_MISSING
          • ValidationErrors.SIDECAR_AND_OTHER_COLUMNS
          • ValidationErrors.SIDECAR_INVALID
          • ValidationErrors.SIDECAR_KEY_MISSING
          • ValidationErrors.STYLE_WARNING
          • ValidationErrors.TAG_EMPTY
          • ValidationErrors.TAG_EXPRESSION_REPEATED
          • ValidationErrors.TAG_EXTENDED
          • ValidationErrors.TAG_EXTENSION_INVALID
          • ValidationErrors.TAG_GROUP_ERROR
          • ValidationErrors.TAG_INVALID
          • ValidationErrors.TAG_NAMESPACE_PREFIX_INVALID
          • ValidationErrors.TAG_NOT_UNIQUE
          • ValidationErrors.TAG_REQUIRES_CHILD
          • ValidationErrors.TEMPORAL_TAG_ERROR
          • ValidationErrors.TILDES_UNSUPPORTED
          • ValidationErrors.UNITS_INVALID
          • ValidationErrors.UNITS_MISSING
          • ValidationErrors.VALUE_INVALID
          • ValidationErrors.VERSION_DEPRECATED
      • exceptions
        • HedExceptions
          • HedExceptions.__init__()
          • HedExceptions.BAD_COLUMN_NAMES
          • HedExceptions.BAD_HED_LIBRARY_NAME
          • HedExceptions.BAD_PARAMETERS
          • HedExceptions.BAD_WITH_STANDARD
          • HedExceptions.BAD_WITH_STANDARD_MULTIPLE_VALUES
          • HedExceptions.CANNOT_PARSE_JSON
          • HedExceptions.CANNOT_PARSE_RDF
          • HedExceptions.CANNOT_PARSE_XML
          • HedExceptions.FILE_NOT_FOUND
          • HedExceptions.GENERIC_ERROR
          • HedExceptions.HED_SCHEMA_NODE_NAME_INVALID
          • HedExceptions.INVALID_DATAFRAME
          • HedExceptions.INVALID_EXTENSION
          • HedExceptions.INVALID_FILE_FORMAT
          • HedExceptions.INVALID_HED_FORMAT
          • HedExceptions.INVALID_LIBRARY_PREFIX
          • HedExceptions.IN_LIBRARY_IN_UNMERGED
          • HedExceptions.ROOTED_TAG_DOES_NOT_EXIST
          • HedExceptions.ROOTED_TAG_HAS_PARENT
          • HedExceptions.ROOTED_TAG_INVALID
          • HedExceptions.SCHEMA_DUPLICATE_LIBRARY
          • HedExceptions.SCHEMA_DUPLICATE_NAMES
          • HedExceptions.SCHEMA_DUPLICATE_PREFIX
          • HedExceptions.SCHEMA_HEADER_INVALID
          • HedExceptions.SCHEMA_HEADER_MISSING
          • HedExceptions.SCHEMA_LIBRARY_INVALID
          • HedExceptions.SCHEMA_LOAD_FAILED
          • HedExceptions.SCHEMA_SECTION_MISSING
          • HedExceptions.SCHEMA_UNKNOWN_HEADER_ATTRIBUTE
          • HedExceptions.SCHEMA_VERSION_INVALID
          • HedExceptions.URL_ERROR
          • HedExceptions.WIKI_DELIMITERS_INVALID
          • HedExceptions.WIKI_LINE_START_INVALID
          • HedExceptions.WIKI_SEPARATOR_INVALID
        • hed.errors.exceptions.HedFileError
          • HedFileError
      • known_error_codes
      • schema_error_messages
        • schema_error_GENERIC_ATTRIBUTE_VALUE_INVALID()
        • schema_error_SCHEMA_ALLOWED_CHARACTERS_INVALID()
        • schema_error_SCHEMA_ATTRIBUTE_NUMERIC_INVALID()
        • schema_error_SCHEMA_ATTRIBUTE_VALUE_DEPRECATED()
        • schema_error_SCHEMA_CHILD_OF_DEPRECATED()
        • schema_error_SCHEMA_CONVERSION_FACTOR_NOT_POSITIVE()
        • schema_error_SCHEMA_DEFAULT_UNITS_DEPRECATED()
        • schema_error_SCHEMA_DEFAULT_UNITS_INVALID()
        • schema_error_SCHEMA_DEPRECATED_INVALID()
        • schema_error_SCHEMA_INVALID_CHILD()
        • schema_error_SCHEMA_INVALID_SIBLING()
        • schema_error_SCHEMA_IN_LIBRARY_INVALID()
        • schema_error_SCHEMA_PRERELEASE_VERSION_USED()
        • schema_error_hed_duplicate_from_library()
        • schema_error_hed_duplicate_node()
        • schema_error_invalid_character_prologue()
        • schema_error_unknown_attribute()
        • schema_warning_SCHEMA_INVALID_CAPITALIZATION()
        • schema_warning_invalid_chars_desc()
        • schema_warning_invalid_chars_tag()
        • schema_warning_non_placeholder_class()
    • models
      • base_input
        • BaseInput
          • BaseInput.__init__()
          • BaseInput.assemble()
          • BaseInput.column_metadata()
          • BaseInput.combine_dataframe()
          • BaseInput.convert_to_form()
          • BaseInput.convert_to_long()
          • BaseInput.convert_to_short()
          • BaseInput.expand_defs()
          • BaseInput.get_column_refs()
          • BaseInput.get_def_dict()
          • BaseInput.get_worksheet()
          • BaseInput.reset_mapper()
          • BaseInput.set_cell()
          • BaseInput.shrink_defs()
          • BaseInput.to_csv()
          • BaseInput.to_excel()
          • BaseInput.validate()
          • BaseInput.EXCEL_EXTENSION
          • BaseInput.TEXT_EXTENSION
          • BaseInput.columns
          • BaseInput.dataframe
          • BaseInput.dataframe_a
          • BaseInput.has_column_names
          • BaseInput.loaded_workbook
          • BaseInput.name
          • BaseInput.needs_sorting
          • BaseInput.onsets
          • BaseInput.series_a
          • BaseInput.series_filtered
          • BaseInput.worksheet_name
      • basic_search
        • check_parentheses()
        • construct_delimiter_map()
        • find_matching()
        • find_words()
        • reverse_and_flip_parentheses()
        • verify_search_delimiters()
      • column_mapper
        • ColumnMapper
          • ColumnMapper.__init__()
          • ColumnMapper.check_for_blank_names()
          • ColumnMapper.check_for_mapping_issues()
          • ColumnMapper.get_column_mapping_issues()
          • ColumnMapper.get_def_dict()
          • ColumnMapper.get_tag_columns()
          • ColumnMapper.get_transformers()
          • ColumnMapper.set_column_map()
          • ColumnMapper.set_column_prefix_dictionary()
          • ColumnMapper.set_tag_columns()
          • ColumnMapper.column_prefix_dictionary
          • ColumnMapper.sidecar_column_data
          • ColumnMapper.tag_columns
      • column_metadata
        • ColumnMetadata
          • ColumnMetadata.__init__()
          • ColumnMetadata.expected_pound_sign_count()
          • ColumnMetadata.get_hed_strings()
          • ColumnMetadata.set_hed_strings()
          • ColumnMetadata.hed_dict
          • ColumnMetadata.source_dict
        • ColumnType
          • ColumnType.Unknown
          • ColumnType.Ignore
          • ColumnType.Categorical
          • ColumnType.Value
          • ColumnType.HEDTags
      • def_expand_gather
        • AmbiguousDef
          • AmbiguousDef.__init__()
          • AmbiguousDef.add_def()
          • AmbiguousDef.get_group()
          • AmbiguousDef.validate()
        • DefExpandGatherer
          • DefExpandGatherer.__init__()
          • DefExpandGatherer.get_ambiguous_group()
          • DefExpandGatherer.process_def_expands()
      • definition_dict
        • DefinitionDict
          • DefinitionDict.__init__()
          • DefinitionDict.add_definitions()
          • DefinitionDict.check_for_definitions()
          • DefinitionDict.get()
          • DefinitionDict.get_as_strings()
          • DefinitionDict.get_definition_entry()
          • DefinitionDict.items()
          • DefinitionDict.issues
      • definition_entry
        • DefinitionEntry
          • DefinitionEntry.__init__()
          • DefinitionEntry.get_definition()
      • df_util
        • convert_to_form()
        • expand_defs()
        • filter_series_by_onset()
        • process_def_expands()
        • replace_ref()
        • shrink_defs()
        • sort_dataframe_by_onsets()
        • split_delay_tags()
      • hed_group
        • HedGroup
          • HedGroup.__init__()
          • HedGroup.append()
          • HedGroup.casefold()
          • HedGroup.check_if_in_original()
          • HedGroup.copy()
          • HedGroup.find_def_tags()
          • HedGroup.find_exact_tags()
          • HedGroup.find_placeholder_tag()
          • HedGroup.find_tags()
          • HedGroup.find_tags_with_term()
          • HedGroup.find_wildcard_tags()
          • HedGroup.get_all_groups()
          • HedGroup.get_all_tags()
          • HedGroup.get_as_form()
          • HedGroup.get_as_indented()
          • HedGroup.get_as_long()
          • HedGroup.get_as_short()
          • HedGroup.get_first_group()
          • HedGroup.get_original_hed_string()
          • HedGroup.groups()
          • HedGroup.lower()
          • HedGroup.remove()
          • HedGroup.replace()
          • HedGroup.sort()
          • HedGroup.sorted()
          • HedGroup.tags()
          • HedGroup.is_group
          • HedGroup.span
      • hed_string
        • HedString
          • HedString.__init__()
          • HedString.append()
          • HedString.casefold()
          • HedString.check_if_in_original()
          • HedString.copy()
          • HedString.expand_defs()
          • HedString.find_def_tags()
          • HedString.find_exact_tags()
          • HedString.find_placeholder_tag()
          • HedString.find_tags()
          • HedString.find_tags_with_term()
          • HedString.find_top_level_tags()
          • HedString.find_wildcard_tags()
          • HedString.from_hed_strings()
          • HedString.get_all_groups()
          • HedString.get_all_tags()
          • HedString.get_as_form()
          • HedString.get_as_indented()
          • HedString.get_as_long()
          • HedString.get_as_original()
          • HedString.get_as_short()
          • HedString.get_first_group()
          • HedString.get_original_hed_string()
          • HedString.groups()
          • HedString.lower()
          • HedString.remove()
          • HedString.remove_definitions()
          • HedString.remove_refs()
          • HedString.replace()
          • HedString.shrink_defs()
          • HedString.sort()
          • HedString.sorted()
          • HedString.split_hed_string()
          • HedString.split_into_groups()
          • HedString.tags()
          • HedString.validate()
          • HedString.CLOSING_GROUP_CHARACTER
          • HedString.OPENING_GROUP_CHARACTER
          • HedString.is_group
          • HedString.span
      • hed_tag
        • HedTag
          • HedTag.__init__()
          • HedTag.base_tag_has_attribute()
          • HedTag.casefold()
          • HedTag.copy()
          • HedTag.get_stripped_unit_value()
          • HedTag.get_tag_unit_class_units()
          • HedTag.has_attribute()
          • HedTag.is_basic_tag()
          • HedTag.is_column_ref()
          • HedTag.is_placeholder()
          • HedTag.is_takes_value_tag()
          • HedTag.is_unit_class_tag()
          • HedTag.is_value_class_tag()
          • HedTag.lower()
          • HedTag.replace_placeholder()
          • HedTag.tag_exists_in_schema()
          • HedTag.tag_modified()
          • HedTag.value_as_default_unit()
          • HedTag.attributes
          • HedTag.base_tag
          • HedTag.default_unit
          • HedTag.expandable
          • HedTag.expanded
          • HedTag.extension
          • HedTag.long_tag
          • HedTag.org_base_tag
          • HedTag.org_tag
          • HedTag.schema_namespace
          • HedTag.short_base_tag
          • HedTag.short_tag
          • HedTag.tag
          • HedTag.unit_classes
          • HedTag.value_classes
      • model_constants
        • DefTagNames
          • DefTagNames.__init__()
          • DefTagNames.ALL_TIME_KEYS
          • DefTagNames.DEFINITION_KEY
          • DefTagNames.DEF_EXPAND_KEY
          • DefTagNames.DEF_KEY
          • DefTagNames.DELAY_KEY
          • DefTagNames.DURATION_KEY
          • DefTagNames.DURATION_KEYS
          • DefTagNames.INSET_KEY
          • DefTagNames.OFFSET_KEY
          • DefTagNames.ONSET_KEY
          • DefTagNames.TEMPORAL_KEYS
      • query_expressions
        • Expression
          • Expression.__init__()
          • Expression.handle_expr()
        • ExpressionAnd
          • ExpressionAnd.__init__()
          • ExpressionAnd.handle_expr()
          • ExpressionAnd.merge_and_groups()
        • ExpressionDescendantGroup
          • ExpressionDescendantGroup.__init__()
          • ExpressionDescendantGroup.handle_expr()
        • ExpressionExactMatch
          • ExpressionExactMatch.__init__()
          • ExpressionExactMatch.handle_expr()
        • ExpressionNegation
          • ExpressionNegation.__init__()
          • ExpressionNegation.handle_expr()
        • ExpressionOr
          • ExpressionOr.__init__()
          • ExpressionOr.handle_expr()
        • ExpressionWildcardNew
          • ExpressionWildcardNew.__init__()
          • ExpressionWildcardNew.handle_expr()
      • query_handler
        • QueryHandler
          • QueryHandler.__init__()
          • QueryHandler.search()
      • query_service
        • get_query_handlers()
        • search_hed_objs()
      • query_util
        • SearchResult
          • SearchResult.__init__()
          • SearchResult.has_same_tags()
          • SearchResult.merge_and_result()
        • Token
          • Token.__init__()
          • Token.And
          • Token.DescendantGroup
          • Token.DescendantGroupEnd
          • Token.ExactMatch
          • Token.ExactMatchEnd
          • Token.ExactMatchOptional
          • Token.LogicalGroup
          • Token.LogicalGroupEnd
          • Token.LogicalNegation
          • Token.NotInLine
          • Token.Or
          • Token.Tag
          • Token.Wildcard
      • sidecar
        • Sidecar
          • Sidecar.__init__()
          • Sidecar.extract_definitions()
          • Sidecar.get_as_json_string()
          • Sidecar.get_column_refs()
          • Sidecar.get_def_dict()
          • Sidecar.load_sidecar_file()
          • Sidecar.load_sidecar_files()
          • Sidecar.save_as_json()
          • Sidecar.validate()
          • Sidecar.all_hed_columns
          • Sidecar.column_data
          • Sidecar.def_dict
      • spreadsheet_input
        • SpreadsheetInput
          • SpreadsheetInput.__init__()
          • SpreadsheetInput.assemble()
          • SpreadsheetInput.column_metadata()
          • SpreadsheetInput.combine_dataframe()
          • SpreadsheetInput.convert_to_form()
          • SpreadsheetInput.convert_to_long()
          • SpreadsheetInput.convert_to_short()
          • SpreadsheetInput.expand_defs()
          • SpreadsheetInput.get_column_refs()
          • SpreadsheetInput.get_def_dict()
          • SpreadsheetInput.get_worksheet()
          • SpreadsheetInput.reset_mapper()
          • SpreadsheetInput.set_cell()
          • SpreadsheetInput.shrink_defs()
          • SpreadsheetInput.to_csv()
          • SpreadsheetInput.to_excel()
          • SpreadsheetInput.validate()
          • SpreadsheetInput.EXCEL_EXTENSION
          • SpreadsheetInput.TEXT_EXTENSION
          • SpreadsheetInput.columns
          • SpreadsheetInput.dataframe
          • SpreadsheetInput.dataframe_a
          • SpreadsheetInput.has_column_names
          • SpreadsheetInput.loaded_workbook
          • SpreadsheetInput.name
          • SpreadsheetInput.needs_sorting
          • SpreadsheetInput.onsets
          • SpreadsheetInput.series_a
          • SpreadsheetInput.series_filtered
          • SpreadsheetInput.worksheet_name
      • string_util
        • gather_descriptions()
        • split_base_tags()
        • split_def_tags()
      • tabular_input
        • TabularInput
          • TabularInput.__init__()
          • TabularInput.assemble()
          • TabularInput.column_metadata()
          • TabularInput.combine_dataframe()
          • TabularInput.convert_to_form()
          • TabularInput.convert_to_long()
          • TabularInput.convert_to_short()
          • TabularInput.expand_defs()
          • TabularInput.get_column_refs()
          • TabularInput.get_def_dict()
          • TabularInput.get_sidecar()
          • TabularInput.get_worksheet()
          • TabularInput.reset_column_mapper()
          • TabularInput.reset_mapper()
          • TabularInput.set_cell()
          • TabularInput.shrink_defs()
          • TabularInput.to_csv()
          • TabularInput.to_excel()
          • TabularInput.validate()
          • TabularInput.EXCEL_EXTENSION
          • TabularInput.HED_COLUMN_NAME
          • TabularInput.TEXT_EXTENSION
          • TabularInput.columns
          • TabularInput.dataframe
          • TabularInput.dataframe_a
          • TabularInput.has_column_names
          • TabularInput.loaded_workbook
          • TabularInput.name
          • TabularInput.needs_sorting
          • TabularInput.onsets
          • TabularInput.series_a
          • TabularInput.series_filtered
          • TabularInput.worksheet_name
      • timeseries_input
        • TimeseriesInput
          • TimeseriesInput.__init__()
          • TimeseriesInput.assemble()
          • TimeseriesInput.column_metadata()
          • TimeseriesInput.combine_dataframe()
          • TimeseriesInput.convert_to_form()
          • TimeseriesInput.convert_to_long()
          • TimeseriesInput.convert_to_short()
          • TimeseriesInput.expand_defs()
          • TimeseriesInput.get_column_refs()
          • TimeseriesInput.get_def_dict()
          • TimeseriesInput.get_worksheet()
          • TimeseriesInput.reset_mapper()
          • TimeseriesInput.set_cell()
          • TimeseriesInput.shrink_defs()
          • TimeseriesInput.to_csv()
          • TimeseriesInput.to_excel()
          • TimeseriesInput.validate()
          • TimeseriesInput.EXCEL_EXTENSION
          • TimeseriesInput.HED_COLUMN_NAME
          • TimeseriesInput.TEXT_EXTENSION
          • TimeseriesInput.columns
          • TimeseriesInput.dataframe
          • TimeseriesInput.dataframe_a
          • TimeseriesInput.has_column_names
          • TimeseriesInput.loaded_workbook
          • TimeseriesInput.name
          • TimeseriesInput.needs_sorting
          • TimeseriesInput.onsets
          • TimeseriesInput.series_a
          • TimeseriesInput.series_filtered
          • TimeseriesInput.worksheet_name
    • schema
      • hed_cache
        • cache_local_versions()
        • cache_xml_versions()
        • get_cache_directory()
        • get_hed_version_path()
        • get_hed_versions()
        • set_cache_directory()
      • hed_schema
        • HedSchema
          • HedSchema.__init__()
          • HedSchema.can_save()
          • HedSchema.check_compliance()
          • HedSchema.finalize_dictionaries()
          • HedSchema.find_tag_entry()
          • HedSchema.get_as_dataframes()
          • HedSchema.get_as_mediawiki_string()
          • HedSchema.get_as_xml_string()
          • HedSchema.get_formatted_version()
          • HedSchema.get_save_header_attributes()
          • HedSchema.get_schema_versions()
          • HedSchema.get_tag_attribute_names_old()
          • HedSchema.get_tag_entry()
          • HedSchema.get_tags_with_attribute()
          • HedSchema.has_duplicates()
          • HedSchema.save_as_dataframes()
          • HedSchema.save_as_mediawiki()
          • HedSchema.save_as_xml()
          • HedSchema.schema_for_namespace()
          • HedSchema.set_schema_prefix()
          • HedSchema.attributes
          • HedSchema.library
          • HedSchema.merged
          • HedSchema.name
          • HedSchema.properties
          • HedSchema.schema_83_props
          • HedSchema.schema_namespace
          • HedSchema.tags
          • HedSchema.unit_classes
          • HedSchema.unit_modifiers
          • HedSchema.units
          • HedSchema.valid_prefixes
          • HedSchema.value_classes
          • HedSchema.version
          • HedSchema.version_number
          • HedSchema.with_standard
      • hed_schema_base
        • HedSchemaBase
          • HedSchemaBase.__init__()
          • HedSchemaBase.check_compliance()
          • HedSchemaBase.find_tag_entry()
          • HedSchemaBase.get_formatted_version()
          • HedSchemaBase.get_schema_versions()
          • HedSchemaBase.get_tag_entry()
          • HedSchemaBase.get_tags_with_attribute()
          • HedSchemaBase.schema_for_namespace()
          • HedSchemaBase.name
          • HedSchemaBase.schema_83_props
          • HedSchemaBase.valid_prefixes
      • hed_schema_constants
        • HedKey
          • HedKey.__init__()
          • HedKey.AllowedCharacter
          • HedKey.AnnotationProperty
          • HedKey.BoolRange
          • HedKey.ConversionFactor
          • HedKey.DefaultUnits
          • HedKey.DeprecatedFrom
          • HedKey.ElementDomain
          • HedKey.ExtensionAllowed
          • HedKey.HedID
          • HedKey.InLibrary
          • HedKey.NumericRange
          • HedKey.Recommended
          • HedKey.RelatedTag
          • HedKey.RequireChild
          • HedKey.Required
          • HedKey.Reserved
          • HedKey.Rooted
          • HedKey.SIUnit
          • HedKey.SIUnitModifier
          • HedKey.SIUnitSymbolModifier
          • HedKey.StringRange
          • HedKey.SuggestedTag
          • HedKey.TagDomain
          • HedKey.TagGroup
          • HedKey.TagRange
          • HedKey.TakesValue
          • HedKey.TopLevelTagGroup
          • HedKey.Unique
          • HedKey.UnitClass
          • HedKey.UnitClassDomain
          • HedKey.UnitClassRange
          • HedKey.UnitDomain
          • HedKey.UnitModifierDomain
          • HedKey.UnitPrefix
          • HedKey.UnitRange
          • HedKey.UnitSymbol
          • HedKey.ValueClass
          • HedKey.ValueClassDomain
          • HedKey.ValueClassRange
        • HedKeyOld
          • HedKeyOld.__init__()
          • HedKeyOld.BoolProperty
          • HedKeyOld.ElementProperty
          • HedKeyOld.IsInheritedProperty
          • HedKeyOld.NodeProperty
          • HedKeyOld.UnitClassProperty
          • HedKeyOld.UnitModifierProperty
          • HedKeyOld.UnitProperty
          • HedKeyOld.ValueClassProperty
        • HedSectionKey
          • HedSectionKey.Tags
          • HedSectionKey.UnitClasses
          • HedSectionKey.Units
          • HedSectionKey.UnitModifiers
          • HedSectionKey.ValueClasses
          • HedSectionKey.Attributes
          • HedSectionKey.Properties
      • hed_schema_df_constants
      • hed_schema_entry
        • HedSchemaEntry
          • HedSchemaEntry.__init__()
          • HedSchemaEntry.attribute_has_property()
          • HedSchemaEntry.finalize_entry()
          • HedSchemaEntry.has_attribute()
          • HedSchemaEntry.section_key
        • HedTagEntry
          • HedTagEntry.__init__()
          • HedTagEntry.attribute_has_property()
          • HedTagEntry.base_tag_has_attribute()
          • HedTagEntry.finalize_entry()
          • HedTagEntry.has_attribute()
          • HedTagEntry.parent
          • HedTagEntry.parent_name
          • HedTagEntry.section_key
        • UnitClassEntry
          • UnitClassEntry.__init__()
          • UnitClassEntry.add_unit()
          • UnitClassEntry.attribute_has_property()
          • UnitClassEntry.finalize_entry()
          • UnitClassEntry.get_derivative_unit_entry()
          • UnitClassEntry.has_attribute()
          • UnitClassEntry.children
          • UnitClassEntry.section_key
        • UnitEntry
          • UnitEntry.__init__()
          • UnitEntry.attribute_has_property()
          • UnitEntry.finalize_entry()
          • UnitEntry.get_conversion_factor()
          • UnitEntry.has_attribute()
          • UnitEntry.section_key
      • hed_schema_group
        • HedSchemaGroup
          • HedSchemaGroup.__init__()
          • HedSchemaGroup.check_compliance()
          • HedSchemaGroup.find_tag_entry()
          • HedSchemaGroup.get_formatted_version()
          • HedSchemaGroup.get_schema_versions()
          • HedSchemaGroup.get_tag_entry()
          • HedSchemaGroup.get_tags_with_attribute()
          • HedSchemaGroup.schema_for_namespace()
          • HedSchemaGroup.name
          • HedSchemaGroup.schema_83_props
          • HedSchemaGroup.valid_prefixes
      • hed_schema_io
        • from_dataframes()
        • from_string()
        • get_hed_xml_version()
        • load_schema()
        • load_schema_version()
        • parse_version_list()
      • hed_schema_section
        • HedSchemaSection
          • HedSchemaSection.__init__()
          • HedSchemaSection.get()
          • HedSchemaSection.get_entries_with_attribute()
          • HedSchemaSection.items()
          • HedSchemaSection.keys()
          • HedSchemaSection.values()
          • HedSchemaSection.duplicate_names
          • HedSchemaSection.section_key
        • HedSchemaTagSection
          • HedSchemaTagSection.__init__()
          • HedSchemaTagSection.get()
          • HedSchemaTagSection.get_entries_with_attribute()
          • HedSchemaTagSection.items()
          • HedSchemaTagSection.keys()
          • HedSchemaTagSection.values()
          • HedSchemaTagSection.duplicate_names
          • HedSchemaTagSection.section_key
        • HedSchemaUnitClassSection
          • HedSchemaUnitClassSection.__init__()
          • HedSchemaUnitClassSection.get()
          • HedSchemaUnitClassSection.get_entries_with_attribute()
          • HedSchemaUnitClassSection.items()
          • HedSchemaUnitClassSection.keys()
          • HedSchemaUnitClassSection.values()
          • HedSchemaUnitClassSection.duplicate_names
          • HedSchemaUnitClassSection.section_key
        • HedSchemaUnitSection
          • HedSchemaUnitSection.__init__()
          • HedSchemaUnitSection.get()
          • HedSchemaUnitSection.get_entries_with_attribute()
          • HedSchemaUnitSection.items()
          • HedSchemaUnitSection.keys()
          • HedSchemaUnitSection.values()
          • HedSchemaUnitSection.duplicate_names
          • HedSchemaUnitSection.section_key
      • schema_attribute_validators
        • allowed_characters_check()
        • attribute_is_deprecated()
        • conversion_factor()
        • in_library_check()
        • is_numeric_value()
        • item_exists_check()
        • tag_exists_base_schema_check()
        • tag_is_deprecated_check()
        • tag_is_placeholder_check()
        • unit_exists()
      • schema_compare
        • compare_differences()
        • compare_schemas()
        • find_matching_tags()
        • gather_schema_changes()
        • pretty_print_change_dict()
      • schema_compliance
        • check_compliance()
        • SchemaValidator
          • SchemaValidator.__init__()
          • SchemaValidator.check_attributes()
          • SchemaValidator.check_duplicate_names()
          • SchemaValidator.check_if_prerelease_version()
          • SchemaValidator.check_invalid_chars()
          • SchemaValidator.check_prologue_epilogue()
          • SchemaValidator.attribute_validators
          • SchemaValidator.attribute_validators_old
      • schema_header_util
        • validate_attributes()
        • validate_library_name()
        • validate_present_attributes()
        • validate_version_string()
      • schema_io
        • base2schema
          • SchemaLoader
            • SchemaLoader.__init__()
            • SchemaLoader.find_rooted_entry()
            • SchemaLoader.load()
            • SchemaLoader.schema
        • df2schema
          • load_dataframes()
          • load_dataframes_from_strings()
          • SchemaLoaderDF
            • SchemaLoaderDF.__init__()
            • SchemaLoaderDF.convert_filenames_to_dict()
            • SchemaLoaderDF.find_rooted_entry()
            • SchemaLoaderDF.load()
            • SchemaLoaderDF.load_spreadsheet()
            • SchemaLoaderDF.schema
        • ontology_util
          • assign_hed_ids_section()
          • convert_df_to_omn()
          • create_empty_dataframes()
          • get_all_ids()
          • get_attributes_from_row()
          • get_library_name_and_id()
          • merge_dfs()
          • remove_prefix()
          • save_dataframes()
          • update_dataframes_from_schema()
        • schema2base
          • Schema2Base
            • Schema2Base.__init__()
            • Schema2Base.process_schema()
        • schema2df
          • Schema2DF
            • Schema2DF.__init__()
            • Schema2DF.process_schema()
        • schema2wiki
          • Schema2Wiki
            • Schema2Wiki.__init__()
            • Schema2Wiki.process_schema()
        • schema2xml
          • Schema2XML
            • Schema2XML.__init__()
            • Schema2XML.process_schema()
        • schema_util
          • format_error()
          • get_api_key()
          • make_url_request()
          • schema_version_greater_equal()
          • url_to_file()
          • url_to_string()
          • xml_element_2_str()
        • text2schema
          • SchemaLoaderText
            • SchemaLoaderText.__init__()
            • SchemaLoaderText.find_rooted_entry()
            • SchemaLoaderText.load()
            • SchemaLoaderText.schema
        • text_util
          • parse_attribute_string()
        • wiki2schema
          • SchemaLoaderWiki
            • SchemaLoaderWiki.__init__()
            • SchemaLoaderWiki.find_rooted_entry()
            • SchemaLoaderWiki.load()
            • SchemaLoaderWiki.schema
        • wiki_constants
          • HedWikiSection
            • HedWikiSection.__init__()
            • HedWikiSection.Attributes
            • HedWikiSection.EndHed
            • HedWikiSection.EndSchema
            • HedWikiSection.Epilogue
            • HedWikiSection.HeaderLine
            • HedWikiSection.Prologue
            • HedWikiSection.Properties
            • HedWikiSection.Schema
            • HedWikiSection.UnitModifiers
            • HedWikiSection.UnitsClasses
            • HedWikiSection.ValueClasses
        • xml2schema
          • SchemaLoaderXML
            • SchemaLoaderXML.__init__()
            • SchemaLoaderXML.find_rooted_entry()
            • SchemaLoaderXML.load()
            • SchemaLoaderXML.schema
        • xml_constants
      • schema_validation_util
        • get_allowed_characters()
        • get_allowed_characters_by_name()
        • get_problem_indexes()
        • schema_version_for_library()
        • validate_schema_description_new()
        • validate_schema_tag_new()
        • validate_schema_term_new()
      • schema_validation_util_deprecated
        • validate_schema_description()
        • validate_schema_tag()
        • verify_no_brackets()
    • tools
      • analysis
        • annotation_util
          • check_df_columns()
          • df_to_hed()
          • extract_tags()
          • generate_sidecar_entry()
          • get_bids_dataset()
          • hed_to_df()
          • merge_hed_dict()
          • series_to_factor()
          • str_to_tabular()
          • strs_to_hed_objs()
          • strs_to_sidecar()
          • to_factor()
          • to_strlist()
        • column_name_summary
          • ColumnNameSummary
            • ColumnNameSummary.__init__()
            • ColumnNameSummary.get_summary()
            • ColumnNameSummary.update()
            • ColumnNameSummary.update_headers()
        • event_manager
          • EventManager
            • EventManager.__init__()
            • EventManager.compress_strings()
            • EventManager.get_type_defs()
            • EventManager.str_list_to_hed()
            • EventManager.unfold_context()
        • file_dictionary
          • FileDictionary
            • FileDictionary.__init__()
            • FileDictionary.create_file_dict()
            • FileDictionary.get_file_path()
            • FileDictionary.iter_files()
            • FileDictionary.key_diffs()
            • FileDictionary.make_file_dict()
            • FileDictionary.make_key()
            • FileDictionary.output_files()
            • FileDictionary.file_dict
            • FileDictionary.file_list
            • FileDictionary.key_list
            • FileDictionary.name
        • hed_tag_counts
          • HedTagCount
            • HedTagCount.__init__()
            • HedTagCount.get_empty()
            • HedTagCount.get_info()
            • HedTagCount.get_summary()
            • HedTagCount.set_value()
          • HedTagCounts
            • HedTagCounts.__init__()
            • HedTagCounts.create_template()
            • HedTagCounts.get_summary()
            • HedTagCounts.merge_tag_dicts()
            • HedTagCounts.organize_tags()
            • HedTagCounts.update_event_counts()
        • hed_tag_manager
          • HedTagManager
            • HedTagManager.__init__()
            • HedTagManager.get_hed_obj()
            • HedTagManager.get_hed_objs()
        • hed_type
          • HedType
            • HedType.__init__()
            • HedType.get_summary()
            • HedType.get_type_def_names()
            • HedType.get_type_factors()
            • HedType.get_type_list()
            • HedType.get_type_value_factors()
            • HedType.get_type_value_level_info()
            • HedType.get_type_value_names()
            • HedType.total_events
            • HedType.type_variables
        • hed_type_counts
          • HedTypeCount
            • HedTypeCount.__init__()
            • HedTypeCount.get_summary()
            • HedTypeCount.to_dict()
            • HedTypeCount.update()
          • HedTypeCounts
            • HedTypeCounts.__init__()
            • HedTypeCounts.add_descriptions()
            • HedTypeCounts.get_summary()
            • HedTypeCounts.update()
            • HedTypeCounts.update_summary()
        • hed_type_defs
          • HedTypeDefs
            • HedTypeDefs.__init__()
            • HedTypeDefs.extract_def_names()
            • HedTypeDefs.get_type_values()
            • HedTypeDefs.split_name()
            • HedTypeDefs.type_def_names
            • HedTypeDefs.type_names
        • hed_type_factors
          • HedTypeFactors
            • HedTypeFactors.__init__()
            • HedTypeFactors.get_factors()
            • HedTypeFactors.get_summary()
            • HedTypeFactors.ALLOWED_ENCODINGS
        • hed_type_manager
          • HedTypeManager
            • HedTypeManager.__init__()
            • HedTypeManager.add_type()
            • HedTypeManager.get_factor_vectors()
            • HedTypeManager.get_type()
            • HedTypeManager.get_type_def_names()
            • HedTypeManager.get_type_tag_factor()
            • HedTypeManager.summarize_all()
            • HedTypeManager.types
        • key_map
          • KeyMap
            • KeyMap.__init__()
            • KeyMap.make_template()
            • KeyMap.remap()
            • KeyMap.remove_quotes()
            • KeyMap.resort()
            • KeyMap.update()
            • KeyMap.columns
        • sequence_map
          • SequenceMap
            • SequenceMap.__init__()
            • SequenceMap.dot_str()
            • SequenceMap.edge_to_str()
            • SequenceMap.filter_edges()
            • SequenceMap.get_edge_list()
            • SequenceMap.prep()
            • SequenceMap.update()
        • tabular_summary
          • TabularSummary
            • TabularSummary.__init__()
            • TabularSummary.extract_sidecar_template()
            • TabularSummary.extract_summary()
            • TabularSummary.get_columns_info()
            • TabularSummary.get_number_unique()
            • TabularSummary.get_summary()
            • TabularSummary.make_combined_dicts()
            • TabularSummary.update()
            • TabularSummary.update_summary()
        • temporal_event
          • TemporalEvent
            • TemporalEvent.__init__()
            • TemporalEvent.set_end()
      • bids
        • bids_dataset
          • BidsDataset
            • BidsDataset.__init__()
            • BidsDataset.get_summary()
            • BidsDataset.get_tabular_group()
            • BidsDataset.validate()
        • bids_file
          • BidsFile
            • BidsFile.__init__()
            • BidsFile.clear_contents()
            • BidsFile.get_entity()
            • BidsFile.get_key()
            • BidsFile.set_contents()
            • BidsFile.contents
        • bids_file_dictionary
          • BidsFileDictionary
            • BidsFileDictionary.__init__()
            • BidsFileDictionary.create_file_dict()
            • BidsFileDictionary.get_file_path()
            • BidsFileDictionary.get_new_dict()
            • BidsFileDictionary.iter_files()
            • BidsFileDictionary.key_diffs()
            • BidsFileDictionary.make_dict()
            • BidsFileDictionary.make_file_dict()
            • BidsFileDictionary.make_key()
            • BidsFileDictionary.make_query()
            • BidsFileDictionary.match_query()
            • BidsFileDictionary.output_files()
            • BidsFileDictionary.split_by_entity()
            • BidsFileDictionary.file_dict
            • BidsFileDictionary.file_list
            • BidsFileDictionary.key_list
            • BidsFileDictionary.name
        • bids_file_group
          • BidsFileGroup
            • BidsFileGroup.__init__()
            • BidsFileGroup.get_sidecars_from_path()
            • BidsFileGroup.summarize()
            • BidsFileGroup.validate_datafiles()
            • BidsFileGroup.validate_sidecars()
        • bids_sidecar_file
          • BidsSidecarFile
            • BidsSidecarFile.__init__()
            • BidsSidecarFile.clear_contents()
            • BidsSidecarFile.get_entity()
            • BidsSidecarFile.get_key()
            • BidsSidecarFile.is_hed()
            • BidsSidecarFile.is_sidecar_for()
            • BidsSidecarFile.set_contents()
            • BidsSidecarFile.contents
        • bids_tabular_dictionary
          • BidsTabularDictionary
            • BidsTabularDictionary.__init__()
            • BidsTabularDictionary.count_diffs()
            • BidsTabularDictionary.create_file_dict()
            • BidsTabularDictionary.get_file_path()
            • BidsTabularDictionary.get_info()
            • BidsTabularDictionary.get_new_dict()
            • BidsTabularDictionary.iter_files()
            • BidsTabularDictionary.key_diffs()
            • BidsTabularDictionary.make_dict()
            • BidsTabularDictionary.make_file_dict()
            • BidsTabularDictionary.make_key()
            • BidsTabularDictionary.make_new()
            • BidsTabularDictionary.make_query()
            • BidsTabularDictionary.match_query()
            • BidsTabularDictionary.output_files()
            • BidsTabularDictionary.report_diffs()
            • BidsTabularDictionary.set_tsv_info()
            • BidsTabularDictionary.split_by_entity()
            • BidsTabularDictionary.file_dict
            • BidsTabularDictionary.file_list
            • BidsTabularDictionary.key_list
            • BidsTabularDictionary.name
        • bids_tabular_file
          • BidsTabularFile
            • BidsTabularFile.__init__()
            • BidsTabularFile.clear_contents()
            • BidsTabularFile.get_entity()
            • BidsTabularFile.get_key()
            • BidsTabularFile.set_contents()
            • BidsTabularFile.contents
      • remodeling
        • backup_manager
          • BackupManager
            • BackupManager.__init__()
            • BackupManager.create_backup()
            • BackupManager.get_backup()
            • BackupManager.get_backup_files()
            • BackupManager.get_backup_path()
            • BackupManager.get_file_key()
            • BackupManager.get_task()
            • BackupManager.restore_backup()
            • BackupManager.BACKUP_DICTIONARY
            • BackupManager.BACKUP_ROOT
            • BackupManager.DEFAULT_BACKUP_NAME
            • BackupManager.RELATIVE_BACKUP_LOCATION
        • cli
          • run_remodel
            • get_parser()
            • handle_backup()
            • main()
            • parse_arguments()
            • parse_tasks()
            • run_bids_ops()
            • run_direct_ops()
          • run_remodel_backup
            • get_parser()
            • main()
          • run_remodel_restore
            • get_parser()
            • main()
        • dispatcher
          • Dispatcher
            • Dispatcher.__init__()
            • Dispatcher.errors_to_str()
            • Dispatcher.get_data_file()
            • Dispatcher.get_schema()
            • Dispatcher.get_summaries()
            • Dispatcher.get_summary_save_dir()
            • Dispatcher.parse_operations()
            • Dispatcher.post_proc_data()
            • Dispatcher.prep_data()
            • Dispatcher.run_operations()
            • Dispatcher.save_summaries()
            • Dispatcher.REMODELING_SUMMARY_PATH
        • operations
          • base_op
            • BaseOp
              • BaseOp.__init__()
              • BaseOp.do_op()
              • BaseOp.validate_input_data()
              • BaseOp.NAME
              • BaseOp.PARAMS
          • base_summary
            • BaseSummary
              • BaseSummary.__init__()
              • BaseSummary.dump_summary()
              • BaseSummary.get_details_dict()
              • BaseSummary.get_individual()
              • BaseSummary.get_summary()
              • BaseSummary.get_summary_details()
              • BaseSummary.get_text_summary()
              • BaseSummary.get_text_summary_details()
              • BaseSummary.merge_all_info()
              • BaseSummary.save()
              • BaseSummary.save_visualizations()
              • BaseSummary.update_summary()
              • BaseSummary.DISPLAY_INDENT
              • BaseSummary.INDIVIDUAL_SUMMARIES_PATH
          • convert_columns_op
            • ConvertColumnsOp
              • ConvertColumnsOp.__init__()
              • ConvertColumnsOp.do_op()
              • ConvertColumnsOp.validate_input_data()
              • ConvertColumnsOp.NAME
              • ConvertColumnsOp.PARAMS
          • factor_column_op
            • FactorColumnOp
              • FactorColumnOp.__init__()
              • FactorColumnOp.do_op()
              • FactorColumnOp.validate_input_data()
              • FactorColumnOp.NAME
              • FactorColumnOp.PARAMS
          • factor_hed_tags_op
            • FactorHedTagsOp
              • FactorHedTagsOp.__init__()
              • FactorHedTagsOp.do_op()
              • FactorHedTagsOp.validate_input_data()
              • FactorHedTagsOp.NAME
              • FactorHedTagsOp.PARAMS
          • factor_hed_type_op
            • FactorHedTypeOp
              • FactorHedTypeOp.__init__()
              • FactorHedTypeOp.do_op()
              • FactorHedTypeOp.validate_input_data()
              • FactorHedTypeOp.NAME
              • FactorHedTypeOp.PARAMS
          • merge_consecutive_op
            • MergeConsecutiveOp
              • MergeConsecutiveOp.__init__()
              • MergeConsecutiveOp.do_op()
              • MergeConsecutiveOp.validate_input_data()
              • MergeConsecutiveOp.NAME
              • MergeConsecutiveOp.PARAMS
          • number_groups_op
            • NumberGroupsOp
              • NumberGroupsOp.__init__()
              • NumberGroupsOp.do_op()
              • NumberGroupsOp.validate_input_data()
              • NumberGroupsOp.NAME
              • NumberGroupsOp.PARAMS
          • number_rows_op
            • NumberRowsOp
              • NumberRowsOp.__init__()
              • NumberRowsOp.do_op()
              • NumberRowsOp.validate_input_data()
              • NumberRowsOp.NAME
              • NumberRowsOp.PARAMS
          • remap_columns_op
            • RemapColumnsOp
              • RemapColumnsOp.__init__()
              • RemapColumnsOp.do_op()
              • RemapColumnsOp.validate_input_data()
              • RemapColumnsOp.NAME
              • RemapColumnsOp.PARAMS
          • remove_columns_op
            • RemoveColumnsOp
              • RemoveColumnsOp.__init__()
              • RemoveColumnsOp.do_op()
              • RemoveColumnsOp.validate_input_data()
              • RemoveColumnsOp.NAME
              • RemoveColumnsOp.PARAMS
          • remove_rows_op
            • RemoveRowsOp
              • RemoveRowsOp.__init__()
              • RemoveRowsOp.do_op()
              • RemoveRowsOp.validate_input_data()
              • RemoveRowsOp.NAME
              • RemoveRowsOp.PARAMS
          • rename_columns_op
            • RenameColumnsOp
              • RenameColumnsOp.__init__()
              • RenameColumnsOp.do_op()
              • RenameColumnsOp.validate_input_data()
              • RenameColumnsOp.NAME
              • RenameColumnsOp.PARAMS
          • reorder_columns_op
            • ReorderColumnsOp
              • ReorderColumnsOp.__init__()
              • ReorderColumnsOp.do_op()
              • ReorderColumnsOp.validate_input_data()
              • ReorderColumnsOp.NAME
              • ReorderColumnsOp.PARAMS
          • split_rows_op
            • SplitRowsOp
              • SplitRowsOp.__init__()
              • SplitRowsOp.do_op()
              • SplitRowsOp.validate_input_data()
              • SplitRowsOp.NAME
              • SplitRowsOp.PARAMS
          • summarize_column_names_op
            • ColumnNamesSummary
              • ColumnNamesSummary.__init__()
              • ColumnNamesSummary.dump_summary()
              • ColumnNamesSummary.get_details_dict()
              • ColumnNamesSummary.get_individual()
              • ColumnNamesSummary.get_summary()
              • ColumnNamesSummary.get_summary_details()
              • ColumnNamesSummary.get_text_summary()
              • ColumnNamesSummary.get_text_summary_details()
              • ColumnNamesSummary.merge_all_info()
              • ColumnNamesSummary.save()
              • ColumnNamesSummary.save_visualizations()
              • ColumnNamesSummary.update_summary()
              • ColumnNamesSummary.DISPLAY_INDENT
              • ColumnNamesSummary.INDIVIDUAL_SUMMARIES_PATH
            • SummarizeColumnNamesOp
              • SummarizeColumnNamesOp.__init__()
              • SummarizeColumnNamesOp.do_op()
              • SummarizeColumnNamesOp.validate_input_data()
              • SummarizeColumnNamesOp.NAME
              • SummarizeColumnNamesOp.PARAMS
              • SummarizeColumnNamesOp.SUMMARY_TYPE
          • summarize_column_values_op
            • ColumnValueSummary
              • ColumnValueSummary.__init__()
              • ColumnValueSummary.dump_summary()
              • ColumnValueSummary.get_details_dict()
              • ColumnValueSummary.get_individual()
              • ColumnValueSummary.get_list_str()
              • ColumnValueSummary.get_summary()
              • ColumnValueSummary.get_summary_details()
              • ColumnValueSummary.get_text_summary()
              • ColumnValueSummary.get_text_summary_details()
              • ColumnValueSummary.merge_all_info()
              • ColumnValueSummary.partition_list()
              • ColumnValueSummary.save()
              • ColumnValueSummary.save_visualizations()
              • ColumnValueSummary.sort_dict()
              • ColumnValueSummary.update_summary()
              • ColumnValueSummary.DISPLAY_INDENT
              • ColumnValueSummary.INDIVIDUAL_SUMMARIES_PATH
            • SummarizeColumnValuesOp
              • SummarizeColumnValuesOp.__init__()
              • SummarizeColumnValuesOp.do_op()
              • SummarizeColumnValuesOp.validate_input_data()
              • SummarizeColumnValuesOp.MAX_CATEGORICAL
              • SummarizeColumnValuesOp.NAME
              • SummarizeColumnValuesOp.PARAMS
              • SummarizeColumnValuesOp.SUMMARY_TYPE
              • SummarizeColumnValuesOp.VALUES_PER_LINE
          • summarize_definitions_op
            • DefinitionSummary
              • DefinitionSummary.__init__()
              • DefinitionSummary.dump_summary()
              • DefinitionSummary.get_details_dict()
              • DefinitionSummary.get_individual()
              • DefinitionSummary.get_summary()
              • DefinitionSummary.get_summary_details()
              • DefinitionSummary.get_text_summary()
              • DefinitionSummary.get_text_summary_details()
              • DefinitionSummary.merge_all_info()
              • DefinitionSummary.save()
              • DefinitionSummary.save_visualizations()
              • DefinitionSummary.update_summary()
              • DefinitionSummary.DISPLAY_INDENT
              • DefinitionSummary.INDIVIDUAL_SUMMARIES_PATH
            • SummarizeDefinitionsOp
              • SummarizeDefinitionsOp.__init__()
              • SummarizeDefinitionsOp.do_op()
              • SummarizeDefinitionsOp.validate_input_data()
              • SummarizeDefinitionsOp.NAME
              • SummarizeDefinitionsOp.PARAMS
              • SummarizeDefinitionsOp.SUMMARY_TYPE
          • summarize_hed_tags_op
            • HedTagSummary
              • HedTagSummary.__init__()
              • HedTagSummary.dump_summary()
              • HedTagSummary.get_details_dict()
              • HedTagSummary.get_individual()
              • HedTagSummary.get_summary()
              • HedTagSummary.get_summary_details()
              • HedTagSummary.get_text_summary()
              • HedTagSummary.get_text_summary_details()
              • HedTagSummary.merge_all_info()
              • HedTagSummary.save()
              • HedTagSummary.save_visualizations()
              • HedTagSummary.summary_to_dict()
              • HedTagSummary.update_summary()
              • HedTagSummary.DISPLAY_INDENT
              • HedTagSummary.INDIVIDUAL_SUMMARIES_PATH
            • SummarizeHedTagsOp
              • SummarizeHedTagsOp.__init__()
              • SummarizeHedTagsOp.do_op()
              • SummarizeHedTagsOp.validate_input_data()
              • SummarizeHedTagsOp.NAME
              • SummarizeHedTagsOp.PARAMS
              • SummarizeHedTagsOp.SUMMARY_TYPE
          • summarize_hed_type_op
            • HedTypeSummary
              • HedTypeSummary.__init__()
              • HedTypeSummary.dump_summary()
              • HedTypeSummary.get_details_dict()
              • HedTypeSummary.get_individual()
              • HedTypeSummary.get_summary()
              • HedTypeSummary.get_summary_details()
              • HedTypeSummary.get_text_summary()
              • HedTypeSummary.get_text_summary_details()
              • HedTypeSummary.merge_all_info()
              • HedTypeSummary.save()
              • HedTypeSummary.save_visualizations()
              • HedTypeSummary.update_summary()
              • HedTypeSummary.DISPLAY_INDENT
              • HedTypeSummary.INDIVIDUAL_SUMMARIES_PATH
            • SummarizeHedTypeOp
              • SummarizeHedTypeOp.__init__()
              • SummarizeHedTypeOp.do_op()
              • SummarizeHedTypeOp.validate_input_data()
              • SummarizeHedTypeOp.NAME
              • SummarizeHedTypeOp.PARAMS
              • SummarizeHedTypeOp.SUMMARY_TYPE
          • summarize_hed_validation_op
            • HedValidationSummary
              • HedValidationSummary.__init__()
              • HedValidationSummary.dump_summary()
              • HedValidationSummary.get_details_dict()
              • HedValidationSummary.get_empty_results()
              • HedValidationSummary.get_error_list()
              • HedValidationSummary.get_individual()
              • HedValidationSummary.get_summary()
              • HedValidationSummary.get_summary_details()
              • HedValidationSummary.get_text_summary()
              • HedValidationSummary.get_text_summary_details()
              • HedValidationSummary.merge_all_info()
              • HedValidationSummary.save()
              • HedValidationSummary.save_visualizations()
              • HedValidationSummary.update_error_location()
              • HedValidationSummary.update_summary()
              • HedValidationSummary.DISPLAY_INDENT
              • HedValidationSummary.INDIVIDUAL_SUMMARIES_PATH
            • SummarizeHedValidationOp
              • SummarizeHedValidationOp.__init__()
              • SummarizeHedValidationOp.do_op()
              • SummarizeHedValidationOp.validate_input_data()
              • SummarizeHedValidationOp.NAME
              • SummarizeHedValidationOp.PARAMS
              • SummarizeHedValidationOp.SUMMARY_TYPE
          • summarize_sidecar_from_events_op
            • EventsToSidecarSummary
              • EventsToSidecarSummary.__init__()
              • EventsToSidecarSummary.dump_summary()
              • EventsToSidecarSummary.get_details_dict()
              • EventsToSidecarSummary.get_individual()
              • EventsToSidecarSummary.get_summary()
              • EventsToSidecarSummary.get_summary_details()
              • EventsToSidecarSummary.get_text_summary()
              • EventsToSidecarSummary.get_text_summary_details()
              • EventsToSidecarSummary.merge_all_info()
              • EventsToSidecarSummary.save()
              • EventsToSidecarSummary.save_visualizations()
              • EventsToSidecarSummary.update_summary()
              • EventsToSidecarSummary.validate_input_data()
              • EventsToSidecarSummary.DISPLAY_INDENT
              • EventsToSidecarSummary.INDIVIDUAL_SUMMARIES_PATH
            • SummarizeSidecarFromEventsOp
              • SummarizeSidecarFromEventsOp.__init__()
              • SummarizeSidecarFromEventsOp.do_op()
              • SummarizeSidecarFromEventsOp.validate_input_data()
              • SummarizeSidecarFromEventsOp.NAME
              • SummarizeSidecarFromEventsOp.PARAMS
              • SummarizeSidecarFromEventsOp.SUMMARY_TYPE
          • valid_operations
        • remodeler_validator
          • RemodelerValidator
            • RemodelerValidator.__init__()
            • RemodelerValidator.validate()
            • RemodelerValidator.BASE_ARRAY
            • RemodelerValidator.MESSAGE_STRINGS
            • RemodelerValidator.OPERATION_DICT
            • RemodelerValidator.PARAMETER_SPECIFICATION_TEMPLATE
      • util
        • data_util
          • add_columns()
          • check_match()
          • delete_columns()
          • delete_rows_by_column()
          • get_eligible_values()
          • get_key_hash()
          • get_new_dataframe()
          • get_row_hash()
          • get_value_dict()
          • make_info_dataframe()
          • reorder_columns()
          • replace_na()
          • replace_values()
          • separate_values()
        • hed_logger
          • HedLogger
            • HedLogger.__init__()
            • HedLogger.add()
            • HedLogger.get_log()
            • HedLogger.get_log_keys()
            • HedLogger.get_log_string()
        • io_util
          • check_filename()
          • clean_filename()
          • extract_suffix_path()
          • get_allowed()
          • get_alphanumeric_path()
          • get_dir_dictionary()
          • get_file_list()
          • get_filtered_by_element()
          • get_filtered_list()
          • get_path_components()
          • get_task_dict()
          • get_task_from_file()
          • get_timestamp()
          • make_path()
          • parse_bids_filename()
        • schema_util
          • flatten_schema()
      • visualization
        • tag_word_cloud
          • create_wordcloud()
          • load_and_resize_mask()
          • word_cloud_to_svg()
        • word_cloud_util
          • default_color_func()
          • generate_contour_svg()
          • random_color_darker()
          • ColormapColorFunc
            • ColormapColorFunc.__init__()
            • ColormapColorFunc.color_func()
    • validator
      • def_validator
        • DefValidator
          • DefValidator.__init__()
          • DefValidator.add_definitions()
          • DefValidator.check_for_definitions()
          • DefValidator.get()
          • DefValidator.get_as_strings()
          • DefValidator.get_definition_entry()
          • DefValidator.items()
          • DefValidator.validate_def_tags()
          • DefValidator.validate_def_value_units()
          • DefValidator.validate_onset_offset()
          • DefValidator.issues
      • hed_validator
        • HedValidator
          • HedValidator.__init__()
          • HedValidator.check_tag_formatting()
          • HedValidator.run_basic_checks()
          • HedValidator.run_full_string_checks()
          • HedValidator.validate()
          • HedValidator.validate_units()
          • HedValidator.pattern_doubleslash
      • onset_validator
        • OnsetValidator
          • OnsetValidator.__init__()
          • OnsetValidator.check_for_banned_tags()
          • OnsetValidator.validate_temporal_relations()
      • sidecar_validator
        • SidecarValidator
          • SidecarValidator.__init__()
          • SidecarValidator.validate()
          • SidecarValidator.validate_structure()
          • SidecarValidator.reserved_category_values
          • SidecarValidator.reserved_column_names
      • spreadsheet_validator
        • SpreadsheetValidator
          • SpreadsheetValidator.__init__()
          • SpreadsheetValidator.validate()
      • tag_util
        • char_util
          • CharValidator
            • CharValidator.__init__()
            • CharValidator.check_for_invalid_extension_chars()
            • CharValidator.check_invalid_character_issues()
            • CharValidator.check_tag_invalid_chars()
            • CharValidator.DEFAULT_ALLOWED_PLACEHOLDER_CHARS
            • CharValidator.INVALID_STRING_CHARS
            • CharValidator.INVALID_STRING_CHARS_PLACEHOLDERS
            • CharValidator.TAG_ALLOWED_CHARS
        • class_util
          • is_clock_face_time()
          • is_date_time()
          • validate_numeric_value_class()
          • validate_text_value_class()
          • UnitValueValidator
            • UnitValueValidator.__init__()
            • UnitValueValidator.check_tag_unit_class_units_are_valid()
            • UnitValueValidator.check_tag_value_class_valid()
            • UnitValueValidator.validate_value_class_type()
            • UnitValueValidator.DATE_TIME_VALUE_CLASS
            • UnitValueValidator.DIGIT_OR_POUND_EXPRESSION
            • UnitValueValidator.NAME_VALUE_CLASS
            • UnitValueValidator.NUMERIC_VALUE_CLASS
            • UnitValueValidator.TEXT_VALUE_CLASS
        • group_util
          • GroupValidator
            • GroupValidator.__init__()
            • GroupValidator.check_for_required_tags()
            • GroupValidator.check_multiple_unique_tags_exist()
            • GroupValidator.check_tag_level_issue()
            • GroupValidator.run_all_tags_validators()
            • GroupValidator.run_tag_level_validators()
            • GroupValidator.validate_duration_tags()
        • string_util
          • StringValidator
            • StringValidator.__init__()
            • StringValidator.check_count_tag_group_parentheses()
            • StringValidator.check_delimiter_issues_in_hed_string()
            • StringValidator.run_string_validator()
            • StringValidator.CLOSING_GROUP_CHARACTER
            • StringValidator.COMMA
            • StringValidator.OPENING_GROUP_CHARACTER
        • tag_util
          • TagValidator
            • TagValidator.__init__()
            • TagValidator.check_capitalization()
            • TagValidator.check_for_placeholder()
            • TagValidator.check_tag_exists_in_schema()
            • TagValidator.check_tag_is_deprecated()
            • TagValidator.check_tag_requires_child()
            • TagValidator.run_individual_tag_validators()
            • TagValidator.CAMEL_CASE_EXPRESSION
  • HED API index

HED resources:

  • Main resource page
  • Project home page
  • Schema viewer
  • Prerelease schema viewer
  • Specification
  • Examples and tutorials
  • Online tools
  • CTagger GUI
  • Web deployment
HED Python
  • Search

© Copyright 2017-2024, HED Working Group. Revision 1b982965.

Built with Sphinx using a theme provided by Read the Docs.