LoadVTK Docs

[Owen Arnold]

Documentation is not helpful enough, and this algorithm will be used by scientists outside of the usual facilities.

• Summary documentation required
• Explanation of different modes in description, as well as the current binary layout expected
• Pros and cons of setting AdaptiveBinned On/Off
• Custom usage example
• Better property documentation required

[Owen Arnold]

refs #7305. Add docs for usage, description, summary and props.

Also move memory check into MDHisto routine, where it belongs. Memory check is based on a predictive MDHistoWorkspace size, so gives false results for MDEventWorkspaces. Also switched AdaptiveBinned property default to on, since this is the preferred loading route.

Changeset: c462ea069b28206bece5bf65d4c654a3c26a9476

[Owen Arnold]

Tester: There have been some minor code changes, but it would make sense to retest these features using the fly.vtk file (available on request or on Babylon5, see #7252). Unit tests should all be running properly, as these have changed. The main thing to test is that the online documentation http://www.mantidproject.org/LoadVTK is consistent with the LoadVTK algorithm.

[Michael Reuter]

Everything seems to be in order here and looks good.

[Stuart Campbell]

This ticket has been transferred to github issue ​8151