Skip to content

Commit

Permalink
Modified the tool diagram
Browse files Browse the repository at this point in the history
  • Loading branch information
VisLab committed Aug 15, 2024
1 parent 567862b commit 0c81a20
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 1 deletion.
9 changes: 8 additions & 1 deletion docs/source/HedMatlabTools.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,12 +8,19 @@ These MATLAB wrappers allow MATLAB users to use HED without learning Python.
## Tool overview

The HED MATLAB tools provide the following interface to HEDTools as explained in more detail in the following sections.
The MATLAB HEDTools package provides two interchangeable implementations of these functions -- calling the HED Python tools through a web service or directly calling the Python HEDTools.
The MATLAB HEDTools package provides two interchangeable implementations of these functions --
calling the HED Python tools through a web service or directly calling the Python HEDTools.

To use HED tools, you first create a HED object by calling `getHedTools`.
If you provide the optional host argument, the HED tools use services, otherwise
direct calls to Python. Once created, you simply call the available methods
using that reference. The process is summarized in the following diagram.

![HED MATLAB tools](./_static/images/MatLabHedToolsCloseFit.png).

Both approaches take MATLAB data as input and translate these values as needed to access the HEDTools.
After making the call, the implementation translates the results back into MATLAB data types.
The MATLAB HedTools accept a variety of different types of MATLAB variables as input.

Calling the HED MATLAB tools using web services requires no installation beyond downloading the
HED MATLAB package, but its use requires Internet access.
Expand Down
Binary file modified docs/source/_static/images/MatLabHedToolsCloseFit.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 0c81a20

Please sign in to comment.