small updates for XPS peak fitting #301
Merged
Conversation
This file contains 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
lukaspie
force-pushed
the
small-xps-changes
branch
from
0b5a809
to
72930d5
Compare
sherjeelshabih
approved these changes
Nov 22, 2024
Comment on lines
+461
to
+474
| <doc> | ||
| Human-readable description of the background fit function. | ||
|
|
||
| .. csv-table:: Examples for background descriptions | ||
| :header: "Background Type", "Description" | ||
|
|
||
| "Linear", "Linear background, i.e., a simple straight line from the minimal to the maximal abscissa value." | ||
| "Shirley", "Shirley background. In the Shirley background, the background intensity at any given binding energy is proportional to the intensity of the total peak area above the background in the lower binding energy peak range (i.e., the background goes up in proportion to the total number of photoelectrons below its binding energy position)." | ||
| "Tougaard", "Tougaard background (or Tougaard universal cross-section approach) which is a methodology for integrating the intensity of the background at a given binding energy from the spectral intensities to higher kinetic energies." | ||
| "Step Down/Step Up", "Background function for fitting a complementary error function to an edge, used for fitting a step in the data." | ||
|
|
||
| In case none of these examples apply, the functional form of the background should be given by the `formula` | ||
| field. | ||
| </doc> |
There was a problem hiding this comment.
All the descriptions have been merged together. Wouldn't it be nice to keep the enemerations along with he merged description?
There was a problem hiding this comment.
The problem with the enum is that there can be too many different background types, so I relaxed it.
Comment on lines
+322
to
+327
| relative_atomic_concentration(NX_FLOAT): | ||
| exists: optional | ||
| unit: NX_ANY | ||
| doc: | | ||
| Atomic concentration of the species defined by this peak. This should be a value | ||
| between 0 and 1. |
There was a problem hiding this comment.
This is added but removed from nxdl.
There was a problem hiding this comment.
This is just placed at a different position (within NXpeak), also in the NXDL.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
This will then also have to be changed in nexusformat#1424