SpikeInterface / SpikeInterface/spikeinterface
bad channel detection `psd_hf_threshold` units documentation
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 847
- Forks
- 280
- Avg merge
- 3d 9h
- Merged PRs (30d)
- 29
Description
The bad channel detection docs specify the units for psd_hf_threshold:
For coherence+psd - an absolute threshold (uV^2/Hz) used as a cutoff for noise channels. Channels with average power at >80% Nyquist larger than this threshold will be labeled as noise. IBL suggests 0.02 for AP data and 1.4 for LFP data.
This assumes that the data is in uV but this is at the discretion of the user. The docs can be changed to specify that it is in sample units with an example in the common uV case. Can double check how this is actually implemented under the hood too.
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the bad channel detection documentation and trace the implementation of psd_hf_threshold to confirm which units it uses. Update the documentation to describe sample units and give the common uV example; done means the wording matches the implementation and the threshold examples are unambiguous.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Active
- Clarity
- Mostly clear
- Newbie friendliness
- 74/100