Skip to content

Commit

Permalink
Updates README and example
Browse files Browse the repository at this point in the history
  • Loading branch information
marksgraham committed Mar 14, 2023
1 parent 7ea931d commit 374d541
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 3 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ pip install oct-converter


## Usage
A number of example usage scripts are included in examples/.
A number of example usage scripts are included in `examples/`.

Here is an example of reading a .fds file:

Expand All @@ -43,7 +43,7 @@ filepath = '/home/mark/Downloads/eg_oct_fds.fds'
fds = FDS(filepath)

oct_volume = fds.read_oct_volume() # returns an OCT volume with additional metadata if available
oct_volume.peek() # plots a montage of the volume
oct_volume.peek(show_contours=True) # plots a montage of the volume, with layer segmentations is available
oct_volume.save('fds_testing.avi') # save volume as a movie
oct_volume.save('fds_testing.png') # save volume as a set of sequential images, fds_testing_[1...N].png
oct_volume.save_projection('projection.png') # save 2D projection
Expand Down
2 changes: 1 addition & 1 deletion examples/demo_fda_extraction.py
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
oct_volume = (
fda.read_oct_volume()
) # returns an OCT volume with additional metadata if available
oct_volume.peek() # plots a montage of the volume
oct_volume.peek(show_contours=True) # plots a montage of the volume
oct_volume.save("fda_testing.avi") # save volume as a movie
oct_volume.save(
"fda_testing.png"
Expand Down

0 comments on commit 374d541

Please sign in to comment.