Ticket #10595 (closed: fixed)
LoadNexusMonitors doc is outdated
Reported by: | Federico M Pouzols | Owned by: | Federico M Pouzols |
---|---|---|---|
Priority: | major | Milestone: | Release 3.3 |
Component: | Documentation | Keywords: | |
Cc: | Blocked By: | #8990 | |
Blocking: | Tester: | Nick Draper |
Description
http://docs.mantidproject.org/nightly/algorithms/LoadNexusMonitors-v1.html says for example that "loads all monitors found in a NeXus file into a single Workspace2D" while in actuality it has the capability to load both event and non event workspaces. What it presently does is to create an EventWorkspace if the input file has event monitor data.
Also, "entry is assumed to be in SNS format" may be outdated, as this algorithm is also being used from LoadEventNexus.
This is related to #8990 which I'm working on now. At the moment it looks like fixing that ticket will require a new property in LoadNexusMonitors.
Change History
comment:2 Changed 6 years ago by Federico Montesino Pouzols
update, loads Workspace2d and EventWorkspace, SNS and ISIS, re #10595
Changeset: 1905e21ac63dff05be900dacbf9d079a945b549c
comment:3 Changed 6 years ago by Federico M Pouzols
This seems to be updated enough for now. Waiting to see that all is well with #8990 before passing this one to the testing pool.
comment:6 Changed 6 years ago by Federico M Pouzols
- Status changed from inprogress to verify
- Resolution set to fixed
The description of the algorithm has been brought a bit more up to date. It definitely can load histogram data and ISIS files, as verified when fixing #8990.
More work to harmonize and clarify a number of issues in LoadEventNexus, LoadNexusMonitors, etc continues in #10619, but there are a few obscure points and that won't be ready in time for 3.3.
comment:7 Changed 6 years ago by Nick Draper
- Status changed from verify to verifying
- Tester set to Nick Draper
comment:8 Changed 6 years ago by Nick Draper
- Status changed from verifying to closed
Merge remote-tracking branch 'origin/feature/10595_LoadNexusMonitors_doc_update'
Full changeset: 348a3a4b574bc1c7620ddbe1b22fce65f82b1291