Ticket #10965 (closed: fixed)
Improve and update LoadFITS documentation
| Reported by: | Federico M Pouzols | Owned by: | Federico M Pouzols |
|---|---|---|---|
| Priority: | major | Milestone: | Release 3.4 |
| Component: | Documentation | Keywords: | |
| Cc: | Blocked By: | ||
| Blocking: | Tester: | Michael Wedel |
Description
This algorithm was created in #10061 and #10383. Its documentation: http://docs.mantidproject.org/nightly/algorithms/LoadFITS-v1.html
will need several updates. Work still needed on this FITS loader includes changing several headers (#10231) and possibly adding support for different formats. The documentation is also a bit sparse at present.
It should be improved in the following respects, among other things:
- Explain better how the data is loaded into workspaces (groups, MatrixWorkspace, etc.)
- Explain also the specificities of this implementation (variants of FITS supported, possible limitations, special headers supported, etc.)
- Headers that are required, recommended, etc. and their intended usage.
Change History
comment:1 Changed 6 years ago by Federico M Pouzols
- Summary changed from Improve and update LoadFits documentation to Improve and update LoadFITS documentation
comment:3 Changed 6 years ago by Federico Montesino Pouzols
- Status changed from assigned to inprogress
clarify current role of IMAGEKEY, re #10965
Changeset: 06bcb8c53a414a89833d51281f4c192a11bc5868
comment:4 Changed 6 years ago by Federico Montesino Pouzols
proper description of alg + simple doc test, re #10965
Changeset: 85bfb6fb7a5d7d8fc7d78441968ef8c98fc9ce84
comment:5 Changed 6 years ago by Federico Montesino Pouzols
a bit more of info about FITS and headers, re #10965
Changeset: 1977676235d5409d9ff41b5182f32fe5586ecdb5
comment:6 Changed 6 years ago by Federico M Pouzols
We can go ahead with the doc improvements, #10231 will then kill some of the input arguments listed/supported at present.
comment:8 Changed 6 years ago by Federico Montesino Pouzols
simplify doc text, use default=0 for ImageKey, re #10965
Changeset: a27f41b3e946eeb544dfca78cfc50580cd442f09
comment:9 Changed 6 years ago by Federico Montesino Pouzols
- Status changed from inprogress to verify
- Resolution set to fixed
This is being verified as pull request #471.
comment:10 Changed 6 years ago by Federico Montesino Pouzols
Jenkins, retest this please
comment:11 Changed 6 years ago by Federico Montesino Pouzols
fix workspace obj name in doc test, re #10965
Changeset: 5ebb5471a7e775c38d6d7b9cb6100b16622e8a05
comment:12 Changed 6 years ago by Federico Montesino Pouzols
clarify text, link WorkspaceGroup and fix ws in test, re #10965
Changeset: 9f10aff09611a0b60e9fc94e8b1324fc63673afd
comment:13 Changed 6 years ago by Federico Montesino Pouzols
fix doc-test keeping _ prefix for FITS logs for now, re #10965
Changeset: afdce0c1cec894a04880841b040137f54f241226
comment:14 Changed 6 years ago by Federico Montesino Pouzols
Jenkins, retest this please
comment:15 Changed 6 years ago by Federico Montesino Pouzols
Jenkins, retest this please
comment:16 Changed 6 years ago by Federico Montesino Pouzols
Jenkins, retest this please
comment:17 Changed 6 years ago by Federico Montesino Pouzols
Jenkins, retest this please
comment:18 Changed 6 years ago by Federico Montesino Pouzols
Jenkins, retest this please
comment:19 Changed 6 years ago by Federico Montesino Pouzols
Jenkins, retest this please
comment:20 Changed 6 years ago by Michael Wedel
- Status changed from verify to verifying
- Tester set to Michael Wedel
comment:21 Changed 6 years ago by Michael Wedel
- Status changed from verifying to closed
Merge pull request #471 from mantidproject/feature/10965_improve_update_LoadFITS_alg_doc
The unit and doc tests for this algorithm pass, both on the build servers as well as locally. The documentation reads well, all the links are working. I did not know FITS at all, now it's clear what kind of data are loaded by the algorithm and what the output workspaces contain.
Full changeset: 43b73d0330fad09aeb2d9020dcaa71fa9b4d52d0
comment:22 Changed 5 years ago by Stuart Campbell
This ticket has been transferred to github issue 11804
