Skip to content

Commit

Permalink
Update wiki re #4464
Browse files Browse the repository at this point in the history
Signed-off-by: Karl Palmen <karl.palmen@stfc.ac.uk>
  • Loading branch information
KarlPalmen committed Aug 6, 2013
1 parent a6896e8 commit 5641029
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 8 deletions.
6 changes: 2 additions & 4 deletions Code/Mantid/Framework/DataHandling/src/LoadAscii.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -6,15 +6,13 @@ By default the algorithm attempts to guess which lines are header lines by tryin
The format can be one of:
* Two columns: 1st column=X, 2nd column=Y, E=0
* For a workspace of ''n'' spectra, 2''n''+1 columns: 1''st'' column=X, 2i''th'' column=Y, 2i+1''th'' column =E
* Four columns: 1st column=X, 2nd column=Y, 3rd column=E, 4th column=DX (X error)
* For a workspace of ''n'' spectra, 2''n''+1 columns: 1''st'' column=X, 2i''th'' column=Y, 2i+1''th'' column =E.
* For a workspace of ''n'' spectra, 2''n''+2 columns: 1''st'' column=X, 2i''th'' column=Y, 2i+1''th'' column =E and column=DX (X error) as last column.
The number of bins is defined by the number of rows.
The resulting workspace will have common X binning for all spectra.
This algorithm cannot load a file created by [[SaveAscii]] if it has X errors written and several spectra.
*WIKI*/
//----------------------------------------------------------------------
Expand Down
11 changes: 7 additions & 4 deletions Code/Mantid/Framework/DataHandling/src/SaveAscii.cpp
Original file line number Diff line number Diff line change
@@ -1,9 +1,12 @@
/*WIKI*
The workspace data are stored in the file in columns: the first column contains the X-values, followed by pairs of Y and E values. Columns are separated by commas. The resulting file can normally be loaded into a workspace by the [[LoadAscii]] algorithm.
The workspace data are stored in the file in columns: the first column contains the X-values, followed by pairs of Y and E values.
If requested, the last column will contain X errors.
Columns are separated by commas. The resulting file can normally be loaded into a workspace by the [[LoadAscii]] algorithm.
==== Limitations ====
The algorithm assumes that the workspace has common X values for all spectra (i.e. is not a [[Ragged Workspace|ragged workspace]]). Only the X values from the first spectrum in the workspace are saved out.
The algorithm assumes that the workspace has common X values for all spectra (i.e. is not a [[Ragged Workspace|ragged workspace]]).
Only the X values from the first spectrum in the workspace are saved out.
*WIKI*/
//----------------------------------------------------------------------
Expand Down Expand Up @@ -66,7 +69,7 @@ namespace Mantid
declareProperty("WorkspaceIndexMax", EMPTY_INT(), mustBePositive,"The ending workspace index.");
declareProperty(new ArrayProperty<int>("SpectrumList"),"List of workspace indices to save.");
declareProperty("Precision", EMPTY_INT(), mustBePositive,"Precision of output double values.");
declareProperty("WriteXError", false, "If true, the error on X will be written as the fourth column.");
declareProperty("WriteXError", false, "If true, the error on X will be written as the last column.");

declareProperty("CommentIndicator", "", "Character(s) to put in front of comment lines.");

Expand All @@ -82,7 +85,7 @@ namespace Mantid
}

declareProperty("Separator", "CSV", boost::make_shared<StringListValidator>(sepOptions),
"Character(s) to put as separator between X, Y, E values.");
"Character(s) to put as separator between the columns.");

declareProperty(new PropertyWithValue<std::string>("CustomSeparator", "", Direction::Input),
"If present, will override any specified choice given to Separator.");
Expand Down

0 comments on commit 5641029

Please sign in to comment.