Polarized SANS metadata: refactor SaveNXcanSAS to support multiple variants of the algorithm #38503
Labels
ISIS Team: LSS
Issue and pull requests managed by the LSS subteam at ISIS
SANS
Issues and pull requests related to SANS
Milestone
Part of #36147. See the design and requirements documents that are linked on that issue for more context.
To support saving of polarized SANS data we will need to save all of the metadata that we currently include in the NXcanSAS file, plus a fairly long list of additional metadata that is specific to polarized experiments. We could add additional parameters to the
SaveNXcanSAS
algorithm in order to achieve this, however this makes the algorithm less easy to use for scientists who are saving non-polarized SANS data. It is also not a sustainable approach for the long-term if more SANS techniques were added that required their own metadata. We have therefore agreed that we will add a newSavePolarizedNXcanSAS
algorithm that will save the "standard" SANS NXcanSAS metadata plus the polarized SANS metadata.In order to support this, we need to refactor
SaveNXcanSAS
into a design that meets the following requirements:I've put together an initial suggestion that could be considered, but I'm sure could be improved!
Possible SaveNXcanSAS refactor.docx
Note that this issue is purely for the refactor of
SaveNXcanSAS
. The implementation of the newSavePolarizedNXcanSAS
will be done afterwards under a separate issue.The text was updated successfully, but these errors were encountered: