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.

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

Improve description of neuropixels calibration files #215

Merged
merged 2 commits into from
Aug 20, 2024
Merged

Conversation

jonnew
Copy link
Member

@jonnew jonnew commented Aug 14, 2024

- More explaination
- More emphasis on their importance
- Path to getting a new one if yours is lost
@jonnew jonnew requested a review from cjsha August 14, 2024 21:43
Copy link
Member

@cjsha cjsha left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

typo

"contains a gain adjustments". Change to "contains gain adjustments" or "contains a gain adjustment"

Other comments/suggestions

The rest of this comment is nitpicks. I don't feel strongly about anything below so feel free to pick and choose what looks good to you and merge.

Though it's sorta implied in your text already, it might be worth explaining this explicitly:

Calibration files are probe-specific and not interchangeable across probes. Calibration file names must contain the serial number of the corresponding probe and should not be changed from the factory-given name to avoid confusion.

You have:

Electrode voltages are scaled using these values to ensure they can be accurately compared across probes. Therefore, using the correct gain calibration file is mandatory to create standardized recordings.

I suggest something like:

Using the correct calibration file is mandatory for Neuropixels to take calibrated measurements and be able to produce useful/meaningful data.

^ I think my text above is more emphatic about setting the correct calibration file. However, it lacks some under-the-hood explanation that your text has.

My preference is to remove the stricken out text:

If you have lost track of the gain calibration file for your probe, you can email IMEC at neuropixels.info@imec.be with the probe serial number to retrieve a new copy.

I didn't comment with line numbers bc these things I brought up repeat on a few different lines

- Improve clarity of neuropixesl calibration file descriptions
@jonnew
Copy link
Member Author

jonnew commented Aug 15, 2024

Addressed these in the latest commit. Accepted most. Disregarded "useful/meaningful" versus "standardized" for gain calibration because later is actually the case.

@jonnew jonnew merged commit 13f7262 into main Aug 20, 2024
6 checks passed
@jonnew jonnew deleted the issue-200 branch August 20, 2024 17:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

More information on ADC calibration files and gain calibration files for NP headstages
2 participants