Skip to content

Commit

Permalink
Refs #10891. Finished improving the documentation.
Browse files Browse the repository at this point in the history
On branch feature/10891_ExportSampleLogs_Doc
-	modified:   ExportSampleLogsToCSVFile-v1.rst
  • Loading branch information
wdzhou committed Mar 3, 2015
1 parent df246fa commit 7312528
Showing 1 changed file with 40 additions and 16 deletions.
56 changes: 40 additions & 16 deletions Code/Mantid/docs/source/algorithms/ExportSampleLogsToCSVFile-v1.rst
Expand Up @@ -9,39 +9,63 @@
Description
-----------

Algorithm 'LoadSampleLogsToCSVFile' exports a specified set of sample logs
Algorithm *LoadSampleLogsToCSVFile* exports a specified set of sample logs
, which are stored in a MatrixWorkspace, to a CSV file.
The header for the sample log csv file can also
be created by this algorithm in a seperate *header* file.

CSV File format
===============

Sample logs are written to a csv file.
A tab separates any two adjacent values.

Each entry of each exported sample log will be an individual entry in the
output CSV file,
except in the situation that two entries with time stamps within time tolerance.

The output CSV file has 2+n columns, where n is the number of sample logs
to be exported.

Time Zone
---------

The time stamps of sample logs are recorded as UTC time in SNS.
Some users wants to see the exported sample log as the neutron facility's local time.
So the input property 'TimeZone' is for this purpose.

For
Here is the definition for the columns.

- Column 0: Absolute time in second
- Column 1: Relative to first log entry's time
- Column 2 to (2 + n) - 1: log values in the order determined by input
*SampleLogNames*

Header file
-----------
===========

A sample log header file can be generated optionally.
It contains theree lines described as below.

- Line 0: Test date: [Test date in string]
- Line 1: Test description: [Description of this log file]
- Line 2: Header content given by user via input property *Header*.
Usually it is the column names in the .csv file

CSV File format
---------------
Time Zone
=========

The time stamps of sample logs are recorded as UTC time in SNS.
Some users wants to see the exported sample log as the neutron facility's local time.
So the input property 'TimeZone' is for this purpose.

Property *TimeZone* does not support all the time zones
but only those with facilities that use Mantid.

Here is the list of all time zones that are allowed by this algorithm.
- UTC
- GMT+0
- America/New_York
- Asia/Shanghai
- Australia/Sydney
- Europe/London
- Europe/Paris
- Europe/Copenhagen


- Column 0: Absolute time in second
- Column 1: Relative to first log entry's time
- Column 2 to (2 + n) - 1: log values in the order determined by input
*SampleLogNames*

Usage
-----
Expand Down

0 comments on commit 7312528

Please sign in to comment.