mantidproject / mantid

Main repository for Mantid code
https://www.mantidproject.org
GNU General Public License v3.0
211 stars 124 forks source link

- Maintenance task for polarization correction Fredrikze Algorithm #38400

Closed yusufjimoh closed 1 week ago

yusufjimoh commented 1 week ago

Description of work

Move the PNR_LABEL and PA_LABEL constants out of the Prop namespace Rename some constants to use mantid naming convention updated documentation

One of the items in the referenced issue—replacing 'p' and 'a' with the constants SpinStateConfigurationsFredrikze::PARA and SpinStateConfigurationsFredrikze::ANTI in the creation of spinStateValidator using std::make_shared<SpinStateValidator>(std::unordered_set<int>{2, 4}, true, 'p', 'a', true);—could not be completed. This is because SpinStateValidator requires characters as inputs, but both constants are of type std::string. Additionally, these constants are used elsewhere in the code, making it difficult to change their type to characters.

Refs #38288

To test:

Follow the instructions on https://docs.mantidproject.org/nightly/algorithms/PolarizationCorrectionFredrikze-v1.html unit tests should pass

*This does not require release notes because it is a maintenance task involving code changes