Add README
Browse files
README.md
ADDED
|
@@ -0,0 +1,71 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
# CANNS Analysis Datasets
|
| 2 |
+
|
| 3 |
+
This repository contains example datasets for the [CANNS (Continuous Attractor Neural Networks)](https://github.com/your-username/canns) data analysis package.
|
| 4 |
+
|
| 5 |
+
## Datasets
|
| 6 |
+
|
| 7 |
+
### ROI_data.txt (703 KB)
|
| 8 |
+
- **Description**: 1D CANN ROI data for bump analysis
|
| 9 |
+
- **Format**: Text file with neural activity measurements
|
| 10 |
+
- **Usage**: 1D CANN analysis, MCMC bump fitting
|
| 11 |
+
- **Example**: Used in 1D CANN analysis tutorials
|
| 12 |
+
|
| 13 |
+
### grid_1.npz (8.7 MB)
|
| 14 |
+
- **Description**: Grid cell spike data with position information
|
| 15 |
+
- **Format**: NumPy archive containing spike times, positions
|
| 16 |
+
- **Keys**: `spike` (spike times), `t` (time), `x`, `y` (positions)
|
| 17 |
+
- **Usage**: 2D CANN analysis, topological data analysis, circular coordinate decoding
|
| 18 |
+
- **Example**: Primary dataset for 2D CANN tutorials
|
| 19 |
+
|
| 20 |
+
### grid_2.npz (4.5 MB)
|
| 21 |
+
- **Description**: Second grid cell dataset for comparison studies
|
| 22 |
+
- **Format**: NumPy archive with spike and position data
|
| 23 |
+
- **Usage**: Comparative analysis, validation studies
|
| 24 |
+
|
| 25 |
+
## Usage
|
| 26 |
+
|
| 27 |
+
Install the CANNS package and use the datasets module:
|
| 28 |
+
|
| 29 |
+
```python
|
| 30 |
+
from canns import datasets
|
| 31 |
+
from canns.analyzer import data_analysis
|
| 32 |
+
|
| 33 |
+
# Automatic dataset download and setup
|
| 34 |
+
datasets.quick_setup()
|
| 35 |
+
|
| 36 |
+
# Load specific datasets
|
| 37 |
+
roi_data = datasets.load_roi_data()
|
| 38 |
+
grid_data = datasets.load_grid_data("grid_1")
|
| 39 |
+
|
| 40 |
+
# Use with analysis tools
|
| 41 |
+
analyzer = data_analysis.CANNDataAnalyzer()
|
| 42 |
+
spikes, x, y, t = analyzer.load_spike_data(datasets.get_dataset_path("grid_1"))
|
| 43 |
+
```
|
| 44 |
+
|
| 45 |
+
## Examples
|
| 46 |
+
|
| 47 |
+
See the [CANNS examples](https://github.com/your-username/canns/tree/master/examples) for complete tutorials:
|
| 48 |
+
|
| 49 |
+
- `data_analysis_demo.py`: Command-line demo
|
| 50 |
+
- `cann_data_analysis_tutorial.ipynb`: Jupyter notebook tutorial
|
| 51 |
+
|
| 52 |
+
## Citation
|
| 53 |
+
|
| 54 |
+
These datasets are derived from the [CANN-data-analysis](https://github.com/Airs702/CANN-data-analysis) repository. Please cite:
|
| 55 |
+
|
| 56 |
+
```bibtex
|
| 57 |
+
@software{cann_data_analysis,
|
| 58 |
+
title = {CANN Data Analysis},
|
| 59 |
+
url = {https://github.com/Airs702/CANN-data-analysis},
|
| 60 |
+
author = {Airs702},
|
| 61 |
+
year = {2024}
|
| 62 |
+
}
|
| 63 |
+
```
|
| 64 |
+
|
| 65 |
+
## License
|
| 66 |
+
|
| 67 |
+
Please refer to the original [CANN-data-analysis repository](https://github.com/Airs702/CANN-data-analysis) for license information.
|
| 68 |
+
|
| 69 |
+
---
|
| 70 |
+
|
| 71 |
+
*Generated automatically for the CANNS package datasets.*
|