Skip to content

Commit

Permalink
docs(README.md;-cookbook.md): Add examples for importing data from di…
Browse files Browse the repository at this point in the history
…fferent sources
  • Loading branch information
Oli4 committed Apr 4, 2023
1 parent eb18f2a commit 2a71e11
Show file tree
Hide file tree
Showing 2 changed files with 28 additions and 4 deletions.
22 changes: 20 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ The `eyepy` python package provides a simple interface to import and process OCT

## Features

* Import Data (Heyex-E2E, Heyex-VOL, Heyex-XML, B-Scan collections, [RETOUCH Challenge](https://retouch.grand-challenge.org/), [AMD Dataset from Duke University](https://people.duke.edu/~sf59/RPEDC_Ophth_2013_dataset.htm))
* Import Data (Heyex-E2E, Heyex-VOL, Heyex-XML, Topcon-FDA, B-Scan collections, [RETOUCH Challenge](https://retouch.grand-challenge.org/), [AMD Dataset from Duke University](https://people.duke.edu/~sf59/RPEDC_Ophth_2013_dataset.htm))
* Analyze OCT volumes (compute and quantify drusen)
* Visualize OCT volumes with annotations and quantifications
* Save and load EyeVolume objects
Expand All @@ -24,13 +24,31 @@ The `eyepy` python package provides a simple interface to import and process OCT
### Installation
To install the latest version of eyepy run `pip install -U eyepie`. It is `eyepie` and not `eyepy` for installation with pip.

### Getting Started
When you don't hava a supported OCT volume at hand you can check out our sample dataset to get familiar with `eyepy`.

```python
from eyepy.data import load
# Import HEYEX XML export
ev = load("drusen_patient")
```

If you have data at hand use one of eyepys import functions.

```python
# Import HEYEX E2E export
ev = ep.import_heyex_e2e("path/to/file.e2e")
# Import HEYEX XML export
ev = ep.import_heyex_xml("path/to/folder")
# Import HEYEX VOL export
ev = ep.import_heyex_vol("path/to/file.vol")
# Import Topcon FDA export
ev = ep.import_topcon_fda("path/to/file.fda")
# Import volume from Duke public dataset
ev = ep.import_duke_mat("path/to/file.mat")
# Import volume form RETOUCH challenge
ev = ep.import_retouch("path/to/volume_folder")
```

# Related Projects:

+ [OCT-Converter](https://github.com/marksgraham/OCT-Converter): Extract raw optical coherence tomography (OCT) and fundus data from proprietary file formats. (.fds/.fda/.e2e/.img/.oct/.dcm)
Expand Down
10 changes: 8 additions & 2 deletions docs/cookbook.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,16 +4,22 @@ Here you learn how to use eyepy to perform common tasks.

## Import OCT data

Currently `eyepy` supports the HEYEX E2E, VOL and XML formats, as well as reading data from several public OCT datasets. All functions return a single `EyeVolume` object representing the data. E2E files may contain several OCT volumes which you can retrieve by setting the parameter `single` to `False`. While you can use Reader objects to parse the data and access specific information, it is recommended to use the provided import functions to get `EyeVolume` object which are a convenient interface to the data that provides a unified interface to data imported from various sources.
Currently `eyepy` supports the HEYEX E2E, VOL and XML formats, as well as reading data from several public OCT datasets. All functions return a single `EyeVolume` object representing the data. E2E files may contain several OCT volumes. The import function only returns the first OCT volume in the file. If you want to read several volumes from a file use the [HeE2eReader][eyepy.io.he.e2e_reader.HeE2eReader] class. While you can use Reader objects to parse the data and access specific information, it is recommended to use when possible, the provided import functions to get `EyeVolume` object which are a convenient interface to the data that provides a unified interface to data imported from various sources.

```python
import eyepy as ep
# Import HEYEX E2E export
ev = ep.import_heyex_e2e("path/to/file.e2e", single=True)
ev = ep.import_heyex_e2e("path/to/file.e2e")
# Import HEYEX XML export
ev = ep.import_heyex_xml("path/to/folder")
# Import HEYEX VOL export
ev = ep.import_heyex_vol("path/to/file.vol")
# Import Topcon FDA export
ev = ep.import_topcon_fda("path/to/file.fda")
# Import volume from Duke public dataset
ev = ep.import_duke_mat("path/to/file.mat")
# Import volume form RETOUCH challenge
ev = ep.import_retouch("path/to/volume_folder")
```

!!! Warning "Missing scale information"
Expand Down

0 comments on commit 2a71e11

Please sign in to comment.