Skip to content

tools.rst

Latest commit

 

History

History
232 lines (172 loc) · 3.97 KB

tools.rst

File metadata and controls

232 lines (172 loc) · 3.97 KB

Tools

Utility functions and data processing tools for HED operations.

Analysis tools

EventManager

.. autoclass:: hed.tools.analysis.event_manager.EventManager
   :members:
   :undoc-members:
   :show-inheritance:

EventChecker

.. autoclass:: hed.tools.analysis.event_checker.EventChecker
   :members:
   :undoc-members:
   :show-inheritance:

EventsChecker

.. autoclass:: hed.tools.analysis.event_checker.EventsChecker
   :members:
   :undoc-members:
   :show-inheritance:

EventsSummary

.. autoclass:: hed.tools.analysis.events_summary.EventsSummary
   :members:
   :undoc-members:
   :show-inheritance:

HedTagManager

.. autoclass:: hed.tools.analysis.hed_tag_manager.HedTagManager
   :members:
   :undoc-members:
   :show-inheritance:

HedTagCount

.. autoclass:: hed.tools.analysis.hed_tag_counts.HedTagCount
   :members:
   :undoc-members:
   :show-inheritance:

HedTagCounts

.. autoclass:: hed.tools.analysis.hed_tag_counts.HedTagCounts
   :members:
   :undoc-members:
   :show-inheritance:

HedTypeManager

.. autoclass:: hed.tools.analysis.hed_type_manager.HedTypeManager
   :members:
   :undoc-members:
   :show-inheritance:

HedType

.. autoclass:: hed.tools.analysis.hed_type.HedType
   :members:
   :undoc-members:
   :show-inheritance:

HedTypeDefs

.. autoclass:: hed.tools.analysis.hed_type_defs.HedTypeDefs
   :members:
   :undoc-members:
   :show-inheritance:

HedTypeFactors

.. autoclass:: hed.tools.analysis.hed_type_factors.HedTypeFactors
   :members:
   :undoc-members:
   :show-inheritance:

HedTypeCount

.. autoclass:: hed.tools.analysis.hed_type_counts.HedTypeCount
   :members:
   :undoc-members:
   :show-inheritance:

HedTypeCounts

.. autoclass:: hed.tools.analysis.hed_type_counts.HedTypeCounts
   :members:
   :undoc-members:
   :show-inheritance:

TabularSummary

.. autoclass:: hed.tools.analysis.tabular_summary.TabularSummary
   :members:
   :undoc-members:
   :show-inheritance:

ColumnNameSummary

.. autoclass:: hed.tools.analysis.column_name_summary.ColumnNameSummary
   :members:
   :undoc-members:
   :show-inheritance:

FileDictionary

.. autoclass:: hed.tools.analysis.file_dictionary.FileDictionary
   :members:
   :undoc-members:
   :show-inheritance:

KeyMap

.. autoclass:: hed.tools.analysis.key_map.KeyMap
   :members:
   :undoc-members:
   :show-inheritance:

TemporalEvent

.. autoclass:: hed.tools.analysis.temporal_event.TemporalEvent
   :members:
   :undoc-members:
   :show-inheritance:

Annotation utilities

.. automodule:: hed.tools.analysis.annotation_util
   :members:
   :undoc-members:

BIDS tools

BidsDataset

.. autoclass:: hed.tools.bids.bids_dataset.BidsDataset
   :members:
   :undoc-members:
   :show-inheritance:

BidsFile

.. autoclass:: hed.tools.bids.bids_file.BidsFile
   :members:
   :undoc-members:
   :show-inheritance:

BidsFileGroup

.. autoclass:: hed.tools.bids.bids_file_group.BidsFileGroup
   :members:
   :undoc-members:
   :show-inheritance:

BidsSidecarFile

.. autoclass:: hed.tools.bids.bids_sidecar_file.BidsSidecarFile
   :members:
   :undoc-members:
   :show-inheritance:

BidsTabularFile

.. autoclass:: hed.tools.bids.bids_tabular_file.BidsTabularFile
   :members:
   :undoc-members:
   :show-inheritance:

BIDS utilities

.. automodule:: hed.tools.bids.bids_util
   :members:
   :undoc-members:

Utility functions

DataFrame utilities

.. automodule:: hed.tools.util.data_util
   :members:
   :undoc-members:

File/IO utilities

.. automodule:: hed.tools.util.io_util
   :members:
   :undoc-members:

Schema utilities

.. automodule:: hed.tools.util.schema_util
   :members:
   :undoc-members: