From 374d5415cc0a68d6ff2ce1ce3301fe8ad87c4bb2 Mon Sep 17 00:00:00 2001 From: Mark Graham Date: Tue, 14 Mar 2023 08:59:58 -0600 Subject: [PATCH] Updates README and example --- README.md | 4 ++-- examples/demo_fda_extraction.py | 2 +- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 1cf6f19..0080a98 100644 --- a/README.md +++ b/README.md @@ -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: @@ -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 diff --git a/examples/demo_fda_extraction.py b/examples/demo_fda_extraction.py index d3049aa..1198012 100644 --- a/examples/demo_fda_extraction.py +++ b/examples/demo_fda_extraction.py @@ -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"