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

Provide more extensive documentation #476

Open
1 of 4 tasks
zain-sohail opened this issue Jul 16, 2024 · 1 comment
Open
1 of 4 tasks

Provide more extensive documentation #476

zain-sohail opened this issue Jul 16, 2024 · 1 comment

Comments

@zain-sohail
Copy link
Member

zain-sohail commented Jul 16, 2024

We start with #474 to use a different theme. This allows very easy way to write docs in markdown (is also currently supported but doesn't format as nicely).

Todos:

  • Move the dataset module guide from api to user guide
  • Provide an IO user guide (For example, sed.io provides a very easy way to save and load binned data in hdf5, which can then be further used)
  • Guide to calibration inner workings (can use Energy calibration bias shift #411 description for energy)
  • Add more here
@rettigl
Copy link
Member

rettigl commented Jul 16, 2024

Some text for energy calibration description:

Generally, the calibration estimates the functional form Energy(TOF), based on the TOF values for a given feature at different energies (bias voltages). This is being done either by nonlinear least-squares fitting, or an analytic solution of a polynomial approximation.
As the energy values provided are Bias voltages, and not directly related to the energy scale to be calibrated, this leaves a constant energy offset free to be determined. The old method allowed to define a specific "reference trace", i.e. a specific bias voltage, and the energy of the reference feature at that particular bias voltage. Ideally, this should have been the bias voltage of the actual measurement, or a corresponding additional shift needed to be applied.
The new approach is to shift the calibration by the bias voltage of the calibration (here, any one can be used, per default the first. Hence no need for ref_id anymore.), i.e. to calculate the energy scale at 0V bias voltage. When applying the energy axis, now the actual bias voltage of the measurement is being added, to obtain the correct energy scale.

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

No branches or pull requests

2 participants