NeurodataWithoutBorders / nwbinspector

Tool to help inspect NWB files for compliance with NWB Best Practices
https://nwbinspector.readthedocs.io/
Other
17 stars 10 forks source link

[Add Check]: ElectricalSeries of dtype int16 with conversion=1.0 and offset=0.0 is potentially wrong? #395

Open CodyCBakerPhD opened 1 year ago

CodyCBakerPhD commented 1 year ago

What would you like to see added to the NWBInspector?

More of a question for either @alejoe91 or @samuelgarcia based on their experience

If you saw an ElectricalSeries that was of dtype uint16 or int16 and the conversion factor (spikeinterface 'gain_to_uV') was all 1.0 and offset 0.0, this is most likely incorrect, right?

If so, how strongly incorrect is it?

@bendichter @rly @oruebel Would/Should it technically count as being invalid? Should it prevent DANDI upload?

Pseudocode or other logic of the check

No response

Do you have any interest in helping implement the check function?

Yes.

Code of Conduct

rly commented 1 year ago

Good question. I think it is highly unlikely to be correct because I cannot think of a situation where electrodes in a neurophysiology experiment would be recording in integer volts. I think that should be invalid. Not sure about preventing DANDI upload. We could err on a stricter rule and relax it if an unexpected use case comes to our attention.

bendichter commented 1 year ago

I agree, int data with a conversion of 1.0 is likely an error.

samuelgarcia commented 1 year ago

Hi Cody. This seams an error. Where this data is from ?

CodyCBakerPhD commented 1 year ago

@samuelgarcia Default TDT and SpikeGadgets v1 both default to 'placeholder' gains in neo/SI

For the GUIDE support for those, we're therefore making the gains a required input as per this discussion