feat/docs #27
Merged
feat/docs #27
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
dimitri-yatsenko
requested changes
Oct 9, 2025
| # 2. Estimate parameters | ||
| params = compute_sensitivity(movie) | ||
| print(f"Estimated parameters:") | ||
| print(f" Conversion gain: {params['sensitivity']:.3f} ADU/photon") |
| params = compute_sensitivity(movie) | ||
| print(f"Estimated parameters:") | ||
| print(f" Conversion gain: {params['sensitivity']:.3f} ADU/photon") | ||
| print(f" Zero level: {params['zero_level']:.1f} ADU") |
|
|
||
| ```python | ||
| # If you know electrons per ADU: | ||
| electrons_per_adu = 2.5 # From camera spec sheet |
There was a problem hiding this comment.
Suggested change
| electrons_per_adu = 2.5 # From camera spec sheet | |
| photons_per_unit = 2.5 # From camera spec sheet |
| ```python | ||
| # If you know electrons per ADU: | ||
| electrons_per_adu = 2.5 # From camera spec sheet | ||
| quantum_efficiency = 0.9 # Photons to electrons conversion |
There was a problem hiding this comment.
quantum efficiency is not photons to electron conversion. This is a highly technical issue and we should just refer to the appropriate literature, like our Nature Protocols paper for example.
| electrons_per_adu = 2.5 # From camera spec sheet | ||
| quantum_efficiency = 0.9 # Photons to electrons conversion | ||
|
|
||
| conversion_gain = electrons_per_adu / quantum_efficiency |
There was a problem hiding this comment.
conversion_gain does not relate to electrons. It describes the increase in the measured signal (in digital units) per detected photon. This does not depend on quantum efficiency.
Merged
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Continues #22 by adding docs using mkdocs-material
Also updates docstrings to numpy style.
Adds a github action to deploy the docs to github pages.