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.

Sign up for GitHub

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

Jump to bottom

No documentation of CrystFEL columns #231

Open
kmdalton opened this issue Nov 9, 2023 · 1 comment
Open

No documentation of CrystFEL columns #231

kmdalton opened this issue Nov 9, 2023 · 1 comment
Labels
documentation Issue related to documentation good first issue Good for newcomers

Comments

@kmdalton
Copy link
Member

kmdalton commented Nov 9, 2023

The docstring for rs.read_crystfeldoesn't say anything about the columns in the dataset which it returns. I suggest the following descriptions as a start:

  • XDET,YDET : internal detector panel coordinates
  • s1x,s1y,s1z : scattered beam wavevector which points from the sample to the bragg peak
  • I, SigI : intensity, uncertainty
  • ewald_offset, angular_ewald_offset : the distance in cartesian space in reciprocal angstroms or polar coordinates in degrees between the observed reflection and the ewald sphere
  • BATCH : the image number
@kmdalton kmdalton added the good first issue Good for newcomers label Nov 9, 2023
@JBGreisman JBGreisman added the documentation Issue related to documentation label Nov 11, 2023
@JBGreisman
Copy link
Member

@kmdalton Do you think it makes sense to incorporate this into #216 because it already includes planned updates to the implementation?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Issue related to documentation good first issue Good for newcomers
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@kmdalton @JBGreisman