Review Calibration and extend documentation

[Gesner Passos]

Review the calibration procedure, make the documentation (so, scientist users could be able to use) and improve where is possible.

[Gesner Passos]

Tester:

plenty of things to be tested here:

• First of all check the documentation at wiki: http://www.mantidproject.org/Tube_Calibration, make sure you are happy with the description there.
• Open the tube.py file and read it all (sorry, but this ticket is to improve and document, you will have to read - it was worse for me, I had to write it :) ) The documentation fits better after parsing it with sphinx, but this is another ticket #7437
  • Make sure you agree with the new interface for the calibration and that it really simplifies or improves.
• Execute all the test examples. If you do not want to execute them all (I understand your concerns). Execute at least those inside: TubeCalibDemoMaps_All.py, TubeCalibDemoMerlin.py, TubeCalibDemoWish_Simple.py.
  • Make sure you are happy with the results.

[Gesner Passos]

Remove from ideal_tube cyclical dependence.

Take off from ideal_tube the constructIdealTubeFromRealTube in order to remove dependency on tube_calib and tube_calib_fit_params.

use numpy instead of math

re #7387

Changeset: ab0df6dea9755829abbeb5daa6b30b8f36bc3a5f

[Gesner Passos]

Conforming documentation to rest

small changes to conform documentation to rest.

For tube_calib_fit_params add an attribute that allows the fitting steps to guess the best parameters (automatic).

re #7387

Changeset: 90edebeb6b11083fe6de60c6fa29f2cacc07115f

[Gesner Passos]

Extension for the tube_calib module

It implements the described automatically guess for the fit parameters in the getPoints method.

Reimplement getPoints method.

Implement getCalibratedPixelPositions using vectorial mathematics.

Conform the documentation to the rest

Change some of the parameters of getCalibration:

• It does not deal with PeakFile but with PeakTable
• Make PlotTube a list of values instead of a single one.
• Remove some checkings, because it will be done at tube module.
• Add the constructIdealTubeFromRealTube, previously in ideal_tube.

re #7387

Changeset: 274834909b83bae6033c3eec8d990ff696402781

[Gesner Passos]

Provide a new interface for the calibration framework

This module will be the interface for the calibration framework. It provides internal documentation that will be make available on #7387.

It also provides a new interface with different arguments for the calibration, in order to not require any special knowlegde of internal objects to interact with the calibration.

So, now, it is possible to calibrate an instrument just providing the workspace, the name of the tubes to calibrate and the expected positions.

re #7387

Changeset: 02d98cedf77564d1e55e8c42d1ea42a44429341c

[Gesner Passos]

Translate some examples and improve documentation

Translate these examples to the new interface of calibration framework. It extends the previous example, providing the techiniques to explore the framework to calibrate, with a nice output, the three instruments MAPS, MERLIN, WISH.

re #7387

Changeset: 696710fcf3bf23bbf23de5f31f70ff415dc558c9

[Gesner Passos]

Simple translation of the previous example to the new interface

re #7387

Changeset: ff4dabf8e285258cf39ffbd25a39038480ed7f36

[Gesner Passos]

Remove from ideal_tube cyclical dependence.

Take off from ideal_tube the constructIdealTubeFromRealTube in order to remove dependency on tube_calib and tube_calib_fit_params.

use numpy instead of math

re #7387

Changeset: e6905151408e1cb7ddd603e82b559cdd461549cd

[Gesner Passos]

Conforming documentation to rest

small changes to conform documentation to rest.

For tube_calib_fit_params add an attribute that allows the fitting steps to guess the best parameters (automatic).

re #7387

Changeset: 939ecbd26014398bed30433adae97ac4f7379bae

[Gesner Passos]

Extension for the tube_calib module

It implements the described automatically guess for the fit parameters in the getPoints method.

Reimplement getPoints method.

Implement getCalibratedPixelPositions using vectorial mathematics.

Conform the documentation to the rest

Change some of the parameters of getCalibration:

• It does not deal with PeakFile but with PeakTable
• Make PlotTube a list of values instead of a single one.
• Remove some checkings, because it will be done at tube module.
• Add the constructIdealTubeFromRealTube, previously in ideal_tube.

re #7387

Changeset: 5070d7f7bb821c58764b8a3afb264ac34d7e55ec

[Gesner Passos]

Provide a new interface for the calibration framework

This module will be the interface for the calibration framework. It provides internal documentation that will be make available on #7387.

It also provides a new interface with different arguments for the calibration, in order to not require any special knowlegde of internal objects to interact with the calibration.

So, now, it is possible to calibrate an instrument just providing the workspace, the name of the tubes to calibrate and the expected positions.

re #7387

Changeset: 0ea0f8f47d3a43ae936ddaf50606c325d11e72aa

[Gesner Passos]

Translate some examples and improve documentation

Translate these examples to the new interface of calibration framework. It extends the previous example, providing the techiniques to explore the framework to calibrate, with a nice output, the three instruments MAPS, MERLIN, WISH.

re #7387

Changeset: c536378a5cce2c200d5a7433634f4a551bcfd18b

[Gesner Passos]

Simple translation of the previous example to the new interface

re #7387

Changeset: 7112a20c0a27144b7b381f8e6fb5a4c2fb1435cd

[Anders Markvardsen]

Merge remote-tracking branch 'origin/feature/7387_calibration_review'

[Anders Markvardsen]

Tested many of the example and code looks good. I may have a few more suggestions to the wiki doc, possibly. Will also see how this compares with doc python code once #7437 is passed

[Stuart Campbell]

This ticket has been transferred to github issue ​8233