Skip to content

Commit

Permalink
Merge pull request #149 from jmartens/patch-1
Browse files Browse the repository at this point in the history
Minor documentation updates
  • Loading branch information
jrkerns committed Oct 31, 2018
2 parents 6d7c7b3 + 0e99073 commit 7939f02
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions docs/source/starshot_docs.rst
Original file line number Diff line number Diff line change
Expand Up @@ -61,13 +61,13 @@ A typical analysis sequence looks like so:
* **Analyze the image** -- After loading the image, all that needs to be done is analyze the image. You may optionally
pass in some settings::

mystar.analyze(radius=50, tolerance=0.8) # see API docs for more parameter info
mystar.analyze(radius=0.5, tolerance=0.8) # see API docs for more parameter info

* **View the results** -- Starshot can print out the summary of results to the console as well as draw a matplotlib image to show the
detected radiation lines and wobble circle::

# print results to the console
print(mystar.return_results())
print(mystar.results())
# view analyzed image
mystar.plot_analyzed_image()

Expand Down

0 comments on commit 7939f02

Please sign in to comment.