updated annotations and documents

hzarei4 · Jun 13, 2024 · a9f65b4 · a9f65b4
1 parent 81b07a4
commit a9f65b4
Show file tree

Hide file tree

Showing 9 changed files with 1,159 additions and 41 deletions.
diff --git a/docs/generate_objects.jl b/docs/generate_objects.jl
diff --git a/docs/src/assets/arr_filaments.png b/docs/src/assets/arr_filaments.png
diff --git a/docs/src/assets/arr_pollen.png b/docs/src/assets/arr_pollen.png
diff --git a/docs/src/assets/arr_resolution_test.png b/docs/src/assets/arr_resolution_test.png
diff --git a/docs/src/function_references/objects.md b/docs/src/function_references/objects.md
@@ -0,0 +1,15 @@
+# Objects
+```@docs
+pollen3D
+object_3D
+filaments3D 
+draw_sphere!
+draw_line!
+filaments3D!
+spokes_object 
+hollow_sphere! 
+resolution_test
+hollow_sphere  
+annotation_3D!
+matrix_read
+```
diff --git a/docs/src/index.md b/docs/src/index.md
@@ -1,16 +1,42 @@
-# SyntheticObjects.jl Documentation
-
-```@docs
-pollen3D
-object_3D
-filaments3D 
-draw_sphere!
-annotation_3D!
-draw_line!
-filaments3D!
-matrix_read
-spokes_object 
-hollow_sphere! 
-resolution_offset 
-hollow_sphere  
-```
+# SyntheticObjects.jl
+
+
+This package creates several synthetic objects in Julia to further process in the image processing routines.
+
+## Overview
+Using this package, user can generate different objetcs for the pupose of image processing. This package contains 2D as well as 3D samples
+of different objects (Numbers, Alphabets, and objects).
+
+
+## Installation
+`SyntheticObjects.jl` can be installed using the command:
+
+```julia
+julia> ] add SyntheticObjects
+```
+
+
+## Examples
+
+```julia
+julia> using SyntheticObjects
+
+# this generates a pollen grain object array
+arr_pollen = pollen3D((256, 256, 256));
+
+
+# a set of filaments in 3D:
+arr_filaments = filaments3D((256,256,256))
+
+# and so on ...     
+```
+### Image of the pollen object (plotted using [`View5D.jl`](https://github.com/RainerHeintzmann/View5D.jl) package)
+![](assets/arr_pollen.png)
+
+### Image of the filaments (plotted using [`View5D.jl`](https://github.com/RainerHeintzmann/View5D.jl) package)
+![](assets/arr_filaments.png)
+
+
+
+### Image of the resolution test (plotted using [`View5D.jl`](https://github.com/RainerHeintzmann/View5D.jl) package)
+![](assets/arr_resolution_test.png)