Skip to content

Commit

Permalink
Re #6709 load algotithm added as a no sig section
Browse files Browse the repository at this point in the history
  • Loading branch information
NickDraper committed Mar 15, 2013
1 parent 4a06128 commit d1afc81
Showing 1 changed file with 3 additions and 8 deletions.
11 changes: 3 additions & 8 deletions Code/Mantid/Framework/DataHandling/src/Load.cpp
Original file line number Diff line number Diff line change
@@ -1,16 +1,14 @@
/*WIKI*
The Load algorithm is a more intelligent algorithm than most other load algorithms. When passed a filename it attempts to search the existing load [[:Category:Algorithms|algorithms]] and find the most appropriate to load the given file. The specific load algorithm is then run as a child algorithm with the exception that it logs messages to the Mantid logger.
==== Specific Load Algorithm Properties ====
Each specific loader will have its own properties that are appropriate to it: SpectrumMin and SpectrumMax for ISIS RAW/NeXuS, FilterByTof_Min and FilterByTof_Max for Event data. The Load algorithm cannot know about these properties until it has been told the filename and found the correct loader. Once this has happened the properties of the specific Load algorithm are redeclared on to that copy of Load.
== Usage ==
*WIKI*/
/*WIKI_USAGE_NO_SIGNATURE*
==== Python ====
Given the variable number and types of possible arguments that Load can take, its simple Python function cannot just list the properties as arguments like the others do. Instead the Python function <code>Load</code> can handle any number of arguments. The OutputWorkspace and Filename arguments are the exceptions in that they are always checked for. A snippet regarding usage from the <code>help(Load)</code> is shown below
<div style="border:1pt dashed blue; background:#f9f9f9;padding: 1em 0;">
<source lang="python">
Expand All @@ -26,13 +24,10 @@ Load('INSTR_1000_event.nxs', OutputWorkspace='event_ws', Precount=True)
# A mix of keyword and non-keyword is also possible
Load(OutputWorkspace='event_ws', Filename='INSTR_1000_event.nxs', Precount=True)
</source></div>
==== Loading Multiple Files ====
Loading multiple files is also possible with <code>Load</code>, as well as workspace addition. For more information, see [[MultiFileLoading]].
*WIKI*/
*WIKI_USAGE_NO_SIGNATURE*/
//----------------------------------------------------------------------
// Includes
//----------------------------------------------------------------------
Expand Down

0 comments on commit d1afc81

Please sign in to comment.