change api

zhiim · Jul 16, 2024 · 588a029 · 588a029
1 parent 4073cbe
commit 588a029
Show file tree

Hide file tree

Showing 10 changed files with 200 additions and 161 deletions.
diff --git a/README.md b/README.md
@@ -9,6 +9,7 @@ Classical DOA Estimation algorithms implemented in Python.
 ```bash
 pip install classical_doa
 ```
+
 or install from source
 
 ```bash
@@ -25,7 +26,7 @@ A sample example of DOA estimation using MUSIC algorithm.
 import numpy as np
 
 from classical_doa import arrays, signals
-from classical_doa.algorithm.music import music
+from classical_doa.algorithm import music
 from classical_doa.plot import plot_spatial_spectrum
 
 # Create a 8-element ULA with 0.5m spacing
@@ -57,44 +58,45 @@ plot_spatial_spectrum(
     num_signal=2,
 )
 ```
+
 You will a get a figure like this:
 ![music_spectrum](pics/music_spectrum.svg)
 
 Check `examples` for more examples.
 
-## What's implemented 
+## What's implemented
 
 ### Array Structures
 
-* Uniform Linear Array (ULA)  
-* Uniform Rectangular Array (URA, to be implemented)
-* Uniform Circular Array (UCA)
+- Uniform Linear Array (ULA)
+- Uniform Rectangular Array (URA, to be implemented)
+- Uniform Circular Array (UCA)
 
 ### Signal Models
 
-* Narrowband  
-    complex stochastic signal
-* Broadband  
-    chirp signal 
+- Narrowband  
+   complex stochastic signal
+- Broadband  
+   chirp signal
 
 ### Algorithms
 
-* ULA
-    - [x] MUSIC
-    - [x] ESPRIT
-    - [x] Root-MUSIC
-    - [x] OMP
-    - [x] l1-SVD
-* URA
-    - [ ] URA-MUSIC
-    - [ ] URA-ESPRIT
-* UCA
-    - [x] UCA-RB-MUSIC
-    - [x] UCA-ESPRIT
-* Broadband
-    - [x] ISSM
-    - [x] CSSM
-    - [x] TOPS
+- ULA
+  - [x] MUSIC
+  - [x] ESPRIT
+  - [x] Root-MUSIC
+  - [x] OMP
+  - [x] l1-SVD
+- URA
+  - [ ] URA-MUSIC
+  - [ ] URA-ESPRIT
+- UCA
+  - [x] UCA-RB-MUSIC
+  - [x] UCA-ESPRIT
+- Broadband
+  - [x] ISSM
+  - [x] CSSM
+  - [x] TOPS
 
 ## License
 

diff --git a/classical_doa/__init__.py b/classical_doa/__init__.py
@@ -1,2 +1,2 @@
-__version__ = "1.0.2"
+__version__ = "1.0.3"
 __author__ = "Qian Xu"
diff --git a/classical_doa/algorithm/__init__.py b/classical_doa/algorithm/__init__.py
@@ -0,0 +1,4 @@
+from .broadband import *
+from .esprit import *
+from .music import *
+from .sparse import *
diff --git a/classical_doa/algorithm/broadband/__init__.py b/classical_doa/algorithm/broadband/__init__.py
@@ -0,0 +1,3 @@
+from .cssm import *
+from .imusic import *
+from .tops import *
diff --git a/examples/broadband.ipynb b/examples/broadband.ipynb
diff --git a/examples/broadband_cn.ipynb b/examples/broadband_cn.ipynb
diff --git a/examples/uca.ipynb b/examples/uca.ipynb
diff --git a/examples/uca_cn.ipynb b/examples/uca_cn.ipynb
diff --git a/examples/ula.ipynb b/examples/ula.ipynb
diff --git a/examples/ula_cn.ipynb b/examples/ula_cn.ipynb