MultipleFileProperty¶

Syntax¶

# Loads the Raw files 1, 2, 3, and 4 for TOSCA, but sums together runs 3 and 4.
Load(Filename='TSC1,2,3+4.raw', OutputWorkspace='Files')

# Loads the Raw files 1, 2 and 3 for TOSCA and 4, 5 and 6 for IRIS.
# The IRIS runs are added together.
Load(Filename='TSC1:3.raw,IRS4-6.raw', OutputWorkspace='Files')

# For TOSCA, adds together run 1 (found in c:/files/) and run 2 (found in c:/store/).
Load(Filename='c:/files/TSC1.raw+c:/store/TSC2.raw', OutputWorkspace='Files')

# For TOSCA, adds together runs 1, 4, 5 and 6.
Load(Filename='TSC1+4-5.raw', OutputWorkspace='Files')

# For IRIS, adds together runs 1, 2, 3, 7, 8 and 9.
Load(Filename='IRS1-3+7-9.raw', OutputWorkspace='Files')

Load Dialog¶

When you load a range of files from the Load Dialog and then reopen the dialog, the files that were loaded previously will now appear in a comma and plus separated list of fully resolved filenames.

Limitations¶

• Currently, Load can only handle multiple files using a single loader at a time. For example, loading a NeXuS file and a Raw file at the same time is not possible.
• It is not possible to plus together Ranges, or Stepped Ranges. (Added Ranges and Stepped Added Ranges may be plussed however.)
• Files that are loaded along with other files will end up with the same algorithm history. Generating a Python script for any of the workspaces, and then rerunning it will result in all the workspaces being loaded.
• The syntax for the different kind of ranges can only be used between run numbers, and not between fully or partially resolved files. For example, TSC1.raw-TSC3.raw is not allowed; use TSC1-3.raw instead.
• For the ILL data, since the file names (numors) do not contain instrument prefixes, multiple file loading will work only if the default facility and instrument are set correspondingly. In MantidWorkbench this can be achieved from the Help->About dialog.

Detailed API Documentation¶

bases: mantid.api.VectorVectorStringPropertyWithValue

class mantid.api.MultipleFileProperty¶

EMPTY_DBL = 8.988465674311579e+307¶

EMPTY_INT = 2147483647¶

EMPTY_LONG = 9223372036854775807¶

allowedValues¶

A list of allowed values

direction¶

Input, Output, InOut or Unknown. See the Direction class

documentation¶

The property’s doc string

dtype((VectorVectorStringPropertyWithValue)self) → str¶

getDefault¶

Get the default value as a string

getGroup¶

Return the ‘group’ of the property, that is, the header in the algorithm’s list of properties.

isDefault¶

Is the property set at the default value

isValid¶

An empty string if the property is valid, otherwise it contains an error message.

name¶

The name of the property

settings¶

Return the object managing this property’s settings

type¶

Returns a string identifier for the type

units¶

The units attached to this property

unitsAsBytes¶

The units attached to this property as a encoded bytes object. It is assumed the caller knows the correct endcoding used.

value¶

valueAsPrettyStr((Property)arg1[, (int)maxLength=0[, (bool)collapseLists=True]]) → str :¶

The value of the property as a formatted string. If maxLength is defined then the output may not contain the full contents of the property. The maxLength and collapseLists arguments do not work for all property types

valueAsStr¶

The value of the property as a string. For some property types, e.g. Workspaces, it is useful to be able to refer to the string value directly

Category: Concepts