Skip to content

Commit

Permalink
re #6669 Improved in file documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
NickDraper committed Mar 5, 2013
1 parent 3b279ab commit 807d9a1
Showing 1 changed file with 20 additions and 3 deletions.
Original file line number Diff line number Diff line change
@@ -1,3 +1,20 @@
"""*WIKI*
Creates a table workspace of the average values of log values against the run number.
There are special cases for:
* beamlog_(counts, frames, etc): last few points end up in next run's log. Find Maximum.
* comment (separate function)
* time series, take average for t>0 (if available)
It should:
# Load any file type that [[Load]] can handle.
# Not crash with multiperiod data - although values will be from period 1
# Handle gaps in the file structure (although this can be slow over a network if you choose a range of 100s)
# Load only a single spectra of the data (if the file loader supports this).
# Print out the list of acceptable log names if one is entered incorrectly.
# Use a hidden workspace for the temporary loaded workspaces, and clean up after itself.
*WIKI*"""

import time
import datetime
import numbers
Expand All @@ -12,9 +29,9 @@ class LoadLogPropertyTable(PythonAlgorithm):
# comment (separate function)
# time series, take average for t>0 (if available)
def PyInit(self):
self.declareProperty(FileProperty(name="FirstFile",defaultValue="",action=FileAction.Load,extensions = ["nxs","raw"]))
self.declareProperty(FileProperty(name="LastFile",defaultValue="",action=FileAction.Load,extensions = ["nxs","raw"]))
self.declareProperty(StringArrayProperty("LogNames",direction=Direction.Input))
self.declareProperty(FileProperty(name="FirstFile",defaultValue="",action=FileAction.Load,extensions = ["nxs","raw"]),"The first file to load from")
self.declareProperty(FileProperty(name="LastFile",defaultValue="",action=FileAction.Load,extensions = ["nxs","raw"]),"The Last file to load from, must be in the same directory, all files in between will also be used")
self.declareProperty(StringArrayProperty("LogNames",direction=Direction.Input),"The comma seperated list of properties to include. \nThe full list will be printed if an invalid value is used.")
self.declareProperty(WorkspaceProperty("OutputWS","",Direction.Output),"Table of results")

def category(self):
Expand Down

0 comments on commit 807d9a1

Please sign in to comment.