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

Improved Documentation for COR and Tilt Usage #2459

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

ashleymeigh2
Copy link
Collaborator

Issue

Closes #2359

Description

While some improvements were already made to the documentation (see issue #2414), not all questions from the issue were fully addressed. This PR extends the improvements to ensure all questions are fully resolved:

Specifically:

What COR and Tilt do exactly:
Already explained as COR ensures alignment, and Tilt adjusts COR linearly across slices.
No changes were needed, as these sections were clear.

What order should I apply them?
Previously outlined that Tilt depends on COR of slice 0 but did not emphasize the sequence.
Added a new "Order" subsection to clarify the sequence: determine COR for slice 0 first, then apply Tilt.

What does refining do?
Already detailed as a manual process to improve accuracy, especially for noisy data.
No changes were made, as this section was comprehensive.

Examples?
Added practical tips subsection

@ashleymeigh2 ashleymeigh2 self-assigned this Jan 21, 2025
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.

Documentation: Improve COR and Tilt Usage Descriptions
2 participants