Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Modified the overall approach diagram #396

Merged
merged 2 commits into from
Aug 15, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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.