openbraininstitute / libsonata

93%

LAST BUILD ON BRANCH master

branch: SELECT

CHANGE BRANCH

x

Sync Branches

• No branch selected
• add-docstrings
• add-learning-engine
• brian2
• cleanup
• cleanup-config-tests
• fix-build
• fix-output
• gnuinstalldirs
• input-poisson
• jplanas/cond-modif-sonata-ext
• jplanas/copyright-update
• katta/bluebrain2openbraininstitute
• katta/ci-macos-check
• katta/comp_sets_2
• katta/compartment_set_input
• katta/electrode-reader
• katta/install_dev
• katta/per-report-electrodes-file
• katta/preserve-input-names-order
• katta/publish-on-release
• katta/selection-iterator
• linux-aarch64
• master
• mechanisms-dir
• nodesets-name
• point-model-dir
• refs/tags/v0.1.30
• refs/tags/v0.1.31
• remove-file-locks
• rev-hdf5
• scikit-build-core
• set_retention_days_for_build_artifacts
• simconf-unspecified
• take-two
• test-format
• update-catch2
• update-clang-format
• update-coverage
• update-docstrings
• update-hdf5-v1.14.6
• update-highfive
• update-pybind11
• update_banner
• v0.1.32
• v0.1.33
• v0.1.34
• v0.1.35
• v0.1.36
• v0.1.37
• weji/build_sdist
• weji/duplicate_keys
• weji/electric_fields
• weji/seclamp
• weji/seclamp_more

Build # 29263983785

Build Type

push

github

Committed by web-flow

Commit Message

Add ElectrodeReader for SONATA electrode weight files (#56)

Adds an `ElectrodeReader` to libsonata for reading SONATA electrode weight HDF5 files (produced by BlueRecording, consumed by neurodamus for LFP computation).

## What

- **`ElectrodeReader`** class following the `ReportReader`/`SpikeReader` pattern: lazy population loading, sorted index for unsorted node_ids, `openPopulation()` + `getPopulationNames()`
- **`ElectrodeDataFrame`** struct for returning scaling factor submatrices with row/column identity
- **`Population::get(node_ids, electrode_ids)`** — Selection-based access on both axes (`nullopt` = all)
- **Electrode metadata** accessors: names, positions, types
- **Python bindings** with zero-copy numpy arrays (`.ids`, `.electrodes`, `.data`)
- **Test fixture** with two populations (unsorted + sorted node_ids)

## Usage (Python)

```python
from libsonata import ElectrodeReader, Selection

reader = ElectrodeReader('electrode_weights.h5')
pop = reader['NodeA']

df = pop.get()                                         # all nodes, all electrodes
df = pop.get(node_ids=Selection([0, 1, 5]))            # specific nodes
df = pop.get(electrode_ids=Selection([0, 2]))          # specific electrodes
df = pop.get(Selection([0, 1]), Selection([0]))        # both

df.ids         # numpy (n_rows, 2): [node_id, compartment_index]
df.electrodes  # numpy (n_cols,): electrode column indices
df.data        # numpy (n_rows, n_cols): scaling factors
```

## Status

- [x] C++ implementation + Python bindings
- [x] Build verified (all 32 existing C++ tests + 115 Python tests pass)
- [x] C++ tests (in progress)
- [x] Python tests (in progress)

Fix: https://github.com/openbraininstitute/libsonata/issues/54

Coverage Stats

199 of 211 new or added lines in 1 file covered. (94.31%)

2713 of 2918 relevant lines covered (92.97%)

49.09 hits per line