Ticket #2459 (closed: fixed)
Improve formatting of help on algorithms in python
Reported by: | Nick Draper | Owned by: | Martyn Gigg |
---|---|---|---|
Priority: | major | Milestone: | Iteration 27 |
Component: | Mantid | Keywords: | |
Cc: | Blocked By: | ||
Blocking: | Tester: | Owen Arnold |
Description (last modified by Nick Draper) (diff)
LoadSNSEventNexus(Filename, OutputWorkspace, FilterByTofMin=None, FilterByTofMax=None, FilterByTimeStart=None, FilterByTimeStop=None, BankName=None, SingleBankPixelsOnly=None, LoadMonitors=None, Precount=None, execute=True) Loads a SNS EventNeXus format file. Optionally, you can filter out events falling outside a range of times-of-flight and/or a time interval. Filename(Input:req) *string* The name (including its full or relative path) of the Nexus file to attempt to load. The file extension must either be .nxs or .NXS [.nxs] OutputWorkspace(Output:req) *class boost::shared_ptr<class Mantid::API::IEventWorkspace>* The name of the output EventWorkspace in which to load the EventNexus file. FilterByTofMin(Input) *number* Optional: To exclude events that do not fall within a range of times-of-flight. This is the minimum accepted value in microseconds. FilterByTofMax(Input) *number* Optional: To exclude events that do not fall within a range of times-of-flight. This is the maximum accepted value in microseconds. FilterByTimeStart(Input) *number* Optional: To only include events after the provided start time, in seconds (relative to the start of the run). FilterByTimeStop(Input) *number* Optional: To only include events before the provided stop time, in seconds (relative to the start of the run). BankName(Input) *string* Optional: To only include events from one bank. Any bank whose name does not match the given string will have no events. SingleBankPixelsOnly(Input) *boolean* Optional: Only applies if you specified a single bank to load with BankName. Only pixels in the specified bank will be created if true; all of the instrument's pixels will be created otherwise. LoadMonitors(Input) *boolean* Load the monitors from the file (optional, default False). Precount(Input) *boolean* Pre-count the number of events in each pixel before allocating memory (optional, default False). This can significantly reduce memory use and memory fragmentation; it may also speed up loading.
Change History
comment:1 Changed 10 years ago by Nick Draper
- Status changed from new to assigned
- Owner set to Martyn Gigg
- Description modified (diff)
- Milestone changed from Iteration 28 to Iteration 27
comment:3 Changed 10 years ago by Martyn Gigg
- Status changed from accepted to verify
- Resolution set to fixed
Note: See
TracTickets for help on using
tickets.