Skip to content

Commit

Permalink
add readme notes on import/export
Browse files Browse the repository at this point in the history
  • Loading branch information
icyveins7 committed May 30, 2024
1 parent 65106c7 commit dc4f30d
Showing 1 changed file with 35 additions and 0 deletions.
35 changes: 35 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -131,6 +131,41 @@ $$

The new window will contain a simple audio player that should arbitrarily play, pause, stop (rewind to the start) and drag the playline around. You can also adjust the frequency of the audio to correct the pitch in realtime.

### Exporting/Importing to Python/MATLAB

You can exported the selected samples for further processing to Python or MATLAB with ```Select Data for Export```. Then, in Python you can do:

```python
# This requires you to have the ipc.py file in your path
from ipc import getReimageData
data = getReimageData()
```

or for MATLAB:

```MATLAB
% Add the matlab/ folder to path to find these functions
data = getReimageData();
```


The reverse is also possible; you can send data for plotting to ReImage from Python:

```python
# This requires you to have the ipc.py file in your path
from ipc import sendReimageData
sendReimageData(data) # Some numpy array
```

or from MATLAB:

```MATLAB
% Add the matlab/ folder to path to find these functions
sendReimageData(data);
```

The transfers are done over the loopback IP address with port 5000 by default, so no disk space is used in either direction.


## Issues

Expand Down

0 comments on commit dc4f30d

Please sign in to comment.