New Algorithm: RadiusSum

[Gesner Passos]

Sum of all the counts inside a ring against the scattering angle for each Radius.

Inputs:

• Centre - position of the centre of the ring (2 or 3 coordinates)
• MinRadius - distance between the centre and the inner circumference (default value = 0)
• MaxRadius - distance between the centre and the outer circumference (default value = min(width, height)) / 2
• NumBins - Number of slices to be taken. The total ring goes from MinRadio to MaxRadio, it will be sliced in NumBins rings, witdh equal to (MaxRadio-MinRadio)/NumBins
• NormalizeByRadius – Boolean flag that indicates if the Summing for each ring should be divided by the Radius powered by NormalizationOrder
• NormalizationOrder - – If 2, the normalization will be divided by the quadratic value of the ring for each radius.

For each pixel, the distance(pixel, centre) will be taken. If the distance(pixel,centre) is inside the interval [rMin,rMax] it is considered valid. Then, this distance will be used to define for which bin it belongs to. And each bin will accumulate the values.

[Gesner Passos]

Creation of the RadiusSum algorithm

just execution of class_maker

re #7829

Changeset: e04fb8bb9c40464f195cc7b466b12a9480d93c82

[Gesner Passos]

RadiusSum: Declaration of the options

Declare all the options for RadiusSum and use the setPropertiesSettings to allow the option NormalizationOrder to appear only when the NormalizeByRadius is selected.

re #7829

Changeset: 55129fb494714176b356b3f201ee4ce6781a81ba

[Gesner Passos]

RadiusSum cache properties values

re #7829

Changeset: 4300e4316a20642f80a8bced3f62d57a79832afa

[Gesner Passos]

Implementation of RingSum algorithm

re #7829

Changeset: cc6dae5355fe58bbefa16b248ab4ff6a8238a60c

[Gesner Passos]

Implement Normalize by Radius

Reorganize and document the code as well.

re #7829

Changeset: 1587db59514e7db7a7ec0a8100882ddc903a8362

[Gesner Passos]

Make some methods on RingProfileTest static to use in RadiusSumTest

re #7829

Changeset: 0b8044abc44b56e2f6787db8573dd261321471a7

[Gesner Passos]

Describe the RadiusSum tests

creation of the unit test for radius sum

re #7829

Changeset: 72fc89abaa2673d42b9931877e1d8e1fe507fb7e

[Gesner Passos]

RadiusSum unit test NormalizeByRadius

re #7829

Changeset: fb7087a1587683e6436963d79ffd45b7e6ccac01

[Gesner Passos]

Conflicts in AlgorithmCMakeList.txt:

Code/Mantid/Framework/Algorithms/CMakeLists.txt

Occurred due to the removal of deprecated algorithms.

re #7829

Changeset: a80b8f12ea6d90291e8f2bfbd5c19f4a67ddc606

[Gesner Passos]

RadiusSum include lacking file numeric

re #7829

Changeset: 355de3545ee81fc5d1d85ba88b1bb714f2b65833

[Gesner Passos]

Remove c++11 features not supported in all compilers

re #7829

Changeset: ba04f031e2f4356691f3594f7f4c031d2ce093d4

[Gesner Passos]

RadiusSum: include boost foreach

re #7829

Changeset: df3337bf44e79780455b5c422021cc1bb3e0b953

[Gesner Passos]

RadiusSumTest Remove c++11 not supported

re #7829

Changeset: b8ce744dc210178bf1e13dae53cec51e5149aafc

[Gesner Passos]

RadiusSumTest: change std::unique_ptr per boost::shared_ptr

Mac does not support std::unique_ptr (c++11)

re #7829

Changeset: b69ca5a6051c9ab2ef10aff690f07aa64fc2e20c

[Gesner Passos]

Executing this

config['default.instrument'] = 'SANS2D'
config['datasearch.directories'] += ';/archive/ndxsans2d/Instrument/data/cycle_13_2/'
ws = LoadNexus('19675')
ws = CropWorkspace(ws, EndWorkspaceIndex=36871)
out_from_instrument = RadiusSum(ws,(-0.05355, -0.16575, 23.281),0.001,0.6, 40,True,2)

result in a spectrum, whose axis X is marked as Time-of-flight...

Fix it.

[Gesner Passos]

Tester: this script exercises the application of RadiusSum in images.

ws_im = LoadNexus('19675_sans_2d.nxs')
out_from_image = RadiusSum(ws_im, (0,0), 0.05,0.22,40,NormalizeByRadius=True,NormalizationOrder=2)
out_from_image_n = RadiusSum(ws_im, (0,0), 0.05,0.22,40)

And this, in workspaces attached to instruments:

config['default.instrument'] = 'SANS2D'
config['datasearch.directories'] += ';/archive/ndxsans2d/Instrument/data/cycle_13_2/'
ws = LoadNexus('19675')
ws = CropWorkspace(ws, EndWorkspaceIndex=36871)
out_from_instrument = RadiusSum(ws,(-0.05355, -0.16575, 23.281),0.01,0.8, 100,True,2)
out_from_instrument_n = RadiusSum(ws,(-0.05355, -0.16575, 23.281),0.01,0.8, 100)

[Gesner Passos]

Precede the previous scripts with

config['default.instrument'] = 'SANS2D'

[Gesner Passos]

RadiusSum: Correct the unit for OutputWorkspace

It also add unit test for this feature.

re #7829

Changeset: df65506849065d7021b0d03f10adfc9d79285375

[Nick Draper]

Merge conflict in Algorithms/CMakeLists.txt

Please merge master into the branch and send for testing again

[Gesner Passos]

Merge remote-tracking branch 'origin/master' into re #7829

Conflicts:

Code/Mantid/Framework/Algorithms/CMakeLists.txt

Changeset: 6c8007ea01d32ebef74fa0d877140bfbc1d2b3bc

[Gesner Passos]

Merge branch 'feature/7829_radius_sum' into develop

Conflicts:

Code/Mantid/Framework/Algorithms/CMakeLists.txt

re #7829

Changeset: 88dd0e68c91e548a76f50e857a960f512bee4506

[Samuel Jackson]

Seems to work fine, but this fails a code inspection due to the algorithm having no wiki documentation. Fix and I'd be happy to verify.

[Gesner Passos]

re #7829: RadiusSum wiki documentation

Changeset: 03dcc41f0c0b36061636f953c0268b5200029c9b

[Gesner Passos]

Wiki page that will be created by wiki_maker.py

[Gesner Passos]

Tester:

Go to the link www.mantidproject.org/RadiusSum, and copy the content of RadiusSum.txt to our wiki, and select the preview, to see how the algorithm will be shown in the wiki after being parsed the the wiki_maker jenkins job.

[Samuel Jackson]

Merge remote-tracking branch 'origin/feature/7829_radius_sum'

Full changeset: ​f0b7cadc03b7922eb2a5f9d28797cba6dfa7bfe6

[Samuel Jackson]

Already tested algorithm and documentation now looks good.

[Stuart Campbell]

This ticket has been transferred to github issue ​8674