Fix for instrument view axes orientation.

[dmitry-ganyushin]

Description of work

8875: [MANTID] The display of BIOSANS "detector1" in Mantid's instrument-viewer has an incorrect orientation

• When viewing the instrument, if we select tab "instrument" then component "detector1", [the component is show with the horizontal axis (X) along the vertical]

Summary of work

The function which calculates 3D projections of instrument components was modified.

Further detail of work

To test:

Open a run file, select tab "Instrument" , and "detector1". The Y-axis should point up.

---

Reviewer

Please comment on the points listed below (full description).
Your comments will be used as part of the gatekeeper process, so please comment clearly on what you have checked during your review. If changes are made to the PR during the review process then your final comment will be the most important for gatekeepers. In this comment you should make it clear why any earlier review is still valid, or confirm that all requested changes have been addressed.

Code Review

• Is the code of an acceptable quality?
• Does the code conform to the coding standards?
• Are the unit tests small and test the class in isolation?
• If there is GUI work does it follow the GUI standards?
• If there are changes in the release notes then do they describe the changes appropriately?
• Do the release notes conform to the release notes guide?

Functional Tests

• Do changes function as described? Add comments below that describe the tests performed?
• Do the changes handle unexpected situations, e.g. bad input?
• Has the relevant (user and developer) documentation been added/updated?

Does everything look good? Mark the review as Approve. A member of @mantidproject/gatekeepers will take care of it.

Gatekeeper

If you need to request changes to a PR then please add a comment and set the review status to "Request changes". This will stop the PR from showing up in the list for other gatekeepers.

[jclarkeSTFC]

I think this will change the orientation for every instrument, are they all wrong, or just BIOSANS?

[peterfpeterson]

Would it be more robust to use the instrument's defaults/reference-frame/pointing-up#axis field (BIOSANS example)? I admit that only POLREF doesn't choose y, but it looks like it is supposed to be configurable.

[peterfpeterson]

I'm surprised that the Instrument::getReferenceFrame() doesn't come into play here. I don't see how one accesses it from the Project3D either

[dmitry-ganyushin]

That changes only the "Instrument"-->"detector1" view and "Instrument"-->"detector1"-->"bank" view
The "Instrument" view is not affected.
For BIOSANS:
"detector1" view current:

"detector1" view proposed:

Banks view current:

Banks view proposed:

For EQSANS
"detector1" view current:

"detector1" proposed view:

Banks view current:

Banks view proposed:

[jclarkeSTFC]

This changes how every instrument looks on that tab, e.g. here's MARI:

[dmitry-ganyushin]

Thanks, can I obtain somehow your file for testing?

[jclarkeSTFC]

You can run LoadEmptyInstrument with InstrumentName="MARI", but all the instruments will be affected, I only used MARI as an example because that happened to be the last file I loaded in Workbench.

[dmitry-ganyushin]

Thanks. I assume the second image is the current implementation. The green axis on the first image points up as in all other (fixed) situations.

[dmitry-ganyushin]

And your main instrument view has also the green axis up

The view is changed, but now have all views more consistent with Y axis up

[RichardWaiteSTFC]

I may not have all the background to this, but I agree with @peterfpeterson that the best solution that is general for all instrument is to use the reference frame in the IDF?

There are instances like here

mantid/Framework/Algorithms/src/BeamProfileFactory.cpp

Line 50 in 864d61e

const double beamHeight = 2 * bboxCentre[frame->pointingUp()] + bbox[frame->pointingUp()];

where

 const auto frame = instrument.getReferenceFrame();

But is the problem that you don't have access to the instrument?

[RichardWaiteSTFC]

I note there are couple of other places in the code where a direction for vertical is hard-coded e.g.

mantid/Framework/Crystal/src/SaveIsawPeaks.cpp

Line 259 in 864d61e

V3D up = findPixelPos(bankName, midX, midY + 1) - findPixelPos(bankName, midX, midY);

mantid/Framework/DataHandling/src/SaveIsawDetCal.cpp

Line 186 in 864d61e

V3D up = findPixelPos(bankName, midX, midY + 1) - findPixelPos(bankName, midX, midY);

mantid/Framework/Algorithms/src/DiffractionEventCalibrateDetectors.cpp

Line 494 in 864d61e

Kernel::V3D Up = V3D(upX, upY, upZ) + CalCenter;

[sf1919]

The release note structure for v6.13 has been created. You can now rebase your branch and move the release note in this PR.