Spgreadr: Difference between revisions
Jump to navigation
Jump to search
| Line 33: | Line 33: | ||
* '''multiselect''' = [ {'on'} |'off'] 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''' = [ {'on'} |'off'] 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. | * '''nonmatching''' : [ 'error' |{'matchvars'}| 'cell'] governs behavior when multiple files are being read which cannot be combined due to mismatched types, sizes, etc. | ||
* ''' spectrumindex''' : [{1}] specifies the index of the spectrum to be imported. Use 'all' to import all of the sub-spectra in a .spg multifile. | * ''' spectrumindex''' : [{1}] specifies the index of the spectrum to be imported. Use 'all' to import all of the sub-spectra in a .spg multifile. Use the colon operator to specify a range of sub-spectra. For example, use 5:10 to import sub-spectra 5 through 10. | ||
===See Also=== | ===See Also=== | ||
[[Data Importing Formats]], [[jcampreadr]], [[spcreadr]], [[writespc]], [[xclreadr]] , [[spareadr]] | [[Data Importing Formats]], [[jcampreadr]], [[spcreadr]], [[writespc]], [[xclreadr]] , [[spareadr]] | ||
Revision as of 07:17, 16 February 2023
Purpose
Reads Thermo Fisher SPG files.
Synopsis
- out = spgreadr
- out = spgreadr('filename')
- out = spgreadr({'filename' 'filename2'})
Description
Read SPG files into a dataset. SPG files are similar to SPA files but differ in that they contain multiple sub-spectra. Spgreadr reads a single spectrum from the .SPG file as indicated by the option spectrumindex.
Inputs
- file = a text string with the name of an SPG file or a cell of strings of SPG filenames. If (filename) is omitted or an empty cell or array, the user will be prompted to select a folder and then one or more files in the identified folder. If (filename) is a blank string , the user will be prompted to select a single file.
Outputs
- out = takes one of two forms:
- 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) a cell array with a dataset object for each input file if the 'nonmatching' option has value 'cell', or
- b) a dataset object containing the input data combined using the MATCHVARS function if the 'nonmatching' option has value 'matchvars'.
Options
options = a structure array with the following fields:
- multiselect = [ {'on'} |'off'] 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.
- spectrumindex : [{1}] specifies the index of the spectrum to be imported. Use 'all' to import all of the sub-spectra in a .spg multifile. Use the colon operator to specify a range of sub-spectra. For example, use 5:10 to import sub-spectra 5 through 10.
See Also
Data Importing Formats, jcampreadr, spcreadr, writespc, xclreadr , spareadr