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

Documentation for voxel grid and event sim functionality #3239

Merged
merged 9 commits into from
Mar 4, 2021

Conversation

saihv
Copy link
Contributor

@saihv saihv commented Dec 22, 2020

About

Some documentation on the internal working, as well as how to use the corresponding API of the new features: voxel grid construction and event camera simulation.

Copy link
Collaborator

@jonyMarino jonyMarino left a comment

Choose a reason for hiding this comment

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

Minor things.
I still need to review the voxel grid doc.
Thanks for this contribution!

docs/event_sim.md Outdated Show resolved Hide resolved
docs/event_sim.md Outdated Show resolved Hide resolved
docs/event_sim.md Show resolved Hide resolved
The working of the event simulator loosely follows this set of operations:
1. Take the difference between the log intensities of the current and previous frames.
2. Iterating over all pixels, calculate the polarity for each each pixel based on a threshold of change in log intensity.
3. Determine the number of events to be fired per pixel, based on extent of intensity change over the threshold. Let $N_{max}$ be the maximum number of events that can occur at a single pixel, then the total number of firings to be simulated at pixel location $u$ would be $N_e(u) = min(N_{max}, \frac{\Delta L(u)}{TOL})$.
Copy link
Collaborator

Choose a reason for hiding this comment

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

How can I test if the formulas are going to be rendered well? Running mkdocs?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

This I am not entirely sure about. Markdown preview works fine for me in VS code. Are there any other docs that have used latex formulae?

Copy link
Contributor

@zimmy87 zimmy87 left a comment

Choose a reason for hiding this comment

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

the voxel grid section looks good to me apart from a few nitpick items

docs/voxel_grid.md Outdated Show resolved Hide resolved
docs/voxel_grid.md Outdated Show resolved Hide resolved
docs/voxel_grid.md Outdated Show resolved Hide resolved
@rajat2004
Copy link
Contributor

The files need to be added to mkdocs.yml as well for them to appear on the site

@jonyMarino jonyMarino merged commit 9fc8b36 into microsoft:master Mar 4, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants