Brukerxrpdreadr: Difference between revisions
Jump to navigation
Jump to search
imported>Jeremy (Created page with "===Purpose=== Reads Bruker XRPD RAW files into a DataSet object. ===Synopsis=== :data = brukerxrpdreadr(filename,''options'') :data = brukerxrpdreadr({'filename' 'filename2...") |
imported>Donal No edit summary |
||
Line 20: | Line 20: | ||
====Outputs==== | ====Outputs==== | ||
*'''data''' = normally a DataSet object with the data read from all files. If | *'''data''' = normally a DataSet object with the data read from all files. | ||
:# If input is a single file, or multiple files containing data that can be combined (same number of data points, same x-axis range, same type of data), the output is a dataset object | |||
:# If the input consists of multiple files containing data that cannot simply be combined (different number of data points, differing x-axis ranges, etc), the output is either: | |||
:::a cell array with a dataset object for each input file if the 'nonmatching' option has value 'cell', or | |||
:::a dataset object containing the input data combined using the MATCHVARS function if the 'nonmatching' option has value 'matchvars'. | |||
===Options=== | ===Options=== | ||
Line 26: | Line 31: | ||
*'''nonmatching''' : [ 'error' | 'cell' |{'match'}] Governs behavior when multiple files are being read which cannot be combined due to mismatched types, sizes, etc. 'match' aligns all files to axis scale on first file, 'cell' returns cell (see outputs, above) 'error' throws an error. | *'''nonmatching''' : [ 'error' | 'cell' |{'match'}] Governs behavior when multiple files are being read which cannot be combined due to mismatched types, sizes, etc. 'match' aligns all files to axis scale on first file, 'cell' returns cell (see outputs, above) 'error' throws an error. | ||
*'''multiselect''': [ 'off' | {'on'} ] governs whether file selection dialog should allow multiple files to be selected and imported. Setting to 'off' will restrict user to importing only one file at a time. | *'''multiselect''': [ 'off' | {'on'} ] governs whether file selection dialog should allow multiple files to be selected and imported. Setting to 'off' will restrict user to importing only one file at a time. | ||
*'''nonmatching''' : [ 'error' |{'matchvars'} 'cell'] Governs behavior when multiple files are being read which cannot be combined due to mismatched types, sizes, etc. | |||
::: 'matchvars' returns a dataset object, | |||
::: 'cell' returns cell (see Outputs), | |||
::: 'error' gives an error. | |||
*'''waitbar''': <tt>[ 'off' |{'on'}]</tt> Governs display of a progress bar when doing multiple file reading. | *'''waitbar''': <tt>[ 'off' |{'on'}]</tt> Governs display of a progress bar when doing multiple file reading. | ||
Latest revision as of 13:26, 17 June 2015
Purpose
Reads Bruker XRPD RAW files into a DataSet object.
Synopsis
- data = brukerxrpdreadr(filename,options)
- data = brukerxrpdreadr({'filename' 'filename2'},options)
Description
Input is the filename of a Bruker XRPD RAW file (or a list of filenames) to read. If omitted, the user is prompted for a file. Multiple input files must contain the same axisscale for the wavelength (variables) mode. The imported files are returned in a Dataset Object.
Optional Inputs
- filename = specifies the file(s) to read using:
- (a) a string specifying a single file to read
- (b) a cell array of strings specifying multiple files to read
- If fname is an empty string or matrix or is not supplied, the user is prompted to identify file(s) to load.
- options = an optional options structure. See Options below.
Outputs
- data = normally a DataSet object with the data read from all files.
- If input is a single file, or multiple files containing data that can be combined (same number of data points, same x-axis range, same type of data), the output is a dataset object
- If the input consists of multiple files containing data that cannot simply be combined (different number of data points, differing x-axis ranges, etc), the output is either:
- a cell array with a dataset object for each input file if the 'nonmatching' option has value 'cell', or
- a dataset object containing the input data combined using the MATCHVARS function if the 'nonmatching' option has value 'matchvars'.
Options
Input 'options' is an options structure containing the following fields
- nonmatching : [ 'error' | 'cell' |{'match'}] Governs behavior when multiple files are being read which cannot be combined due to mismatched types, sizes, etc. 'match' aligns all files to axis scale on first file, 'cell' returns cell (see outputs, above) 'error' throws an error.
- multiselect: [ 'off' | {'on'} ] governs whether file selection dialog should allow multiple files to be selected and imported. Setting to 'off' will restrict user to importing only one file at a time.
- nonmatching : [ 'error' |{'matchvars'} 'cell'] Governs behavior when multiple files are being read which cannot be combined due to mismatched types, sizes, etc.
- 'matchvars' returns a dataset object,
- 'cell' returns cell (see Outputs),
- 'error' gives an error.
- waitbar: [ 'off' |{'on'}] Governs display of a progress bar when doing multiple file reading.
See Also
Data Importing Formats, jcampreadr, opusreadr, pereadr, spareadr, spcreadr, writespc, xclreadr