HedString
=========

.. currentmodule:: hed.models.hed_string

.. autoclass:: hed.models.hed_string.HedString
   :noindex:

.. rubric:: Methods

.. autosummary::
   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

.. rubric:: Attributes

.. autosummary::
   HedString.CLOSING_GROUP_CHARACTER
   HedString.OPENING_GROUP_CHARACTER
   HedString.is_group
   HedString.span
.. _method-__init__:

.. automethod:: hed.models.hed_string.HedString.__init__
.. _method-append:

.. automethod:: hed.models.hed_string.HedString.append
.. _method-casefold:

.. automethod:: hed.models.hed_string.HedString.casefold
.. _method-check_if_in_original:

.. automethod:: hed.models.hed_string.HedString.check_if_in_original
.. _method-copy:

.. automethod:: hed.models.hed_string.HedString.copy
.. _method-expand_defs:

.. automethod:: hed.models.hed_string.HedString.expand_defs
.. _method-find_def_tags:

.. automethod:: hed.models.hed_string.HedString.find_def_tags
.. _method-find_exact_tags:

.. automethod:: hed.models.hed_string.HedString.find_exact_tags
.. _method-find_placeholder_tag:

.. automethod:: hed.models.hed_string.HedString.find_placeholder_tag
.. _method-find_tags:

.. automethod:: hed.models.hed_string.HedString.find_tags
.. _method-find_tags_with_term:

.. automethod:: hed.models.hed_string.HedString.find_tags_with_term
.. _method-find_top_level_tags:

.. automethod:: hed.models.hed_string.HedString.find_top_level_tags
.. _method-find_wildcard_tags:

.. automethod:: hed.models.hed_string.HedString.find_wildcard_tags
.. _method-from_hed_strings:

.. automethod:: hed.models.hed_string.HedString.from_hed_strings
.. _method-get_all_groups:

.. automethod:: hed.models.hed_string.HedString.get_all_groups
.. _method-get_all_tags:

.. automethod:: hed.models.hed_string.HedString.get_all_tags
.. _method-get_as_form:

.. automethod:: hed.models.hed_string.HedString.get_as_form
.. _method-get_as_indented:

.. automethod:: hed.models.hed_string.HedString.get_as_indented
.. _method-get_as_long:

.. automethod:: hed.models.hed_string.HedString.get_as_long
.. _method-get_as_original:

.. automethod:: hed.models.hed_string.HedString.get_as_original
.. _method-get_as_short:

.. automethod:: hed.models.hed_string.HedString.get_as_short
.. _method-get_first_group:

.. automethod:: hed.models.hed_string.HedString.get_first_group
.. _method-get_original_hed_string:

.. automethod:: hed.models.hed_string.HedString.get_original_hed_string
.. _method-groups:

.. automethod:: hed.models.hed_string.HedString.groups
.. _method-lower:

.. automethod:: hed.models.hed_string.HedString.lower
.. _method-remove:

.. automethod:: hed.models.hed_string.HedString.remove
.. _method-remove_definitions:

.. automethod:: hed.models.hed_string.HedString.remove_definitions
.. _method-remove_refs:

.. automethod:: hed.models.hed_string.HedString.remove_refs
.. _method-replace:

.. automethod:: hed.models.hed_string.HedString.replace
.. _method-shrink_defs:

.. automethod:: hed.models.hed_string.HedString.shrink_defs
.. _method-sort:

.. automethod:: hed.models.hed_string.HedString.sort
.. _method-sorted:

.. automethod:: hed.models.hed_string.HedString.sorted
.. _method-split_hed_string:

.. automethod:: hed.models.hed_string.HedString.split_hed_string
.. _method-split_into_groups:

.. automethod:: hed.models.hed_string.HedString.split_into_groups
.. _method-tags:

.. automethod:: hed.models.hed_string.HedString.tags
.. _method-validate:

.. automethod:: hed.models.hed_string.HedString.validate
.. _attribute-CLOSING_GROUP_CHARACTER:

.. autoattribute:: hed.models.hed_string.HedString.CLOSING_GROUP_CHARACTER
.. _attribute-OPENING_GROUP_CHARACTER:

.. autoattribute:: hed.models.hed_string.HedString.OPENING_GROUP_CHARACTER
.. _attribute-is_group:

.. autoattribute:: hed.models.hed_string.HedString.is_group
.. _attribute-span:

.. autoattribute:: hed.models.hed_string.HedString.span