New Algorithm: RingProfile

[Gesner Passos]

Sum of the counts against a ring (or circumference)

Inputs:

• Centre
• MinRadius
• MaxRadius
• NumBins
• StartAngle
• Sense

[Gesner Passos]

Creation of the RingProfile algorithm

just execution of class_maker

re #7776

Changeset: 6613938bf19cbedc49eaee5c48a44ad9bcdc23a8

[Gesner Passos]

Implementation of the RingProfile Algorithm

This commit adress the creation of the unit test and the implementation of the algorithm as well.

re #7776

Changeset: 61e8c9229db64213df08ad28b637a849707df866

[Gesner Passos]

Add progress report to algorithm RingProfile

re #7776

Changeset: b97ed3abb02be507484e09d723175332dc9e8d1c

[Gesner Passos]

Change the way to get the limit positions from workspace

Before, it tried to use the getBoundingBox from the instrument. But, if there were no sample attached to the workspace, a segmentation fault was triggered.

Now, it will try to get the limits of the position from the detectors, by querying the first available detector and the last one, and from their position guess the region defined by the instrument.

re #7776

Changeset: 6ccd6c5c1cd15f97744e41e211ac07c685ec0832

[Gesner Passos]

Requirement Change for the output angles in RingProfile

Before, it was said that the angles in ringprofile would be the real angle from the 3d space, but this cause the other mantidplot things to break, as they are not expecting the horizontal axis to sank.

To avoid this, the requirement was changed to say that the degrees are always relative to the ring itself, which means, it will always be:

angle = i*360/NumBins

re #7776

Changeset: e52c02843b24bcafc704e89de3ae619e5ab9f37d

[Gesner Passos]

Tester:

In order to help testing this ticket I've uploaded two scripts: create_rings.py and ring_image.py. Both, create workspaces that are rings around a center, and them, apply the RingProfile to small rings and concatenate the answers to cover the whole image. At the end, it creates a ring_alls workspace. Each spectrum of this workspace represents the result of RingProfile for a specific ring inside the image.

Run these scripts, change the inputs, and options. And check that they are as 'one would expect'.

I will have to create a similar algorithm, so, feedback on the code review and how to better organize it is really welcome.

[Owen Arnold]

This has been really well done. The documentation for this algorithm is excellent. The use of ASCII art to demonstrate the test setups is also highly useful. My one minor point would be that the X-axis label of "Scattering Angle" is wrong and will be misleading to the users.

[Owen Arnold]

Reopen so that axis label can be changed. I suggest that "Ring Angle" might be a better name than "Scattering Angle"

[Gesner Passos]

Change the unit of RingProfile

re #7776

Changeset: ed597edfd59e5a0847425ad6f4084debc014aebc

[Gesner Passos]

There are some doxygen warnings to be dealt with

​http://download.mantidproject.org/jenkins/job/is_doxygen_develop/lastBuild/warnings11Result/file.1207707663/

c++ check ​http://download.mantidproject.org/jenkins/view/All/job/isis_cppcheck/3677/cppcheckResult/?

[Gesner Passos]

Correct the doxygen warnings for RingProfile

re #7776

Changeset: a6f99ff6ba66723d07e03bf7625aa6d8d47a8c56

[Gesner Passos]

Deal with cpp check related to RingProfile

There were 3 groups of warnings:

1 - scope variable of xpos, diffx, distance in the line 563. This warning was ignored, as putting these variables inside the scope (inside the loop) would be worse. 2 - unsignedLessThanZero - variable i in line 276. Corrected 3 - unreadVariable - x\y\zOutside unused line 324. Corrected.

re #7776

Changeset: c30f32d35a10f4ae6a01161b9f47149c1a8f1f87

[Gesner Passos]

I checked that the doxygen warnings wave gone. But, the cppcheck is applied to the master branch. So, I can not check if they will disappear. The tester will have to do a code review of the commit in comment:17. We will afterwards check the result of the cppcheck in the master branch.

[Stuart Campbell]

This ticket has been transferred to github issue ​8621