new add07 add compress instruments in sqw #752
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
cmarooney-stfc
added
the
documentation
abuts
reviewed
Nov 30, 2021
documentation/add/07-sqw_redesign.md
Outdated
Comment on lines
20
to
23
| 1. The object exists in two distinct forms: | ||
| - "SQW" which contains all experimental data and the detector pixel array, | ||
| - "DND" which contains only processed neutron image data | ||
|
|
There was a problem hiding this comment.
I believe, it should be rewritten as
- "DND" which contains processed neutron image data
- "SQW" -- everything DND object contains plus all experimental data, the detector pixel array and all relevant data describing the experiment.
There was a problem hiding this comment.
Done - see commit 10.01.22
documentation/add/07-sqw_redesign.md
Outdated
| - "SQW" which contains all experimental data and the detector pixel array, | ||
| - "DND" which contains only processed neutron image data | ||
|
|
||
| While conceptually these two forms remain distinct, over time the interdependence of their implementations has grown, and to support further development of the object it is desirable to refactor the objects to remove such interdependence. |
There was a problem hiding this comment.
not sure this makes sense. one form fully contains another and brings more. But these words may mean something too.
There was a problem hiding this comment.
Text rewritten to emphasize that the data differences are clearly as described - one form does contain the other - but the functional implementations required revision which has now been done.. See commit 10.01.22
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.
The design document add/07-sqw-redesign provided details on how the new sqw object should be constructed, but did not describe the rationale for this, which is to compress the number of instruments etc down from one per run per cut (counting the original sqw object as cut-#0) to a list of unique objects for which each run has an index to the list, and where cuts have list copies which do not duplicate memory through the copy-on-write mechanism.
This extension to the document adds this rationale and provides sketches of workflows where the instruments can be inserted to prevent duplications of unique instruments. Samples etc will be handled in the same way