Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Make band_mean and band_sd in DecompositionSeries optional #570

Open
rly opened this issue Feb 5, 2024 · 2 comments · May be fixed by #593
Open

Make band_mean and band_sd in DecompositionSeries optional #570

rly opened this issue Feb 5, 2024 · 2 comments · May be fixed by #593
Assignees
@stephprince
Labels
category: bug errors in the code or code behavior priority: low alternative solution already working and/or relevant to only specific user(s)
Milestone
2.8.0

Comments

@rly
Copy link
Contributor

rly commented Feb 5, 2024

The docs for band_mean and band_sd in DecompositionSeries say that these fields are specific to Gaussian filters. Not all filters used in neurophysiology are Gaussian though, e.g., an LFP decomposition into alpha, beta, and gamma bands is not Gaussian, and LFP decomposition is supposed to be supported by this neurodata type. These table columns should be optional.

Relatedly, the DecompositionSeries.bands table should be its own type. See #336
@rly rly added category: bug errors in the code or code behavior priority: low alternative solution already working and/or relevant to only specific user(s) labels Feb 5, 2024
@stephprince
Copy link
Contributor

I came across this issue when trying to add a documentation example for DecompositionSeries to address NeurodataWithoutBorders/pynwb#1938. I agree band_mean and band_sd should be made optional as they do not apply to all filter types.

It might be helpful to add an optional filter or filter_type text column as the type of filter used is relevant information for interpreting the DecompositionSeries data values.

@stephprince stephprince added this to the 2.8.0 milestone Oct 31, 2024
@stephprince stephprince self-assigned this Oct 31, 2024
@rly
Copy link
Contributor Author

rly commented Nov 1, 2024

I agree @stephprince

@stephprince stephprince linked a pull request Nov 7, 2024 that will close this issue
Open
7 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@stephprince stephprince

Labels
category: bug errors in the code or code behavior priority: low alternative solution already working and/or relevant to only specific user(s)
Projects
None yet
Milestone
2.8.0
Development

Successfully merging a pull request may close this issue.

Make band_mean and band_std in DecompositionSeries optional NeurodataWithoutBorders/nwb-schema
2 participants
@rly @stephprince